DzImporter Class Reference
[File Input and Output Objects]

Base class for all file importers. More...

Inheritance diagram for DzImporter:

List of all members.

Methods
String	getDescription ()
String	getExtension (Number i)
Number	getNumExtensions ()
DzError	readFile (String filename, DzFileIOSettings options)
DzError	readFile (String filename)
Boolean	recognize (String filename)

---

Detailed Description

Base class for all file importers.

---

Member Function Documentation

String DzImporter::getDescription

(

)

Returns:

A description of the importer that can be placed in a file type selection combo box (e.g. "Acclaim Skeleton").

String DzImporter::getExtension

(

Number

i

)

Returns:

The i'th file extension (excluding the preceding dot) supported by this importer.

Number DzImporter::getNumExtensions

(

)

Returns:

The number of supported file extensions for this importer.

DzError DzImporter::readFile	(	String	filename,
		DzFileIOSettings	options
	)

Imports from a file.

Parameters:

	filename	Name of the file to import.
	options	The options for the importer.

Returns:

DZ_NO_ERROR on success, or an error code if the import failed.

DzError DzImporter::readFile

(

String

filename

)

Imports from a file.

Parameters:

filename

Name of the file to import.

Returns:

DZ_NO_ERROR on success, or an error code if the import failed.

Boolean DzImporter::recognize

(

String

filename

)

Test the given filename and file contents to see if this importer can read it.

Parameters:

filename

The name of the file to test.

Returns:

true if the importer can import the file, otherwise false.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.