AL::maya::FileTranslatorBase< T > Class Template Reference

A utility class that provides a 'unique' base class to derive new translator from. More...

#include <FileTranslatorBase.h>

Inheritance diagram for AL::maya::FileTranslatorBase< T >:

Public Member Functions
virtual MStatus	reader (const MFileObject &file, const OptionsParser &options, FileAccessMode mode)
	Override this method to read your files (do not use the version from MPxFileTranslator!) More...
virtual MStatus	writer (const MFileObject &file, const OptionsParser &options, FileAccessMode mode)
	Override this method to write your files (do not use the version from MPxFileTranslator!) More...

Static Public Member Functions
template<typename FnPlugin >
static MStatus	registerTranslator (FnPlugin &plugin)
	unregister the file translator More...
template<typename FnPlugin >
static MStatus	deregisterTranslator (FnPlugin &plugin)
	unregister the file translator More...
static MStatus	specifyOptions (FileTranslatorOptions &options)
	default fall back in case no options are needed in the derived translator More...

Detailed Description

template<typename T>
class AL::maya::FileTranslatorBase< T >

A utility class that provides a 'unique' base class to derive new translator from.

Member Function Documentation

template<typename T >

template<typename FnPlugin >

static MStatus AL::maya::FileTranslatorBase< T >::deregisterTranslator ( FnPlugin &  plugin )

inlinestatic

unregister the file translator

Parameters

plugin

the MFnPlugin function set

template<typename T >

virtual MStatus AL::maya::FileTranslatorBase< T >::reader ( const MFileObject &  file, const OptionsParser &  options, FileAccessMode  mode  )

inlinevirtual

Override this method to read your files (do not use the version from MPxFileTranslator!)

Parameters

file	the file to read into maya
options	a set of Key/Value pair options passed through from the MEL GUI
mode	does this actually serve any purpose?

Returns

a failure in this case (because you need to override to import the file)

template<typename T >

template<typename FnPlugin >

static MStatus AL::maya::FileTranslatorBase< T >::registerTranslator ( FnPlugin &  plugin )

inlinestatic

unregister the file translator

Parameters

plugin

the MFnPlugin function set

template<typename T >

static MStatus AL::maya::FileTranslatorBase< T >::specifyOptions ( FileTranslatorOptions &  options )

inlinestatic

default fall back in case no options are needed in the derived translator

Parameters

options

the file translator options

Returns

MS::kSuccess if options were correctly specified

template<typename T >

virtual MStatus AL::maya::FileTranslatorBase< T >::writer ( const MFileObject &  file, const OptionsParser &  options, FileAccessMode  mode  )

inlinevirtual

Override this method to write your files (do not use the version from MPxFileTranslator!)

Parameters

file	information about the file to export
options	a set of Key/Value pair options passed through from the MEL GUI
mode	are we exporting everything, or only the selected objects

Returns

a failure in this case (because you need to override to import the file)

---

The documentation for this class was generated from the following files:

• src/lib/AL_USDMaya/AL/maya/Common.h
• src/lib/AL_USDMaya/AL/maya/FileTranslatorBase.h