plane()
Creates a plane with transform options.
Returns: Plane
Signatures
plane(plane: PlaneLike, options: PlaneTransformOptions): Plane
Creates a plane with transform options.
| Parameter | Type | Description |
|---|---|---|
plane | PlaneLike | The standard plane or normal vector |
options | PlaneTransformOptions | Transform options (offset, rotate, etc.) |
PlaneTransformOptions
| Property | Type | Description |
|---|---|---|
offset | number | Distance to translate the plane along its normal (optional) |
rotateX | number | Rotation around the plane's X axis (in degrees) (optional) |
rotateY | number | Rotation around the plane's Y axis (in degrees) (optional) |
rotateZ | number | Rotation around the plane's Z axis / normal (in degrees) (optional) |
plane(plane: PlaneLike, offset: number): Plane
Creates a plane with an offset.
| Parameter | Type | Description |
|---|---|---|
plane | PlaneLike | The standard plane or normal vector |
offset | number | The offset distance |
plane(selection: SceneObject): Plane
Creates a plane from a selection. A selected face yields that face's plane; a selected edge yields a plane at the edge start, oriented normal to the edge and facing outward (away from the edge body), like a start cap.
| Parameter | Type | Description |
|---|---|---|
selection | SceneObject | The selected face or edge to create a plane from |
plane(selection: SceneObject, options: PlaneTransformOptions): Plane
Creates a plane from a face selection with transform options.
| Parameter | Type | Description |
|---|---|---|
selection | SceneObject | The selected face to create a plane from |
options | PlaneTransformOptions | Transform options (offset, rotate, etc.) |
plane(selection: SceneObject, offsetOrPosition: number): Plane
Creates a plane from a selection with a numeric second argument. For a
face, the number is the offset distance along the face normal. For an
edge, it is a normalized position from 0 (start) to 1 (end), and the
plane is created at that point oriented normal to the edge. The normal
follows the edge's forward direction, except at the start (0) where it
faces outward (away from the edge body), so both ends read like caps.
| Parameter | Type | Description |
|---|---|---|
selection | SceneObject | The selected face or edge |
offsetOrPosition | number | Face: offset distance. Edge: normalized 0–1 position. |
plane(edge: SceneObject, position: "start" | "middle" | "end"): Plane
Creates a plane at a named position along an edge, oriented normal to the
edge. At 'start' the normal faces outward (away from the edge body);
'middle' and 'end' follow the edge's forward direction.
| Parameter | Type | Description |
|---|---|---|
edge | SceneObject | The selected edge |
position | "start" | "middle" | "end" | 'start', 'middle', or 'end' |
plane(plane: Plane, options: PlaneTransformOptions): Plane
Transforms an existing plane with options.
| Parameter | Type | Description |
|---|---|---|
plane | Plane | The existing plane to transform |
options | PlaneTransformOptions | Transform options (offset, rotate, etc.) |
plane(p1: PlaneLike, p2: PlaneLike, options?: PlaneTransformOptions): Plane
Creates a plane midway between two standard planes or normal vectors.
| Parameter | Type | Description |
|---|---|---|
p1 | PlaneLike | The first standard plane or normal vector |
p2 | PlaneLike | The second standard plane or normal vector |
options | PlaneTransformOptions | Transform options (offset, rotate, etc.) (optional) |
plane(p1: Plane, p2: Plane, options?: PlaneTransformOptions): Plane
Creates a plane midway between two existing Plane objects.
| Parameter | Type | Description |
|---|---|---|
p1 | Plane | The first Plane object |
p2 | Plane | The second Plane object |
options | PlaneTransformOptions | Transform options (offset, flip, sticky, etc.) (optional) |
All signatures also accept an optional targetPlane parameter as the last argument to draw on a specific plane.