User Tools

Site Tools


DzNumericProperty

Base class of all numeric properties.

More...

Inherits :

Inherited By : DzFloatProperty and DzIntProperty

Enumerations

Methods

DAZ Script
voidclearMap ()
voidcopyMapFrom ( DzNumericProperty otherProp )
BooleandoesClampChangeValue ()
DzPropertyfindMatchingProperty ( DzNode node, Boolean useStrictMatching=true )
NumbergetDefaultMapGamma ()
NumbergetDefaultMapTextureType ()
NumbergetDoubleDefaultValue ()
NumbergetDoubleValue ( DzTime tm )
NumbergetDoubleValue ()
DzNumericPropertygetFollowProperty ()
NumbergetFollowValue ()
NumbergetFollowValue ( DzTime tm )
DzNumericPropertygetLinkProperty ()
DzTexturegetMapValue ()
DzTexturegetMapValue ( DzTime time )
DzDoubleVectorgetNDoubleValue ()
DzDoubleVectorgetNDoubleValue ( DzTime tm )
NumbergetNValueCount ()
DzTextureModifiergetTextureModifier ()
NumbergetTextureModifierFlags ()
DzFloatColorgetValueAsFloatColor ( DzTime tm )
DzFloatColorgetValueAsFloatColor ()
DzInt2getValueAsInt2 ()
DzInt2getValueAsInt2 ( DzTime tm )
DzVec2getValueAsVec2 ()
DzVec2getValueAsVec2 ( DzTime tm )
DzVec3getValueAsVec3 ()
DzVec3getValueAsVec3 ( DzTime tm )
XYZInterestgetXYZInterest ()
voidinsertController ( DzNumericController controller, Number idx=-1 )
BooleanisClamped ()
BooleanisInvalidWithoutMap ()
BooleanisLinked ()
BooleanisMappable ()
BooleanisMapped ()
BooleanisMaster ()
BooleanisModulo ()
voidlinkTo ( DzNumericProperty master )
voidsetDefaultMapGamma ( Number gamma )
voidsetDefaultMapTextureType ( Number type )
voidsetDoubleDefaultValue ( Number val )
voidsetDoubleValue ( Number val )
voidsetDoubleValue ( DzTime tm, Number val )
voidsetIsClamped ( Boolean val )
voidsetIsMappable ( Boolean val )
voidsetIsModulo ( Boolean val )
voidsetMap ( String imgFile )
voidsetMap ( DzTexture img )
voidsetMustHaveMap ( Boolean val )
voidsetTextureModifier ( DzTextureModifier txtMod )
voidsetTextureModifierFlags ( Number flags )
voidsetXYZInterest ( XYZInterest interest )
voidunlink ()

Signals

Detailed Description

TODO: Add detailed description.

Enumerations


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

Methods


void : clearMap()

Clear the image map for this property.


void : copyMapFrom( DzNumericProperty otherProp )

TODO: Add description.


Boolean : doesClampChangeValue()

TODO: Add description.


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:


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()

TODO: Add description.


Number : getDoubleValue( DzTime tm )

Parameter(s):

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

Return Value:

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

See Also:


Number : getDoubleValue()

Return Value:

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

See Also:


DzNumericProperty : getFollowProperty()

TODO: Add description.


Number : getFollowValue()

TODO: Add description.


Number : getFollowValue( DzTime tm )

TODO: Add description.


DzNumericProperty : getLinkProperty()

Return Value:

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

See Also:


DzTexture : getMapValue()

Return Value:

  • The image map at the current time. If this property is not mappable, the returned image will be empty.

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 the object is not mappable, the returned image will be empty.

DzDoubleVector : getNDoubleValue()

TODO: Add description.


DzDoubleVector : getNDoubleValue( DzTime tm )

TODO: Add description.


Number : getNValueCount()

TODO: Add description.


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.

Since:

  • 4.6.4.82

DzFloatColor : getValueAsFloatColor( DzTime tm )

TODO: Add description.


DzFloatColor : getValueAsFloatColor()

TODO: Add description.


DzInt2 : getValueAsInt2()

TODO: Add description.


DzInt2 : getValueAsInt2( DzTime tm )

TODO: Add description.


DzVec2 : getValueAsVec2()

TODO: Add description.


DzVec2 : getValueAsVec2( DzTime tm )

TODO: Add description.


DzVec3 : getValueAsVec3()

TODO: Add description.


DzVec3 : getValueAsVec3( DzTime tm )

TODO: Add description.


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 unless a map is assigned, otherwise false.

Boolean : isLinked()

Return Value:

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

See Also:


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:


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:


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 )

TODO: Add description.


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:


void : setDoubleValue( DzTime tm, Number val )

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

Parameter(s):

  • tm - The scene time at which to set the value of the property.
  • val - The value to set the property to.

See Also:


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.

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.

Signals


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()

TODO: Add description.


void : defaultMapTextureTypeChanged()

TODO: Add description.


void : isMappableChanged()

TODO: Add description.


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()

TODO: Add description.


void : textureModifierFlagsChanged()

TODO: Add description.


void : unlinked()

Signature:“unlinked()”

Emitted when the property is unlinked from another property.