Enum ModelingCmdEndpoint

pub enum ModelingCmdEndpoint {
    EngineUtilEvaluatePath,
    StartPath,
    MovePathPen,
    ExtendPath,
    Extrude,
    TwistExtrude,
    Sweep,
    Revolve,
    Solid3dShellFace,
    RevolveAboutEdge,
    Loft,
    ClosePath,
    CameraDragStart,
    CameraDragMove,
    CameraDragEnd,
    DefaultCameraGetSettings,
    DefaultCameraGetView,
    DefaultCameraSetView,
    DefaultCameraLookAt,
    DefaultCameraPerspectiveSettings,
    DefaultCameraZoom,
    Export2d,
    Export3d,
    Export,
    EntityGetParentId,
    EntityGetNumChildren,
    EntityGetChildUuid,
    EntityGetAllChildUuids,
    EntityGetSketchPaths,
    EntityGetDistance,
    EntityClone,
    EntityLinearPatternTransform,
    EntityLinearPattern,
    EntityCircularPattern,
    EntityMakeHelix,
    EntityMakeHelixFromParams,
    EntityMakeHelixFromEdge,
    EntityMirror,
    EntityMirrorAcrossEdge,
    SelectWithPoint,
    SelectAdd,
    SelectRemove,
    SceneClearAll,
    SelectReplace,
    HighlightSetEntity,
    HighlightSetEntities,
    NewAnnotation,
    UpdateAnnotation,
    EdgeLinesVisible,
    ObjectVisible,
    ObjectBringToFront,
    ObjectSetMaterialParamsPbr,
    GetEntityType,
    Solid3dGetAllEdgeFaces,
    Solid2dAddHole,
    Solid3dGetAllOppositeEdges,
    Solid3dGetOppositeEdge,
    Solid3dGetNextAdjacentEdge,
    Solid3dGetPrevAdjacentEdge,
    Solid3dGetCommonEdge,
    Solid3dFilletEdge,
    FaceIsPlanar,
    FaceGetPosition,
    FaceGetCenter,
    FaceGetGradient,
    SendObject,
    EntitySetOpacity,
    EntityFade,
    MakePlane,
    PlaneSetColor,
    SetTool,
    MouseMove,
    MouseClick,
    SketchModeDisable,
    GetSketchModePlane,
    CurveSetConstraint,
    EnableSketchMode,
    EnableDryRun,
    DisableDryRun,
    SetBackgroundColor,
    SetCurrentToolProperties,
    SetDefaultSystemProperties,
    CurveGetType,
    CurveGetControlPoints,
    ProjectEntityToPlane,
    ProjectPointsToPlane,
    TakeSnapshot,
    MakeAxesGizmo,
    PathGetInfo,
    PathGetCurveUuidsForVertices,
    PathGetCurveUuid,
    PathGetVertexUuids,
    PathGetSketchTargetUuid,
    HandleMouseDragStart,
    HandleMouseDragMove,
    HandleMouseDragEnd,
    RemoveSceneObjects,
    PlaneIntersectAndProject,
    CurveGetEndPoints,
    ReconfigureStream,
    ImportFiles,
    SetSceneUnits,
    Mass,
    Density,
    Volume,
    CenterOfMass,
    SurfaceArea,
    DefaultCameraFocusOn,
    SetSelectionType,
    SetSelectionFilter,
    DefaultCameraSetOrthographic,
    DefaultCameraSetPerspective,
    DefaultCameraCenterToSelection,
    DefaultCameraCenterToScene,
    ZoomToFit,
    OrientToFace,
    ViewIsometric,
    Solid3dGetExtrusionFaceInfo,
    Solid3dGetAdjacencyInfo,
    SelectClear,
    SelectGet,
    GetNumObjects,
    SetObjectTransform,
    BooleanUnion,
    BooleanIntersection,
    BooleanSubtract,
    MakeOffsetPath,
    AddHoleFromOffset,
    SetGridReferencePlane,
    SetGridScale,
    SetGridAutoScale,
}

Each modeling command (no parameters or fields).

Variants

EngineUtilEvaluatePath

Evaluates the position of a path in one shot (engine utility for kcl executor)

StartPath

Start a new path.

MovePathPen

Move the path’s “pen”. If you’re in sketch mode, these coordinates are in the local coordinate system, not the world’s coordinate system. For example, say you’re sketching on the plane {x: (1,0,0), y: (0,1,0), origin: (0, 0, 50)}. In other words, the plane 50 units above the default XY plane. Then, moving the pen to (1, 1, 0) with this command uses local coordinates. So, it would move the pen to (1, 1, 50) in global coordinates.

ExtendPath

Extend a path by adding a new segment which starts at the path’s “pen”. If no “pen” location has been set before (via MovePen), then the pen is at the origin.

Extrude

Command for extruding a solid 2d.

TwistExtrude

Command for twist extruding a solid 2d.

Sweep

Extrude the object along a path.

Revolve

Command for revolving a solid 2d.

Solid3dShellFace

Command for shelling a solid3d face

RevolveAboutEdge

Command for revolving a solid 2d about a brep edge

Loft

Command for lofting sections to create a solid

ClosePath

Closes a path, converting it to a 2D solid.

CameraDragStart

Camera drag started.

CameraDragMove

Camera drag continued.

CameraDragEnd

Camera drag ended

DefaultCameraGetSettings

Gets the default camera’s camera settings

DefaultCameraGetView

Gets the default camera’s view state

DefaultCameraSetView

Sets the default camera’s view state

DefaultCameraLookAt

Change what the default camera is looking at.

DefaultCameraPerspectiveSettings

Change what the default camera is looking at.

DefaultCameraZoom

Adjust zoom of the default camera.

Export2d

Export a sketch to a file.

Export3d

Export the scene to a file.

Export

Export the scene to a file.

EntityGetParentId

What is this entity’s parent?

EntityGetNumChildren

How many children does the entity have?

EntityGetChildUuid

What is the UUID of this entity’s n-th child?

EntityGetAllChildUuids

What are all UUIDs of this entity’s children?

EntityGetSketchPaths

What are all UUIDs of all the paths sketched on top of this entity?

EntityGetDistance

What is the distance between these two entities?

EntityClone

Create a pattern using this entity by specifying the transform for each desired repetition. Transformations are performed in the following order (first applied to last applied): scale, rotate, translate.

EntityLinearPatternTransform

Create a pattern using this entity by specifying the transform for each desired repetition. Transformations are performed in the following order (first applied to last applied): scale, rotate, translate.

EntityLinearPattern

Create a linear pattern using this entity.

EntityCircularPattern

Create a circular pattern using this entity.

EntityMakeHelix

Create a helix using the input cylinder and other specified parameters.

EntityMakeHelixFromParams

Create a helix using the specified parameters.

EntityMakeHelixFromEdge

Create a helix using the specified parameters.

EntityMirror

Mirror the input entities over the specified axis. (Currently only supports sketches)

EntityMirrorAcrossEdge

Mirror the input entities over the specified edge. (Currently only supports sketches)

SelectWithPoint

Modifies the selection by simulating a “mouse click” at the given x,y window coordinate Returns ID of whatever was selected.

SelectAdd

Adds one or more entities (by UUID) to the selection.

SelectRemove

Removes one or more entities (by UUID) from the selection.

SceneClearAll

Removes all of the Objects in the scene

SelectReplace

Replaces current selection with these entities (by UUID).

HighlightSetEntity

Changes the current highlighted entity to whichever one is at the given window coordinate. If there’s no entity at this location, clears the highlight.

HighlightSetEntities

Changes the current highlighted entity to these entities.

NewAnnotation

Create a new annotation

UpdateAnnotation

Update an annotation

EdgeLinesVisible

Changes visibility of scene-wide edge lines on brep solids

ObjectVisible

Hide or show an object

ObjectBringToFront

Bring an object to the front of the scene

ObjectSetMaterialParamsPbr

Set the material properties of an object

GetEntityType

What type of entity is this?

Solid3dGetAllEdgeFaces

Gets all faces which use the given edge.

Solid2dAddHole

Add a hole to a Solid2d object before extruding it.

Solid3dGetAllOppositeEdges

Gets all edges which are opposite the given edge, across all possible faces.

Solid3dGetOppositeEdge

Gets the edge opposite the given edge, along the given face.

Solid3dGetNextAdjacentEdge

Gets the next adjacent edge for the given edge, along the given face.

Solid3dGetPrevAdjacentEdge

Gets the previous adjacent edge for the given edge, along the given face.

Solid3dGetCommonEdge

Gets the shared edge between these two faces if it exists

Solid3dFilletEdge

Fillets the given edge with the specified radius.

FaceIsPlanar

Determines whether a brep face is planar and returns its surface-local planar axes if so

FaceGetPosition

Determines a position on a brep face evaluated by parameters u,v

FaceGetCenter

Obtains the surface “center of mass”

FaceGetGradient

Determines the gradient (dFdu, dFdv) + normal vector on a brep face evaluated by parameters u,v

SendObject

Send object to front or back.

EntitySetOpacity

Set opacity of the entity.

EntityFade

Fade entity in or out.

MakePlane

Make a new plane

PlaneSetColor

Set the color of a plane.

SetTool

Set the current tool.

MouseMove

Send a mouse move event

MouseClick

Send a mouse click event Updates modified/selected entities.

SketchModeDisable

Disable sketch mode. If you are sketching on a face, be sure to not disable sketch mode until you have extruded. Otherwise, your object will not be fused with the face.

GetSketchModePlane

Get the plane for sketch mode.

CurveSetConstraint

Get the plane for sketch mode.

EnableSketchMode

Sketch on some entity (e.g. a plane, a face).

EnableDryRun

Sets whether or not changes to the scene or its objects will be done as a “dry run” In a dry run, successful commands won’t actually change the model. This is useful for catching errors before actually making the change.

DisableDryRun

Sets whether or not changes to the scene or its objects will be done as a “dry run” In a dry run, successful commands won’t actually change the model. This is useful for catching errors before actually making the change.

SetBackgroundColor

Set the background color of the scene.

SetCurrentToolProperties

Set the properties of the tool lines for the scene.

SetDefaultSystemProperties

Set the default system properties used when a specific property isn’t set.

CurveGetType

Get type of the given curve.

CurveGetControlPoints

Get control points of the given curve.

ProjectEntityToPlane

Project an entity on to a plane.

ProjectPointsToPlane

Project a list of points on to a plane.

TakeSnapshot

Take a snapshot of the current view.

MakeAxesGizmo

Add a gizmo showing the axes.

PathGetInfo

Query the given path.

PathGetCurveUuidsForVertices

Obtain curve ids for vertex ids

PathGetCurveUuid

Obtain curve id by index

PathGetVertexUuids

Obtain vertex ids for a path

PathGetSketchTargetUuid

Obtain the sketch target id (if the path was drawn in sketchmode) for a path

HandleMouseDragStart

Start dragging the mouse.

HandleMouseDragMove

Continue dragging the mouse.

HandleMouseDragEnd

Stop dragging the mouse.

RemoveSceneObjects

Remove scene objects.

PlaneIntersectAndProject

Utility method. Performs both a ray cast and projection to plane-local coordinates. Returns the plane coordinates for the given window coordinates.

CurveGetEndPoints

Find the start and end of a curve.

ReconfigureStream

Reconfigure the stream.

ImportFiles

Import files to the current model.

SetSceneUnits

Set the units of the scene. For all following commands, the units will be interpreted as the given units. Any previously executed commands will not be affected or have their units changed. They will remain in the units they were originally executed in.

Mass

Get the mass of entities in the scene or the default scene.

Density

Get the density of entities in the scene or the default scene.

Volume

Get the volume of entities in the scene or the default scene.

CenterOfMass

Get the center of mass of entities in the scene or the default scene.

SurfaceArea

Get the surface area of entities in the scene or the default scene.

DefaultCameraFocusOn

Focus the default camera upon an object in the scene.

SetSelectionType

When you select some entity with the current tool, what should happen to the entity?

SetSelectionFilter

What kind of entities can be selected?

DefaultCameraSetOrthographic

Use orthographic projection.

DefaultCameraSetPerspective

Use perspective projection.

DefaultCameraCenterToSelection

Updates the camera to center to the center of the current selection (or the origin if nothing is selected)

DefaultCameraCenterToScene

Updates the camera to center to the center of the current scene’s bounds

ZoomToFit

Fit the view to the specified object(s).

OrientToFace

Looks along the normal of the specified face (if it is planar!), and fits the view to it.

ViewIsometric

Fit the view to the scene with an isometric view.

Solid3dGetExtrusionFaceInfo

Get a concise description of all of an extrusion’s faces.

Solid3dGetAdjacencyInfo

Get a concise description of all of solids edges.

SelectClear

Clear the selection

SelectGet

Find all IDs of selected entities

GetNumObjects

Get the number of objects in the scene

SetObjectTransform

Set the transform of an object.

BooleanUnion

Create a new solid from combining other smaller solids. In other words, every part of the input solids will be included in the output solid.

BooleanIntersection

Create a new solid from intersecting several other solids. In other words, the part of the input solids where they all overlap will be the output solid.

BooleanSubtract

Create a new solid from subtracting several other solids. The ‘target’ is what will be cut from. The ‘tool’ is what will be cut out from ‘target’.

MakeOffsetPath

Make a new path by offsetting an object by a given distance. The new path’s ID will be the ID of this command.

AddHoleFromOffset

Add a hole to a closed path by offsetting it a uniform distance inward.

SetGridReferencePlane

Align the grid with a plane or a planar face.

SetGridScale

Set the scale of the grid lines in the video feed.

SetGridAutoScale

Set the grid lines to auto scale. The grid will get larger the further you zoom out, and smaller the more you zoom in.

Trait Implementations

impl Clone for ModelingCmdEndpoint

fn clone(&self) -> ModelingCmdEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelingCmdEndpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelingCmdEndpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ModelingCmdEndpoint

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

Formats the value using the given formatter.

impl From<ModelingCmd> for ModelingCmdEndpoint

You can easily convert each modeling command with its fields, into a modeling command without fields.

fn from(v: ModelingCmd) -> Self

Converts to this type from the input type.

impl PartialEq for ModelingCmdEndpoint

fn eq(&self, other: &ModelingCmdEndpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ModelingCmdEndpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelingCmdEndpoint