axis()
Creates an axis datum on a world axis.
Returns: Axis
Signatures
axis(axis: AxisLike): Axis
Creates an axis datum on a world axis.
| Parameter | Type | Description |
|---|---|---|
axis | AxisLike | The world axis: "x", "y" or "z" |
axis(axis: AxisLike, options: AxisTransformOptions): Axis
Creates an axis datum on a world axis, moved and tilted by the transform options.
| Parameter | Type | Description |
|---|---|---|
axis | AxisLike | The world axis: "x", "y" or "z" |
options | AxisTransformOptions | Offsets (offsetX, offsetY, offsetZ), applied first, then rotations (rotateX, rotateY, rotateZ) around the world axes |
axis(source: SceneObject): Axis
Creates an axis from a scene object's edge.
| Parameter | Type | Description |
|---|---|---|
source | SceneObject | The scene object whose edge defines the axis |
axis(source: SceneObject, options: AxisTransformOptions): Axis
Creates an axis from a scene object's edge with transform options.
| Parameter | Type | Description |
|---|---|---|
source | SceneObject | The scene object whose edge defines the axis |
options | AxisTransformOptions | Offsets (offsetX, offsetY, offsetZ), applied first, then rotations (rotateX, rotateY, rotateZ) around the world axes |
axis(axis: Axis, options: AxisTransformOptions): Axis
Transforms an existing axis with options.
| Parameter | Type | Description |
|---|---|---|
axis | Axis | The existing axis to transform |
options | AxisTransformOptions | Offsets (offsetX, offsetY, offsetZ), applied first, then rotations (rotateX, rotateY, rotateZ) around the world axes |
axis(a1: AxisLike, a2: AxisLike, options?: AxisTransformOptions): Axis
Creates an axis midway between two world axes.
| Parameter | Type | Description |
|---|---|---|
a1 | AxisLike | The first world axis: "x", "y" or "z" |
a2 | AxisLike | The second world axis: "x", "y" or "z" |
options | AxisTransformOptions | Offsets (offsetX, offsetY, offsetZ), applied first, then rotations (rotateX, rotateY, rotateZ) around the world axes (optional) |
axis(a1: Axis, a2: Axis, options?: AxisTransformOptions): Axis
Creates an axis midway between two existing Axis objects.
| Parameter | Type | Description |
|---|---|---|
a1 | Axis | The first Axis object |
a2 | Axis | The second Axis object |
options | AxisTransformOptions | Offsets (offsetX, offsetY, offsetZ), applied first, then rotations (rotateX, rotateY, rotateZ) around the world axes (optional) |