Base class for all property types.
Inherits :
Inherited By : DzImageProperty, DzNodeProperty, DzNumericProperty and DzStringProperty
This is the base class for all properties that are owned or controlled by Elements. Properties can be keyable or not.
See Also:
Enumerated values for the type of interpolation to apply for a given key.
Since:
—–
Enumerated values for controlling which attributes of a property are reset.
Since:
—–
Enumerated values for controlling how the value of a property is set.
Since:
Holds the author of the file for this property. (Read Only)
Since:
Holds the revision version of the asset file for this property. (Read Only)
Since:
Holds the asset id for this property.
Since:
Holds the modified date of the asset file for this property. (Read Only)
Since:
Holds whether or not the asset for this property needs to be saved. (Read Only)
Since:
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:
Holds the asset URI for this property. (Read Only)
Since:
Boolean : emitValueChangedOnSceneClear
Holds whether or not currentValueChanged() is emitted when the scene is cleared.
Attention:
Since:
void : addValueToSettings( DzTime tm, DzSettings settings, PropertyValueSettingsFlags flags=Standard )
Adds a value to a settings.
Parameter(s):
Since:
void : addValueToSettings( DzSettings settings, PropertyValueSettingsFlags flags=Standard )
Adds a value to a settings.
Parameter(s):
Since:
void : beginEdit()
Creates an undo item for the property.
DzUri : buildIdUriToRoot( DzNode rootNode=null )
Parameter(s):
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:
Since:
DzUri : buildNameUriToRoot( DzNode rootNode=null )
Parameter(s):
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:
Since:
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):
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:
Attention:
DzProperty : createAlias()
Creates a new property that forwards all edits of its values to the property it is an alias of.
Return Value:
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.
See Also:
Number : deleteKeys( Number start, Number end )
Deletes all keys within a specified range.
Parameter(s):
Return Value:
Attention:
See Also:
Number : deleteKeys( DzTimeRange interval )
Clears key values within the given range, including the endpoints.
Parameter(s):
Return Value:
See Also:
Deletes all selected keys.
Return Value:
See Also:
Boolean : doCurrentAttributesMatchDefinition()
Return Value:
true
if the current property attributes are the same as the definitions, otherwise false
.See Also:
Number : findKeyIndex( DzTime tm )
Return Value:
Since:
DzProperty : findMatchingProperty( DzNode node )
Searches node
for a property that matches the name of this property.
Parameter(s):
See Also:
void : finishEdit()
Finalizes the undo item and pushes it on to the undo stack.
DzProperty : getAlias( Number index )
Parameter(s):
Return Value:
index
(if valid), otherwise null.DzProperty : getAliasTarget()
Return Value:
void : getAttributes( DzPropertySettings settings )
Populates the given settings object with the attributes of this property.
DzUri : getAutoFollowTargetUri()
Return Value:
See Also:
Since:
DzController : getController( Number idx )
Parameter(s):
Return Value:
Return Value:
Return Value:
Number : getIndexOfSlaveControllers( DzController controller )
Return Value:
InterpolationType : getKeyInterpolationType( Number i )
Parameter(s):
Return Value:
See Also:
Since:
Array : getKeyInterpolationTypeValues( Number i )
Parameter(s):
Return Value:
Attention:
Since:
Return Value:
DzTime : getKeyTime( Number i )
Parameter(s):
Return Value:
Return Value:
Number : getNumAliases()
Return Value:
Return Value:
Number : getNumKeys()
Return Value:
Number : getNumKeys( DzTimeRange range )
Parameter(s):
Return Value:
Return Value:
Number : getNumSlaveControllers()
Return Value:
Return Value:
Return Value:
DzPresentation : getPresentation()
Return Value:
geometryregion_dz : getRegion()
Return Value:
DzTimeRange : getSelectedKeyRange()
Return Value:
DzController : getSlaveController( Number idx )
Return Value:
Array : getSlaveControllerList()
Return Value:
String : getWidgetClass( Boolean styled=true )
Parameter(s):
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:
String : getWidgetClassOverride( Boolean styled=true )
Parameter(s):
true
, the return value will be the name of the styled widget class.Return Value:
See Also:
Since:
Return Value:
true
if this property has controllers, otherwise false
.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):
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:
Return Value:
true
if this property is an alias to another property, otherwise false
(default).Boolean : isCombinable( DzProperty prop )
Parameter(s):
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:
Boolean : isDynamicallyHidden()
Return Value:
true
if this property should [temporarily] not be shown in the interface, otherwise false
.Return Value:
true
if the property is being edited, otherwise false
.Boolean : isFavorite()
Return Value:
true
if the property is a favorite, otherwise false
.Return Value:
true
if the property is a global favorite, otherwise false
.Return Value:
true
if this property should not be shown in the interface, otherwise false
.Boolean : isKeySelected( Number i )
Parameter(s):
Return Value:
true
if the key at the given index is selected, otherwise false
.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
.Return Value:
true
if the property is new, otherwise false
.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
.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
.Return Value:
true
if this property can be deleted by the user, otherwise false
.Locks/Unlocks this property. When locked, a property will not accept new key values or changes to current key values.
Parameter(s):
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):
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( DzController controller, Number newIdx )
Moves the controller ctrl
to location newIdx
Parameter(s):
Return Value:
true
if the move was successful, otherwise false
.Boolean : moveControllerToIndex( Number curIdx, Number newIdx )
Moves the controller at curIdx
to newIdx
Parameter(s):
false
.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:
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:
void : removeAllControllers()
Removes all controllers from this property.
void : removeController( DzProperty prop )
Removes the controller that references the given property.
Parameter(s):
void : removeController( Number idx )
Removes the controller at the given index from this property.
Parameter(s):
void : removeController( DzController controller )
Removes the given controller from this property.
Parameter(s):
void : reset( PropertyResetFlags resetFlags=ResetDefault )
Restores this property.
Parameter(s):
Since:
void : restoreAttributesFromDefinition()
Restores the attributes of this property to match its definition.
See Also:
Since:
Number : selectAllKeys( Boolean onOff=true )
Select or deselect all keys.
Parameter(s):
true
, the keys will be selected. If false
, the keys will be deselected.Return Value:
void : selectKey( Number i, Boolean onOff=true )
Selects/deselects the i'th key.
Parameter(s):
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):
true
, the keys will be selected. If false
, the keys will be deselected.Return Value:
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):
void : setAutoFollowTargetUri( DzUri path )
Sets a path to locate the property on the follow target to follow.
Parameter(s):
See Also:
Since:
void : setCanAnimate( Boolean yesNo )
Sets whether this property is animatable.
Parameter(s):
true
, the property is set to be animatable.Attention:
void : setCanAutoFollow( Boolean onOff )
Sets whether or not the property can automatically follow properties on a following figure.
Parameter(s):
true
, the property will be considered during auto-follow.Attention:
void : setDynamicallyAutoFollow( Boolean yesNo )
Sets whether or not this property should [temporarily] auto-follow.
Parameter(s):
true
, the property dynamically auto-follows.Attention:
Since:
void : setDynamicallyHidden( Boolean yesNo )
Sets whether or not this property should be [temporarily] hidden in the interface.
Parameter(s):
true
, the property is dynamically hidden.Attention:
Since:
void : setHidden( Boolean yesNo )
Sets whether or not this property is hidden in the interface.
Parameter(s):
true
, the property is hidden.void : setIsFavorite( Boolean onOff )
Sets whether or not the property is a favorite.
Parameter(s):
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):
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):
true
, the property will be set as a manipulator.void : setIsRigProperty( Boolean yesNo )
Sets whether this property is a rigging property.
Parameter(s):
true
, the property is set to be a rigging-property.Attention:
void : setIsUserProperty( Boolean yesNo )
Sets whether this property is a user property (i.e., can be deleted by the user).
Parameter(s):
true
, the property is set to be a user-property.Attention:
void : setKeyInterpolationType( Number i, InterpolationType interp, Number param0, Number param1, Number param2 )
Sets the interpolation method for the i'th key.
Parameter(s):
Since:
void : setKeyInterpolationType( Number i, InterpolationType interp )
Sets the interpolation method for the i'th key.
Parameter(s):
Since:
void : setLabel( String label )
Sets the label that the user sees in the interface for this property.
Parameter(s):
See Also:
void : setNew( Boolean onOff )
Sets whether or not the property is marked new.
Parameter(s):
true
, this property will be marked new.void : setOverrideControllers( Boolean onOff )
Sets whether or not this property will override its controllers.
Parameter(s):
true
, this property will override its controllers.Sets the group that this property belongs to.
Parameter(s):
void : setPresentation( DzPresentation pres )
Parameter(s):
void : setRegion( geometryregion_dz reg )
Parameter(s):
void : setSelected( Boolean onOff )
Sets whether or not the property is selected.
Parameter(s):
true
, the property will be set as selected.void : setValueFromSettings( DzSettings settings, PropertyValueSettingsFlags flags=Standard )
Sets the value using settings.
Parameter(s):
Since:
void : setValueFromSettings( DzTime tm, DzSettings settings, PropertyValueSettingsFlags flags=Standard )
Sets the value using settings.
Parameter(s):
Since:
DzError : setWidgetClassOverride( String styledWgtClassName, String wgtClassName )
Sets the name of the widget class to override the default widget class for this property.
Parameter(s):
Return Value:
See Also:
Since:
void : aliasListChanged()
Signature:“aliasListChanged()”
Emitted when the alias list for this property has changed.
void : assetModified()
Signature:“assetModified()”
Emitted when this property has been modified.
void : assetWasSaved()
Signature:“assetWasSaved()”
Emitted after this property has been saved.
void : autoFollowTargetUriChanged( DzUri path )
Signature:“autoFollowTargetUriChanged(const DzUri&)”
Emitted when the URI for the auto-follow target of this property has changed.
Parameter(s):
void : canAnimateChanged( Boolean enabled )
Signature:“canAnimateChanged(bool)”
Emitted when animation for this property is enabled or disabled.
Parameter(s):
true
, animation was enabled for the property, otherwise animation was disabled.void : canAutoFollowChanged( Boolean canAutoFollow )
Signature:“canAutoFollowChanged(bool)”
Emitted when the state for whether this property can auto-follow changed.
Parameter(s):
true
if the property can auto-follow, otherwise false
.void : controllerListChanged()
Signature:“controllerListChanged()”
Emitted when the controller list for this property has changed.
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 )
Signature:“dynamicallyAutoFollowChanged(bool)”
Emitted when the dynamically auto-follow hidden state of this property is changed.
Parameter(s):
true
if the property is currently dynamically auto-follow hidden in the interface, otherwise false
.void : dynamicallyHiddenChanged( Boolean hidden )
Signature:“dynamicallyHiddenChanged(bool)”
Emitted when the dynamically hidden state of this property is changed.
Parameter(s):
true
if the property is currently dynamically hidden in the interface, otherwise false
.void : editFinished()
Signature:“editFinished()”
Emitted when editing of this property has finished.
void : groupChanged( DzPropertyGroup group )
Signature:“groupChanged(DzPropertyGroup*)”
Emitted when the group this property is in changed.
Parameter(s):
void : hiddenChanged( Boolean hidden )
Signature:“hiddenChanged(bool)”
Emitted when the hidden state of this property is changed.
Parameter(s):
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):
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):
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):
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):
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):
void : labelChanged( String newLabel )
Signature:“labelChanged(const QString&)”
Emitted when the label of this property is changed.
Parameter(s):
void : lockStateChanged()
Signature:“lockStateChanged()”
Emitted when the lock state of this property has changed.
void : newStateChanged()
Signature:“newStateChanged()”
Emitted when the new state of this property has changed.
void : overridingControllersChanged( Boolean overriding )
Signature:“overridingControllersChanged(bool)”
Emitted when the state for whether this property overrides its controllers changed.
Parameter(s):
true
if the property is currently overriding controllers, otherwise false
.void : presentationIconChanged()
Signature:“presentationIconChanged()”
Emitted when the presentation icon for this property has changed.
void : propertyDeleted( DzProperty prop )
Signature:“propertyDeleted(DzProperty*)”
Emitted when this property is destroyed.
Parameter(s):
void : regionChanged()
Signature:“regionChanged()”
Emitted when the region for this property has changed.
void : removed()
Signature:“removed()”
Emitted when this property is removed.
void : selectionStateChanged()
Signature:“selectionStateChanged()”
Emitted when this property is selected or deselected.
void : slaveControllerListChanged()
Signature:“slaveControllerListChanged()”
Emitted when the slave controller list for this property has changed.
void : valueChanged( DzTimeRange range )
Signature:“valueChanged(const DzTimeRange&)”
Emitted when the value of this property is changed.
Parameter(s):