usdrt::UsdGeomScope

Defined in usdrt/scenegraph/usd/usdGeom/scope.h

Functions

usdrt::PhysxSchemaPhysxParticleSystem::CreateProxyPrimRel: See GetProxyPrimRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::PhysxSchemaPhysxParticleSystem::CreatePurposeAttr: See GetPurposeAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxParticleSystem::CreateVisibilityAttr: See GetVisibilityAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::UsdGeomScope::Define: Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxParticleSystem::GetProxyPrimRel: The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim. This is entirely optional, but can be useful in several scenarios:
usdrt::PhysxSchemaPhysxParticleSystem::GetPurposeAttr: Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.
usdrt::PhysxSchemaPhysxParticleSystem::GetVisibilityAttr: Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. Visibility is animatable, allowing a sub-tree of geometry to be present for some segment of a shot, and absent from others; unlike the action of deactivating geometry prims, invisible geometry is still available for inspection, for positioning, for defining volumes, etc.
usdrt::UsdGeomScope::UsdGeomScope: Construct a UsdGeomScope on the prim held by schemaObj . Should be preferred over UsdGeomScope (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdGeomScope::UsdGeomScope: Construct a UsdGeomScope on UsdPrim prim . Equivalent to UsdGeomScope::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdGeomScope::operator bool: Boolean operator.
usdrt::UsdGeomScope::~UsdGeomScope: Destructor.

Variables

usdrt::UsdGeomScope::schemaType: Compile time constant representing what kind of schema this class is.

class UsdGeomScope : public usdrt::UsdGeomImageable 

Scope is the simplest grouping primitive, and does not carry the baggage of transformability. Note that transforms should inherit down through a Scope successfully - it is just a guaranteed no-op from a transformability perspective.

Public Functions

inline explicit UsdGeomScope(const UsdPrim &prim = UsdPrim()): Construct a UsdGeomScope on UsdPrim prim. Equivalent to UsdGeomScope::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdGeomScope(const UsdSchemaBase &schemaObj): Construct a UsdGeomScope on the prim held by schemaObj . Should be preferred over UsdGeomScope(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdGeomScope(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

inline UsdAttribute GetVisibilityAttr() const

Visibility is meant to be the simplest form of “pruning” visibility that is supported by most DCC apps. Visibility is animatable, allowing a sub-tree of geometry to be present for some segment of a shot, and absent from others; unlike the action of deactivating geometry prims, invisible geometry is still available for inspection, for positioning, for defining volumes, etc.


Declaration	`token visibility = "inherited"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	inherited, invisible

inline UsdAttribute CreateVisibilityAttr() const: See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPurposeAttr() const

Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.

See UsdGeom_ImageablePurpose for more detail about how purpose is computed and used.


Declaration	`uniform token purpose = "default"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	default, render, proxy, guide

inline UsdAttribute CreatePurposeAttr() const: See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdRelationship GetProxyPrimRel() const

The proxyPrim relationship allows us to link a prim whose purpose is “render” to its (single target) purpose=”proxy” prim. This is entirely optional, but can be useful in several scenarios:

In a pipeline that does pruning (for complexity management) by deactivating prims composed from asset references, when we deactivate a purpose=”render” prim, we will be able to discover and additionally deactivate its associated purpose=”proxy” prim, so that preview renders reflect the pruning accurately.

DCC importers may be able to make more aggressive optimizations for interactive processing and display if they can discover the proxy for a given render prim.

With a little more work, a Hydra-based application will be able to map a picked proxy prim back to its render geometry for selection.

Note

It is only valid to author the proxyPrim relationship on prims whose purpose is “render”.

inline UsdRelationship CreateProxyPrimRel() const: See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline UsdGeomScope Define(const UsdStageRefPtr &stage, const SdfPath &path): Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped 

Compile time constant representing what kind of schema this class is.