User Tools

Site Tools


DzImporter

Base class for all file importers.

More...

Inherits :

Inherited By : bvhimporter_dz, DzFbxImporter, DzGeometryImporter and DzPZ3Importer

Methods

Detailed Description

TODO: Add detailed description.

Methods


String : getDescription()

Return Value:

  • A description of the importer that can be placed in a file type selection combobox (e.g. “Acclaim Skeleton”).

String : getExtension( Number i )

Return Value:

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

Number : getNumExtensions()

Return Value:

  • The number of supported file extensions for this importer.

DzError : readFile( String filename, DzFileIOSettings options )

Imports from a file.

Parameter(s):

  • filename - The full path of the file to import
  • options - The options to use while importing the file

Return Value:

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

DzError : readFile( String filename )

Imports from a file.

Parameter(s):

  • filename - Name of the file to import.

Return Value:

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

Boolean : recognize( String filename )

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

Parameter(s):

  • filename - The name of the file to test.

Return Value:

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