All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GusdUSD_Traverse Class Referenceabstract

Base class for custom stage traversal. More...

+ Inheritance diagram for GusdUSD_Traverse:

Classes

struct  Opts
 Base class that can be derived to provide configuration options to the traversal. More...
 

Public Types

typedef std::pair< UsdPrim, exint > PrimIndexPair
 

Public Member Functions

virtual OptsCreateOpts () const
 
virtual bool FindPrims (const UsdPrim &root, UsdTimeCode time, GusdPurposeSet purposes, UT_Array< UsdPrim > &prims, bool skipRoot=true, const Opts *opts=nullptr) const =0
 Find prims beneath the given root. More...
 
virtual bool FindPrims (const UT_Array< UsdPrim > &roots, const GusdDefaultArray< UsdTimeCode > &times, const GusdDefaultArray< GusdPurposeSet > &purposes, UT_Array< PrimIndexPair > &prims, bool skipRoot=true, const Opts *opts=nullptr) const =0
 Find prims beneath the given root prims. More...
 
bool FindPrims (const UT_Array< UsdPrim > &roots, const GusdDefaultArray< UsdTimeCode > &times, const GusdDefaultArray< GusdPurposeSet > &purposes, UT_Array< UsdPrim > &prims, bool skipRoot=true, const Opts *opts=nullptr) const
 

Detailed Description

Base class for custom stage traversal.

To register traversals, define a static GusdUSD_TraverseType singleton that takes an instance of the traverse object.

Definition at line 57 of file USD_Traverse.h.

Member Function Documentation

virtual bool FindPrims ( const UsdPrim root,
UsdTimeCode  time,
GusdPurposeSet  purposes,
UT_Array< UsdPrim > &  prims,
bool  skipRoot = true,
const Opts opts = nullptr 
) const
pure virtual

Find prims beneath the given root.

Implemented in GusdUSD_CustomTraverse, and GusdUSD_TraverseSimpleT< Visitor >.

virtual bool FindPrims ( const UT_Array< UsdPrim > &  roots,
const GusdDefaultArray< UsdTimeCode > &  times,
const GusdDefaultArray< GusdPurposeSet > &  purposes,
UT_Array< PrimIndexPair > &  prims,
bool  skipRoot = true,
const Opts opts = nullptr 
) const
pure virtual

Find prims beneath the given root prims.

Note that the input array of prims may contain invalid prims. The returned prims array holds the new prims, and the index of their root prim from the roots array. The array is sorted by the index and the prim path.

Implemented in GusdUSD_CustomTraverse, and GusdUSD_TraverseSimpleT< Visitor >.


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