Constructor
new Path3D(points, optionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
points |
Array.<Vector3>
|
|
Path points. |
options |
Object
|
<optional>
|
Optional options.
Properties
| Name |
Type |
Attributes |
Default |
Description |
loop |
boolean
|
<optional>
|
false
|
Whether the path is looped. |
|
- Source:
Throws:
-
-
When inputs are invalid.
-
-
Type
-
TypeError
-
-
When points are insufficient.
-
-
Type
-
RangeError
Classes
- Path3D
Members
loop
- Source:
points
- Source:
totalLength
- Source:
Methods
getPointAt(pathParameter, outopt) → {Vector3}
Returns a point at normalized position along the path (arc-length parameterization).
Parameters:
| Name |
Type |
Attributes |
Description |
pathParameter |
number
|
|
Normalized path parameter in [0..1]. |
out |
Vector3
|
<optional>
|
Optional output vector. |
- Source:
Throws:
-
When inputs are invalid.
-
-
Type
-
TypeError
Returns:
-
Type
-
Vector3
getTangentAt(pathParameter, outopt) → {Vector3}
Returns a normalized tangent at normalized position along the path (arc-length parameterization).
Parameters:
| Name |
Type |
Attributes |
Description |
pathParameter |
number
|
|
Normalized path parameter in [0..1]. |
out |
Vector3
|
<optional>
|
Optional output vector. |
- Source:
Throws:
-
When inputs are invalid.
-
-
Type
-
TypeError
Returns:
-
Type
-
Vector3