SubnodeData Class Reference

The SubnodeData Javascript class. More...

Public Slots

bool visible ()
 Returns true if the subnode is visible, false if it is hidden. More...
 
void setVisible (bool visible)
 Sets whether or not the subnode is visible. More...
 
bool enabled ()
 Returns true if the subnode is enabled, false if it is disabled. More...
 
void setEnabled (bool enabled)
 Sets whether or not the subnode is enabled. More...
 
String name ()
 Returns the name of the subnode. This is the Key used when the SubnodeData object was created. More...
 
Matrix4x4 localTransformation ()
 Returns the Matrix4x4 representing the transformations done locally to this subnode. More...
 
Point3d pivot ()
 Returns the Point3d position of the subnode's pivot. More...
 
void setPivot (Point3d pivot)
 Sets the coordinates of the subnode's pivot. More...
 
Point3d position ()
 Returns the Point3d position of the subnode's position, or offset. More...
 
void setPosition (Point3d position)
 Sets the coordinates of the subnode's position. More...
 
Point3d scale ()
 Returns a Point3d representation of the subnode's scale. More...
 
void setScale (Point3d scale)
 Sets the Subnode's scale. More...
 
Quaternion rotation ()
 Returns the Quaternion representation of the subnode's rotation. More...
 
void setRotation (Quaternion rotation)
 Sets the subnode's rotation. More...
 

Public Member Functions

 SubnodeData (String subnodeName, String nodeName, double frame)
 Create a new SubnodeData object. More...
 

Properties

bool visible
 See visible() and setVisible(). More...
 
bool enabled
 See enabled() and setEnabled(). More...
 
String name
 See name(). More...
 
Matrix4x4 localTransformation
 See localTransformation(). More...
 
Point3d pivot
 See pivot() and setPivot(). More...
 
Point3d position
 See position() and setPosition(). More...
 
Point3d scale
 See scale() and setScale(). More...
 
Quaternion rotation
 See rotation() and setRotation(). More...
 

Detailed Description

The SubnodeData Javascript class.

Subnodes are the 3d objects that make up a 3d Model, and can be found in the 3D Graph View. The SubnodeData methods allow access and editing of subnode properties.

Constructor & Destructor Documentation

◆ SubnodeData()

SubnodeData::SubnodeData ( String  subnodeName,
String  nodeName,
double  frame 
)

Create a new SubnodeData object.

Parameters
subnodeName: The name, or key, of the subnode found in the 3D Graph View.
nodeName: The name of the node corresponding to the 3d Model. This can also be a SubnodeTransformation node.
frame: The frame number.

Member Function Documentation

◆ enabled

bool SubnodeData::enabled ( )
slot

Returns true if the subnode is enabled, false if it is disabled.

Returns
true if the subnode is enabled, false if it is disabled.

◆ localTransformation

Matrix4x4 SubnodeData::localTransformation ( )
slot

Returns the Matrix4x4 representing the transformations done locally to this subnode.

Returns
The Matrix4x4 representing the transformations done locally to this subnode.

◆ name

String SubnodeData::name ( )
slot

Returns the name of the subnode. This is the Key used when the SubnodeData object was created.

Returns
The name of the subnode.

◆ pivot

Point3d SubnodeData::pivot ( )
slot

Returns the Point3d position of the subnode's pivot.

Returns
The Point3d position of the subnode's pivot in field units.

◆ position

Point3d SubnodeData::position ( )
slot

Returns the Point3d position of the subnode's position, or offset.

Returns
The Point3d position of the subnode's position, or offset in field units.

◆ rotation

Quaternion SubnodeData::rotation ( )
slot

Returns the Quaternion representation of the subnode's rotation.

Returns
The Quaternion representation of the subnode's rotation.

◆ scale

Point3d SubnodeData::scale ( )
slot

Returns a Point3d representation of the subnode's scale.

Note
This is not actually a 3d Point, but carries the X, Y and Z values of the subnode's scale.
Returns
A Point3d representation of the subnode's scale.

◆ setEnabled

void SubnodeData::setEnabled ( bool  enabled)
slot

Sets whether or not the subnode is enabled.

Parameters
enabled: true to enable the subnode, false to disable it.

◆ setPivot

void SubnodeData::setPivot ( Point3d  pivot)
slot

Sets the coordinates of the subnode's pivot.

Parameters
pivot: The Point3d to set the subnode's pivot to in field units.

◆ setPosition

void SubnodeData::setPosition ( Point3d  position)
slot

Sets the coordinates of the subnode's position.

Parameters
position: The Point3d to set the subnode's position to in field units.

◆ setRotation

void SubnodeData::setRotation ( Quaternion  rotation)
slot

Sets the subnode's rotation.

Parameters
rotation: The Quaternion to set the subnode's rotation to.

◆ setScale

void SubnodeData::setScale ( Point3d  scale)
slot

Sets the Subnode's scale.

Note
This is not actually a 3d Point, but carries the X, Y and Z values of the subnode's scale.
Parameters
scale: The Point3d to set the subnode's scale to.

◆ setVisible

void SubnodeData::setVisible ( bool  visible)
slot

Sets whether or not the subnode is visible.

Parameters
visible: true to show the Subnode, false to hide it.

◆ visible

bool SubnodeData::visible ( )
slot

Returns true if the subnode is visible, false if it is hidden.

Returns
true if the subnode is visible, false if it is hidden.

Property Documentation

◆ enabled

bool SubnodeData::enabled
readwrite

◆ localTransformation

Matrix4x4 SubnodeData::localTransformation
read

◆ name

String SubnodeData::name
read

See name().

◆ pivot

Point3d SubnodeData::pivot
readwrite

See pivot() and setPivot().

◆ position

Point3d SubnodeData::position
readwrite

◆ rotation

Quaternion SubnodeData::rotation
readwrite

◆ scale

Point3d SubnodeData::scale
readwrite

See scale() and setScale().

◆ visible

bool SubnodeData::visible
readwrite