Coppercube API Documentation
Class PathSceneNode
A path scene node stores a 3d path which can be used for example by Animators to move SceneNodes along it.
Extends
SceneNode.
| Field Attributes | Field Name and Description |
|---|---|
|
Specifies if the path is a closed circle or a unclosed line.
|
|
|
Array of path nodes, of type Vect3d.
|
|
|
Tightness of the spline, specifies how the line is interpolated between the path nodes.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Get the axis aligned, not transformed bounding box of this node.
|
|
|
getPathNodePosition(idx)
|
|
|
getPointOnPath(posOnPath, relative)
|
|
|
getType()
Returns the type string of the scene node.
|
- Methods borrowed from class SceneNode:
- addAnimator, addChild, createClone, getAbsolutePosition, getAbsoluteTransformation, getAnimatorOfType, getAnimators, getMaterial, getMaterialCount, getParent, getRelativeTransformation, getTransformedBoundingBox, init, OnAnimate, OnRegisterSceneNode, removeAnimator, removeChild, render, updateAbsolutePosition
Field Detail
{Boolean}
IsClosedCircle
Specifies if the path is a closed circle or a unclosed line.
{Array}
Nodes
Array of path nodes, of type Vect3d.
{Number}
Tightness
Tightness of the spline, specifies how the line is interpolated between the path nodes.
With this, you can create for example either cardinal splines (tightness != 0.5) or catmull-rom-splines (tightness == 0.5).
Method Detail
{Box3D}
getBoundingBox()
Get the axis aligned, not transformed bounding box of this node.
This means that if this node is an animated 3d character, moving in a room, the bounding box will
always be around the origin. To get the box in real world coordinates, just transform it with the matrix
you receive with getAbsoluteTransformation() or simply use getTransformedBoundingBox(), which does the same.
- Returns:
- {Box3D} Bounding box of this scene node.
{Vect3d}
getPathNodePosition(idx)
- Parameters:
- idx
- {Number} Index of the path node
- Returns:
- {Vect3d} returns the 3d vector of the position of the specified path node
{Vect3d}
getPointOnPath(posOnPath, relative)
- Parameters:
- posOnPath
- {Number} Value between 0 and 1, meaning 0 is the start of the path and 1 is the end of the path.
- relative
- {Boolean} set to true to get the position relative to the position of the path scene node, set to false to receive the position in absolute world space.
- Returns:
- {Vect3d} returns the 3d vector of the position
{String}
getType()
Returns the type string of the scene node.
Returns 'path' for the mesh scene node.
- Returns:
- {String} type name of the scene node.