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

#include <USD_Traverse.h>

+ Inheritance diagram for GusdUSD_Traverse:

Classes

struct  Opts
 

Public Types

typedef std::pair< UsdPrim, exintPrimIndexPair
 

Public Member Functions

virtual ~GusdUSD_Traverse ()
 
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
 
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
 
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.

Examples:
USD/SOP_usdimport.h, and USD/SOP_usdunpack.h.

Definition at line 57 of file USD_Traverse.h.

Member Typedef Documentation

Definition at line 60 of file USD_Traverse.h.

Constructor & Destructor Documentation

virtual GusdUSD_Traverse::~GusdUSD_Traverse ( )
inlinevirtual

Definition at line 63 of file USD_Traverse.h.

Member Function Documentation

virtual Opts* GusdUSD_Traverse::CreateOpts ( ) const
inlinevirtual

Reimplemented in GusdUSD_CustomTraverse.

Definition at line 65 of file USD_Traverse.h.

virtual bool GusdUSD_Traverse::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 GusdUSD_Traverse::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 >.

bool GusdUSD_Traverse::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

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