AL_USDMaya  0.16.6
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
AL::usdmaya::nodes::LayerVisitor Class Reference

A class that follows the visitor pattern to walk through all layer nodes associated with the specified proxy shape node. More...

#include <LayerVisitor.h>

Public Member Functions

 LayerVisitor (ProxyShape *shape)
 ctor More...
 
virtual ~LayerVisitor ()
 dtor
 
void visitAll ()
 call to visit all of the layers
 
virtual void onVisit ()
 override to implement your own custom processing for each layer.
 
LayerthisLayer () const
 returns the current layer being visited More...
 
LayerparentLayer () const
 returns the parent of the current layer being visited More...
 
bool isSubLayer () const
 returns true if the current layer is a sub layer More...
 
uint32_t depth () const
 returns the recursion depth. More...
 

Detailed Description

A class that follows the visitor pattern to walk through all layer nodes associated with the specified proxy shape node.

Constructor & Destructor Documentation

AL::usdmaya::nodes::LayerVisitor::LayerVisitor ( ProxyShape shape)

ctor

Parameters
shapethe proxy shape whose layers you wish to iterate over

Member Function Documentation

uint32_t AL::usdmaya::nodes::LayerVisitor::depth ( ) const
inline

returns the recursion depth.

Returns
the recursion depth
bool AL::usdmaya::nodes::LayerVisitor::isSubLayer ( ) const
inline

returns true if the current layer is a sub layer

Returns
true if the current layer is a sub layer, false if it's a child layer
Layer* AL::usdmaya::nodes::LayerVisitor::parentLayer ( ) const
inline

returns the parent of the current layer being visited

Returns
the parent of the current layer
Layer* AL::usdmaya::nodes::LayerVisitor::thisLayer ( ) const
inline

returns the current layer being visited

Returns
the current layer

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