|
Usd_Term | operator! (Usd_PrimFlags flag) |
|
Usd_PrimFlagsConjunction | operator&& (Usd_Term lhs, Usd_Term rhs) |
|
Usd_PrimFlagsConjunction | operator&& (const Usd_PrimFlagsConjunction &conjunction, Usd_Term rhs) |
|
Usd_PrimFlagsConjunction | operator&& (Usd_Term lhs, const Usd_PrimFlagsConjunction &conjunction) |
|
Usd_PrimFlagsConjunction | operator&& (Usd_PrimFlags lhs, Usd_PrimFlags rhs) |
|
Usd_PrimFlagsDisjunction | operator|| (Usd_Term lhs, Usd_Term rhs) |
|
Usd_PrimFlagsDisjunction | operator|| (const Usd_PrimFlagsDisjunction &disjunction, Usd_Term rhs) |
|
Usd_PrimFlagsDisjunction | operator|| (Usd_Term lhs, const Usd_PrimFlagsDisjunction &disjunction) |
|
Usd_PrimFlagsDisjunction | operator|| (Usd_PrimFlags lhs, Usd_PrimFlags rhs) |
|
Usd_PrimFlagsPredicate | UsdTraverseInstanceProxies (Usd_PrimFlagsPredicate predicate) |
| This function is used to allow the prim traversal functions listed under Prim predicate flags to traverse beneath instance prims and return descendants that pass the specified predicate as instance proxy prims.
|
|
Usd_PrimFlagsPredicate | UsdTraverseInstanceProxies () |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Convenience method equivalent to calling UsdTraverseInstanceProxies with the UsdPrimDefaultPredicate that is used by default for prim traversals.
|
|
Provides terms for UsdPrim flags that can be combined to form either a conjunction (via &&) or a disjunction (via ||). The result is a predicate functor object that tests those flags on the passed prim. Currently UsdPrim::GetFilteredChildren(), UsdPrim::GetNextFilteredSibling(), UsdPrim::GetFilteredDescendants(), and UsdPrimRange() accept these predicates to filter out unwanted prims.
For example:
unspecified UsdPrimIsLoaded
Tests UsdPrim::IsLoaded()
unspecified UsdPrimIsModel
Tests UsdPrim::IsModel()
For performance, these predicates are implemented by a bitwise test, so arbitrary boolean expressions cannot be represented. The set of boolean expressions that can be represented are conjunctions with possibly negated terms (or disjunctions, by De Morgan's law). Here are some examples of valid expressions:
unspecified UsdPrimIsGroup
Tests UsdPrim::IsGroup()
unspecified UsdPrimIsActive
Tests UsdPrim::IsActive()
unspecified UsdPrimIsDefined
Tests UsdPrim::IsDefined()
unspecified UsdPrimIsAbstract
Tests UsdPrim::IsAbstract()
Here are some examples of invalid expressions:
The following variables provide the clauses that can be combined and negated to produce predicates:
Definition in file primFlags.h.
Usd_PrimFlagsPredicate UsdTraverseInstanceProxies |
( |
Usd_PrimFlagsPredicate |
predicate | ) |
|
|
inline |
This function is used to allow the prim traversal functions listed under Prim predicate flags to traverse beneath instance prims and return descendants that pass the specified predicate
as instance proxy prims.
For example:
prim.GetFilteredChildren(
Usd_PrimFlagsPredicate UsdTraverseInstanceProxies()
This is an overloaded member function, provided for convenience. It differs from the above function o...
unspecified UsdPrimAllPrimsPredicate
Predicate that includes all prims.
Users may also call Usd_PrimFlagsPredicate::TraverseInstanceProxies to enable traversal beneath instance prims. This function is equivalent to:
predicate.TraverseInstanceProxies(true);
However, this function may be more convenient, especially when calling a prim traversal function with a default-constructed tautology predicate.
Definition at line 577 of file primFlags.h.
unspecified UsdPrimDefaultPredicate |
|
extern |
The default predicate used for prim traversals in methods like UsdPrim::GetChildren, UsdStage::Traverse, and by UsdPrimRange.
This is a conjunction that includes all active, loaded, defined, non-abstract prims, equivalent to:
This represents the prims on a stage that a processor would typically consider present, meaningful, and needful of consideration.
See Prim predicate flags for more information.