Inheritance diagram for DzProperty:
This is the base class for all properties that are owned or controlled by Elements. Properties can be keyable or not.
void DzProperty::beginEdit | ( | ) |
When beginEdit is called, the property will create an undo item.
Boolean DzProperty::canAnimate | ( | ) |
DzProperty::canAnimateChanged | ( | Boolean | enabled | ) | [signal] |
Signature: "canAnimateChanged(bool)"
Emitted when animation for this property is enabled or disabled.
enabled | If true, animation was enabled for the property, otherwise, animation was diasbled. |
void DzProperty::cancelEdit | ( | ) |
Finish the edit operation but cancel any changes.
void DzProperty::copyFrom | ( | DzProperty | prop | ) |
Copies the value(s) of the given property into this property.
DzPropertyClipboard DzProperty::copyToClipboard | ( | ) |
Copies the value(s) of the property to a 'clipboard' so that they may be saved and applied (copied) to another property - or to the same property. Subclasses should reimplement this function if they contain implementation specific data that needs to be copied.
DzProperty::currentValueChanged | ( | ) | [signal] |
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.
void DzProperty::deleteAllKeys | ( | ) |
Deletes all keys on this property.
Deletes all keys starting at index start and ending at index end. User is responsible to assure proper ranges for key indexes.
Number DzProperty::deleteKeys | ( | DzTimeRange | interval | ) |
Clears key values within the given range, including the endpoints.
int DzProperty::deleteSelectedKeys | ( | ) |
Deletes all selected keys.
void DzProperty::finishEdit | ( | ) |
When finishEdit is called the undo item will be finalized and pushed on to the stack.
void DzProperty::getAttributes | ( | DzPropertySettings | settings | ) |
Populates the given settings object with the attributes of this property.
DzController DzProperty::getController | ( | Number | idx | ) |
Array DzProperty::getControllerList | ( | ) |
Provided for use by DAZ Script - plug-in developers should use the much more efficient controllerListIterator() function.
DzPropertyGroup DzProperty::getGroup | ( | ) |
Number DzProperty::getKeyIndexRange | ( | DzTimeRange | iv, | |
Number | start | |||
) |
DzTimeRange DzProperty::getKeyRange | ( | ) |
String DzProperty::getLabel | ( | ) |
Number DzProperty::getNumControllers | ( | ) |
Number DzProperty::getNumKeys | ( | DzTimeRange | range | ) |
Number DzProperty::getNumKeys | ( | ) |
Number DzProperty::getNumSelectedKeys | ( | ) |
DzElement DzProperty::getOwner | ( | ) |
String DzProperty::getPath | ( | ) |
DzTimeRange DzProperty::getSelectedKeyRange | ( | ) |
String DzProperty::getWidgetClass | ( | ) |
DzProperty::groupChanged | ( | DzPropertyGroup | newGroup | ) | [signal] |
Signature: "groupChanged(DzPropertyGroup*)"
Emitted when the group this property is in changed.
newGroup | The group this property was added to |
Boolean DzProperty::hasControllers | ( | ) |
Boolean DzProperty::hasKeys | ( | ) |
DzProperty::hiddenChanged | ( | Boolean | hidden | ) | [signal] |
Signature: "hiddenChanged(bool)"
Emitted when the hidden state of this property is changed.
hidden | true if the property is currently hidden in the interface. |
Boolean DzProperty::isFavorite | ( | ) |
DzProperty::isFavoriteChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "isFavoriteChanged(bool)"
Emitted when this property is set or unset as a favorite.
onOff | If true, the property is now a favorite, otherwise, the property is no longer a favorite. |
Boolean DzProperty::isGlobalFavorite | ( | ) |
DzProperty::isGlobalFavoriteChanged | ( | Boolean | onOff | ) | [signal] |
Signature: "isGlobalFavoriteChanged(bool)"
Emitted when this property is set or unset as a global favorite.
onOff | If true, the property is now a global favorite, otherwise, the property is no longer a global favorite. |
Boolean DzProperty::isHidden | ( | ) |
Boolean DzProperty::isLocked | ( | ) |
Boolean DzProperty::isManipulator | ( | ) |
DzProperty::isManipulatorChanged | ( | Boolean | isManip | ) | [signal] |
Signature: "isManipulatorChanged(bool)"
Emitted when this property is set or unset as a manipulator.
isManip | If true, the property is now a manipulator, otherwise, the property is no longer a manipulator. |
Boolean DzProperty::isNumeric | ( | ) |
Boolean DzProperty::isPrivateProperty | ( | ) |
Boolean DzProperty::isRigProperty | ( | ) |
Boolean DzProperty::isSelected | ( | ) |
Boolean DzProperty::isUserProperty | ( | ) |
DzProperty::isUserPropertyChanged | ( | Boolean | isUserProp | ) | [signal] |
Signature: "isUserPropertyChanged(bool)"
Emitted when this property is set or unset as a user property.
isUserProp | If true, the property is now a user property, otherwise, the property is no longer a user property. |
DzProperty::keySelectionChanged | ( | DzTimeRange | range | ) | [signal] |
Signature: "keySelectionChanged(const DzTimeRange&)"
Emitted when the selection state of this property's keys has changed.
range | The range in which selection changed. |
DzProperty::labelChanged | ( | String | newLabel | ) | [signal] |
Signature: "labelChanged(const QString&)"
Emitted when the label of this property is changed.
newLabel | The new label of this property. |
void DzProperty::lock | ( | Boolean | onOff | ) |
Locks/Unlocks this property. When locked, a property will not accept new key values or changes to current key values.
DzProperty::lockStateChanged | ( | ) | [signal] |
Signature: "lockStateChanged()"
Emitted when the lock state of this property has changed.
Boolean DzProperty::moveControllertoIndex | ( | DzController | ctrl, | |
Number | newIdx | |||
) |
Moves the controller ctrl to location newIdx
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 |
Moves the controller at location curIdx to location newIdx
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 |
void DzProperty::removeAllControllers | ( | ) |
Removes all controllers from this property.
void DzProperty::removeController | ( | DzProperty | prop | ) |
Removes the controller that references the given property.
void DzProperty::removeController | ( | DzController | ctrl | ) |
Removes the given controller from this property.
void DzProperty::removeController | ( | Number | idx | ) |
Removes the controller at the given index from this property.
DzProperty::removed | ( | ) | [signal] |
Signature: "removed()"
Emitted when this property is removed.
Select or deselect all keys.
DzProperty::selectionStateChanged | ( | ) | [signal] |
Signature: "selectionStateChanged()"
Emitted when this property is selected or deselected.
void DzProperty::selectKeys | ( | DzTimeRange | range, | |
Boolean | onOff | |||
) |
Sets the seletion state of any keys in the given range.
void DzProperty::setAttributes | ( | DzPropertySettings | settings | ) |
Sets attributes for this property.
void DzProperty::setCanAnimate | ( | Boolean | yesNo | ) |
Sets whether this property is animatable. Should only called to set initial values on a property that has been created using the default constructor. Should not be called otherwise.
void DzProperty::setHidden | ( | Boolean | yesNo | ) |
Hide or show this property in the interface.
void DzProperty::setIsFavorite | ( | Boolean | onOff | ) |
Sets whether or not the property is a favorite.
void DzProperty::setIsGlobalFavorite | ( | Boolean | onOff | ) |
Sets whether or not the property is a global favorite.
void DzProperty::setIsManipulator | ( | Boolean | onOff | ) |
Sets whether or not the property is a manipulator.
void DzProperty::setIsRigProperty | ( | Boolean | yesNo | ) |
Sets whether this property is a rigging property. Should only called to set initial values on a property that has been created using the default constructor. Should not be called otherwise.
void DzProperty::setIsUserProperty | ( | Boolean | yesNo | ) |
Sets whether this property is a user property (i.e. can be deleted). Should only called to set initial values on a property that has been created using the default constructor. Should not be called otherwise.
void DzProperty::setLabel | ( | String | label | ) |
Sets the label that the user sees for this property. Must be unique among all the other properties of this property's owner.
void DzProperty::setPath | ( | String | path | ) |
Sets the group that this property will belong to based on the given full path.
void DzProperty::setSelected | ( | Boolean | onOff | ) |
Sets whether or not the property is selected.
DzProperty::valueChanged | ( | DzTimeRange | range | ) | [signal] |
Signature: "valueChanged(const DzTimeRange&)"
Emitted when the value of this property is changed.
range | The range over which the property has changed |