DzNodeProperty Class Reference
[Property Objects]

An animatable node property. More...

Inheritance diagram for DzNodeProperty:

List of all members.

Constructors
	DzNodeProperty (String name, Boolean canAnimate, Boolean isUserProperty)
	DzNodeProperty ()
Methods
void	exclude (DzNode node)
DzNode	getDefaultValue ()
DzNode	getKeyValue (Number i)
DzNode	getValue (DzTime tm)
DzNode	getValue ()
Boolean	isExcluded (DzNode node)
void	setDefaultValue (DzNode val)
void	setKeyValue (Number which, DzNode val)
void	setValue (DzTime tm, DzNode val)
void	setValue (DzNode val)
Signals
void	aboutToChange ()
	Signature: "aboutToChange()"

---

Detailed Description

An animatable node property.

An animatible 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 to 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.

---

Constructor & Destructor Documentation

DzNodeProperty::DzNodeProperty

(

)

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

DzNodeProperty::DzNodeProperty	(	String	name,
		Boolean	canAnimate,
		Boolean	isUserProperty
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:

	name	The name of this property.
	canAnimate	If true, create an animatible property. If false, a non-animatible property is created.
	isUserProperty	If true, create a user property. User properties are properties that can be added/deleted by users.

---

Member Function Documentation

DzNodeProperty::aboutToChange

(

)

[signal]

Signature: "aboutToChange()"

Emitted immediately before the value of the property changes.

Reimplemented in DzSkeletonProperty.

void DzNodeProperty::exclude

(

DzNode

node

)

Excludes the given node from becomming the value of this property

DzNode DzNodeProperty::getDefaultValue

(

)

Returns:

The default value of the property, NULL if none.

DzNode DzNodeProperty::getKeyValue

(

Number

i

)

Returns:

The value of the property at the given key, NULL if no node is selected.

DzNode DzNodeProperty::getValue

(

DzTime

tm

)

Returns:

The value of the property at the given time, NULL if no node is selected.

DzNode DzNodeProperty::getValue

(

)

Returns:

The value of the property, NULL if no node is selected.

Boolean DzNodeProperty::isExcluded

(

DzNode

node

)

Returns:

true if the given node is excluded from becoming the value of this property.

void DzNodeProperty::setDefaultValue

(

DzNode

val

)

Set the default value of the property.

void DzNodeProperty::setKeyValue	(	Number	which,
		DzNode	val
	)

Set the value of the property for the given key.

void DzNodeProperty::setValue	(	DzTime	tm,
		DzNode	val
	)

Set the value of the property at the given time.

void DzNodeProperty::setValue

(

DzNode

val

)

Set the value of the property.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.