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 face selection.
| Parameter | Type | Description |
|---|---|---|
selection | SceneObject | The selected face 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, offset: number): Plane
Creates a plane from a face selection with an offset.
| Parameter | Type | Description |
|---|---|---|
selection | SceneObject | The selected face to create a plane from |
offset | number | The offset distance |
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) |
note
All signatures also accept an optional targetPlane parameter as the last argument to draw on a specific plane.