User Tools

Site Tools


DzProperty

Base class for all property types.

More...

Inherits :

Inherited By : DzImageProperty, DzNodeProperty, DzNumericProperty and DzStringProperty

Enumerations

Properties

Methods

DAZ Script
voidaddValueToSettings ( DzTime tm, DzSettings settings, PropertyValueSettingsFlags flags=Standard )
voidaddValueToSettings ( DzSettings settings, PropertyValueSettingsFlags flags=Standard )
voidbeginEdit ()
DzUribuildNameUriToRoot ( DzNode rootNode=undefined )
BooleancanAnimate ()
BooleancanAutoFollow ()
voidcancelEdit ()
voidclearRegion ( Boolean preservePath=true )
voidcopyFrom ( DzProperty prop )
propertyclipboard_dzcopyToClipboard ()
DzPropertycreateAlias ()
BooleancurrentValueIsDefaultValue ()
BooleancurrentValueIsDefinitionValue ()
voiddeleteAllKeys ()
NumberdeleteKeys ( DzTimeRange interval )
NumberdeleteKeys ( Number start, Number end )
NumberdeleteSelectedKeys ()
DzPropertyfindMatchingProperty ( DzNode node )
voidfinishEdit ()
DzPropertygetAlias ( Number index )
DzPropertygetAliasTarget ()
voidgetAttributes ( DzPropertySettings settings )
DzUrigetAutoFollowTargetUri ()
DzControllergetController ( Number idx )
ArraygetControllerList ()
DzPropertyGroupgetGroup ()
NumbergetIndexOfSlaveControllers ( DzController cntrl )
DzTimeRangegetKeyRange ()
DzTimegetKeyTime ( Number i )
StringgetLabel ()
NumbergetNumAliases ()
NumbergetNumControllers ()
NumbergetNumKeys ()
NumbergetNumKeys ( DzTimeRange range )
NumbergetNumSelectedKeys ()
NumbergetNumSlaveControllers ()
DzElementgetOwner ()
StringgetPath ()
DzPresentationgetPresentation ()
geometryregion_dzgetRegion ()
DzTimeRangegetSelectedKeyRange ()
DzControllergetSlaveController ( Number idx )
ArraygetSlaveControllerList ()
StringgetWidgetClass ( Boolean styled=true )
StringgetWidgetClassOverride ( Boolean styled=true )
BooleanhasControllers ()
BooleanhasKeys ()
BooleanhasSlaveControllers ()
BooleanhasWidgetClassOverride ( Boolean styled=true )
BooleanisAlias ()
BooleanisCombinable ( DzProperty prop )
BooleanisDynamicallyAutoFollow ()
BooleanisDynamicallyHidden ()
BooleanisEditing ()
BooleanisFavorite ()
BooleanisGlobalFavorite ()
BooleanisHidden ()
BooleanisKeySelected ( Number i )
BooleanisLocked ()
BooleanisManipulator ()
BooleanisNew ()
BooleanisNumeric ()
BooleanisOverridingControllers ()
BooleanisPrivateProperty ()
BooleanisRigProperty ()
BooleanisSelected ()
BooleanisUserProperty ()
voidlock ( Boolean onOff )
BooleanmodifyAsset ( DzUri newUri )
BooleanmodifyAsset ()
BooleanmoveControllerToIndex ( Number curIdx, Number newIdx )
BooleanmoveControllerToIndex ( DzController ctrl, Number newIdx )
DzPropertypropertyDuplicate ()
BooleanrawValueIsDefinitionValue ()
voidremoveAllControllers ()
voidremoveController ( DzController ctrl )
voidremoveController ( Number idx )
voidremoveController ( DzProperty prop )
NumberselectAllKeys ( Boolean onOff=true )
voidselectKey ( Number i, Boolean onOff=true )
NumberselectKeys ( DzTimeRange range, Boolean onOff )
voidsetAttributes ( DzPropertySettings settings )
voidsetAutoFollowTargetUri ( DzUri path )
voidsetCanAnimate ( Boolean yesNo )
voidsetCanAutoFollow ( Boolean onOff )
voidsetDynamicallyAutoFollow ( Boolean yesNo )
voidsetDynamicallyHidden ( Boolean yesNo )
voidsetHidden ( Boolean yesNo )
voidsetIsFavorite ( Boolean onOff )
voidsetIsGlobalFavorite ( Boolean onOff )
voidsetIsManipulator ( Boolean onOff )
voidsetIsRigProperty ( Boolean yesNo )
voidsetIsUserProperty ( Boolean yesNo )
voidsetLabel ( String label )
voidsetNew ( Boolean onOff )
voidsetOverrideControllers ( Boolean onOff )
voidsetPath ( String path )
voidsetPresentation ( DzPresentation pres )
voidsetRegion ( geometryregion_dz reg )
voidsetSelected ( Boolean onOff )
voidsetValueFromSettings ( DzSettings settings, PropertyValueSettingsFlags flags=Standard )
voidsetValueFromSettings ( DzTime tm, DzSettings settings, PropertyValueSettingsFlags flags=Standard )
DzErrorsetWidgetClassOverride ( String styledWgtClassName, String wgtClassName )

Signals

Detailed Description

This is the base class for all properties that are owned or controlled by Elements. Properties can be keyable or not.

See Also:

Enumerations


: PropertyValueSettingsFlag

TODO: Add description.

  • Standard - Best for saving/loading; includes raw value; sets without adjusting.
  • IncludeDefault - Include the default value.
  • CurrentValue - Includes the value instead of the raw value.
  • AdjustValue - Best for setting.
  • SkipImages - Excludes images.

Properties


DzAuthor : assetAuthor

Holds the author of the file for this property. (Read Only)

Since:

  • 4.8.1.21

DzVersion : assetFileRevision

Holds the revision version of the asset file for this property. (Read Only)

Since:

  • 4.8.1.21

String : assetId

Holds the asset id for this property.

Since:

  • 4.8.1.18

Date : assetModifiedDate

Holds the modified date of the asset file for this property. (Read Only)

Since:

  • 4.8.1.21

DzUri : assetSource

Holds the URI of the asset source for this property; only valid when the asset is in an embedded state - i.e. modified. (Read Only)

Since:

  • 4.8.1.21

DzUri : assetUri

Holds the asset URI for this property. (Read Only)

Since:

  • 4.8.1.18

Boolean : emitValueChangedOnSceneClear

Holds whether or not the current value changed emits on scene clear.

Methods


void : addValueToSettings( DzTime tm, DzSettings settings, PropertyValueSettingsFlags flags=Standard )

Adds a value to a settings.

Parameter(s):

  • tm - The scene time to add the value for.
  • settings - The settings to add the data to.
  • flags - The flags for controlling the operation.

Since:

  • 4.7.1.72

void : addValueToSettings( DzSettings settings, PropertyValueSettingsFlags flags=Standard )

Adds a value to a settings.

Parameter(s):

  • settings - The settings to add the data to.
  • flags - The flags for controlling the operation.

Since:

  • 4.7.1.72

void : beginEdit()

Creates an undo item for the property.


DzUri : buildNameUriToRoot( DzNode rootNode=undefined )

Parameter(s):

  • rootNode - The node the path should be relative too. If null (default) the skeleton will be used when parented to a skeleton, otherwise the property's own node will be used if it is not part of a skeleton hierarchy.

Return Value:

  • A name path URI repersenting this property, relative to the root node.

Since:

  • 4.9.2.20

Boolean : canAnimate()

Return Value:

  • true if it is legal to animate this property, otherwise false.

Boolean : canAutoFollow()

Return Value:

  • true if the property can automatically follow a property on a following figure, otherwise false.

void : cancelEdit()

Finish the edit operation but cancel any changes.


void : clearRegion( Boolean preservePath=true )

Clears the region associated with this property.

Parameter(s):

  • preservePath - If true (default), this property's path will not be affected, otherwise the region's path will be removed from this property's path.

void : copyFrom( DzProperty prop )

Copies the value(s) of the given property into this property.


propertyclipboard_dz : copyToClipboard()

Copies the value(s) of the property to a 'clipboard' so that they may be saved and applied (pasted) to another property; or to the same property.

Return Value:

  • The 'clipboard' which holds a copy of the current property's value(s). These values are a snapshot of the current state of the property, and will remain unchanged even if the property is changed or deleted.

Attention:

  • The caller is responsible for deleting this object.

DzProperty : createAlias()

Creates a new property that forwards all edits of its values to the property it is an alias of.

Return Value:

  • The created property alias.

Boolean : currentValueIsDefaultValue()

Return Value:

  • true if the current value of the property is the same as the default value, otherwise false.

See Also:


Boolean : currentValueIsDefinitionValue()

Return Value:

  • true if the current value of the property is the same as the value in the file definition, otherwise false.

See Also:


void : deleteAllKeys()

Deletes all keys on this property.


Number : deleteKeys( DzTimeRange interval )

Clears key values within the given range, including the endpoints.

Return Value:

  • The number of keys actually deleted.

Number : deleteKeys( Number start, Number end )

Deletes all keys within a specified range.

Parameter(s):

  • start - The key index to start from.
  • end - The key index to end at.

Return Value:

  • The number of keys deleted.

Attention:

  • You are responsible to ensure the key indices are within the valid range.

Number : deleteSelectedKeys()

Deletes all selected keys.

Return Value:

  • The number of keys actually removed.

DzProperty : findMatchingProperty( DzNode node )

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

Parameter(s):

  • node - The node to search.

See Also:


void : finishEdit()

Finalizes the undo item and pushes it on to the undo stack.


DzProperty : getAlias( Number index )

Parameter(s):

  • index - The index of the alias to this property to get.

Return Value:

  • The alias to this property at index (if valid), otherwise NULL.

DzProperty : getAliasTarget()

Return Value:

  • The property that this property is an alias of, or NULL if none (default).

void : getAttributes( DzPropertySettings settings )

Populates the given settings object with the attributes of this property.


DzUri : getAutoFollowTargetUri()

Return Value:

  • The auto-follow target URI for this property.

See Also:

Since:

  • 4.9.2.19

DzController : getController( Number idx )

Parameter(s):

  • idx - The index of the controller on this property to get.

Return Value:

  • The i'th controller on this property.

Array : getControllerList()

Return Value:

  • A list of the controllers on this property.

DzPropertyGroup : getGroup()

Return Value:

  • The property group that this property belongs to (if any), otherwise NULL.

Number : getIndexOfSlaveControllers( DzController cntrl )

Return Value:

  • The index of controllers that are slaved to this property (if any), otherwise -1.

DzTimeRange : getKeyRange()

Return Value:

  • The total range of keys on this property.

DzTime : getKeyTime( Number i )

Parameter(s):

  • i - The index of the key time within the current key range.

Return Value:

  • The time of the i'th key within the current key range.

String : getLabel()

Return Value:

  • The user-defined label for this property.

Number : getNumAliases()

Return Value:

  • The number of aliases to this property that exist.

Number : getNumControllers()

Return Value:

  • The number of controllers for this property

Number : getNumKeys()

Return Value:

  • The total number of keys on this property.

Number : getNumKeys( DzTimeRange range )

Parameter(s):

  • range - The range to get the number of keys in.

Return Value:

  • The number of keys that exist within the given range, including endpoints.

Number : getNumSelectedKeys()

Return Value:

  • The number of currently selected keys on this property.

Number : getNumSlaveControllers()

Return Value:

  • The number of controllers that are slaved to this property.

DzElement : getOwner()

Return Value:

  • The current owner of this property.

String : getPath()

Return Value:

  • The slash ('/') delimited hierarchical path of the group this property is assigned to.

DzPresentation : getPresentation()

Return Value:

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

geometryregion_dz : getRegion()

Return Value:

  • The geometry region for this property (if any), otherwise NULL.

DzTimeRange : getSelectedKeyRange()

Return Value:

  • A range that encompasses all currently selected keys on this property.

DzController : getSlaveController( Number idx )

Return Value:

  • The i'th controller that is slaved to this property.

Array : getSlaveControllerList()

Return Value:

  • A list of the controllers that are slaved to this property.

String : getWidgetClass( Boolean styled=true )

Parameter(s):

  • styled - If true, the returned classname should be the styled version (i.e., DS 4 vs DS 3). If false, the returned classname should be the base version.

Return Value:

  • The classname of the widget to use for displaying this property to the user.

String : getWidgetClassOverride( Boolean styled=true )

Parameter(s):

  • styled - If true, the return value will be the name of the styled widget class.

Return Value:

  • The name of the styled widget class, otherwise the name of the standard widget class; this will be an empty string if the corresponding value has not been set.

See Also:

Since:

  • 4.6.4.88

Boolean : hasControllers()

Return Value:

  • true if this property has controllers, otherwise false.

Boolean : hasKeys()

Return Value:

  • true if this property has key data, otherwise false.

Boolean : hasSlaveControllers()

Return Value:

  • true if this property has controllers that are slaved to it, otherwise false.

Boolean : hasWidgetClassOverride( Boolean styled=true )

Parameter(s):

  • styled - If true, the return value will be based on whether or not an override for the styled widget class has been specified.

Return Value:

  • true if an override for the widget class has been specified, otherwise false.

See Also:

Since:

  • 4.6.4.88

Boolean : isAlias()

Return Value:

  • true if this property is an alias to another property, otherwise false (default).

Boolean : isCombinable( DzProperty prop )

Parameter(s):

  • prop - The property in question.

Return Value:

  • true if this property and prop can be combined in the UI, otherwise false.

Boolean : isDynamicallyAutoFollow()

Return Value:

  • true if this property should [temporarily] auto-follow, otherwise false.

See Also:

Since:

  • 4.8.0.23

Boolean : isDynamicallyHidden()

Return Value:

  • true if this property should [temporarily] not be shown in the interface, otherwise false.

Boolean : isEditing()

Return Value:

  • true if the property is being edited, otherwise false.

Boolean : isFavorite()

Return Value:

  • true if the property is a favorite, otherwise false.

Boolean : isGlobalFavorite()

Return Value:

  • true if the property is a global favorite, otherwise false.

Boolean : isHidden()

Return Value:

  • true if this property should not be shown in the interface, otherwise false.

Boolean : isKeySelected( Number i )

Parameter(s):

  • i - The index of the key in question.

Return Value:

  • true if the key at the given index is selected, otherwise false.

Boolean : isLocked()

Return Value:

  • true if this property is locked, otherwise false.

Boolean : isManipulator()

Return Value:

  • true if the property will cause manipulation updates of the object in the viewport (default), otherwise false.

Boolean : isNew()

Return Value:

  • true if the property is new, otherwise false.

Boolean : isNumeric()

Return Value:

  • true if this property can be retrieved/set as a scalar numeric value, otherwise false.

Boolean : isOverridingControllers()

Return Value:

  • true if the property is currently overriding its controllers, otherwise false.

Boolean : isPrivateProperty()

Return Value:

  • true if this property is private, otherwise false.

Boolean : isRigProperty()

Return Value:

  • true if this property is for rigging, otherwise false.

Boolean : isSelected()

Return Value:

  • true if the property is selected, otherwise false.

Boolean : isUserProperty()

Return Value:

  • true if this property can be deleted by the user, otherwise false.

void : lock( Boolean onOff )

Locks/Unlocks this property. When locked, a property will not accept new key values or changes to current key values.

Parameter(s):

  • onOff - If true, the property will be locked. If false, the property will be unlocked.

Boolean : modifyAsset( DzUri newUri )

Marks the asset as being modified.

Parameter(s):

  • newUri - The URI for the asset.

Return Value:

  • true if the asset was successfully marked as being modified, otherwise false.

Boolean : modifyAsset()

Marks the asset as being modified.

Return Value:

  • true if the asset was successfully marked as being modified, otherwise false.

Boolean : moveControllerToIndex( Number curIdx, Number newIdx )

Moves the controller at curIdx to newIdx

Parameter(s):

  • curIdx - The index of the controller to move. If < 0 or >= DzProperty::getNumControllers() this method will return false.
  • newIdx - The index to move the controller to. If < 0 the controller will be moved to the beginning of the list. If >= DzProperty::getNumControllers(), the controller will be moved to the end of the list.

Return Value:

  • true if the move was successful, otherwise false.

Boolean : moveControllerToIndex( DzController ctrl, Number newIdx )

Moves the controller ctrl to location newIdx

Parameter(s):

  • ctrl - The controller to remove.
  • newIdx - The index to move the controller to. If < 0 the controller will be moved to the beginning of the list. If >= DzProperty::getNumControllers(), the controller will be moved to the end of the list.

Return Value:

  • true if the move was successful, otherwise false.

DzProperty : propertyDuplicate()

Creates a copy of this property. The property will not have controllers, an owner, be in a region, or be linked.

Return Value:

  • A duplicate of this property (if successful), otherwise null.

Boolean : rawValueIsDefinitionValue()

Return Value:

  • true if the raw value of the property is the same as the value in the file definition, otherwise false.

See Also:

Since:

  • 4.9.2.1

void : removeAllControllers()

Removes all controllers from this property.


void : removeController( DzController ctrl )

Removes the given controller from this property.

Parameter(s):

  • ctrl - The controller to remove.

void : removeController( Number idx )

Removes the controller at the given index from this property.

Parameter(s):

  • idx - The index of the controller to remove.

void : removeController( DzProperty prop )

Removes the controller that references the given property.

Parameter(s):

  • prop - The property to remove the controller for.

Number : selectAllKeys( Boolean onOff=true )

Select or deselect all keys.

Parameter(s):

  • onOff - If true, the keys will be selected. If false, the keys will be deselected.

Return Value:

  • The number of keys whose state was changed.

void : selectKey( Number i, Boolean onOff=true )

Selects/deselects the i'th key.

Parameter(s):

  • i - The index of the key to select/deselect.
  • onOff - If true, the key will be selected. If false, the key will be deselected.

Number : selectKeys( DzTimeRange range, Boolean onOff )

Sets the selection state of any keys in the given range.

Parameter(s):

  • range - The range of keys to select/deselect.
  • onOff - If true, the keys will be selected. If false, the keys will be deselected.

Return Value:

  • The number of keys whose selection state changed.

void : setAttributes( DzPropertySettings settings )

Sets attributes for this property. “UserProperty” and “RigProperty” attributes are not copied from the settings unless a bool setting of “ForceSetUser” and/or “ForceSetRig” is set on the property settings object respectively.

Parameter(s):

  • settings - The settings to use to set attributes.

void : setAutoFollowTargetUri( DzUri path )

Sets a path to locate the property on the follow target to follow.

Parameter(s):

  • path - The URI for the property to automatically follow. The node path is assumed to be relative to the target skeleton.

See Also:

Since:

  • 4.9.2.19

void : setCanAnimate( Boolean yesNo )

Sets whether this property is animatable.

Parameter(s):

  • yesNo - If true, the property is set to be animatable.

Attention:

  • This method should only called to set initial values on a property that has been created using the default constructor.

void : setCanAutoFollow( Boolean onOff )

Sets whether or not the property can automatically follow properties on a following figure.

Parameter(s):

  • onOff - If true, the property will be considered during auto-follow.

Attention:

  • When associated with a figure that is a follow target, this value determines whether or not this property will be projected onto the follower (if this property is the control for an auto-follow modifier, e.g., morph_dz). When associated with a figure that is a follower, this value determines whether or not the name of this property (or the name of a modifier that owns this property) will be used to find a match in the follow target and if found add the found property's value (minus its default value) to this property's value (as possible depending on any constrains/controllers).

void : setDynamicallyAutoFollow( Boolean yesNo )

Sets whether or not this property should [temporarily] auto-follow.

Parameter(s):

  • yesNo - If true, the property dynamically auto-follows.

Attention:

  • The dynamically auto-follow state is not saved.

Since:

  • 4.8.0.23

void : setDynamicallyHidden( Boolean yesNo )

Sets whether or not this property should be [temporarily] hidden in the interfacee.

Parameter(s):

  • yesNo - If true, the property is dynamically hidden.

Attention:

  • The dynamically hidden state is not saved.

Since:

  • 4.8.0.23

void : setHidden( Boolean yesNo )

Sets whether or not this property is hidden in the interface.

Parameter(s):

  • yesNo - If true, the property is hidden.

void : setIsFavorite( Boolean onOff )

Sets whether or not the property is a favorite.

Parameter(s):

  • onOff - If true, the property will be set as a favorite.

void : setIsGlobalFavorite( Boolean onOff )

Sets whether or not the property is a global favorite.

Parameter(s):

  • onOff - If true, the property will be set as a global favorite.

void : setIsManipulator( Boolean onOff )

Sets whether or not the property is one that will cause manipulation updates of the object in the viewport.

Parameter(s):

  • onOff - If true, the property will be set as a manipulator.

void : setIsRigProperty( Boolean yesNo )

Sets whether this property is a rigging property.

Parameter(s):

  • yesNo - If true, the property is set to be a rigging-property.

Attention:

  • This method should only be called to set initial values on a property that has been created using the default constructor.

void : setIsUserProperty( Boolean yesNo )

Sets whether this property is a user property (i.e., can be deleted by the user).

Parameter(s):

  • yesNo - If true, the property is set to be a user-property.

Attention:

  • This method should only be called to set initial values on a property that has been created using the default constructor.

void : setLabel( String label )

Sets the label that the user sees in the interface for this property.

Parameter(s):

  • path - The label to set; should be unique among all the other properties of this property's owner.

void : setNew( Boolean onOff )

Sets whether or not the property is marked new.

Parameter(s):

  • onOff - If true, this property will be marked new.

void : setOverrideControllers( Boolean onOff )

Sets whether or not this property will override its controllers.

Parameter(s):

  • onOff - If true, this property will override its controllers.

void : setPath( String path )

Sets the group that this property belongs to.

Parameter(s):

  • path - The slash ('/') delimited hierarchical path of the group to assign this property to.

void : setPresentation( DzPresentation pres )

Parameter(s):

  • pres - The presentation to set on this property.

void : setRegion( geometryregion_dz reg )

Parameter(s):

  • reg - The geoemtry region to set.

void : setSelected( Boolean onOff )

Sets whether or not the property is selected.

Parameter(s):

  • onOff - If true, the property will be set as selected.

void : setValueFromSettings( DzSettings settings, PropertyValueSettingsFlags flags=Standard )

Sets the value using settings.

Parameter(s):

  • settings - The settings with the data to set.
  • flags - The flags for controlling the operation.

Since:

  • 4.7.1.72

void : setValueFromSettings( DzTime tm, DzSettings settings, PropertyValueSettingsFlags flags=Standard )

Sets the value using settings.

Parameter(s):

  • tm - The scene time to set the value at.
  • settings - The settings with the data to set.
  • flags - The flags for controlling the operation.

Since:

  • 4.7.1.72

DzError : setWidgetClassOverride( String styledWgtClassName, String wgtClassName )

Sets the name of the widget class to override the default widget class for this property.

Parameter(s):

  • styledWgtClassName - The name of the styled widget class.
  • wgtClassName - The name of the standard widget class.

Return Value:

  • DZ_NO_ERROR if no error occurs, otherwise an appropriate error code.

See Also:

Since:

  • 4.6.4.88

Signals


void : aliasListChanged()

TODO: Add description.


void : assetModified()

TODO: Add description.


void : assetWasSaved()

TODO: Add description.


void : autoFollowTargetUriChanged( DzUri path )

TODO: Add description.


void : canAnimateChanged( Boolean enabled )

Signature:“canAnimateChanged(bool)”

Emitted when animation for this property is enabled or disabled.

Parameter(s):

  • enabled - If true, animation was enabled for the property, otherwise animation was disabled.

void : canAutoFollowChanged( Boolean canAutoFollow )

TODO: Add description.


void : controllerListChanged()

TODO: Add description.


void : currentValueChanged()

Signature:“currentValueChanged()”

Emitted when the value of this property at the current time has changed. If the current time changes and this property has animation data, this signal is emitted as appropriate. Subclasses of DzProperty should call emitCurrentValueChanged() when the value has changed.


void : dynamicallyAutoFollowChanged( Boolean onOff )

TODO: Add description.


void : dynamicallyHiddenChanged( Boolean hidden )

TODO: Add description.


void : editFinished()

TODO: Add description.


void : groupChanged( DzPropertyGroup group )

Signature:“groupChanged(DzPropertyGroup*)”

Emitted when the group this property is in changed.

Parameter(s):

  • newGroup - The group this property was added to.

void : hiddenChanged( Boolean hidden )

Signature:“hiddenChanged(bool)”

Emitted when the hidden state of this property is changed.

Parameter(s):

  • hidden - true if the property is currently hidden in the interface, otherwise false.

void : isFavoriteChanged( Boolean onOff )

Signature:“isFavoriteChanged(bool)”

Emitted when this property is set or unset as a favorite.

Parameter(s):

  • onOff - If true, the property is now a favorite, otherwise the property is no longer a favorite.

void : isGlobalFavoriteChanged( Boolean onOff )

Signature:“isGlobalFavoriteChanged(bool)”

Emitted when this property is set or unset as a global favorite.

Parameter(s):

  • onOff - If true, the property is now a global favorite, otherwise the property is no longer a global favorite.

void : isManipulatorChanged( Boolean isManip )

Signature:“isManipulatorChanged(bool)”

Emitted when this property is set or unset as a manipulator.

Parameter(s):

  • isManip - If true, the property is now a manipulator, otherwise the property is no longer a manipulator.

void : isUserPropertyChanged( Boolean isUserProp )

Signature:“isUserPropertyChanged(bool)”

Emitted when this property is set or unset as a user property.

Parameter(s):

  • isUserProp - If true, the property is now a user property, otherwise the property is no longer a user property.

void : keySelectionChanged( DzTimeRange range )

Signature:“keySelectionChanged(const DzTimeRange&)”

Emitted when the selection state of this property's keys has changed.

Parameter(s):

  • range - The range in which selection changed.

void : labelChanged( String newLabel )

Signature:“labelChanged(const QString&)”

Emitted when the label of this property is changed.

Parameter(s):

  • newLabel - The new label of this property.

void : lockStateChanged()

Signature:“lockStateChanged()”

Emitted when the lock state of this property has changed.


void : newStateChanged()

TODO: Add description.


void : overridingControllersChanged( Boolean overriding )

Signature:“overridingControllersChanged(bool)”

Emitted when the state for whether this property overrides its controllers changed.

Parameter(s):

  • hidden - true if the property is currently overriding controllers, otherwise false.

void : presentationIconChanged()

TODO: Add description.


void : propertyDeleted( DzProperty prop )

Signature:“propertyDeleted(DzProperty*)”

Emitted when this property is destroyed.

Parameter(s):

  • thisProperty - The deleted property; this property.

void : regionChanged()

TODO: Add description.


void : removed()

Signature:“removed()”

Emitted when this property is removed.


void : selectionStateChanged()

Signature:“selectionStateChanged()”

Emitted when this property is selected or deselected.


void : slaveControllerListChanged()

TODO: Add description.


void : valueChanged( DzTimeRange range )

Signature:“valueChanged(const DzTimeRange&)”

Emitted when the value of this property is changed.

Parameter(s):

  • range - The range over which the property has changed.