User Tools

Site Tools


DzTypeAssetContainer

Class that represents a container for Asset Types.

More...

Inherits :

Methods

DAZ Script
NumberaddChildContainer ( String childType )
NumberaddChildContainer ( DzTypeAssetContainer childType )
voidclear ()
DzTypeAssetContainerfindChildContainer ( String typeStr )
StringgetTextPath ( Boolean ignoreRoot=true )
StringgetTypeName ()
BooleanignoreAssetConflicts ()
BooleaninsertToSpecificType ( DzAsset asset, String type )
BooleanremoveAssetCausesDelete ()
BooleanupdateChildren ()

Signals

voidaboutToClear ()

Detailed Description

TODO: Add detailed description.

Methods


Number : addChildContainer( String childType )

Adds a new container with the given name, if one doesn't already exist.

Parameter(s):

  • childType - The type for this container.

Return Value:

  • The index of the newly inserted container. If a container of the same type already exists, the index of that container will be returned.

Number : addChildContainer( DzTypeAssetContainer childType )

Adds the given container if one of the same type name doesn't exist.

Parameter(s):

  • childType - The child container to be inserted.

Return Value:

  • The index of the newly added container or, if a container already exists with the same name, the index of that container.

void : clear()

Clears all the child containers and assets associated with this container. Emits endAssetRemove() and endChildContainerRemove().


DzTypeAssetContainer : findChildContainer( String typeStr )

Parameter(s):

  • typeStr - The container to find.

Return Value:

  • The container with the given type name, if it exists, otherwise null.

String : getTextPath( Boolean ignoreRoot=true )

Parameter(s):

  • ignoreRoot - If true, the root item will not be included in the path.

Return Value:

  • The displayed text path of this container.

String : getTypeName()

Return Value:

  • The type name for this container.

Boolean : ignoreAssetConflicts()

Return Value:

  • true if asset conflicts should be ignored, otherwise false.

Boolean : insertToSpecificType( DzAsset asset, String type )

Attempts to insert the asset to a specific type.

Parameter(s):

  • asset - The asset to be inserted.
  • type - The type for the asset.

Return Value:

  • true if successful, otherwise false.

Boolean : removeAssetCausesDelete()

Return Value:

  • true if removing an asset from this container causes it to be deleted.

Boolean : updateChildren()

TODO: Add description.

Signals


void : aboutToClear()

TODO: Add description.