Enum ModelingCmd

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

Commands that the KittyCAD engine can execute.

Variants

EngineUtilEvaluatePath(EngineUtilEvaluatePath)

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

StartPath(StartPath)

Start a new path.

MovePathPen(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(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(Extrude)

Command for extruding a solid 2d.

TwistExtrude(TwistExtrude)

Command for twist extruding a solid 2d.

Sweep(Sweep)

Extrude the object along a path.

Revolve(Revolve)

Command for revolving a solid 2d.

Solid3dShellFace(Solid3dShellFace)

Command for shelling a solid3d face

RevolveAboutEdge(RevolveAboutEdge)

Command for revolving a solid 2d about a brep edge

Loft(Loft)

Command for lofting sections to create a solid

ClosePath(ClosePath)

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

CameraDragStart(CameraDragStart)

Camera drag started.

CameraDragMove(CameraDragMove)

Camera drag continued.

CameraDragEnd(CameraDragEnd)

Camera drag ended

DefaultCameraGetSettings(DefaultCameraGetSettings)

Gets the default camera’s camera settings

DefaultCameraGetView(DefaultCameraGetView)

Gets the default camera’s view state

DefaultCameraSetView(DefaultCameraSetView)

Sets the default camera’s view state

DefaultCameraLookAt(DefaultCameraLookAt)

Change what the default camera is looking at.

DefaultCameraPerspectiveSettings(DefaultCameraPerspectiveSettings)

Change what the default camera is looking at.

DefaultCameraZoom(DefaultCameraZoom)

Adjust zoom of the default camera.

Export2d(Export2d)

Export a sketch to a file.

Export3d(Export3d)

Export the scene to a file.

Export(Export)

Export the scene to a file.

EntityGetParentId(EntityGetParentId)

What is this entity’s parent?

EntityGetNumChildren(EntityGetNumChildren)

How many children does the entity have?

EntityGetChildUuid(EntityGetChildUuid)

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

EntityGetAllChildUuids(EntityGetAllChildUuids)

What are all UUIDs of this entity’s children?

EntityGetSketchPaths(EntityGetSketchPaths)

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

EntityGetDistance(EntityGetDistance)

What is the distance between these two entities?

EntityClone(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(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(EntityLinearPattern)

Create a linear pattern using this entity.

EntityCircularPattern(EntityCircularPattern)

Create a circular pattern using this entity.

EntityMakeHelix(EntityMakeHelix)

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

EntityMakeHelixFromParams(EntityMakeHelixFromParams)

Create a helix using the specified parameters.

EntityMakeHelixFromEdge(EntityMakeHelixFromEdge)

Create a helix using the specified parameters.

EntityMirror(EntityMirror)

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

EntityMirrorAcrossEdge(EntityMirrorAcrossEdge)

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

SelectWithPoint(SelectWithPoint)

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

SelectAdd(SelectAdd)

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

SelectRemove(SelectRemove)

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

SceneClearAll(SceneClearAll)

Removes all of the Objects in the scene

SelectReplace(SelectReplace)

Replaces current selection with these entities (by UUID).

HighlightSetEntity(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(HighlightSetEntities)

Changes the current highlighted entity to these entities.

NewAnnotation(NewAnnotation)

Create a new annotation

UpdateAnnotation(UpdateAnnotation)

Update an annotation

EdgeLinesVisible(EdgeLinesVisible)

Changes visibility of scene-wide edge lines on brep solids

ObjectVisible(ObjectVisible)

Hide or show an object

ObjectBringToFront(ObjectBringToFront)

Bring an object to the front of the scene

ObjectSetMaterialParamsPbr(ObjectSetMaterialParamsPbr)

Set the material properties of an object

GetEntityType(GetEntityType)

What type of entity is this?

Solid3dGetAllEdgeFaces(Solid3dGetAllEdgeFaces)

Gets all faces which use the given edge.

Solid2dAddHole(Solid2dAddHole)

Add a hole to a Solid2d object before extruding it.

Solid3dGetAllOppositeEdges(Solid3dGetAllOppositeEdges)

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

Solid3dGetOppositeEdge(Solid3dGetOppositeEdge)

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

Solid3dGetNextAdjacentEdge(Solid3dGetNextAdjacentEdge)

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

Solid3dGetPrevAdjacentEdge(Solid3dGetPrevAdjacentEdge)

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

Solid3dGetCommonEdge(Solid3dGetCommonEdge)

Gets the shared edge between these two faces if it exists

Solid3dFilletEdge(Solid3dFilletEdge)

Fillets the given edge with the specified radius.

FaceIsPlanar(FaceIsPlanar)

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

FaceGetPosition(FaceGetPosition)

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

FaceGetCenter(FaceGetCenter)

Obtains the surface “center of mass”

FaceGetGradient(FaceGetGradient)

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

SendObject(SendObject)

Send object to front or back.

EntitySetOpacity(EntitySetOpacity)

Set opacity of the entity.

EntityFade(EntityFade)

Fade entity in or out.

MakePlane(MakePlane)

Make a new plane

PlaneSetColor(PlaneSetColor)

Set the color of a plane.

SetTool(SetTool)

Set the current tool.

MouseMove(MouseMove)

Send a mouse move event

MouseClick(MouseClick)

Send a mouse click event Updates modified/selected entities.

SketchModeDisable(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(GetSketchModePlane)

Get the plane for sketch mode.

CurveSetConstraint(CurveSetConstraint)

Get the plane for sketch mode.

EnableSketchMode(EnableSketchMode)

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

EnableDryRun(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(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(SetBackgroundColor)

Set the background color of the scene.

SetCurrentToolProperties(SetCurrentToolProperties)

Set the properties of the tool lines for the scene.

SetDefaultSystemProperties(SetDefaultSystemProperties)

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

CurveGetType(CurveGetType)

Get type of the given curve.

CurveGetControlPoints(CurveGetControlPoints)

Get control points of the given curve.

ProjectEntityToPlane(ProjectEntityToPlane)

Project an entity on to a plane.

ProjectPointsToPlane(ProjectPointsToPlane)

Project a list of points on to a plane.

TakeSnapshot(TakeSnapshot)

Take a snapshot of the current view.

MakeAxesGizmo(MakeAxesGizmo)

Add a gizmo showing the axes.

PathGetInfo(PathGetInfo)

Query the given path.

PathGetCurveUuidsForVertices(PathGetCurveUuidsForVertices)

Obtain curve ids for vertex ids

PathGetCurveUuid(PathGetCurveUuid)

Obtain curve id by index

PathGetVertexUuids(PathGetVertexUuids)

Obtain vertex ids for a path

PathGetSketchTargetUuid(PathGetSketchTargetUuid)

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

HandleMouseDragStart(HandleMouseDragStart)

Start dragging the mouse.

HandleMouseDragMove(HandleMouseDragMove)

Continue dragging the mouse.

HandleMouseDragEnd(HandleMouseDragEnd)

Stop dragging the mouse.

RemoveSceneObjects(RemoveSceneObjects)

Remove scene objects.

PlaneIntersectAndProject(PlaneIntersectAndProject)

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

CurveGetEndPoints(CurveGetEndPoints)

Find the start and end of a curve.

ReconfigureStream(ReconfigureStream)

Reconfigure the stream.

ImportFiles(ImportFiles)

Import files to the current model.

SetSceneUnits(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(Mass)

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

Density(Density)

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

Volume(Volume)

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

CenterOfMass(CenterOfMass)

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

SurfaceArea(SurfaceArea)

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

DefaultCameraFocusOn(DefaultCameraFocusOn)

Focus the default camera upon an object in the scene.

SetSelectionType(SetSelectionType)

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

SetSelectionFilter(SetSelectionFilter)

What kind of entities can be selected?

DefaultCameraSetOrthographic(DefaultCameraSetOrthographic)

Use orthographic projection.

DefaultCameraSetPerspective(DefaultCameraSetPerspective)

Use perspective projection.

DefaultCameraCenterToSelection(DefaultCameraCenterToSelection)

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

DefaultCameraCenterToScene(DefaultCameraCenterToScene)

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

ZoomToFit(ZoomToFit)

Fit the view to the specified object(s).

OrientToFace(OrientToFace)

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

ViewIsometric(ViewIsometric)

Fit the view to the scene with an isometric view.

Solid3dGetExtrusionFaceInfo(Solid3dGetExtrusionFaceInfo)

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

Solid3dGetAdjacencyInfo(Solid3dGetAdjacencyInfo)

Get a concise description of all of solids edges.

SelectClear(SelectClear)

Clear the selection

SelectGet(SelectGet)

Find all IDs of selected entities

GetNumObjects(GetNumObjects)

Get the number of objects in the scene

SetObjectTransform(SetObjectTransform)

Set the transform of an object.

BooleanUnion(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(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(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(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(AddHoleFromOffset)

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

SetGridReferencePlane(SetGridReferencePlane)

Align the grid with a plane or a planar face.

SetGridScale(SetGridScale)

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

SetGridAutoScale(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.

Implementations

impl ModelingCmd

pub fn is_safe_to_batch(&self) -> bool

Is this command safe to run in an engine batch?

Trait Implementations

impl Clone for ModelingCmd

fn clone(&self) -> ModelingCmd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelingCmd

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelingCmd

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<CmdVariant> From<CmdVariant> for ModelingCmd

where CmdVariant: ModelingCmdVariant,

fn from(value: CmdVariant) -> Self

Converts to this type from the input type.

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 JsonSchema for ModelingCmd

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ModelingCmd

fn eq(&self, other: &ModelingCmd) -> 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 ModelingCmd

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for ModelingCmd

type WithoutGenerics = ModelingCmd

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ModelingCmd

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl StructuralPartialEq for ModelingCmd