Base class for maya translator usd plugins. The TfType of these plugins has to be derived from the base TfType, TranslatorBase. More...

#include <TranslatorBase.h>

Inheritance diagram for AL::usdmaya::fileio::translators::TranslatorBase:

Public Types
typedef TranslatorBase	This

typedef TfRefPtr< This >	RefPtr

Public Types inherited from AL::usdmaya::fileio::translators::TranslatorAbstract
typedef TranslatorAbstract	This
	this type

typedef TfRefPtr< This >	RefPtr
	the type of a reference this type

typedef TfWeakPtr< This >	Ptr
	weak pointer to this type

Public Member Functions
virtual	~TranslatorBase ()
	dtor

TfType	getTranslatedType () const override
	returns the translated prim type

TranslatorContextPtr	context () const
	returns the context currently being used to translate the USD prims. The context can be used to add references to prims you have created in your translator plugins

UsdStageRefPtr	getUsdStage () const
	return the usd stage associated with this context More...

virtual void	exportCustomAnim (const MDagPath &path, UsdPrim &prim, const UsdTimeCode &timeCode)
	override if you have a node that needs to generate animation that cannot be mapped between an MPlug and a UsdAttribute. More...

Public Member Functions inherited from AL::usdmaya::fileio::translators::TranslatorAbstract
virtual	~TranslatorAbstract ()
	dtor

virtual bool	needsTransformParent () const
	if the custom node type you are importing requires a parent transform (e.g. you are importing a shape node), then this method should return true. If however you do not need a parent transform (e.g. you are importing a texture!), then you can return false here. More...

virtual MStatus	initialize ()
	Override this to do a one time initialization of your translator. Primarily this is to allow you to extract some MObject attribute handles from an MNodeClass, to avoid the need for calling findPlug at runtime (and the inherent cost of the strcmps/hash lookup that entails) More...

virtual MStatus	import (const UsdPrim &prim, MObject &parent, MObject &createdObj)
	Override this method to import a prim into your scene. More...

virtual UsdPrim	exportObject (UsdStageRefPtr stage, MDagPath dagPath, const SdfPath &usdPath, const ExporterParams &params)

virtual MStatus	postImport (const UsdPrim &prim)
	If your node needs to set up any relationships after import (for example, adding the node to a set, or making attribute connections), then all of that work should be performed here. More...

virtual MStatus	preTearDown (UsdPrim &prim)
	This method will be called prior to the tear down process taking place. This is the last chance you have to do any serialisation whilst all of the existing nodes are available to query. More...

virtual MStatus	tearDown (const SdfPath &path)
	If your plugin creates any nodes within Maya, then this method should be overridden to remove those nodes. This forms a central role within the variant switching system. More...

virtual bool	supportsUpdate () const
	override this method and return true if the translator supports update More...

virtual bool	importableByDefault () const
	If a translator is importableByDefault=true, it will always be automatically imported on ProxyShape initialisation. More...

virtual MStatus	update (const UsdPrim &prim)
	Optionally override this method to copy the attribute values from the prim onto the Maya nodes you have created. More...

virtual ExportFlag	canExport (const MObject &obj)
	Method used to test a Maya node to see whether it can be exported.

Static Public Member Functions
static AL_USDMAYA_PUBLIC RefPtr	manufacture (const std::string &primType, TranslatorContextPtr context)=delete
	Internal method used to create a new instance of a plugin translator. More...

Protected Member Functions
virtual void	setTranslatedType (const TfType &translatedType)
	internal method. Used within AL_USDMAYA_DEFINE_TRANSLATOR macro to set the schema type of the node we translate. More...

virtual void	setContext (const TranslatorContextPtr context)
	internal method. Used within AL_USDMAYA_DEFINE_TRANSLATOR macro to set the translation context More...

Detailed Description

Base class for maya translator usd plugins. The TfType of these plugins has to be derived from the base TfType, TranslatorBase.

Member Function Documentation

virtual void AL::usdmaya::fileio::translators::TranslatorBase::exportCustomAnim	(	const MDagPath &	path,
		UsdPrim &	prim,
		const UsdTimeCode &	timeCode
	)

inlinevirtual

override if you have a node that needs to generate animation that cannot be mapped between an MPlug and a UsdAttribute.

Parameters

path	path to the object being exported
prim	the prim to write the data into
timeCode	the time value to sample the data at

UsdStageRefPtr AL::usdmaya::fileio::translators::TranslatorBase::getUsdStage ( ) const

inline

return the usd stage associated with this context

Returns: the usd stage

static AL_USDMAYA_PUBLIC RefPtr AL::usdmaya::fileio::translators::TranslatorBase::manufacture	(	const std::string &	primType,
		TranslatorContextPtr	context
	)

staticdelete

Internal method used to create a new instance of a plugin translator.

Parameters

primType	the type of translator to manufacture
context	the translation context

Returns: a handle to the newly created plugin translator

virtual void AL::usdmaya::fileio::translators::TranslatorBase::setContext ( const TranslatorContextPtr context )

inlineprotectedvirtual

internal method. Used within AL_USDMAYA_DEFINE_TRANSLATOR macro to set the translation context

Parameters

context the internal context

virtual void AL::usdmaya::fileio::translators::TranslatorBase::setTranslatedType ( const TfType & translatedType )

inlineprotectedvirtual

internal method. Used within AL_USDMAYA_DEFINE_TRANSLATOR macro to set the schema type of the node we translate.

Parameters

translatedType the schema type name

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

src/lib/AL_USDMaya/AL/usdmaya/fileio/translators/TranslatorBase.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation