Inheritance diagram for DzPropertyGroup:
Methods | |
DzPropertyGroup | findChild (String name) |
DzPropertyGroup | findSibling (String name) |
Array | getAllPaths () |
Boolean | getCollapsed () |
DzPropertyGroup | getFirstChild () |
DzPropertyGroup | getNextSibling () |
Number | getNumProperties () |
DzPropertyGroup | getParent () |
String | getPath () |
DzProperty | getProperty (Number i) |
DzPropertyGroupTree | getTree () |
Boolean | moveChildToIndex (String childName, Number newIndex) |
Boolean | movePropertyToIndex (DzProperty prop, Number newIndex) |
Boolean | movePropertyToIndex (String propName, Number newIndex) |
void | setCollapsed (Boolean onOff) |
Signals | |
void | addedChild (DzPropertyGroup newChild) |
Signature: "addedChild(DzPropertyGroup*)" | |
void | childListChanged () |
Signature: "childListChanged()" | |
void | parentChanged (DzPropertyGroup newParent) |
Signature: "parentChanged(DzPropertyGroup*)" | |
void | removedChild (DzPropertyGroup child) |
Signature: "removedChild(DzPropertyGroup*)" | |
void | treeChanged () |
Signature: "treeChanged()" |
DzPropertyGroup objects are all owned and managed by DzElement objects. Do not create property groups yourself - they are automatically created as needed when you assign individual properties to a group. To iterate through the property groups for an element, use DzElement::getPropertyGroups() to get the property group tree that the element's properties are grouped in.
// Create a new property oProperty = new DzFloatProperty( "MyDeformer Control", true, false ); // Set the path of the property - this moves the property to the group cooresponding // to the given path, creating groups if necessary. oProperty.setPath( "/Defomers/MyDeformerGroup" );
DzPropertyGroup::addedChild | ( | DzPropertyGroup | newChild | ) | [signal] |
Signature: "addedChild(DzPropertyGroup*)"
Emitted when a child has been added to the group.
void DzPropertyGroup::childListChanged | ( | ) | [signal] |
Signature: "childListChanged()"
Emitted when the child list of the group has changed.
DzPropertyGroup DzPropertyGroup::findChild | ( | String | name | ) |
name | The name of the property grou to look for. |
DzPropertyGroup DzPropertyGroup::findSibling | ( | String | name | ) |
name | The name of the sibling to look for. |
Array DzPropertyGroup::getAllPaths | ( | ) |
Provided for convenience and DAZ Script access.
bool DzPropertyGroup::getCollapsed | ( | ) |
DzPropertyGroup DzPropertyGroup::getFirstChild | ( | ) |
DzPropertyGroup DzPropertyGroup::getNextSibling | ( | ) |
Number DzPropertyGroup::getNumProperties | ( | ) |
DzPropertyGroup DzPropertyGroup::getParent | ( | ) |
String DzPropertyGroup::getPath | ( | ) |
DzProperty DzPropertyGroup::getProperty | ( | Number | i | ) |
i | The index of the property to return. |
DzPropertyGroupTree DzPropertyGroup::getTree | ( | ) |
Moves the child group to a different position in the list.
childName | The name of the child group to move | |
newIndex | The position in the list to move the child group to. |
Boolean DzPropertyGroup::movePropertyToIndex | ( | DzProperty | prop, | |
Number | newIndex | |||
) |
This is an overloaded method, provided for convenience. Moves prop to a new location within the group.
prop | The property to move. This property must be in this group to be successful. | |
newIndex | The location to move prop to. If newIndex is not a valid index, prop is moved to the end of the list. |
Moves the property to a different location in the group list.
propName | The name of the property to move | |
newIndex | The new position in the list for the property |
DzPropertyGroup::parentChanged | ( | DzPropertyGroup | newParent | ) | [signal] |
Signature: "parentChanged(DzPropertyGroup*)"
Emitted when the parent of the group has changed.
DzPropertyGroup::removedChild | ( | DzPropertyGroup | child | ) | [signal] |
Signature: "removedChild(DzPropertyGroup*)"
Emitted when a child has been removed from the group.
void DzPropertyGroup::setCollapsed | ( | Boolean | onOff | ) |
Sets whether the group is displayed as collapsed in the interface.
onOff | If true, the group is collapsed, if false, the group is expanded. |
void DzPropertyGroup::treeChanged | ( | ) | [signal] |
Signature: "treeChanged()"
Emitted when the tree has changed.