User Tools

Site Tools


DzNodeProperty

An animatable node property.

More...

Inherits :

Inherited By : DzSkeletonProperty

Constructors

DAZ Script
DzNodeProperty ()
DzNodeProperty ( String name, Boolean canAnimate, Boolean isUserProperty )

Methods

DAZ Script
voidexclude ( DzNode node )
DzNodegetDefaultValue ()
DzNodegetKeyValue ( Number i )
DzNodegetValue ( DzTime tm )
DzNodegetValue ()
BooleanisExcluded ( DzNode node )
voidsetDefaultValue ( DzNode val )
voidsetKeyValue ( Number which, DzNode val )
voidsetValue ( DzTime tm, DzNode val )
voidsetValue ( DzNode val )

Signals

voidaboutToChange ()

Detailed Description

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.

Constructors


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.

Methods


void : exclude( DzNode node )

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

Parameter(s):

  • node - The node to exclude.

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.

void : setDefaultValue( DzNode val )

Set the default value of the property.

Parameter(s):

  • val - The default value for this property.

void : setKeyValue( Number which, DzNode val )

Set the value of the property for the given key.

Parameter(s):

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

void : setValue( DzTime tm, DzNode val )

Set the value of the property at the given time.

Parameter(s):

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

void : setValue( DzNode val )

Set the value of the property.

Parameter(s):

  • val - The node to associate with this property.

Signals


void : aboutToChange()

Signature:“aboutToChange()”

Emitted immediately before the value of the property changes.