DzNumericProperty Class Reference
[Property Objects]

Base class of all numeric properties. More...

Inheritance diagram for DzNumericProperty:

DzProperty DzBase QObject Object DzFloatProperty DzIntProperty DzNumericNodeProperty DzBoolProperty DzColorProperty DzEnumProperty List of all members.

Enumerations



enum  XYZInterest { NO_INTEREST, X_INTEREST, Y_INTEREST, Z_INTEREST }

Methods

void clearMap ()
Number getDoubleValue (DzTime tm)
Number getDoubleValue ()
DzNumericProperty getLinkProperty ()
DzTexture getMapValue ()
DzTexture getMapValue (DzTime time)
XYZInterest getXYZInterest ()
void insertController (DzNumericController controller, Number idx=-1)
Boolean isClamped ()
Boolean isInvalidWithoutMap ()
Boolean isLinked ()
Boolean isMappable ()
Boolean isMapped ()
Boolean isMaster ()
Boolean isModulo ()
void linkTo (DzNumericProperty master)
void setDoubleValue (DzTime tm, Number val)
void setDoubleValue (Number val)
void setIsClamped (Boolean val)
void setIsMappable (Boolean val)
void setIsModulo (Boolean val)
void setMap (String imgFile)
void setMap (DzTexture img)
void setMustHaveMap (Boolean val)
void setXYZInterest (XYZInterest interest)
void unlink ()

Signals

void clampedChanged (Boolean onOff)
 Signature: "clampedChanged(bool)"
void linked ()
 Signature: "linked()"
void mapChanged ()
 Signature: "mapChanged()"
void minMaxChanged ()
 Signature: "minMaxChanged()"
void unlinked ()
 Signature: "unlinked()"

Detailed Description

Base class of all numeric properties.


Member Enumeration Documentation

enum DzNumericProperty::XYZInterest

The axis that this properties value is applied to.

Enumerator:
NO_INTEREST  Default - this property is not associated with an axis
X_INTEREST  Value is used by an X Axis control
Y_INTEREST  Value is used by an Y Axis control
Z_INTEREST  Value is used by an Z Axis control


Member Function Documentation

DzNumericProperty::clampedChanged ( Boolean  onOff  )  [signal]

Signature: "clampedChanged(bool)"

Emitted when the clamped state for this property has changed.

void DzNumericProperty::clearMap (  ) 

Clear the image map for this property

Number DzNumericProperty::getDoubleValue ( DzTime  tm  ) 

Parameters:
tm The scene time at which to get the value of the property.
Returns:
The value of the property at the given time, as a double precision number.
See also:
getDoubleValue(), setDoubleValue()

Number DzNumericProperty::getDoubleValue (  ) 

Returns:
The value of the property at the current time, as a double precision number.
See also:
getDoubleValue( DzTime tm ), setDoubleValue()

DzNumericProperty DzNumericProperty::getLinkProperty (  ) 

Returns:
The property this property is linked to, Null if this property is not linked.
See also:
isLinked(), isMaster(), linkTo(), unlink()

DzTexture DzNumericProperty::getMapValue (  ) 

Returns:
The image map at the current time. If the object is not mappable, the returned image will be empty.

Boolean DzNumericProperty::getMapValue ( DzTime  time  ) 

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

XYZInterest DzNumericProperty::getXYZInterest (  ) 

Returns:
The XYZ interest for this property, if any.

void DzNumericProperty::insertController ( DzNumericController  controller,
Number  idx = -1 
)

Adds a controller to this property.

Boolean DzNumericProperty::isClamped (  ) 

Returns:
true if this property's value is currently clamped (for display only).

Boolean DzNumericProperty::isInvalidWithoutMap (  ) 

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

Boolean DzNumericProperty::isLinked (  ) 

Returns:
true if this property is linked to another property.
See also:
isMaster(), getLinkProperty(), linkTo(), unlink()

Boolean DzNumericProperty::isMappable (  ) 

Returns:
true if this property is mappable (i.e. can have an associated image map).

Boolean DzNumericProperty::isMapped (  ) 

Returns:
true if this property is currently mapped.

Boolean DzNumericProperty::isMaster (  ) 

Returns:
true if this property is the master in a property link.
See also:
isLinked(), getLinkProperty(), linkTo(), unlink()

Boolean DzNumericProperty::isModulo (  ) 

Returns:
true if this property is modulo (i.e. has a value beyond), otherwise false.

DzNumericProperty::linked (  )  [signal]

Signature: "linked()"

Emitted when the property is linked to another property.

void DzNumericProperty::linkTo ( DzNumericProperty  master  ) 

Links this property to the given property. This is the DAZ Studio implemetation of Poser LinkParms.

See also:
unlink(), isMaster(), isLinked(), getLinkProperty()

DzNumericProperty::mapChanged (  )  [signal]

Signature: "mapChanged()"

Emitted when the image map for this property has changed.

DzNumericProperty::minMaxChanged (  )  [signal]

Signature: "minMaxChanged()"

Emitted when the min and/or max values for this property have changed.

void DzNumericProperty::setDoubleValue ( DzTime  tm,
Number  val 
)

Sets the value of the property at the given time, with the double precision number.

Parameters:
tm The scene time at which to set the value of the property.
val The value to set the property to.
See also:
getDoubleValue(), setDoubleValue()

DzNumericProperty::setDoubleValue ( Number  val  ) 

Sets the value for this property at the current time, or the default value if this property is not animatable, as a double precision number.

Parameters:
val The value to set the property to.
See also:
getDoubleValue()

void DzNumericProperty::setIsClamped ( Boolean  val  ) 

Sets whether or not the value is clamped to its min and max.

void DzNumericProperty::setIsMappable ( Boolean  val  ) 

Sets whether or not this property is mappable.

void DzNumericProperty::setIsModulo ( Boolean  val  ) 

Sets whether or not the value is modulo over min and max; i.e. the amount in which the value exceeds the min or max is applied as the value in the same direction from the opposite limit

Has no effect if isClamped() is true.

void DzNumericProperty::setMap ( String  imgFile  ) 

Set the image map for this property

void DzNumericProperty::setMap ( DzTexture  img  ) 

Set the image map for this property

void DzNumericProperty::setMustHaveMap ( Boolean  val  ) 

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

void DzNumericProperty::setXYZInterest ( XYZInterest  interest  ) 

Set the XYZ interest for this property

void DzNumericProperty::unlink (  ) 

Unlinks this property

DzNumericProperty::unlinked (  )  [signal]

Signature: "unlinked()"

Emitted when the property is unlinked from another property.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.