This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UsdShadeCoordSysAPI Class Reference

UsdShadeCoordSysAPI provides a way to designate, name, and discover coordinate systems. More...

#include <coordSysAPI.h>

+ Inheritance diagram for UsdShadeCoordSysAPI:

Classes

struct  Binding
 A coordinate system binding. More...
 

Public Member Functions

 UsdShadeCoordSysAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
 Construct a UsdShadeCoordSysAPI on UsdPrim prim with name name .
 
 UsdShadeCoordSysAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
 Construct a UsdShadeCoordSysAPI on the prim held by schemaObj with name name.
 
virtual USDSHADE_API ~UsdShadeCoordSysAPI ()
 Destructor.
 
TfToken GetName () const
 Returns the name of this multiple-apply schema instance.
 
USDSHADE_API UsdRelationship GetBindingRel () const
 Prim binding expressing the appropriate coordinate systems.
 
USDSHADE_API UsdRelationship CreateBindingRel () const
 See GetBindingRel(), and also Create vs Get Property Methods for when to use Get vs Create.
 
USDSHADE_API bool HasLocalBindings () const
 Returns true if the prim has local coordinate system relationship exists.
 
USDSHADE_API std::vector< BindingGetLocalBindings () const
 Get the list of coordinate system bindings local to this prim.
 
USDSHADE_API Binding GetLocalBinding () const
 Get the coordinate system bindings local to this prim corresponding to this instance name.
 
USDSHADE_API std::vector< BindingFindBindingsWithInheritance () const
 Find the list of coordinate system bindings that apply to this prim, including inherited bindings.
 
USDSHADE_API Binding FindBindingWithInheritance () const
 Find the coordinate system bindings that apply to this prim, including inherited bindings.
 
USDSHADE_API bool Bind (const TfToken &name, const SdfPath &path) const
 Bind the name to the given path.
 
USDSHADE_API bool ApplyAndBind (const TfToken &name, const SdfPath &path) const
 A convinience API for clients to use to Apply schema in accordance with new UsdShadeCoordSysAPI schema constructs and appropriate Bind the target.
 
USDSHADE_API bool Bind (const SdfPath &path) const
 Bind the name to the given path.
 
USDSHADE_API bool ClearBinding (const TfToken &name, bool removeSpec) const
 Clear the indicated coordinate system binding on this prim from the current edit target.
 
USDSHADE_API bool ClearBinding (bool removeSpec) const
 Clear the coordinate system binding on the prim corresponding to the instanceName of this UsdShadeCoordSysAPI, from the current edit target.
 
USDSHADE_API bool BlockBinding (const TfToken &name) const
 Block the indicated coordinate system binding on this prim by blocking targets on the underlying relationship.
 
USDSHADE_API bool BlockBinding () const
 Block the indicated coordinate system binding on this prim by blocking targets on the underlying relationship.
 
USDSHADE_API TfToken GetBindingBaseName () const
 Strips "coordSys:" from the relationship name and returns "<instanceName>:binding".
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim .
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj .
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor.
 
- 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.
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped.
 
bool IsAPISchema () const
 Returns whether this is an API schema or not.
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not.
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not.
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is.
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim.
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema.
 
virtual USD_API ~UsdSchemaBase ()
 Destructor.
 
UsdPrim GetPrim () const
 Return this schema object's held prim.
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath().
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null.
 
USD_API operator bool () const
 Return true if this schema object is compatible with its held prim, false otherwise.
 

Static Public Member Functions

static USDSHADE_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
 
static USDSHADE_API TfTokenVector GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.
 
static USDSHADE_API UsdShadeCoordSysAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdShadeCoordSysAPI holding the prim adhering to this schema at path on stage.
 
static USDSHADE_API UsdShadeCoordSysAPI Get (const UsdPrim &prim, const TfToken &name)
 Return a UsdShadeCoordSysAPI with name name holding the prim prim.
 
static USDSHADE_API std::vector< UsdShadeCoordSysAPIGetAll (const UsdPrim &prim)
 Return a vector of all named instances of UsdShadeCoordSysAPI on the given prim.
 
static USDSHADE_API bool IsSchemaPropertyBaseName (const TfToken &baseName)
 Checks if the given name baseName is the base name of a property of CoordSysAPI.
 
static USDSHADE_API bool IsCoordSysAPIPath (const SdfPath &path, TfToken *name)
 Checks if the given path path is of an API schema of type CoordSysAPI.
 
static USDSHADE_API bool CanApply (const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
 Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim.
 
static USDSHADE_API UsdShadeCoordSysAPI Apply (const UsdPrim &prim, const TfToken &name)
 Applies this multiple-apply API schema to the given prim along with the given instance name, name.
 
static USDSHADE_API bool HasLocalBindingsForPrim (const UsdPrim &prim)
 Returns true if the prim has UsdShadeCoordSysAPI applied.
 
static USDSHADE_API std::vector< BindingGetLocalBindingsForPrim (const UsdPrim &prim)
 Get the list of coordinate system bindings local to this prim, across all multi-apply instanceNames.
 
static USDSHADE_API std::vector< BindingFindBindingsWithInheritanceForPrim (const UsdPrim &prim)
 Find the list of coordinate system bindings that apply to this prim, including inherited bindings.
 
static USDSHADE_API TfToken GetCoordSysRelationshipName (const std::string &coordSysName)
 Returns the fully namespaced coordinate system relationship name, given the coordinate system name.
 
static USDSHADE_API bool CanContainPropertyName (const TfToken &name)
 Test whether a given name contains the "coordSys:" prefix.
 
static USDSHADE_API TfToken GetBindingBaseName (const TfToken &name)
 Strips "coordSys:" from the relationship name and returns "<instanceName>:binding".
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI
 Compile time constant representing what kind of schema this class is.
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is.
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 Compile time constant representing what kind of schema this class is.
 

Protected Member Functions

USDSHADE_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to.
 
- Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to.
 
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName.
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName.
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema.
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held
prim.
 
- 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
 Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.
 

Detailed Description

UsdShadeCoordSysAPI provides a way to designate, name, and discover coordinate systems.

Coordinate systems are implicitly established by UsdGeomXformable prims, using their local space. That coordinate system may be bound (i.e., named) from another prim. The binding is encoded as a single-target relationship. Coordinate system bindings apply to descendants of the prim where the binding is expressed, but names may be re-bound by descendant prims.

CoordSysAPI is a multi-apply API schema, where instance names signify the named coordinate systems. The instance names are used with the "coordSys:" namespace to determine the binding to the UsdGeomXformable prim.

Named coordinate systems are useful in shading (and other) workflows. An example is projection paint, which projects a texture from a certain view (the paint coordinate system), encoded as (e.g.) "rel coordSys:paint:binding". Using the paint coordinate frame avoids the need to assign a UV set to the object, and can be a concise way to project paint across a collection of objects with a single shared paint coordinate system.

Definition at line 65 of file coordSysAPI.h.


Class Documentation

◆ UsdShadeCoordSysAPI::Binding

struct UsdShadeCoordSysAPI::Binding

A coordinate system binding.

Binds a name to a coordSysPrim for the bindingPrim (and its descendants, unless overriden).

Definition at line 256 of file coordSysAPI.h.

Class Members
SdfPath bindingRelPath
SdfPath coordSysPrimPath
TfToken name

Constructor & Destructor Documentation

◆ UsdShadeCoordSysAPI() [1/2]

UsdShadeCoordSysAPI ( const UsdPrim prim = UsdPrim(),
const TfToken name = TfToken() 
)
inlineexplicit

Construct a UsdShadeCoordSysAPI on UsdPrim prim with name name .

Equivalent to UsdShadeCoordSysAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "coordSys:name"));

for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 82 of file coordSysAPI.h.

◆ UsdShadeCoordSysAPI() [2/2]

UsdShadeCoordSysAPI ( const UsdSchemaBase schemaObj,
const TfToken name 
)
inlineexplicit

Construct a UsdShadeCoordSysAPI on the prim held by schemaObj with name name.

Should be preferred over UsdShadeCoordSysAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

Definition at line 91 of file coordSysAPI.h.

◆ ~UsdShadeCoordSysAPI()

virtual USDSHADE_API ~UsdShadeCoordSysAPI ( )
virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDSHADE_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDSHADE_API UsdShadeCoordSysAPI Apply ( const UsdPrim prim,
const TfToken name 
)
static

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding "CoordSysAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'CoordSysAPI:instance1' is added to 'apiSchemas'.

Returns
A valid UsdShadeCoordSysAPI object is returned upon success. An invalid (or empty) UsdShadeCoordSysAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ ApplyAndBind()

USDSHADE_API bool ApplyAndBind ( const TfToken name,
const SdfPath path 
) const

A convinience API for clients to use to Apply schema in accordance with new UsdShadeCoordSysAPI schema constructs and appropriate Bind the target.

Note that this is only for clients using old behavior.

Deprecated:

◆ Bind() [1/2]

USDSHADE_API bool Bind ( const SdfPath path) const

Bind the name to the given path.

The prim at the given path is expected to be UsdGeomXformable, in order for the binding to be succesfully resolved.

◆ Bind() [2/2]

USDSHADE_API bool Bind ( const TfToken name,
const SdfPath path 
) const

Bind the name to the given path.

The prim at the given path is expected to be UsdGeomXformable, in order for the binding to be succesfully resolved.

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to True, adds a binding conforming to the new multi-apply UsdShadeCoordSysAPI schema. If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to Warn, try to also bind to multi-apply API compliant relationship for the prim, along with backward compatible deprecated behavior.

◆ BlockBinding() [1/2]

USDSHADE_API bool BlockBinding ( ) const

Block the indicated coordinate system binding on this prim by blocking targets on the underlying relationship.

◆ BlockBinding() [2/2]

USDSHADE_API bool BlockBinding ( const TfToken name) const

Block the indicated coordinate system binding on this prim by blocking targets on the underlying relationship.

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to True, blocks binding conforming to the new multi-apply UsdShadeCoordSysAPI schema. If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to Warn, try to also block binding for multi-apply API compliant relationship for the prim, along with backward compatible deprecated behavior.

◆ CanApply()

static USDSHADE_API bool CanApply ( const UsdPrim prim,
const TfToken name,
std::string *  whyNot = nullptr 
)
static

Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim.

If this schema can not be a applied the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ CanContainPropertyName()

static USDSHADE_API bool CanContainPropertyName ( const TfToken name)
static

Test whether a given name contains the "coordSys:" prefix.

◆ ClearBinding() [1/2]

USDSHADE_API bool ClearBinding ( bool  removeSpec) const

Clear the coordinate system binding on the prim corresponding to the instanceName of this UsdShadeCoordSysAPI, from the current edit target.

Only remove the spec if removeSpec is true (leave the spec to preserve meta-data we may have intentionally authored on the relationship)

◆ ClearBinding() [2/2]

USDSHADE_API bool ClearBinding ( const TfToken name,
bool  removeSpec 
) const

Clear the indicated coordinate system binding on this prim from the current edit target.

Only remove the spec if removeSpec is true (leave the spec to preserve meta-data we may have intentionally authored on the relationship)

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to True, clears a binding conforming to the new multi-apply UsdShadeCoordSysAPI schema. If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to Warn, try to also clear binding for multi-apply API compliant relationship for the prim, along with backward compatible deprecated behavior.

◆ CreateBindingRel()

USDSHADE_API UsdRelationship CreateBindingRel ( ) const

See GetBindingRel(), and also Create vs Get Property Methods for when to use Get vs Create.

◆ FindBindingsWithInheritance()

USDSHADE_API std::vector< Binding > FindBindingsWithInheritance ( ) const

Find the list of coordinate system bindings that apply to this prim, including inherited bindings.

This computation examines this prim and ancestors for the strongest binding for each name. A binding expressed by a child prim supercedes bindings on ancestors.

Note that this API does not validate the prims at the target paths; they may be of incorrect type, or missing entirely.

Binding relationships with no resolved targets are skipped.

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to True, returns bindings conforming to the new multi-apply UsdShadeCoordSysAPI schema. If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to Warn, try to get multi-apply API compliant local bindings for the prim, if none fallback to backward compatible deprecated behavior.

◆ FindBindingsWithInheritanceForPrim()

static USDSHADE_API std::vector< Binding > FindBindingsWithInheritanceForPrim ( const UsdPrim prim)
static

Find the list of coordinate system bindings that apply to this prim, including inherited bindings.

This computation examines this prim and ancestors for the strongest binding for each name. A binding expressed by a child prim supercedes bindings on ancestors. Only prims which have the UsdShadeCoordSysAPI applied are considered and queried for a binding.

Note that this API does not validate the prims at the target paths; they may be of incorrect type, or missing entirely.

Binding relationships with no resolved targets are skipped.

◆ FindBindingWithInheritance()

USDSHADE_API Binding FindBindingWithInheritance ( ) const

Find the coordinate system bindings that apply to this prim, including inherited bindings.

This computation examines this prim and ancestors for the strongest binding for the specific instanceName. A binding expressed by a child prim supercedes bindings on ancestors. Only ancestor prims which have the UsdShadeCoordSysAPI:instanceName applied are considered.

Note that this API does not validate the prims at the target paths; they may be of incorrect type, or missing entirely.

Binding relationships with no resolved targets are skipped.

◆ Get() [1/2]

static USDSHADE_API UsdShadeCoordSysAPI Get ( const UsdPrim prim,
const TfToken name 
)
static

Return a UsdShadeCoordSysAPI with name name holding the prim prim.

Shorthand for UsdShadeCoordSysAPI(prim, name);

◆ Get() [2/2]

static USDSHADE_API UsdShadeCoordSysAPI Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdShadeCoordSysAPI 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. path must be of the format <path>.coordSys:name .

This is shorthand for the following:

TfToken name = SdfPath::StripNamespace(path.GetToken());
stage->GetPrimAtPath(path.GetPrimPath()), name);
static SDF_API std::string StripNamespace(const std::string &name)
Returns name stripped of any namespaces.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
UsdShadeCoordSysAPI provides a way to designate, name, and discover coordinate systems.
Definition: coordSysAPI.h:66

◆ GetAll()

static USDSHADE_API std::vector< UsdShadeCoordSysAPI > GetAll ( const UsdPrim prim)
static

Return a vector of all named instances of UsdShadeCoordSysAPI on the given prim.

◆ GetBindingBaseName() [1/2]

USDSHADE_API TfToken GetBindingBaseName ( ) const

Strips "coordSys:" from the relationship name and returns "<instanceName>:binding".

◆ GetBindingBaseName() [2/2]

static USDSHADE_API TfToken GetBindingBaseName ( const TfToken name)
static

Strips "coordSys:" from the relationship name and returns "<instanceName>:binding".

◆ GetBindingRel()

USDSHADE_API UsdRelationship GetBindingRel ( ) const

Prim binding expressing the appropriate coordinate systems.

◆ GetCoordSysRelationshipName()

static USDSHADE_API TfToken GetCoordSysRelationshipName ( const std::string &  coordSysName)
static

Returns the fully namespaced coordinate system relationship name, given the coordinate system name.

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI

◆ GetLocalBinding()

USDSHADE_API Binding GetLocalBinding ( ) const

Get the coordinate system bindings local to this prim corresponding to this instance name.

This does not process inherited bindings. It does not validate that a prim exists at the indicated path. If the binding relationship has multiple targets, only the first is used.

◆ GetLocalBindings()

USDSHADE_API std::vector< Binding > GetLocalBindings ( ) const

Get the list of coordinate system bindings local to this prim.

This does not process inherited bindings. It does not validate that a prim exists at the indicated path. If the binding relationship has multiple targets, only the first is used.

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to True, returns bindings conforming to the new multi-apply UsdShadeCoordSysAPI schema. If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to Warn, try to get multi-apply API compliant local bindings for the prim, if none fallback to backward compatible deprecated behavior.

◆ GetLocalBindingsForPrim()

static USDSHADE_API std::vector< Binding > GetLocalBindingsForPrim ( const UsdPrim prim)
static

Get the list of coordinate system bindings local to this prim, across all multi-apply instanceNames.

This does not process inherited bindings. It does not validate that a prim exists at the indicated path. If the binding relationship has multiple targets, only the first is used.

Note that this will always return empty vector of bindings if the prim being queried does not have UsdShadeCoordSysAPI applied.

◆ GetName()

TfToken GetName ( ) const
inline

Returns the name of this multiple-apply schema instance.

Definition at line 117 of file coordSysAPI.h.

◆ GetSchemaAttributeNames() [1/2]

static USDSHADE_API TfTokenVector GetSchemaAttributeNames ( bool  includeInherited,
const TfToken instanceName 
)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.

Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.

◆ GetSchemaAttributeNames() [2/2]

static USDSHADE_API const TfTokenVector & GetSchemaAttributeNames ( bool  includeInherited = true)
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.

◆ HasLocalBindings()

USDSHADE_API bool HasLocalBindings ( ) const

Returns true if the prim has local coordinate system relationship exists.

Deprecated:
This method is deprecated as it operates on the old non-applied UsdShadeCoordSysAPI If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to True, if prim has appropriate API applied, that is conforming to the new behavior. If USD_SHADE_COORD_SYS_IS_MULTI_APPLY is set to Warn, try to see if multi-apply API compliant local bindings are present for the prim, if not fallback to backward compatible deprecated behavior.

◆ HasLocalBindingsForPrim()

static USDSHADE_API bool HasLocalBindingsForPrim ( const UsdPrim prim)
static

Returns true if the prim has UsdShadeCoordSysAPI applied.

Which implies it has the appropriate binding relationship(s).

◆ IsCoordSysAPIPath()

static USDSHADE_API bool IsCoordSysAPIPath ( const SdfPath path,
TfToken name 
)
static

Checks if the given path path is of an API schema of type CoordSysAPI.

If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

◆ IsSchemaPropertyBaseName()

static USDSHADE_API bool IsSchemaPropertyBaseName ( const TfToken baseName)
static

Checks if the given name baseName is the base name of a property of CoordSysAPI.

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry
friend

Definition at line 217 of file coordSysAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI
static

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

See also
UsdSchemaKind

Definition at line 71 of file coordSysAPI.h.


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