User Tools

Site Tools


DzAssetIOMgr

Manager of all scene setting save filter classes.

More...

Inherits :

Enumerations

Static Methods

Methods

DAZ Script
DzErrordoLoad ( String filePath, DzOpenMethod open=DefaultMethod, DzFileLoadFilter filter=null )
DzErrordoSave ( Number filterIndex )
DzErrordoSaveWithOptions ( DzAssetIOFilter filter, DzFileIOSettings options, Boolean saveOnly=false, String filePath=“”, String startingDir=“”, String category=“” )
DzErrordoSceneSaveAs ()
StringgetDefaultDSONAssetCachePath ()
StringgetDSONAssetCachePath ()
StringgetLoadPath ()
StringgetSavePath ()
DzErrorloadFromUri ( DzUri fileUri, DzOpenMethod open=DefaultMethod, DzFileLoadFilter filter=null )
voidsetDSONAssetCachePath ( String cacheFullPath )

Signals

Detailed Description

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Don't create an instance of this class, but rather request a pointer to it from DzApp via DzApp::getAssetIOMgr().

See Also:

Enumerations


: DzOpenMethod

TODO: Add description.

  • DefaultMethod - TODO: Add description.
  • OpenNew - TODO: Add description.
  • MergeFile - TODO: Add description.

Static Methods


Number : findFilter( String className )

Parameter(s):

  • className - The class name of the save filter to find.

Return Value:

  • The index of the save filter with the given class name.

QObject : findObjectInstance( DzUri uri )

Return Value:

  • The object for the given URI to a file instance during a file load.

Since:

  • 4.9.4.111

DzAssetIOFilter : getFilter( Number i )

Parameter(s):

  • i - The index of the save filter to get.

Return Value:

  • A new instance of the i'th save filter in the list.

String : getFilterName( Number i )

Parameter(s):

  • i - The index of the save filter to get the name of.

Return Value:

  • The name of the i'th save filter.

Number : getNumFilters()

Return Value:

  • The number of save filters currently supported.

Methods


DzError : doLoad( String filePath, DzOpenMethod open=DefaultMethod, DzFileLoadFilter filter=null )

Loads an asset file.

Parameter(s):

  • filePath - The full path of the file to load.
  • open - The open method to use.
  • filter - The filter to use.

Return Value:

  • DZ_NO_ERROR if the file load was successful.

See Also:


DzError : doSave( Number filterIndex )

Save the scene contents to a file with the given save filter. Prompts the user for a file to save to.

Parameter(s):

  • filterIndex - The index of the save filter to use.

Return Value:

  • DZ_NO_ERROR if the file save was successful.

DzError : doSaveWithOptions( DzAssetIOFilter filter, DzFileIOSettings options, Boolean saveOnly=false, String filePath=“”, String startingDir=“”, String category=“” )

Save the scene contents to a file with the given save filter. Prompts the user for a file to save to.

Parameter(s):

  • filter - The filter to use.
  • options - The options to use.
  • saveOnly - Whether to only save the file, or to also create an associated icon and assign metadata.
  • filePath - The full path of the file to save to.
  • startingDir - The path of the directory to start the save dialog in.
  • category - The category to assign the saved file to.

Return Value:

  • DZ_NO_ERROR if the file save was successful.

DzError : doSceneSaveAs()

Save the scene contents to a file. Prompts the user for a file to save to.

Return Value:

  • DZ_NO_ERROR if the file save was successful.

String : getDefaultDSONAssetCachePath()

Return Value:

  • The default path for the DSON assets cache.

String : getDSONAssetCachePath()

Return Value:

  • The path that the DSON assets cache resides in.

String : getLoadPath()

Return Value:

  • The last directory that files were loaded from.

String : getSavePath()

Return Value:

  • The last directory that files were saved to.

DzError : loadFromUri( DzUri fileUri, DzOpenMethod open=DefaultMethod, DzFileLoadFilter filter=null )

Loads an asset from URI.

Parameter(s):

  • fileUri - The URI of the file to load.
  • open - The open method to use.
  • filter - The filter to use.

Return Value:

  • DZ_NO_ERROR if the file load was successful.

See Also:


void : setDSONAssetCachePath( String cacheFullPath )

Parameter(s):

  • cacheFullPath - The path to set for the DSON assets cache.

Signals


void : assetImported()

TODO: Add description.


void : assetImportStarting()

TODO: Add description.


void : assetSaved()

TODO: Add description.


void : missingNodeParent( DzNode node, DzUri uri )

TODO: Add description.