DzExportMgr Class Reference
[Manager Objects, File Input and Output Objects]

Manager of all scene file exporter classes. More...

Inheritance diagram for DzExportMgr:

List of all members.

Methods
Boolean	canExport (String filename)
DzError	exportFile (String fileName, Number exporterIndex, DzFileIOSettings options)
DzError	exportFile (String fileName, Number exporterIndex)
DzExporter	findExporter (String filename)
DzExporter	findExporterByClassName (String className)
Number	findExporterIndex (String filename)
DzExporter	getExporter (Number i)
String	getExportPath ()
Number	getNumExporters ()
void	makeExportFileFilter (DzFileFilter filter, String defaultFilter="")
void	setExportPath (String path)
Signals
void	fileExported ()
	Signature: "fileExported()"
void	fileExportStarting ()
	Signature: "fileExportStarting()"

---

Detailed Description

Manager of all scene file exporter classes.

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::getExportMgr().

---

Member Function Documentation

Boolean DzExportMgr::canExport

(

String

filename

)

Uses the extension from each of the exporters and attempts to match an exporter with the extension of the filename.

Parameters:

filename

The name of the file to try to find an exporter for.

Returns:

true if an exporter was found that can write the given file.

DzError DzExportMgr::exportFile	(	String	fileName,
		Number	exporterIndex,
		DzFileIOSettings	options
	)

Export the scene contents to a file.

Parameters:

	filename	The name of the file to export to.
	exporterIndex	The index of the exporter class to use. If this is less than 0, then the extension of fileName is used to attempt to find an appropiate exporter.

Returns:

DZ_NO_ERROR if the file export was successfull.

DzError DzExportMgr::exportFile	(	String	fileName,
		Number	exporterIndex
	)

Export the scene contents to a file.

Parameters:

	filename	The name of the file to export to.
	exporterIndex	The index of the exporter class to use. If this is less than 0, then the extension of fileName is used to attempt to find an appropiate exporter.

Returns:

DZ_NO_ERROR if the file export was successfull.

void DzExportMgr::fileExported

(

)

[signal]

Signature: "fileExported()"

Emitted when a file export operation is finished

void DzExportMgr::fileExportStarting

(

)

[signal]

Signature: "fileExportStarting()"

Emitted when a file export operation is started

DzExporter DzExportMgr::findExporter

(

String

filename

)

Uses the extension from each of the exporters and attempts to match an exporter with the extension of the filename.

Parameters:

filename

The name of the file to try to find an exporter for.

Returns:

A new instance of the matching exporter, or NULL if none was found. The caller takes ownership of this pointer and is responsible for deleting it.

DzExporter DzExportMgr::findExporterByClassName

(

String

className

)

Uses the class name of each of the exporters and attempts to find an exporter with the given class name.

Parameters:

className

The name of the exporter class to find.

Returns:

A new instance of the matching exporter, or NULL if none was found. The caller takes ownership of this pointer and is responsible for deleting it.

Number DzExportMgr::findExporterIndex

(

String

filename

)

Uses the extension from each of the exporters and attempts to match an exporter with the extension of the filename.

Parameters:

filename

The name of the file to try to find an exporter for.

Returns:

The index of a matching exporter, or -1 if none was found.

DzExporter DzExportMgr::getExporter

(

Number

i

)

Parameters:

i

The index of the exporter to get an instance of.

Returns:

A new instance of the i'th exporter in the list. The caller takes ownership of this pointer and is responsible for deleting it when finished.

String DzExportMgr::getExportPath

(

)

Returns:

The current default directory that files are exported to.

int DzExportMgr::getNumExporters

(

)

Returns:

The number of exporters currently supported.

void DzExportMgr::makeExportFileFilter	(	DzFileFilter	filter,
		String	defaultFilter = ""
	)

Populates the given filter with all the types recognized by the export manager.

Parameters:

	filter	The filter to populate
	defaultFilter	The filter to set as the default

void DzExportMgr::setExportPath

(

String

path

)

Sets the default directory that files are exported to.

Parameters:

path

The new default path for exporting files.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.