Skip to main content

sketch()

Draws 2D geometry on a standard plane.

Returns: SceneObject

tip

See the guide for detailed usage examples.

Signatures

sketch(plane: PlaneLike, sketcher: () => void): SceneObject

Draws 2D geometry on a standard plane.

ParameterTypeDescription
planePlaneLikeThe plane to sketch on
sketcher() => voidCallback containing sketch operations

sketch(face: SceneObject, sketcher: () => void): SceneObject

Draws 2D geometry on a face selection.

ParameterTypeDescription
faceSceneObjectThe face to sketch on
sketcher() => voidCallback containing sketch operations

sketch(plane: Plane, sketcher: () => void): SceneObject

Draws 2D geometry on an existing Plane object.

ParameterTypeDescription
planePlaneThe Plane object to sketch on
sketcher() => voidCallback containing sketch operations