Module shared

Source
Expand description

Types that are shared between various modeling commands, like Point3d.

Structs§

Angle
An angle, with a specific unit.
AnnotationLineEndOptions
Options for annotation text
AnnotationOptions
Options for annotations
AnnotationTextOptions
Options for annotation text
CameraSettings
Camera settings including position, center, fov etc
CameraViewState
Color
An RGBA color
ComponentTransform
Container that holds a translate, rotate and scale. Defaults to no change, everything stays the same (i.e. the identity function).
ExportFile
A file to be exported to the client.
ExtrudedFaceInfo
IDs for the extruded faces.
PerspectiveCameraParameters
Defines a perspective view.
Point2d
A point in 2D space
Point3d
A point in 3D space
Point4d
A point in homogeneous (4D) space
Rotation
A rotation defined by an axis, origin of rotation, and an angle.
SideFace
IDs for a side face, extruded from the path of some sketch/2D shape.
Transform
Ways to transform each solid being replicated in a repeating pattern.
TransformBy
How a property of an object should be transformed.

Enums§

AnnotationLineEnd
Annotation line end type
AnnotationTextAlignmentX
Horizontal Text alignment
AnnotationTextAlignmentY
Vertical Text alignment
AnnotationType
The type of annotation
CameraDragInteractionType
The type of camera drag interaction.
CameraMovement
A type of camera movement applied after certain camera operations
CurveType
The type of Curve (embedded within path)
CutStrategy
What strategy (algorithm) should be used for cutting? Defaults to Automatic.
CutType
What kind of cut to do
DistanceType
The type of distance Distances can vary depending on the objects used as input.
EngineErrorCode
The type of error sent by the KittyCAD graphics engine.
EntityType
The type of entity
ExtrusionFaceCapType
Possible types of faces which can be extruded from a 3D solid.
FileExportFormat
The valid types of output file formats.
FileExportFormat2d
The valid types of 2D output file formats.
FileImportFormat
The valid types of source file formats.
GlobalAxis
The global axes.
Opposite
If bidirectional or symmetric operations are needed this enum encapsulates the required information.
OriginType
The type of origin
PathCommand
The path component command type (within a Path)
PathComponentConstraintBound
The path component constraint bounds type
PathComponentConstraintType
The path component constraint type
PathSegment
A segment of a path. Paths are composed of many segments.
PostEffectType
Post effect type
RelativeTo
What is the given geometry relative to?
SceneSelectionType
The type of scene selection change
SceneToolType
The type of scene’s active tool
WorldCoordinateSystem

Type Aliases§

Quaternion
A quaternion