User Tools

Site Tools


DzInstanceGroupItem

A class for creating a single instance of another node in a group of like nodes.

More...

Inherits :

Constructors

DAZ Script
DzInstanceGroupItem ()

Methods

Signals

Detailed Description

This class can be used to create a single instance of another DzNode (subclass) that also has a DzOobject for inclusion in a group of like nodes. These instances are drawn the same as the target node except for transforms.

Constructors


DzInstanceGroupItem()

TODO: Add description.

Methods


void : copyTransformFromNode( DzNode node )

Copies the transform values of the given nodes transform properties. Also copies rotation order.

Parameter(s):

  • node - The node to copy transform values from.

void : copyTransformToNode( DzNode node )

Copies the transform values to the given nodes transform properties. Also copies rotation order

Parameter(s):

  • node - The node to copy transform values from.

DzVec3 : getEndPointValues()

Return Value:

  • The endpoint values of this item.

Number : getGeneralScaleValue()

Return Value:

  • The general scale value of this item.

String : getLabel()

Return Value:

  • The label of this item.

DzVec3 : getLocalPos()

Return Value:

  • The local-space position of the item at the current time.

DzQuat : getLocalRot()

Return Value:

  • The local-space rotation of the item at the current time.

DzMatrix3 : getLocalScale()

Return Value:

  • The local-space scale of the item at the time.

DzMatrix3 : getLocalTransform()

Return Value:

  • A matrix representing the composed local transform for this item at the current time.

DzQuat : getOrientation()

Return Value:

  • The orientation of the item.

DzVec3 : getOrientationValues()

Return Value:

  • The orientation values of this item, in degrees.

DzVec3 : getOriginValues()

Return Value:

  • The origin (centerpoint) values of this item.

DzVec3 : getPositionValues()

Return Value:

  • The potion values of this item.

DzRotationOrder : getRotationOrder()

Return Value:

  • The rotation order of this item.

DzVec3 : getRotationValues()

Return Value:

  • The rotation values of this item, in degrees.

DzVec3 : getWSPos( DzTime tm, Boolean defaultVal=false )

Parameter(s):

  • tm - The scene time at which to get the the transform.
  • defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

  • The world-space position of the item.

DzVec3 : getWSPos()

Return Value:

  • The world-space position of the item at the current time.

DzQuat : getWSRot( DzTime tm, Boolean defaultVal=false )

Parameter(s):

  • tm - The scene time at which to get the the transform.
  • defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

  • The world-space rotation of the item.

DzQuat : getWSRot()

Return Value:

  • The world-space rotation of the item at the current time.

DzMatrix3 : getWSScale( DzTime tm, Boolean defaultVal=false )

Parameter(s):

  • tm - The scene time at which to get the the transform.
  • defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

  • The world-space scale of the item.

DzMatrix3 : getWSScale()

Return Value:

  • The world-space scale of the item at the current time.

DzMatrix3 : getWSTransform()

Return Value:

  • A matrix representing the composed world-space transform for this item at the current time.

DzMatrix3 : getWSTransform( DzTime tm, Boolean defaultVal=false )

Parameter(s):

  • tm - The scene time at which to get the the transform.
  • defaultVal - Use the default version of the origin, end point, and orientation instead of the current position.

Return Value:

  • A matrix representing the composed world-space transform for this item.

DzVec3 : getXYZScaleValues()

Return Value:

  • The xyz scale values of this item.

Boolean : inheritsScale()

Return Value:

  • true if this node inherits scale from its parent, otherwise false.

void : setEndPoint( Number x, Number y, Number z )

Sets the endpoint for this item.

Parameter(s):

  • x - The x position.
  • y - The y position.
  • z - The z position.

void : setInheritScale( Boolean onOff )

Sets whether or not this node inherits the scale of its parent.

Parameter(s):

  • onOff - If true, scaling the parent of this node will scale this node also.

void : setLabel( String label )

Sets the label for this item.

Parameter(s):

  • label - The label to set.

void : setOrientation( Number x, Number y, Number z )

Sets the orientation for this item.

Parameter(s):

  • x - The rotation, in degrees, on the x axis.
  • y - The rotation, in degrees, on the y axis.
  • z - The rotation, in degrees, on the z axis.

void : setOrigin( Number x, Number y, Number z )

Sets the origin for this item.

Parameter(s):

  • x - The x position.
  • y - The y position.
  • z - The z position.

void : setPosition( Number x, Number y, Number z )

Sets the position for this item.

Parameter(s):

  • x - The x position.
  • y - The y position.
  • z - The z position.

void : setRotation( Number x, Number y, Number z )

Sets the rotation for this item.

Parameter(s):

  • x - The rotation, in degrees, on the x axis.
  • y - The rotation, in degrees, on the y axis.
  • z - The rotation, in degrees, on the z axis.

void : setRotationOrder( DzRotationOrder order )

Sets the rotation order for this item.

Parameter(s):

  • order - The rotation order to set.

void : setScale( Number x, Number y, Number z, Number genScale )

Sets the scale for this item.

Parameter(s):

  • x - The scale on the x axis.
  • y - The scale on the y axis.
  • z - The scale on the z axis.
  • genScale - The general scale.

Signals


void : localTransformChanged()

Signature:“localTransformChanged()”

Emitted when the local transform for this item has changed.


void : transformChanged()

Signature:“transformChanged()”

Emitted when the transform for this item has changed.