An animatable node property.

More...

Inherits :

• QObject
  • DzBase
    • DzProperty

Inherited By : DzSkeletonProperty

An animatable property whose value is a choice of one of the node objects in the current scene, or none. Instead of tracking a numeric value, this property maintains a pointer to another node in the scene. Use this property when you need an element to track a user-selected scene node; for example, this property could be used in a node to allow the user to select another node in the scene to follow, or it could be used by a modifier that uses a node in the scene to determine how it is applied, etc.

DzNodeProperty()

Constructor. Creates a non-animatable, non-user property.

DzNodeProperty( String name, Boolean canAnimate, Boolean isUserProperty )

Parameter(s):

• name - The name of this property.
• canAnimate - If true, creates an animatable property.
• isUserProperty - If true, creates a user property; user properties are properties that can be added/deleted by users.

void : exclude( DzNode node )

Excludes the given node from becoming the value of this property.

Parameter(s):

• node - The node to exclude.

Attention:

• Adding a node to this list will remove all values/keys with that node from this property.

See Also:

• unexclude()
• isExcluded()

DzNode : getDefaultValue()

Return Value:

• The default value of the property (if any), otherwise NULL.

DzNode : getKeyValue( Number i )

Parameter(s):

• index - The index of the key to get a value for.

Return Value:

• The value of the property at the given key (if any), otherwise NULL.

DzNode : getValue( DzTime tm )

Parameter(s):

• tm - The scene time for which to get the value of the property.

Return Value:

• The value of the property at the given time (if any), otherwise NULL.

DzNode : getValue()

Return Value:

• The value of the property (if any), otherwise NULL.

Boolean : isExcluded( DzNode node )

Parameter(s):

• node - The node to check for exclusion.

Return Value:

• true if the given node is excluded from becoming the value of this property, otherwise false.

See Also:

• exclude()
• unexclude()

void : setDefaultValue( DzNode node )

Set the default value of the property.

Parameter(s):

• node - The default value for this property.

Attention:

• A node that has been added to the list of nodes to exclude cannot be set as the default value of this property.

See Also:

• exclude()
• isExcluded()
• unexclude()

void : setKeyValue( Number which, DzNode node )

Set the value of the property for the given key.

Parameter(s):

• which - The index of the key to set a value for.
• node - The node to associate with the given key.

Attention:

• A node that has been added to the list of nodes to exclude cannot be set as the value of this property.

See Also:

• exclude()
• isExcluded()
• unexclude()

void : setValue( DzNode node )

Set the value of the property.

Parameter(s):

• node - The node to associate with this property.

Attention:

• A node that has been added to the list of nodes to exclude cannot be set as the value of this property.

See Also:

• exclude()
• isExcluded()
• unexclude()

void : setValue( DzTime tm, DzNode node )

Set the value of the property at the given time.

Parameter(s):

• tm - The scene time for which to set the value.
• node - The node to associate with this property.

Attention:

• A node that has been added to the list of nodes to exclude cannot be set as the value of this property.

See Also:

• exclude()
• isExcluded()
• unexclude()

void : unexclude( DzNode node )

Removes the given node from the list of excluded nodes.

Parameter(s):

• node - The node to unexclude.

See Also:

• exclude()
• isExcluded()

Since:

• 4.12.1.83

void : aboutToChange()

Signature:“aboutToChange()”

Emitted immediately before the value of the property changes.