UsdPrimTypeInfo Class Reference

Class that holds the full type information for a prim. More...

#include <primTypeInfo.h>

Public Member Functions
const TfToken &	GetTypeName () const
	Returns the concrete prim type name.
const TfTokenVector &	GetAppliedAPISchemas () const
	Returns the list of applied API schemas, directly authored on the prim, that impart additional properties on its prim definition.
const TfType &	GetSchemaType () const
	Returns the TfType of the actual concrete schema that prims of this type will use to create their prim definition.
const TfToken &	GetSchemaTypeName () const
	Returns the type name associated with the schema type returned from GetSchemaType.
const UsdPrimDefinition &	GetPrimDefinition () const
	Returns the prim definition associated with this prim type's schema type and applied API schemas.
bool	operator== (const UsdPrimTypeInfo &other) const
bool	operator!= (const UsdPrimTypeInfo &other) const

Static Public Member Functions
static USD_API const UsdPrimTypeInfo &	GetEmptyPrimType ()
	Returns the empty prim type info.

Detailed Description

Class that holds the full type information for a prim.

It holds the type name, applied API schema names, and possibly a mapped schema type name which represent a unique full type. The info this holds is used to cache and provide the "real" schema type for the prim's type name regardless of whether it is a recognized prim type or not. The optional "mapped schema type name" is used to obtain a valid schema type for an unrecognized prim type name if the stage provides a fallback type for the unrecognized type. This class also provides access to the prim definition that defines all the built-in properties and metadata of a prim of this type.

Definition at line 30 of file primTypeInfo.h.

Member Function Documentation

GetAppliedAPISchemas()

const TfTokenVector & GetAppliedAPISchemas ( ) const

inline

Returns the list of applied API schemas, directly authored on the prim, that impart additional properties on its prim definition.

This does NOT include the applied API schemas that may be defined in the conrete prim type's prim definition..

Definition at line 40 of file primTypeInfo.h.

GetEmptyPrimType()

static USD_API const UsdPrimTypeInfo & GetEmptyPrimType ( )

static

Returns the empty prim type info.

GetPrimDefinition()

const UsdPrimDefinition & GetPrimDefinition ( ) const

inline

Returns the prim definition associated with this prim type's schema type and applied API schemas.

Definition at line 65 of file primTypeInfo.h.

GetSchemaType()

const TfType & GetSchemaType ( ) const

inline

Returns the TfType of the actual concrete schema that prims of this type will use to create their prim definition.

Typically, this will be the type registered in the schema registry for the concrete prim type returned by GetTypeName. But if the stage provided this type info with a fallback type because the prim type name is not a recognized schema, this will return the provided fallback schema type instead.

See also

Fallback Prim Types

Definition at line 52 of file primTypeInfo.h.

GetSchemaTypeName()

const TfToken & GetSchemaTypeName ( ) const

inline

Returns the type name associated with the schema type returned from GetSchemaType.

This will always be equivalent to calling UsdSchemaRegistry::GetConcreteSchemaTypeName on the type returned by GetSchemaType and will typically be the same as GetTypeName as long as the prim type name is a recognized prim type.

See also

Fallback Prim Types

Definition at line 61 of file primTypeInfo.h.

GetTypeName()

const TfToken & GetTypeName ( ) const

inline

Returns the concrete prim type name.

Definition at line 34 of file primTypeInfo.h.

operator!=()

bool operator!= ( const UsdPrimTypeInfo &  other ) const

inline

Definition at line 83 of file primTypeInfo.h.

operator==()

bool operator== ( const UsdPrimTypeInfo &  other ) const

inline

Definition at line 77 of file primTypeInfo.h.

---

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

• pxr/usd/usd/primTypeInfo.h