DzNumericNodeProperty Class Reference
[Property Objects]

Numeric (float) property that has an associated node pointer. More...

Inheritance diagram for DzNumericNodeProperty:

List of all members.

Constructors
	DzNumericNodeProperty (String name, Boolean canAnimate, Boolean isUserProperty, Number initVal=0.0)
	DzNumericNodeProperty ()
Methods
DzNode	getNode ()
Boolean	isInvalidWithoutNode ()
void	setMustHaveNode (Boolean onOff)
void	setNode (DzNode node)
Signals
void	invalidWithoutNodeChanged (Boolean onOff)
	Signature: "invalidWithoutNodeChanged(bool)"
void	nodeChanged (DzNode node)
	Signature: "nodeChanged(DzNode*)"

---

Detailed Description

Numeric (float) property that has an associated node pointer.

This property tracks both a numeric value and a node value - it is essentially a combination of a DzFloatProperty and a DzNodeProperty in a single property. The main benefit of this is to display the settings to the user as a single parameter, it also provides several conveniences for the programmer in linking the two values together. Currently, this property is used by DzNode to implement the 'Point At' parameter.

---

Constructor & Destructor Documentation

DzNumericNodeProperty::DzNumericNodeProperty

(

)

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

DzNumericNodeProperty::DzNumericNodeProperty	(	String	name,
		Boolean	canAnimate,
		Boolean	isUserProperty,
		Number	initVal = 0.0
	)

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, creates an animatable property.
	isUserProperty	If true, create a user property. User properties are properties that can be added/deleted by users.
	initVal	The initial value of the property

---

Member Function Documentation

DzNode DzNumericNodeProperty::getNode

(

)

Returns:

The image map for the given time. If the object is not mappable, the returned image will be empty.

DzNumericNodeProperty::invalidWithoutNodeChanged

(

Boolean

onOff

)

[signal]

Signature: "invalidWithoutNodeChanged(bool)"

Emitted when this property's invalid without node state has changed.

Boolean DzNumericNodeProperty::isInvalidWithoutNode

(

)

Returns:

true if the value of this property is invalid unless a map is assigned.

DzNumericNodeProperty::nodeChanged

(

DzNode

node

)

[signal]

Signature: "nodeChanged(DzNode*)"

Emitted when the node associated with this property has changed.

void DzNumericNodeProperty::setMustHaveNode

(

Boolean

onOff

)

Sets whether or not this property value is valid when no node is assigned.

void DzNumericNodeProperty::setNode

(

DzNode

node

)

Set the node for this property

---

Copyright © 2002 - 2009 DAZ 3D, Inc.