 |
Scope is the simplest grouping primitive, and does not carry the baggage of transformability. More...
Inheritance diagram for UsdGeomScope:Public Member Functions | |
| UsdGeomScope (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomScope on UsdPrim prim . More... | |
| UsdGeomScope (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomScope on the prim held by schemaObj . More... | |
| virtual USDGEOM_API | ~UsdGeomScope () |
| Destructor. More... | |
| Public Member Functions inherited from UsdGeomImageable | |
| UsdGeomImageable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomImageable on UsdPrim prim . More... | |
| UsdGeomImageable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomImageable on the prim held by schemaObj . More... | |
| virtual USDGEOM_API | ~UsdGeomImageable () |
| Destructor. More... | |
| USDGEOM_API UsdAttribute | GetVisibilityAttr () const |
| Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. More... | |
| USDGEOM_API UsdAttribute | CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
| See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
| USDGEOM_API 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. More... | |
| USDGEOM_API UsdAttribute | CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
| See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
| USDGEOM_API UsdRelationship | GetProxyPrimRel () const |
| The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim. More... | |
| USDGEOM_API UsdRelationship | CreateProxyPrimRel () const |
| See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
| USDGEOM_API void | MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
| Make the imageable visible if it is invisible at the given time. More... | |
| USDGEOM_API void | MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
| Makes the imageable invisible if it is visible at the given time. More... | |
| USDGEOM_API TfToken | ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const |
| Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any. More... | |
| USDGEOM_API TfToken | ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective visibility of this prim, given the computed visibility of its parent prim at the given time. More... | |
| USDGEOM_API PurposeInfo | ComputePurposeInfo () const |
| Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions. More... | |
| USDGEOM_API PurposeInfo | ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose information about this prim, given the computed purpose information of its parent prim. More... | |
| USDGEOM_API TfToken | ComputePurpose () const |
| Calculate the effective purpose information about this prim. More... | |
| USDGEOM_API UsdPrim | ComputeProxyPrim (UsdPrim *renderPrim=NULL) const |
| Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel(), or an invalid UsdPrim if this prim has no proxy. More... | |
| USDGEOM_API bool | SetProxyPrim (const UsdPrim &proxy) const |
Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim. More... | |
| USDGEOM_API bool | SetProxyPrim (const UsdSchemaBase &proxy) const |
| USDGEOM_API GfBBox3d | ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in world space, at the specified time, and for the specified purposes. More... | |
| USDGEOM_API GfBBox3d | ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in local space, at the specified time, and for the specified purposes. More... | |
| USDGEOM_API GfBBox3d | ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the untransformed bound of this prim, at the specified time, and for the specified purposes. More... | |
| USDGEOM_API GfMatrix4d | ComputeLocalToWorldTransform (UsdTimeCode const &time) const |
| Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present. More... | |
| USDGEOM_API GfMatrix4d | ComputeParentToWorldTransform (UsdTimeCode const &time) const |
| Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself. More... | |
| USDGEOM_API UsdGeomPrimvar | CreatePrimvar (const TfToken &attrName, const SdfValueTypeName &typeName, const TfToken &interpolation=TfToken(), int elementSize=-1) const |
| USDGEOM_API UsdGeomPrimvar | GetPrimvar (const TfToken &name) const |
| USDGEOM_API std::vector < UsdGeomPrimvar > | GetPrimvars () const |
| USDGEOM_API std::vector < UsdGeomPrimvar > | GetAuthoredPrimvars () const |
| USDGEOM_API bool | HasPrimvar (const TfToken &name) const |
| Public Member Functions inherited from UsdTyped | |
| UsdTyped (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdTyped on UsdPrim prim . More... | |
| UsdTyped (const UsdSchemaBase &schemaObj) | |
Construct a UsdTyped on the prim wrapped by schemaObj . More... | |
| Public Member Functions inherited from UsdSchemaBase | |
| bool | IsConcrete () const |
| Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More... | |
| bool | IsTyped () const |
| Returns whether or not this class inherits from UsdTyped. More... | |
| bool | IsAPISchema () const |
| Returns whether this is an API schema or not. More... | |
| bool | IsAppliedAPISchema () const |
| Returns whether this is an applied API schema or not. More... | |
| bool | IsMultipleApplyAPISchema () const |
| Returns whether this is an applied API schema or not. More... | |
| UsdSchemaKind | GetSchemaKind () const |
| Returns the kind of schema this class is. More... | |
| USD_API | UsdSchemaBase (const UsdPrim &prim=UsdPrim()) |
Construct and store prim as the held prim. More... | |
| USD_API | UsdSchemaBase (const UsdSchemaBase &otherSchema) |
Construct and store for the same prim held by otherSchema. More... | |
| virtual USD_API | ~UsdSchemaBase () |
| Destructor. More... | |
| USD_API | operator bool () const |
| UsdPrim | GetPrim () const |
| Return this schema object's held prim. More... | |
| SdfPath | GetPath () const |
| Shorthand for GetPrim()->GetPath(). More... | |
| USD_API const UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
| Return the prim definition associated with this schema instance if one exists, otherwise return null. More... | |
Static Public Member Functions | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
| static USDGEOM_API UsdGeomScope | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomScope holding the prim adhering to this schema at path on stage. More... | |
| static USDGEOM_API UsdGeomScope | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More... | |
| Static Public Member Functions inherited from UsdGeomImageable | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
| static USDGEOM_API UsdGeomImageable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomImageable holding the prim adhering to this schema at path on stage. More... | |
| static USDGEOM_API const TfTokenVector & | GetOrderedPurposeTokens () |
| Returns an ordered list of allowed values of the purpose attribute. More... | |
| Static Public Member Functions inherited from UsdTyped | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
| static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdTyped holding the prim adhering to this schema at path on stage. More... | |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
| Compile time constant representing what kind of schema this class is. More... | |
| Static Public Attributes inherited from UsdGeomImageable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Compile time constant representing what kind of schema this class is. More... | |
| Static Public Attributes inherited from UsdTyped | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Compile time constant representing what kind of schema this class is. More... | |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
| USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
| Returns the kind of schema this class belongs to. More... | |
| Protected Member Functions inherited from UsdTyped | |
| USD_API bool | _IsCompatible () const override |
| Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More... | |
| Protected Member Functions inherited from UsdSchemaBase | |
| virtual UsdSchemaKind | _GetSchemaType () const |
| const TfType & | _GetType () const |
| USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
| class | UsdSchemaRegistry |
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.
|
inlineexplicit |
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
|
inlineexplicit |
Construct a UsdGeomScope on the prim held by schemaObj .
Should be preferred over UsdGeomScope(schemaObj.GetPrim()), as it preserves SchemaBase state.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdGeomImageable.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a UsdGeomScope holding the prim adhering to this schema at path on stage.
If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended methods of the schemas involved.
|
static |
Compile time constant representing what kind of schema this class is.
1.8.5 
