All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdTyped Class Reference

#include <typed.h>

+ Inheritance diagram for UsdTyped:

Public Member Functions

 UsdTyped (const UsdPrim &prim=UsdPrim())
 UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API ~UsdTyped ()
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
bool IsTyped () const
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
bool IsAppliedAPISchema () const
bool IsMultipleApplyAPISchema () const
UsdSchemaType GetSchemaType () const
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 UsdPrimDefinitionGetSchemaClassPrimDefinition () const

Static Public Member Functions

static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase

Protected Member Functions

USD_API bool _IsCompatible () const override
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaType _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

Detailed Description

The base class for all typed schemas (those that can impart a typeName to a UsdPrim), and therefore the base class for all instantiable and "IsA" schemas.

UsdTyped implements a typeName-based query for its override of UsdSchemaBase::_IsCompatible(). It provides no other behavior.

Definition at line 47 of file typed.h.

Constructor & Destructor Documentation

UsdTyped::UsdTyped ( const UsdPrim prim = UsdPrim())

Construct a UsdTyped on UsdPrim prim . Equivalent to UsdTyped::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 59 of file typed.h.

UsdTyped::UsdTyped ( const UsdSchemaBase schemaObj)

Construct a UsdTyped on the prim wrapped by schemaObj . Should be preferred over UsdTyped(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 67 of file typed.h.

virtual USD_API UsdTyped::~UsdTyped ( )

Member Function Documentation

USD_API bool UsdTyped::_IsCompatible ( ) const

Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. This check is performed when clients invoke the explicit bool operator.

Reimplemented from UsdSchemaBase.

static USD_API UsdTyped UsdTyped::Get ( const UsdStagePtr &  stage,
const SdfPath path 

Return a UsdTyped 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 const TfTokenVector& UsdTyped::GetSchemaAttributeNames ( bool  includeInherited = true)

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.

Definition at line 79 of file typed.h.

Member Data Documentation

const UsdSchemaType UsdTyped::schemaType = UsdSchemaType::AbstractBase

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

See Also
UsdSchemaType in usd/common.h

Definition at line 53 of file typed.h.

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