Struct GcsSystem 

pub struct GcsSystem { /* private fields */ }

The geometric constraint system.

Owns all entities (points, lines, circles) and constraints. Provides CRUD operations and orchestrates the solver.

Implementations

impl GcsSystem

pub fn new() -> GcsSystem

Create a new empty GCS.

pub fn add_point(&mut self, data: PointData) -> Handle<PointData>

Add a point. Returns its handle.

pub fn point(&self, id: Handle<PointData>) -> Option<&PointData>

Get a point by handle.

pub fn point_mut(&mut self, id: Handle<PointData>) -> Option<&mut PointData>

Get a mutable reference to a point.

pub fn remove_point( &mut self, id: Handle<PointData>, ) -> Result<PointData, SketchError>

Remove a point. Fails if referenced by any line, circle, or constraint.

Errors

Returns SketchError::EntityInUse if the point is referenced by a line, circle, or constraint. Returns SketchError::InvalidHandle if the handle is stale or invalid.

pub fn add_line( &mut self, p1: Handle<PointData>, p2: Handle<PointData>, ) -> Result<Handle<LineData>, SketchError>

Add a line between two existing points.

Errors

Returns SketchError::InvalidHandle if either point handle is invalid.

pub fn line(&self, id: Handle<LineData>) -> Option<&LineData>

Get a line by handle.

pub fn remove_line( &mut self, id: Handle<LineData>, ) -> Result<LineData, SketchError>

Remove a line. Fails if referenced by any constraint.

Errors

Returns SketchError::EntityInUse if the line is referenced by a constraint. Returns SketchError::InvalidHandle if the handle is stale or invalid.

pub fn add_circle( &mut self, center: Handle<PointData>, radius: f64, ) -> Result<Handle<CircleData>, SketchError>

Add a circle with a center point and radius.

Errors

Returns SketchError::InvalidHandle if the center point handle is invalid.

pub fn circle(&self, id: Handle<CircleData>) -> Option<&CircleData>

Get a circle by handle.

pub fn remove_circle( &mut self, id: Handle<CircleData>, ) -> Result<CircleData, SketchError>

Remove a circle. Fails if referenced by any constraint.

Errors

Returns SketchError::EntityInUse if the circle is referenced by a constraint. Returns SketchError::InvalidHandle if the handle is stale or invalid.

pub fn add_arc( &mut self, center: Handle<PointData>, start: Handle<PointData>, end: Handle<PointData>, ) -> Result<Handle<ArcData>, SketchError>

Add an arc defined by center, start, and end points.

Auto-adds an internal PointOnArc(end, arc) constraint so that dist(center, end) == dist(center, start) is maintained dynamically as the start point moves.

Errors

Returns SketchError::InvalidHandle if any point handle is invalid.

pub fn arc(&self, id: Handle<ArcData>) -> Option<&ArcData>

Get an arc by handle.

pub fn arc_mut(&mut self, id: Handle<ArcData>) -> Option<&mut ArcData>

Get a mutable reference to an arc.

pub fn remove_arc( &mut self, id: Handle<ArcData>, ) -> Result<ArcData, SketchError>

Remove an arc. Fails if referenced by any user constraint.

Also removes the internal distance constraint that was auto-added by add_arc.

Errors

Returns SketchError::EntityInUse if the arc is referenced by a constraint. Returns SketchError::InvalidHandle if the handle is stale or invalid.

pub fn arc_count(&self) -> usize

Number of arcs.

pub fn arcs(&self) -> impl Iterator<Item = (Handle<ArcData>, &ArcData)>

Iterate over all arcs.

pub fn add_constraint( &mut self, constraint: Constraint, ) -> Result<Handle<ConstraintEntry>, SketchError>

Add a constraint. Validates that all referenced entities exist.

Errors

Returns SketchError::InvalidHandle if any entity referenced by the constraint does not exist.

pub fn remove_constraint( &mut self, id: Handle<ConstraintEntry>, ) -> Result<(), SketchError>

Remove a constraint by handle.

Errors

Returns SketchError::InvalidHandle if the handle is stale or invalid.

pub fn constraint(&self, id: Handle<ConstraintEntry>) -> Option<&Constraint>

Get a constraint by handle.

pub fn constraint_count(&self) -> usize

Number of constraints (includes internal arc constraints).

pub fn point_count(&self) -> usize

Number of points.

pub fn line_count(&self) -> usize

Number of lines.

pub fn circle_count(&self) -> usize

Number of circles.

pub fn solve( &mut self, max_iterations: usize, tolerance: f64, ) -> Result<SolveResult, SketchError>

Solve the constraint system.

Modifies entity positions in-place to satisfy all constraints.

Errors

Returns SketchError if the system parameters are in an invalid state. The Result wrapper is retained for future error paths (e.g. singular Jacobian detection).

pub fn dof(&mut self) -> DofAnalysis

Analyze degrees of freedom in the current system.

pub fn points(&self) -> impl Iterator<Item = (Handle<PointData>, &PointData)>

Iterate over all points.

pub fn lines(&self) -> impl Iterator<Item = (Handle<LineData>, &LineData)>

Iterate over all lines.

pub fn circles(&self) -> impl Iterator<Item = (Handle<CircleData>, &CircleData)>

Iterate over all circles.

Trait Implementations

impl Clone for GcsSystem

fn clone(&self) -> GcsSystem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for GcsSystem

fn default() -> GcsSystem

Returns the “default value” for a type.