 |
Class representing the builtin definition of a prim given the schemas registered in the schema registry. More...
Public Member Functions | |
| const TfTokenVector & | GetPropertyNames () const |
| Return the list of names of builtin properties for this prim definition. More... | |
| const TfTokenVector & | GetAppliedAPISchemas () const |
| Return the list of names of the API schemas that have been applied to this prim definition in order. More... | |
| SdfSpecType | GetSpecType (const TfToken &propName) const |
Return the SdfSpecType for propName if it is a builtin property of the prim type represented by this prim definition. More... | |
| SdfPrimSpecHandle | GetSchemaPrimSpec () const |
| SdfPropertySpecHandle | GetSchemaPropertySpec (const TfToken &propName) const |
| Return the property spec that defines the fallback for the property named propName on prims of this prim definition's type. More... | |
| SdfAttributeSpecHandle | GetSchemaAttributeSpec (const TfToken &attrName) const |
| This is a convenience method. More... | |
| SdfRelationshipSpecHandle | GetSchemaRelationshipSpec (const TfToken &relName) const |
| This is a convenience method. More... | |
| template<class T > | |
| bool | GetAttributeFallbackValue (const TfToken &attrName, T *value) const |
Retrieves the fallback value for the attribute named attrName and stores it in value if possible. More... | |
| TfTokenVector | ListMetadataFields () const |
| Returns the list of names of metadata fields that are defined by this prim definition for the prim itself. More... | |
| template<class T > | |
| bool | GetMetadata (const TfToken &key, T *value) const |
Retrieves the fallback value for the metadata field named key, that is defined by this prim definition for the prim itself and stores it in value if possible. More... | |
| template<class T > | |
| bool | GetMetadataByDictKey (const TfToken &key, const TfToken &keyPath, T *value) const |
Retrieves the value at keyPath from the fallback dictionary value for the dictionary metadata field named key, that is defined by this prim definition for the prim itself, and stores it in value if possible. More... | |
| USD_API std::string | GetDocumentation () const |
| Returns the documentation metadata defined by the prim definition for the prim itself. More... | |
| TfTokenVector | ListPropertyMetadataFields (const TfToken &propName) const |
Returns the list of names of metadata fields that are defined by this prim definition for property propName if a property named propName exists. More... | |
| template<class T > | |
| bool | GetPropertyMetadata (const TfToken &propName, const TfToken &key, T *value) const |
Retrieves the fallback value for the metadata field named key, that is defined by this prim definition for the property named propName, and stores it in value if possible. More... | |
| template<class T > | |
| bool | GetPropertyMetadataByDictKey (const TfToken &propName, const TfToken &key, const TfToken &keyPath, T *value) const |
Retrieves the value at keyPath from the fallback dictionary value for the dictionary metadata field named key, that is defined by this prim definition for the property named propName, and stores it in value if possible. More... | |
| USD_API std::string | GetPropertyDocumentation (const TfToken &propName) const |
Returns the documentation metadata defined by the prim definition for the property named propName if it exists. More... | |
Friends | |
| class | UsdSchemaRegistry |
Class representing the builtin definition of a prim given the schemas registered in the schema registry.
It provides access to the the builtin properties and metadata of a prim whose type is defined by this definition.
Instances of this class can only be created by the UsdSchemaRegistry.
Definition at line 45 of file primDefinition.h.
|
inline |
Return the list of names of the API schemas that have been applied to this prim definition in order.
Definition at line 55 of file primDefinition.h.
|
inline |
Retrieves the fallback value for the attribute named attrName and stores it in value if possible.
Returns true if the attribute exists in this prim definition and it has a fallback value defined. Returns false otherwise.
Definition at line 117 of file primDefinition.h.
| USD_API std::string GetDocumentation | ( | ) | const |
Returns the documentation metadata defined by the prim definition for the prim itself.
|
inline |
Retrieves the fallback value for the metadata field named key, that is defined by this prim definition for the prim itself and stores it in value if possible.
Returns true if a fallback value is defined for the given metadata key. Returns false otherwise.
Definition at line 136 of file primDefinition.h.
Retrieves the value at keyPath from the fallback dictionary value for the dictionary metadata field named key, that is defined by this prim definition for the prim itself, and stores it in value if possible.
Returns true if a fallback dictionary value is defined for the given metadata key and it contains a value at keyPath. Returns false otherwise.
Definition at line 153 of file primDefinition.h.
| USD_API std::string GetPropertyDocumentation | ( | const TfToken & | propName | ) | const |
Returns the documentation metadata defined by the prim definition for the property named propName if it exists.
Retrieves the fallback value for the metadata field named key, that is defined by this prim definition for the property named propName, and stores it in value if possible.
Returns true if a fallback value is defined for the given metadata key for the named property. Returns false otherwise.
Definition at line 183 of file primDefinition.h.
|
inline |
Retrieves the value at keyPath from the fallback dictionary value for the dictionary metadata field named key, that is defined by this prim definition for the property named propName, and stores it in value if possible.
Returns true if a fallback dictionary value is defined for the given metadata key for the named property and it contains a value at keyPath. Returns false otherwise.
Definition at line 201 of file primDefinition.h.
|
inline |
Return the list of names of builtin properties for this prim definition.
Definition at line 51 of file primDefinition.h.
|
inline |
This is a convenience method.
It is shorthand for TfDynamic_cast<SdfAttributeSpecHandle>( GetSchemaPropertySpec(primType, attrName));
Definition at line 92 of file primDefinition.h.
|
inline |
Returns the prim spec in the registered schematics that represents this prim definition's prim type. This will be null for invalid prim types or definitions composed for a prim with applied API schemas.
Definition at line 76 of file primDefinition.h.
|
inline |
Return the property spec that defines the fallback for the property named propName on prims of this prim definition's type.
Return null if there is no such property spec.
Definition at line 81 of file primDefinition.h.
|
inline |
This is a convenience method.
It is shorthand for TfDynamic_cast<SdfRelationshipSpecHandle>( GetSchemaPropertySpec(primType, relName));
Definition at line 103 of file primDefinition.h.
|
inline |
Return the SdfSpecType for propName if it is a builtin property of the prim type represented by this prim definition.
Otherwise return SdfSpecTypeUnknown.
Definition at line 62 of file primDefinition.h.
|
inline |
Returns the list of names of metadata fields that are defined by this prim definition for the prim itself.
Definition at line 124 of file primDefinition.h.
|
inline |
Returns the list of names of metadata fields that are defined by this prim definition for property propName if a property named propName exists.
Definition at line 170 of file primDefinition.h.
1.8.5 
