Struct FrontendState 

pub struct FrontendState { /* private fields */ }

Implementations

impl FrontendState

pub fn new() -> Self

pub fn scene_graph(&self) -> &SceneGraph

Get a reference to the scene graph

pub fn default_length_unit(&self) -> UnitLength

pub async fn create_sketch_checkpoint( &mut self, exec_outcome: ExecOutcome, ) -> Result<SketchCheckpointId>

pub async fn edit_segments_with_options( &mut self, ctx: &ExecutorContext, version: Version, sketch: ObjectId, segments: Vec<ExistingSegmentCtor>, options: EditSegmentsOptions, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

Edit sketch segments with optional drag-solve overrides.

Drag anchors add hidden fixed cursor points and constrain the referenced segment bodies to pass through them, which lets body drags use the same anchor model without pinning all child points. Preview callers disable solver writeback so solved geometry can be returned without feeding every solver value back into KCL.

pub async fn edit_distance_constraint_label_position_with_options( &mut self, ctx: &ExecutorContext, version: Version, sketch: ObjectId, constraint_id: ObjectId, label_position: Point2d<Number>, options: EditDistanceConstraintLabelPositionOptions, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

Edit a distance-constraint label position with optional solver writeback.

Drag previews set commit_solved_initial_guesses to false so label placement can be previewed against solved geometry without advancing persistent KCL state until drag completion.

pub async fn restore_sketch_checkpoint( &mut self, checkpoint_id: SketchCheckpointId, ) -> Result<RestoreSketchCheckpointOutcome>

pub fn clear_sketch_checkpoints(&mut self)

impl FrontendState

pub async fn hack_set_program( &mut self, ctx: &ExecutorContext, program: Program, ) -> ExecResult<SetProgramOutcome>

pub async fn engine_execute( &mut self, ctx: &ExecutorContext, program: Program, ) -> Result<SceneGraphDelta, KclErrorWithOutputs>

Decorate engine execution such that our state is updated and the scene graph is added to the return.

Trait Implementations

impl Clone for FrontendState

fn clone(&self) -> FrontendState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrontendState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FrontendState

fn default() -> Self

Returns the “default value” for a type.

impl SketchApi for FrontendState

async fn batch_split_segment_operations( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, edit_segments: Vec<ExistingSegmentCtor>, add_constraints: Vec<Constraint>, delete_constraint_ids: Vec<ObjectId>, _new_segment_info: NewSegmentInfo, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

Splitting a segment means creating a new segment, editing the old one, and then migrating a bunch of the constraints from the original segment to the new one (i.e. deleting them and re-adding them on the other segment).

To keep this efficient we require as few executions as possible: we create the new segment first (to get its id), then do all edits and new constraints, and do all deletes at the end (since deletes invalidate ids).

async fn execute_mock( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

Execute the sketch in mock mode, without changing anything. This is useful after editing segments, and the user releases the mouse button.

async fn new_sketch( &mut self, ctx: &ExecutorContext, _project: ProjectId, _file: FileId, _version: Version, args: SketchCtor, ) -> ExecResult<(SourceDelta, SceneGraphDelta, ObjectId)>

async fn edit_sketch( &mut self, ctx: &ExecutorContext, _project: ProjectId, _file: FileId, _version: Version, sketch: ObjectId, ) -> ExecResult<SceneGraphDelta>

async fn exit_sketch( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, ) -> ExecResult<SceneGraph>

async fn delete_sketch( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn add_segment( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, segment: SegmentCtor, _label: Option<String>, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn edit_segments( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, segments: Vec<ExistingSegmentCtor>, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn delete_objects( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, constraint_ids: Vec<ObjectId>, segment_ids: Vec<ObjectId>, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn add_constraint( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, constraint: Constraint, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn chain_segment( &mut self, ctx: &ExecutorContext, version: Version, sketch: ObjectId, previous_segment_end_point_id: ObjectId, segment: SegmentCtor, _label: Option<String>, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn edit_constraint( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, constraint_id: ObjectId, value_expression: String, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn edit_distance_constraint_label_position( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, constraint_id: ObjectId, label_position: Point2d<Number>, anchor_segment_ids: Vec<ObjectId>, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

async fn batch_tail_cut_operations( &mut self, ctx: &ExecutorContext, _version: Version, sketch: ObjectId, edit_segments: Vec<ExistingSegmentCtor>, add_constraints: Vec<Constraint>, delete_constraint_ids: Vec<ObjectId>, additional_edited_segment_ids: Vec<ObjectId>, ) -> ExecResult<(SourceDelta, SceneGraphDelta)>

Batch operations for tail-cut trim: edit a segment, add coincident constraints, delete constraints, and execute once.