AL_USDMaya  0.29.4
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AL::usdmaya::fileio::translators::DgNodeTranslator Class Reference

Utility class that transfers DgNodes between Maya and USD. More...

#include <DgNodeTranslator.h>

Inheritance diagram for AL::usdmaya::fileio::translators::DgNodeTranslator:
AL::usdmaya::fileio::translators::DagNodeTranslator AL::usdmaya::fileio::translators::TransformTranslator

Public Member Functions

virtual AL_USDMAYA_PUBLIC MObject createNode (const UsdPrim &from, MObject parent, const char *nodeType, const ImporterParams &params)
 Creates a new maya node of the given type and set attributes based on input prim. More...
 
AL_USDMAYA_PUBLIC MStatus copyAttributes (const UsdPrim &from, MObject to, const ImporterParams &params)
 helper method to copy attributes from the UsdPrim to the Maya node More...
 
virtual AL_USDMAYA_PUBLIC bool attributeHandled (const UsdAttribute &usdAttr)
 A temporary solution. Given a custom attribute, if a translator handles it somehow (i.e. lazy approach to not creating a schema), then overload this method and return true on the attribute you are handling. This will prevent the attribute from being imported/exported as a dynamic attribute. More...
 

Static Public Member Functions

static AL_USDMAYA_PUBLIC MStatus registerType ()
 static type registration More...
 
static AL_USDMAYA_PUBLIC MStatus copyAttributes (const MObject &from, UsdPrim &to, const ExporterParams &params)
 Copies data from the maya node onto the usd primitive. More...
 

Detailed Description

Utility class that transfers DgNodes between Maya and USD.

Member Function Documentation

virtual AL_USDMAYA_PUBLIC bool AL::usdmaya::fileio::translators::DgNodeTranslator::attributeHandled ( const UsdAttribute &  usdAttr)
virtual

A temporary solution. Given a custom attribute, if a translator handles it somehow (i.e. lazy approach to not creating a schema), then overload this method and return true on the attribute you are handling. This will prevent the attribute from being imported/exported as a dynamic attribute.

Parameters
usdAttrthe attribute to test
Returns
true if your translator is handling this attr
AL_USDMAYA_PUBLIC MStatus AL::usdmaya::fileio::translators::DgNodeTranslator::copyAttributes ( const UsdPrim &  from,
MObject  to,
const ImporterParams params 
)

helper method to copy attributes from the UsdPrim to the Maya node

Parameters
fromthe UsdPrim to copy the data from
tothe maya node to copy the data to
paramsthe importer params to determine what to import
Returns
MS::kSuccess if ok
static AL_USDMAYA_PUBLIC MStatus AL::usdmaya::fileio::translators::DgNodeTranslator::copyAttributes ( const MObject &  from,
UsdPrim &  to,
const ExporterParams params 
)
static

Copies data from the maya node onto the usd primitive.

Parameters
fromthe maya node to copy the data from
tothe USD prim to copy the attributes to
paramsthe exporter params to determine what should be exported
Returns
MS::kSuccess if ok
virtual AL_USDMAYA_PUBLIC MObject AL::usdmaya::fileio::translators::DgNodeTranslator::createNode ( const UsdPrim &  from,
MObject  parent,
const char *  nodeType,
const ImporterParams params 
)
virtual

Creates a new maya node of the given type and set attributes based on input prim.

Parameters
fromthe UsdPrim to copy the data from
parentthe parent Dag node to parent the newly created object under
nodeTypethe maya node type to create
paramsthe importer params that determines what will be imported
Returns
the newly created node

Reimplemented in AL::usdmaya::fileio::translators::TransformTranslator, and AL::usdmaya::fileio::translators::DagNodeTranslator.

static AL_USDMAYA_PUBLIC MStatus AL::usdmaya::fileio::translators::DgNodeTranslator::registerType ( )
static

static type registration

Returns
MS::kSuccess if ok

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