HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Friends | List of all members
UsdSchemaRegistry Class Reference

#include <schemaRegistry.h>

+ Inheritance diagram for UsdSchemaRegistry:

Public Member Functions

const UsdPrimDefinition * FindConcretePrimDefinition (const TfToken &typeName) const
 
const UsdPrimDefinition * FindAppliedAPIPrimDefinition (const TfToken &typeName) const
 
const UsdPrimDefinition * GetEmptyPrimDefinition () const
 Returns the empty prim definition. More...
 
USD_API std::unique_ptr
< UsdPrimDefinition > 		BuildComposedPrimDefinition (const TfToken &primType, const TfTokenVector &appliedAPISchemas) const
 
const VtDictionary & GetFallbackPrimTypes () const
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase ()
 
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase & __GetTfWeakBase__ () const
 
const TfWeakBase & operator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Static Public Member Functions

static USD_API UsdSchemaRegistry & GetInstance ()
 
static USD_API TfToken GetSchemaTypeName (const TfType &schemaType)
 
template<class SchemaType >
static TfToken GetSchemaTypeName ()
 
static USD_API TfToken GetConcreteSchemaTypeName (const TfType &schemaType)
 
static USD_API TfToken GetAPISchemaTypeName (const TfType &schemaType)
 
static USD_API TfType GetTypeFromSchemaTypeName (const TfToken &typeName)
 
static USD_API TfType GetConcreteTypeFromSchemaTypeName (const TfToken &typeName)
 
static USD_API TfType GetAPITypeFromSchemaTypeName (const TfToken &typeName)
 
static USD_API bool IsDisallowedField (const TfToken &fieldName)
 
static USD_API bool IsTyped (const TfType &primType)
 Returns true if the prim type primType inherits from UsdTyped. More...
 
static USD_API UsdSchemaKind GetSchemaKind (const TfType &schemaType)
 
static USD_API UsdSchemaKind GetSchemaKind (const TfToken &typeName)
 
static USD_API bool IsConcrete (const TfType &primType)
 
static USD_API bool IsConcrete (const TfToken &primType)
 
static USD_API bool IsAbstract (const TfType &primType)
 
static USD_API bool IsAbstract (const TfToken &primType)
 
static USD_API bool IsAppliedAPISchema (const TfType &apiSchemaType)
 Returns true if apiSchemaType is an applied API schema type. More...
 
static USD_API bool IsAppliedAPISchema (const TfToken &apiSchemaType)
 Returns true if apiSchemaType is an applied API schema type. More...
 
static USD_API bool IsMultipleApplyAPISchema (const TfType &apiSchemaType)
 Returns true if apiSchemaType is a multiple-apply API schema type. More...
 
static USD_API bool IsMultipleApplyAPISchema (const TfToken &apiSchemaType)
 Returns true if apiSchemaType is a multiple-apply API schema type. More...
 
static USD_API TfType GetTypeFromName (const TfToken &typeName)
 
static USD_API std::pair
< TfToken, TfToken > 		GetTypeNameAndInstance (const TfToken &apiSchemaName)
 
static USD_API bool IsAllowedAPISchemaInstanceName (const TfToken &apiSchemaName, const TfToken &instanceName)
 
static USD_API const
TfTokenVector & 		GetAPISchemaCanOnlyApplyToTypeNames (const TfToken &apiSchemaName, const TfToken &instanceName=TfToken())
 
static USD_API const std::map
< TfToken, TfTokenVector > & 		GetAutoApplyAPISchemas ()
 
static USD_API void CollectAddtionalAutoApplyAPISchemasFromPlugins (std::map< TfToken, TfTokenVector > *autoApplyAPISchemas)
 
static USD_API TfToken MakeMultipleApplyNameTemplate (const std::string &namespacePrefix, const std::string &baseName)
 
static USD_API TfToken MakeMultipleApplyNameInstance (const std::string &nameTemplate, const std::string &instanceName)
 
static USD_API TfToken GetMultipleApplyNameTemplateBaseName (const std::string &nameTemplate)
 
static USD_API bool IsMultipleApplyNameTemplate (const std::string &nameTemplate)
 

Friends

class TfSingleton< UsdSchemaRegistry >
 
class UsdPrimDefinition
 

Additional Inherited Members

- Protected Member Functions inherited from TfWeakBase
 ~TfWeakBase ()
 
TfRefPtr< Tf_Remnant > _Register () const
 
template<class T >
TfRefPtr< Tf_Remnant > _Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

Detailed Description

Singleton registry that provides access to schema type information and the prim definitions for registered Usd "IsA" and applied API schema types. It also contains the data from the generated schemas that is used by prim definitions to provide properties and fallbacks.

The data contained herein comes from the generatedSchema.usda file (generated when a schema.usda file is processed by usdGenSchema) of each schema-defining module. The registry expects each schema type to be represented as a single prim spec with its inheritance flattened, i.e. the prim spec contains a union of all its local and class inherited property specs and metadata fields.

It is used by the Usd core, via UsdPrimDefinition, to determine how to create scene description for unauthored "built-in" properties of schema classes, to enumerate all properties for a given schema class, and finally to provide fallback values for unauthored built-in properties.

Definition at line 65 of file schemaRegistry.h.

Member Function Documentation

USD_API std::unique_ptr<UsdPrimDefinition> UsdSchemaRegistry::BuildComposedPrimDefinition ( const TfToken &  primType,
const TfTokenVector &  appliedAPISchemas 
) const

Composes and returns a new UsdPrimDefinition from the given primType and list of appliedSchemas. This prim definition will contain a union of properties from the registered prim definitions of each of the provided types.

static USD_API void UsdSchemaRegistry::CollectAddtionalAutoApplyAPISchemasFromPlugins ( std::map< TfToken, TfTokenVector > *  autoApplyAPISchemas)
static

Collects all the additional auto apply schemas that can be defined in a plugin through "AutoApplyAPISchemas" metadata and adds the mappings to autoApplyAPISchemas.

These are separate from the auto-apply schemas that are built in to the applied API schema types themselves and can be defined in any plugin to map any applied API schema to any concrete prim type.

Note that GetAutoApplyAPISchemas will already include API schemas collected from this method; this function is provided for clients that may want to collect just these plugin API schema mappings.

const UsdPrimDefinition* UsdSchemaRegistry::FindAppliedAPIPrimDefinition ( const TfToken &  typeName) const
inline

Finds the prim definition for the given typeName token if typeName is a registered applied API schema type. Returns null if it is not.

Definition at line 360 of file schemaRegistry.h.

const UsdPrimDefinition* UsdSchemaRegistry::FindConcretePrimDefinition ( const TfToken &  typeName) const
inline

Finds the prim definition for the given typeName token if typeName is a registered concrete typed schema type. Returns null if it is not.

Definition at line 351 of file schemaRegistry.h.

static USD_API const TfTokenVector& UsdSchemaRegistry::GetAPISchemaCanOnlyApplyToTypeNames ( const TfToken &  apiSchemaName,
const TfToken &  instanceName = TfToken() 
)
static

Returns a list of prim type names that the given apiSchemaName can only be applied to.

A non-empty list indicates that the API schema can only be applied to prim that are or derive from prim type names in the list. If the list is empty, the API schema can be applied to prims of any type.

If a non-empty instanceName is provided, this will first look for a list of "can only apply to" names specific to that instance of the API schema and return that if found. If a list is not found for the specific instance, it will fall back to looking for a "can only apply to" list for just the schema name itself.

static USD_API TfToken UsdSchemaRegistry::GetAPISchemaTypeName ( const TfType &  schemaType)
static

Return the type name in the USD schema for API schema types only from the given registered schemaType.

static USD_API TfType UsdSchemaRegistry::GetAPITypeFromSchemaTypeName ( const TfToken &  typeName)
static

Return the TfType of the schema corresponding to the given API schema type name typeName. This the inverse of GetAPISchemaTypeNAme.

static USD_API const std::map<TfToken, TfTokenVector>& UsdSchemaRegistry::GetAutoApplyAPISchemas ( )
static

Returns a map of the names of all registered auto apply API schemas to the list of type names each is registered to be auto applied to.

The list of type names to apply to will directly match what is specified in the plugin metadata for each schema type. While auto apply schemas do account for the existence and validity of the type names and expand to include derived types of the listed types, the type lists returned by this function do not.

static USD_API TfToken UsdSchemaRegistry::GetConcreteSchemaTypeName ( const TfType &  schemaType)
static

Return the type name in the USD schema for concrete prim types only from the given registered schemaType.

static USD_API TfType UsdSchemaRegistry::GetConcreteTypeFromSchemaTypeName ( const TfToken &  typeName)
static

Return the TfType of the schema corresponding to the given concrete prim type name typeName. This the inverse of GetConcreteSchemaTypeName.

const UsdPrimDefinition* UsdSchemaRegistry::GetEmptyPrimDefinition ( ) const
inline

Returns the empty prim definition.

Definition at line 376 of file schemaRegistry.h.

const VtDictionary& UsdSchemaRegistry::GetFallbackPrimTypes ( ) const
inline

Returns a dictionary mapping concrete schema prim type names to a VtTokenArray of fallback prim type names if fallback types are defined for the schema type in its registered schema.

The standard use case for this to provide schema defined metadata that can be saved with a stage to inform an older version of USD - that may not have some schema types - as to which types it can used instead when encountering a prim of one these types.

See Also
UsdStage::WriteFallbackPrimTypes
Usd_OM_FallbackPrimTypes

Definition at line 400 of file schemaRegistry.h.

static USD_API UsdSchemaRegistry& UsdSchemaRegistry::GetInstance ( )
inlinestatic

Definition at line 68 of file schemaRegistry.h.

static USD_API TfToken UsdSchemaRegistry::GetMultipleApplyNameTemplateBaseName ( const std::string &  nameTemplate)
static

Returns the base name for the multiple apply schema name template nameTemplate.

The base name is the substring of the given name template that comes after the instance name placeholder and the subsequent namespace delimiter. If the given property name does not contain the instance name placeholder, it is not a name template and the name template is returned as is.

static USD_API UsdSchemaKind UsdSchemaRegistry::GetSchemaKind ( const TfType &  schemaType)
static

Returns the kind of the schema the given schemaType represents.

This returns UsdSchemaKind::Invalid if schemaType is not a valid schema type or if the kind cannot be determined from type's plugin information.

static USD_API UsdSchemaKind UsdSchemaRegistry::GetSchemaKind ( const TfToken &  typeName)
static

Returns the kind of the schema the given typeName represents.

This returns UsdSchemaKind::Invalid if typeName is not a valid schema type name or if the kind cannot be determined from type's plugin information.

static USD_API TfToken UsdSchemaRegistry::GetSchemaTypeName ( const TfType &  schemaType)
static

Return the type name in the USD schema for prims or API schemas of the given registered schemaType.

template<class SchemaType >
static TfToken UsdSchemaRegistry::GetSchemaTypeName ( )
inlinestatic

Return the type name in the USD schema for prims or API schemas of the given registered SchemaType.

Definition at line 81 of file schemaRegistry.h.

static USD_API TfType UsdSchemaRegistry::GetTypeFromName ( const TfToken &  typeName)
static

Finds the TfType of a schema with typeName

This is primarily for when you have been provided Schema typeName (perhaps from a User Interface or Script) and need to identify if a prim's type inherits/is that typeName. If the type name IS known, then using the schema class is preferred.

1 # This code attempts to match all prims on a stage to a given
2 # user specified type, making the traditional schema based idioms not
3 # applicable.
4 data = parser.parse_args()
5 tfType = UsdSchemaRegistry.GetTypeFromName(data.type)
6 matchedPrims = [p for p in stage.Traverse() if p.IsA(tfType)]
Note
It's worth noting that GetTypeFromName("Sphere") == GetTypeFromName("UsdGeomSphere"), as this function resolves both the Schema's C++ class name and any registered aliases from a libraries plugInfo.json file. However, GetTypeFromName("Boundable") != GetTypeFromName("UsdGeomBoundable") because type aliases don't get registered for abstract schema types.
static USD_API TfType UsdSchemaRegistry::GetTypeFromSchemaTypeName ( const TfToken &  typeName)
static

Return the TfType of the schema corresponding to the given prim or API schema name typeName. This the inverse of GetSchemaTypeName.

static USD_API std::pair<TfToken, TfToken> UsdSchemaRegistry::GetTypeNameAndInstance ( const TfToken &  apiSchemaName)
static

Returns the schema type name and the instance name parsed from the given apiSchemaName

apiSchemaName is the name of an applied schema as it appears in the list of applied schemas on a prim. For single-apply API schemas the name will just be the schema type name. For multiple-apply schemas the name should include the schema type name and the applied instance name separated by a namespace delimiter, for example 'CollectionAPI:plasticStuff'.

This function returns the separated schema type name and instance name component tokens if possible, otherwise it returns the apiSchemaName as the type name and an empty instance name.

Note that no validation is done on the returned tokens. Clients are advised to use GetTypeFromSchemaTypeName() to validate the typeName token.

See Also
UsdPrim::AddAppliedSchema(const TfToken&) const
UsdPrim::GetAppliedSchemas() const
static USD_API bool UsdSchemaRegistry::IsAbstract ( const TfType &  primType)
static

Returns true if the prim type primType is an abstract schema type and, unlike a concrete type, is not instantiable in scene description.

static USD_API bool UsdSchemaRegistry::IsAbstract ( const TfToken &  primType)
static

Returns true if the prim type primType is an abstract schema type and, unlike a concrete type, is not instantiable in scene description.

static USD_API bool UsdSchemaRegistry::IsAllowedAPISchemaInstanceName ( const TfToken &  apiSchemaName,
const TfToken &  instanceName 
)
static

Returns true if the given instanceName is an allowed instance name for the multiple apply API schema named apiSchemaName.

Any instance name that matches the name of a property provided by the API schema is disallowed and will return false. If the schema type has plugin metadata that specifies allowed instance names, then only those specified names are allowed for the schema type. If the instance name is empty or the API is not a multiple apply schema, this will return false.

static USD_API bool UsdSchemaRegistry::IsAppliedAPISchema ( const TfType &  apiSchemaType)
static

Returns true if apiSchemaType is an applied API schema type.

static USD_API bool UsdSchemaRegistry::IsAppliedAPISchema ( const TfToken &  apiSchemaType)
static

Returns true if apiSchemaType is an applied API schema type.

static USD_API bool UsdSchemaRegistry::IsConcrete ( const TfType &  primType)
static

Returns true if the prim type primType is instantiable in scene description.

static USD_API bool UsdSchemaRegistry::IsConcrete ( const TfToken &  primType)
static

Returns true if the prim type primType is instantiable in scene description.

static USD_API bool UsdSchemaRegistry::IsDisallowedField ( const TfToken &  fieldName)
static

Returns true if the field fieldName cannot have fallback values specified in schemas.

Fields are generally disallowed because their fallback values aren't used. For instance, fallback values for composition arcs aren't used during composition, so allowing them to be set in schemas would be misleading.

static USD_API bool UsdSchemaRegistry::IsMultipleApplyAPISchema ( const TfType &  apiSchemaType)
static

Returns true if apiSchemaType is a multiple-apply API schema type.

static USD_API bool UsdSchemaRegistry::IsMultipleApplyAPISchema ( const TfToken &  apiSchemaType)
static

Returns true if apiSchemaType is a multiple-apply API schema type.

static USD_API bool UsdSchemaRegistry::IsMultipleApplyNameTemplate ( const std::string &  nameTemplate)
static

Returns true if nameTemplate is a multiple apply schema name template.

The given nameTemplate is a name template if and only if it contains the instance name place holder "__INSTANCE_NAME__" as an exact match as one of the tokenized components of the name tokenized by the namespace delimiter.

static USD_API bool UsdSchemaRegistry::IsTyped ( const TfType &  primType)
static

Returns true if the prim type primType inherits from UsdTyped.

static USD_API TfToken UsdSchemaRegistry::MakeMultipleApplyNameInstance ( const std::string &  nameTemplate,
const std::string &  instanceName 
)
static

Returns an instance of a multiple apply schema name from the given nameTemplate for the given instanceName.

The returned name is created by replacing the instance name placeholder "__INSTANCE_NAME__" in the name template with the given instance name. If the instance name placeholder is not found in nameTemplate, then the name template is not multiple apply name template and is returned as is.

Note that the instance name placeholder must be found as an exact full word match with one of the tokenized components of the name template, when tokenized by the namespace delimiter, in order for it to be treated as a placeholder and substituted with the instance name.

static USD_API TfToken UsdSchemaRegistry::MakeMultipleApplyNameTemplate ( const std::string &  namespacePrefix,
const std::string &  baseName 
)
static

Creates a name template that can represent a property or API schema that belongs to a multiple apply schema and will therefore have multiple instances with different names.

The name template is created by joining the namespacePrefix, the instance name placeholder "__INSTANCE_NAME__", and the baseName using the namespace delimiter. Therefore the returned name template will be of one of the following forms depending on whether either of the inputs is empty:

  1. namespacePrefix:INSTANCE_NAME:baseName
  2. namespacePrefix:INSTANCE_NAME
  3. INSTANCE_NAME:baseName
  4. INSTANCE_NAME

Name templates can be passed to MakeMultipleApplyNameInstance along with an instance name to create the name for a particular instance.

Friends And Related Function Documentation

friend class TfSingleton< UsdSchemaRegistry >
friend

Definition at line 405 of file schemaRegistry.h.

friend class UsdPrimDefinition
friend

Definition at line 445 of file schemaRegistry.h.

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