User Tools

Site Tools


DzPropertyGroup

Represents a grouping of properties.

More...

Inherits :

Static Methods

Methods

DAZ Script
DzPropertyGroupfindChild ( String name )
DzPropertyfindProperty ( String propName, Boolean traverse=false, Boolean recurse=false )
DzPropertyfindPropertyByLabel ( String propLabel, Boolean traverse=false, Boolean recurse=false )
DzPropertyGroupfindSibling ( String name )
ArraygetAllPaths ()
ArraygetAllProperties ()
BooleangetCollapsed ()
DzPropertyGroupgetFirstChild ()
DzPropertyGroupgetNextSibling ()
NumbergetNumProperties ()
DzPropertyGroupgetParent ()
StringgetPath ()
DzPropertyGroupgetPreviousSibling ()
DzPropertygetProperty ( Number i )
geometryregion_dzgetRegion ()
DzPropertyGroupTreegetTree ()
NumberindexOfProperty ( DzProperty prop )
BooleanisRegion ()
BooleanmovePropertyToIndex ( DzProperty prop, Number newIndex )
voidsetCollapsed ( Boolean onOff )
voidsetUniquePropertyLabel ( DzProperty prop )
voidsort ()

Signals

voidaddedChild ( DzPropertyGroup newChild )
voidchildListChanged ()
voidparentChanged ( DzPropertyGroup newParent )
voidpropertyVisiblityChanged ( DzPropertyGroup grp, DzProperty prop )
voidremovedChild ( DzPropertyGroup child )
voidtreeChanged ()

Detailed Description

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 corresponding
// to the given path, creating groups if necessary.
oProperty.setPath( "/Defomers/MyDeformerGroup" );

See Also:

Static Methods


String : getDefaultGroupName()

Return Value:

  • The name of the default group.

Since:

  • 4.7.1.66

Methods


DzPropertyGroup : findChild( String name )

Parameter(s):

  • name - The name of the property group to look for.

Return Value:

  • The child with the given name (if any), otherwise NULL.

DzProperty : findProperty( String propName, Boolean traverse=false, Boolean recurse=false )

Parameter(s):

  • propName - The name of the property to find.
  • traverse - If true, the siblings of this group will be checked.
  • recurse - If true, the children of this group will be checked.

Return Value:

  • The property in this group with the given name (if any), otherwise null.

Since:

  • 4.7.1.34

DzProperty : findPropertyByLabel( String propLabel, Boolean traverse=false, Boolean recurse=false )

Parameter(s):

  • propLabel - The label of the property to find.
  • traverse - If true, the siblings of this group will be checked.
  • recurse - If true, the children of this group will be checked.

Return Value:

  • The property in this group with the given label (if any), otherwise null.

Since:

  • 4.9.3.11

DzPropertyGroup : findSibling( String name )

Parameter(s):

  • name - The name of the sibling to look for.

Return Value:

  • The sibling with the given name (if any), otherwise NULL.

Array : getAllPaths()

Provided for convenience and DAZ Script access.

Return Value:

  • A list of all property group paths begining with this group.

Array : getAllProperties()

Return Value:

  • A list of all properties in this group.

Since:

  • 4.9.4.101

Boolean : getCollapsed()

Return Value:

  • true if the group is collapsed, otherwise false.

DzPropertyGroup : getFirstChild()

Return Value:

  • The first child group, if any.

DzPropertyGroup : getNextSibling()

Return Value:

  • The next sibling to this group (if any), otherwise NULL.

Number : getNumProperties()

Return Value:

  • The number of properties in this group.

DzPropertyGroup : getParent()

Return Value:

  • The current parent of this group.

String : getPath()

Return Value:

  • The path of this group.

DzPropertyGroup : getPreviousSibling()

Return Value:

  • The previous sibling (if any), otherwise NULL.

Since:

  • 4.7.1.66

DzProperty : getProperty( Number i )

Parameter(s):

  • i - The index of the property to return.

Return Value:

  • The i'th property in this group.

geometryregion_dz : getRegion()

Return Value:

  • The region associated with this property group (if any), otherwise NULL.

DzPropertyGroupTree : getTree()

Return Value:

  • The property group tree that this group belongs to.

Number : indexOfProperty( DzProperty prop )

Return Value:

  • The index of prop in the group, or -1 if prop is not in the group

Boolean : isRegion()

Return Value:


Boolean : movePropertyToIndex( DzProperty prop, Number newIndex )

Moves prop to a new location within the group.

Parameter(s):

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

Return Value:

  • true if the move was successful, otherwise false.

void : setCollapsed( Boolean onOff )

Sets whether or not the group is displayed as collapsed in the interface.

Parameter(s):

  • onOff - If true, the group is collapsed. If false, the group is expanded.

void : setUniquePropertyLabel( DzProperty prop )

Sets the label of prop to a unique version of itself.


void : sort()

Alpha-numerically sorts the property groups, and the properties in them.

Signals


void : addedChild( DzPropertyGroup newChild )

Signature:“addedChild(DzPropertyGroup*)”

Emitted when a child has been added to the group.

Parameter(s):

  • newChild - The newly added group.

void : childListChanged()

Signature:“childListChanged()”

Emitted when the child list of the group has changed.


void : parentChanged( DzPropertyGroup newParent )

Signature:“parentChanged(DzPropertyGroup*)”

Emitted when the parent of the group has changed.

Parameter(s):

  • newParent - The new parent of the group.

void : propertyVisiblityChanged( DzPropertyGroup grp, DzProperty prop )

Signature:“propertyVisiblityChanged(DzPropertyGroup*,DzProperty*)”

Emitted when the visibility of a property in the group has changed.

Parameter(s):

  • grp - The group containing the property.
  • prop - The property that changed.

void : removedChild( DzPropertyGroup child )

Signature:“removedChild(DzPropertyGroup*)”

Emitted when a child has been removed from the group.

Parameter(s):

  • child - The group that has been removed.

void : treeChanged()

Signature:“treeChanged()”

Emitted when the tree has changed.