Crate kittycad_modeling_cmds

KittyCAD’s Modeling API lets you design 3D models.

Re-exports

• pub use ok_response::output;

Modules

• base64
  Base64 data that encodes to url safe base64, but can decode from multiple base64 implementations to account for various clients and libraries. Compatible with serde and JsonSchema.
• coord
  Various coordinate systems.
• each_cmd
  Definition of each modeling command.
• format
  Import and export types.
• id
  Modeling command IDs, used to associated requests and responses. Also used to construct commands which refer to previous commands.
• length_unit
  A length unit is a type that converts a length value from one unit to another. In the case of the engine we will always convert to millimeters, since that is what the engine uses.
• ok_response
  When a modeling command is successful, these responses could be returned.
• shared
  Types that are shared between various modeling commands, like Point3d.
• units
  Units of measurement.

Structs

• CameraDragEnd
  Camera drag ended
• CameraDragMove
  Camera drag continued.
• CameraDragStart
  Camera drag started.
• CenterOfMass
  Get the center of mass of entities in the scene or the default scene.
• ClosePath
  Closes a path, converting it to a 2D solid.
• CurveGetControlPoints
  Get control points of the given curve.
• CurveGetEndPoints
  Find the start and end of a curve.
• CurveGetType
  Get type of the given curve.
• CurveSetConstraint
  Get the plane for sketch mode.
• DefaultCameraDisableSketchMode
  Disable sketch mode, from the default camera.
• DefaultCameraEnableSketchMode
  Enable sketch mode, where users can sketch 2D geometry. Users choose a plane to sketch on.
• DefaultCameraFocusOn
  Focus the default camera upon an object in the scene.
• DefaultCameraLookAt
  Change what the default camera is looking at.
• DefaultCameraPerspectiveSettings
  Change what the default camera is looking at.
• DefaultCameraSetOrthographic
  Use orthographic projection.
• DefaultCameraSetPerspective
  Use perspective projection.
• DefaultCameraZoom
  Adjust zoom of the default camera.
• Density
  Get the density of entities in the scene or the default scene.
• EditModeEnter
  Enter edit mode
• EditModeExit
  Exit edit mode
• EnableSketchMode
  Sketch on some entity (e.g. a plane, a face).
• EntityCircularPattern
  Create a circular pattern using this entity (currently only valid for 3D solids).
• EntityFade
  Fade entity in or out.
• EntityGetAllChildUuids
  What are all UUIDs of this entity’s children?
• EntityGetChildUuid
  What is the UUID of this entity’s n-th child?
• EntityGetDistance
  What is the distance between these two entities?
• EntityGetNumChildren
  How many children does the entity have?
• EntityGetParentId
  What is this entity’s parent?
• EntityLinearPattern
  Create a linear pattern using this entity (currently only valid for 3D solids).
• EntitySetOpacity
  Set opacity of the entity.
• Export
  Export the scene to a file.
• 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.
• GetEntityType
  What type of entity is this?
• GetSketchModePlane
  Get the plane for sketch mode.
• HandleMouseDragEnd
  Stop dragging the mouse.
• HandleMouseDragMove
  Continue dragging the mouse.
• HandleMouseDragStart
  Start dragging the mouse.
• HighlightSetEntities
  Changes the current highlighted entity to these entities.
• 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.
• ImportFile
  File to import into the current model. If you are sending binary data for a file, be sure to send the WebSocketRequest as binary/bson, not text/json.
• ImportFiles
  Import files to the current model.
• MakeAxesGizmo
  Add a gizmo showing the axes.
• MakePlane
  Make a new plane
• Mass
  Get the mass of entities in the scene or the default scene.
• MouseClick
  Send a mouse click event Updates modified/selected entities.
• MouseMove
  Send a mouse move event
• MovePathPen
  Move the path’s “pen”.
• NewAnnotation
  Create a new annotation
• ObjectBringToFront
  Bring an object to the front of the scene
• ObjectSetMaterialParamsPbr
  Set the material properties of an object
• ObjectVisible
  Hide or show an object
• PathGetCurveUuidsForVertices
  Obtain curve ids for vertex ids
• PathGetInfo
  Query the given path.
• PathGetVertexUuids
  Obtain vertex ids for a path
• PlaneIntersectAndProject
  Utility method. Performs both a ray cast and projection to plane-local coordinates. Returns the plane coordinates for the given window coordinates.
• PlaneSetColor
  Set the color of a plane.
• ReconfigureStream
  Reconfigure the stream.
• RemoveSceneObjects
  Remove scene objects.
• SelectAdd
  Adds one or more entities (by UUID) to the selection.
• SelectClear
  Clear the selection
• SelectGet
  Find all IDs of selected entities
• SelectRemove
  Removes one or more entities (by UUID) from the selection.
• SelectReplace
  Replaces current selection with these entities (by UUID).
• SelectWithPoint
  Modifies the selection by simulating a “mouse click” at the given x,y window coordinate Returns ID of whatever was selected.
• SendObject
  Send object to front or back.
• SetSceneUnits
  Set the units of the scene. For all following commands, the units will be interpreted as the given units.
• SetSelectionFilter
  What kind of entities can be selected?
• SetSelectionType
  When you select some entity with the current tool, what should happen to the entity?
• SetTool
  Set the current tool.
• 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.
• SketchModeEnable
  Enable sketch mode on the given plane. If you want to sketch on a face, use enable_sketch_mode instead.
• Solid2dAddHole
  Add a hole to a Solid2d object before extruding it.
• Solid3dFilletEdge
  Fillets the given edge with the specified radius.
• Solid3dGetAllEdgeFaces
  Gets all faces which use the given edge.
• Solid3dGetAllOppositeEdges
  Gets all edges which are opposite the given edge, across all possible faces.
• Solid3dGetExtrusionFaceInfo
  Get a concise description of all of an extrusion’s faces.
• Solid3dGetNextAdjacentEdge
  Gets the next adjacent edge for the given edge, along the given face.
• Solid3dGetOppositeEdge
  Gets the edge opposite the given edge, along the given face.
• Solid3dGetPrevAdjacentEdge
  Gets the previous adjacent edge for the given edge, along the given face.
• StartPath
  Start a new path.
• SurfaceArea
  Get the surface area of entities in the scene or the default scene.
• TakeSnapshot
  Take a snapshot of the current view.
• UpdateAnnotation
  Update an annotation
• Volume
  Get the volume of entities in the scene or the default scene.

Enums

• ImageFormat
  Enum containing the variety of image formats snapshots may be exported to.
• ModelingCmd
  Commands that the KittyCAD engine can execute.

Traits

• ModelingCmdOutput
  Anything that can be a ModelingCmd output.
• ModelingCmdVariant
  Some modeling command executed on the KittyCAD engine.