Base class of all numeric properties.

More...

Inherits :

• QObject
  • DzBase
    • DzProperty

Inherited By : DzFloatProperty and DzIntProperty

---

: XYZInterest

The axis that this properties value is applied to.

• 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.
• ALL_INTEREST - Value is used by the General Scale control.

---

void : clearMap()

Clear the image map for this property.

---

void : copyMapFrom( DzNumericProperty otherProp )

Copies the map from another property to this one.

Parameter(s):

• otherProp - The property to copy the map from.

Since:

• 4.9.2.61

---

Boolean : doesClampChangeValue()

Return Value:

• true if the clamp on this property changes its value, otherwise false.

Since:

• 4.9.0.24

---

DzProperty : findMatchingProperty( DzNode node, Boolean useStrictMatching=true )

Searches node for a property that matches the name of this property.

Parameter(s):

• node - The node to search.
• useStrictMatching - If true (default), any found property will only be considered a match if it is the same type as this property. If false, any found property will be considered a match if it inherits from DzNumericProperty.

See Also:

• DzProperty::findMatchingProperty()

---

Number : getDefaultMapGamma()

Return Value:

• The default map gamma.

Since:

• 4.5.2.23

---

Number : getDefaultMapTextureType()

Return Value:

• The default map texture type.

Since:

• 4.6.4.30

---

Number : getDoubleDefaultValue()

Return Value:

• The default value of this property as a double precision value.

See Also:

• setDoubleDefaultValue()

---

Number : getDoubleValue( DzTime tm )

Parameter(s):

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

Return Value:

• The value of this property, as a double precision number, at the given time.

See Also:

• getDoubleValue()
• setDoubleValue()

---

Number : getDoubleValue()

Return Value:

• The value of the property at the current time, as a double precision number.

See Also:

• getDoubleValue( DzTime )
• setDoubleValue()

---

DzNumericProperty : getFollowProperty()

Return Value:

• The property that this property is connected to via auto-follow. If this property cannot auto-follow or is not connected to a property via auto-follow, then this method returns null.

See Also:

• DzProperty::canAutoFollow()

---

Number : getFollowValue()

Return Value:

• The difference between the current value of the follow property and its default value at the current time. If no auto-follow property is set, or auto-follow is not enabled for this property, then this method returns 0.

---

Number : getFollowValue( DzTime tm )

Parameter(s):

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

Return Value:

• The difference between the current value of the follow property and this properties default value tm. If no auto-follow property is set, or auto-follow is not enabled for this property, then this method returns 0.

---

DzNumericProperty : getLinkProperty()

Return Value:

• The property that this property is directly linked to (if any), otherwise NULL.

See Also:

• isLinked()
• isMaster()
• linkTo()
• unlink()

---

DzTexture : getMapValue()

Return Value:

• The image map at the current time (if any), otherwise null.

---

DzTexture : getMapValue( DzTime time )

Parameter(s):

• time - The time at which to get the map value for this property.

Return Value:

• The image map for the given time (if any), otherwise null.

---

Array : getNDoubleValue()

Return Value:

• A list of the values this property has.

Since:

• 4.6.4.98

---

Array : getNDoubleValue( DzTime tm )

Parameter(s):

• tm - The scene time at which to get the value.

Return Value:

• A list of the values this property has.

Since:

• 4.6.4.98

---

Number : getNValueCount()

Return Value:

• The number of values this property has.

Since:

• 4.6.4.98

---

DzTextureModifier : getTextureModifier()

Return Value:

• The texture modifier for this property (if any), otherwise NULL.

Since:

• 4.6.4.80

---

Number : getTextureModifierFlags()

Return Value:

• The texture modifier flags.

See Also:

• DzTextureModifier::Modifications

Since:

• 4.6.4.82

---

DzFloatColor : getValueAsFloatColor( DzTime tm )

Parameter(s):

• tm - The scene time at which to get the value.

Return Value:

• The value of this property as a DzFloatColor.

Since:

• 4.7.1.56

---

DzFloatColor : getValueAsFloatColor()

Return Value:

• The value of this property as a float color.

Since:

• 4.7.1.56

---

DzInt2 : getValueAsInt2()

Return Value:

• The value of this property as a DzInt2.

Since:

• 4.7.1.56

---

DzInt2 : getValueAsInt2( DzTime tm )

Parameter(s):

• tm - The scene time at which to get the value.

Return Value:

• The value of this property as a DzInt2.

Since:

• 4.7.1.56

---

DzVec2 : getValueAsVec2()

Return Value:

• The value of this property as a DzVec2.

Since:

• 4.7.1.56

---

DzVec2 : getValueAsVec2( DzTime tm )

Parameter(s):

• tm - The scene time at which to get the value.

Return Value:

• The value of this property as a DzVec2.

Since:

• 4.7.1.56

---

DzVec3 : getValueAsVec3()

Return Value:

• The value of this property as a DzVec3.

Since:

• 4.7.1.56

---

DzVec3 : getValueAsVec3( DzTime tm )

Parameter(s):

• tm - The scene time at which to get the value.

Return Value:

• The value of this property as a DzVec3.

Since:

• 4.7.1.56

---

XYZInterest : getXYZInterest()

Return Value:

• The XYZ interest for this property (if any).

---

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

Adds a controller to this property.

Parameter(s):

• controller - The controller to insert.
• idx - The index where the controller should be inserted.

---

Boolean : isClamped()

Return Value:

• true if this property's value is clamped (for display purposes), otherwise false.

---

Boolean : isInvalidWithoutMap()

Return Value:

• true if the value of this property is invalid without a map assigned, otherwise false.

---

Boolean : isLinked()

Return Value:

• true if this property has a direct link to another property, otherwise false.

See Also:

• isMaster()
• getLinkProperty()
• linkTo()
• unlink()

---

Boolean : isMappable()

Return Value:

• true if this property is mappable (i.e., can have an associated image map), otherwise false.

---

Boolean : isMapped()

Return Value:

• true if this property is currently mapped, otherwise false.

---

Boolean : isMaster()

Return Value:

• true if this property is the master in a direct link between two properties.

See Also:

• isLinked()
• getLinkProperty()
• linkTo()
• unlink()

---

Boolean : isModulo()

Return Value:

• true if this property 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), otherwise false.

---

void : linkTo( DzNumericProperty master )

Establishes a direct link between this property and the given property.

Parameter(s):

• master - The property to be linked with this property.

Attention:

• This is the DAZ Studio equivalent of a LinkParm in Poser.

See Also:

• unlink()
• isMaster()
• isLinked()
• getLinkProperty()

---

void : setDefaultMapGamma( Number gamma )

Sets the default map gamma.

Parameter(s):

• gamma - The gamma value to set.

Since:

• 4.5.2.23

---

void : setDefaultMapTextureType( Number type )

Sets the default map texture type.

Parameter(s):

• type - The map texture type to set.

Since:

• 4.6.4.30

---

void : setDoubleDefaultValue( Number val )

Sets the default value for this property.

Parameter(s):

• val - The value to set as the default for this property.

See Also:

• getDoubleDefaultValue()

---

void : 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.

Parameter(s):

• val - The value to set the property to.

See Also:

• getDoubleValue()

---

void : setDoubleValue( DzTime tm, Number val )

Sets the value for this property at the given time; or the default value if this property is not animatable.

Parameter(s):

• tm - The scene time to set the value for.
• val - The value to set for this property.

See Also:

• getDoubleValue()
• setDoubleValue()

---

void : setIsClamped( Boolean val )

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

Parameter(s):

• val - If true, this property is clamped.

---

void : setIsMappable( Boolean val )

Sets whether or not this property is mappable.

Parameter(s):

• val - If true, this property is mappable.

---

void : 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.

• min = 0, max = 359, value = 365 = 5.
• min = 0, max = 359, value = -60 = 300.

Has no effect if isClamped() is true.

Parameter(s):

• val - If true, this value is modulo over min and max.

---

void : setMap( String imgFile )

Set the image map for this property.

Parameter(s):

• imgFile - The name of the file to use as an image map.

---

void : setMap( DzTexture img )

Set the image map for this property.

Parameter(s):

• img - The image map for this property.

---

void : setMustHaveMap( Boolean val )

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

Parameter(s):

• val - If true, this property must have a map assigned.

---

void : setTextureModifier( DzTextureModifier txtMod )

Sets the texture modifier.

Parameter(s):

• txtMod - The texture modifier to set.

Since:

• 4.6.4.80

---

void : setTextureModifierFlags( Number flags )

Sets texture modifier flags for this property.

Parameter(s):

• flags - The texture modifier flags to set.

See Also:

• DzTextureModifier::Modifications

Since:

• 4.6.4.82

---

void : setXYZInterest( XYZInterest interest )

Set the XYZ interest for this property.

Parameter(s):

• interest - The new XYZ interest for this property.

---

void : unlink()

Unlinks this property.

---

void : clampedChanged( Boolean onOff )

Signature:“clampedChanged(bool)”

Emitted when the clamped state for this property has changed.

Parameter(s):

• onOff - If true, then this property is clamped

---

void : defaultMapGammaChanged()

Signature:“defaultMapGammaChanged()”

Emitted when the default map gamma for this property has changed.

---

void : defaultMapTextureTypeChanged()

Signature:“defaultMapTextureTypeChanged()”

Emitted when the default map texture type for this property has changed.

---

void : isMappableChanged()

Signature:“isMappableChanged()”

Emitted when the state of whether or not this property is mappable has changed.

---

void : linked()

Signature:“linked()”

Emitted when the property is linked to another property.

---

void : mapChanged()

Signature:“mapChanged()”

Emitted when the image map for this property has changed.

---

void : minMaxChanged()

Signature:“minMaxChanged()”

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

---

void : textureModifierChanged()

Signature:“textureModifierChanged()”

Emitted when the texture modifier for this property has changed.

---

void : textureModifierFlagsChanged()

Signature:“textureModifierFlagsChanged()”

Emitted when the flags on the texture modifier for this property have changed.

---

void : unlinked()

Signature:“unlinked()”

Emitted when the property is unlinked from another property.