Translator API

Classes that deal with the import/export of USD data into maya. More...

Classes
class	AL::usdmaya::fileio::translators::DagNodeTranslator
	A class to transfer dag node data between Usd <–> Maya. More...
class	AL::usdmaya::fileio::translators::DgNodeTranslator
	Utility class that transfers DgNodes between Maya and USD. More...
class	AL::usdmaya::fileio::translators::TransformTranslator
	A utility class to transfer transform nodes between Maya and USD. More...
class	AL::usdmaya::fileio::translators::TranslatorAbstract
	The base class interface of all translator plugins. The absolute minimum a translator plugin must implement are the following 3 methods: More...
class	AL::usdmaya::fileio::translators::TranslatorBase
	Base class for maya translator usd plugins. The TfType of these plugins has to be derived from the base TfType, TranslatorBase. More...
class	AL::usdmaya::fileio::translators::TranslatorManufacture
	Forms a registry of all plug-in translator types registered. More...
class	AL::usdmaya::fileio::translators::TranslatorFactoryBase
	the factory interface, used to create an instance of a particular translator type More...
class	AL::usdmaya::fileio::translators::TranslatorFactory< T >
	the factory instance for a given translator type More...
struct	AL::usdmaya::fileio::translators::TranslatorParameters
	Transient aggregate of values that aims to direct the Translation of Prims. Typically an object of this struct is created and used for a set group of prim path translations then it is destroyed. More...
struct	AL::usdmaya::fileio::translators::TranslatorContext
	This class provides a context to store mappings between UsdPrims, and the Maya nodes that represent them. More...

Macros
#define	AL_USDMAYA_DECLARE_TRANSLATOR(PlugClass)
	a macro to declare a plug-in translator More...
#define	AL_USDMAYA_DEFINE_TRANSLATOR(PlugClass, TranslatedType)
	a macro to define a plug-in translator More...

Detailed Description

Classes that deal with the import/export of USD data into maya.

Macro Definition Documentation

#define AL_USDMAYA_DECLARE_TRANSLATOR

(

PlugClass

)

Value:

typedef PlugClass This;                                                         \
typedef TfRefPtr<This> RefPtr;                                                  \
typedef TfWeakPtr<This> Ptr;                                                    \
AL_MAYA_MACROS_PUBLIC                                                           \
static RefPtr create(TranslatorContextPtr context);

a macro to declare a plug-in translator

#define AL_USDMAYA_DEFINE_TRANSLATOR	(		PlugClass,
			TranslatedType
	)

Value:

TfRefPtr<PlugClass>                                                             \
PlugClass::create(TranslatorContextPtr context) {                               \
  TfType const &type = TfType::Find<TranslatedType>();                          \
  if(!type.IsUnknown()) {                                                       \
    TfRefPtr<PlugClass> plugin = TfCreateRefPtr(new This());                    \
    plugin->setTranslatedType(type);                                            \
    plugin->setContext(context);                                                \
    if(!plugin->initialize()) return TfRefPtr<PlugClass>();                     \
    return plugin;                                                              \
  }                                                                             \
  else {                                                                        \
    TF_CODING_ERROR(                                                            \
      "Failed to get %s usd type, maybe the needed plugin is not loaded",       \
      typeid(TranslatedType).name());                                           \
    return TfNullPtr;                                                           \
  }                                                                             \
}                                                                               \
                                                                                \
TF_REGISTRY_FUNCTION(TfType)                                                    \
{                                                                               \
    TfType::Define<PlugClass, TfType::Bases<TranslatorBase>>()                  \
        .SetFactory<TranslatorFactory<PlugClass>>();                            \
}

a macro to define a plug-in translator