AL_USDMaya  0.16.6
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
AL::usdmaya::cmds::LayerCommandBase Class Reference
Commands

Helper class. More...

#include <LayerCommands.h>

Inheritance diagram for AL::usdmaya::cmds::LayerCommandBase:
AL::usdmaya::cmds::LayerCreateSubLayer AL::usdmaya::cmds::LayerCurrentEditTarget AL::usdmaya::cmds::LayerExport AL::usdmaya::cmds::LayerGetLayers AL::usdmaya::cmds::LayerSave AL::usdmaya::cmds::LayerSetMuted

Public Member Functions

nodes::ProxyShape * getShapeNode (const MArgDatabase &args)
 find the proxy shape node from a valid pre-parsed arg database More...
 
UsdStageRefPtr getShapeNodeStage (const MArgDatabase &args)
 get the USD stage More...
 
MArgDatabase makeDatabase (const MArgList &args)
 construct the arg data base from an args list. If any errors are found during parsing, an error will be thrown More...
 
MObject getSelectedNode (const MArgDatabase &args, const MTypeId typeId)
 hunt for the first node of the specified type found in the selection list object args More...
 

Static Public Member Functions

static MSyntax setUpCommonSyntax ()
 sets up some core/common command params for all the layer commands. Just specifies that selection can be used as an argument. More...
 

Detailed Description

Helper class.

Member Function Documentation

MObject AL::usdmaya::cmds::LayerCommandBase::getSelectedNode ( const MArgDatabase &  args,
const MTypeId  typeId 
)

hunt for the first node of the specified type found in the selection list object args

Parameters
argsthe pre-parsed argument data base
typeIdthe typeId of the object type that may appear as one of the selected objects
Returns
the MObject of the node if found
nodes::ProxyShape* AL::usdmaya::cmds::LayerCommandBase::getShapeNode ( const MArgDatabase &  args)

find the proxy shape node from a valid pre-parsed arg database

Parameters
argsthe argument database to get the proxy shape from
Returns
the proxy shape node (if found in the args)
UsdStageRefPtr AL::usdmaya::cmds::LayerCommandBase::getShapeNodeStage ( const MArgDatabase &  args)

get the USD stage

Parameters
argsthe argument database to get the stage from
Returns
the stage from a proxy shape node (if found in the args)
MArgDatabase AL::usdmaya::cmds::LayerCommandBase::makeDatabase ( const MArgList &  args)

construct the arg data base from an args list. If any errors are found during parsing, an error will be thrown

Parameters
argsthe args list passed to the MPxCommand from Maya
Returns
the new data base
static MSyntax AL::usdmaya::cmds::LayerCommandBase::setUpCommonSyntax ( )
static

sets up some core/common command params for all the layer commands. Just specifies that selection can be used as an argument.

Returns
the syntax object with the command command flags specified
The documentation for this class was generated from the following file: