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 ()
	Destructor. More...
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
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
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 UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

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

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USD_API UsdSchemaKind	_GetSchemaKind () const override
USD_API bool	_IsCompatible () const override
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

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 concrete, instantiable "IsA" schemas.

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

Definition at line 61 of file typed.h.

Constructor & Destructor Documentation

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

inlineexplicit

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 73 of file typed.h.

UsdTyped::UsdTyped ( const UsdSchemaBase &  schemaObj )

inlineexplicit

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

Definition at line 81 of file typed.h.

virtual USD_API UsdTyped::~UsdTyped ( )

virtual

Destructor.

Member Function Documentation

USD_API UsdSchemaKind UsdTyped::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdSchemaBase.

Reimplemented in UsdGeomPointInstancer, UsdGeomBasisCurves, UsdGeomXformable, UsdGeomMesh, UsdGeomCamera, UsdShadeMaterial, UsdGeomNurbsPatch, UsdMediaSpatialAudio, UsdRenderPass, UsdGeomHermiteCurves, UsdGeomSubset, UsdShadeShader, UsdUIBackdrop, UsdShadeNodeGraph, UsdLuxLightFilter, UsdGeomNurbsCurves, UsdProcGenerativeProcedural, UsdRenderVar, UsdGeomPlane, UsdRenderProduct, UsdVolVolume, UsdGeomCone, UsdGeomCylinder, UsdGeomPoints, UsdPhysicsCollisionGroup, UsdPhysicsSphericalJoint, UsdRenderDenoisePass, UsdRenderSettings, UsdSkelBlendShape, UsdGeomCapsule, UsdLuxPluginLight, UsdLuxPluginLightFilter, UsdPhysicsPrismaticJoint, UsdPhysicsRevoluteJoint, UsdSkelRoot, UsdSkelSkeleton, UsdVolField3DAsset, UsdVolOpenVDBAsset, UsdPhysicsJoint, UsdSkelAnimation, UsdLuxRectLight, UsdGeomCube, UsdGeomSphere, UsdLuxCylinderLight, UsdGeomScope, UsdLuxGeometryLight, UsdLuxPortalLight, UsdLuxDiskLight, UsdLuxDistantLight, UsdPhysicsDistanceJoint, UsdGeomBoundable, UsdLuxSphereLight, UsdPhysicsFixedJoint, UsdPhysicsScene, UsdGeomXform, UsdSkelPackedJointAnimation, UsdGeomCurves, UsdGeomImageable, UsdGeomGprim, UsdRenderSettingsBase, UsdVolFieldAsset, UsdLuxBoundableLightBase, UsdLuxNonboundableLightBase, UsdGeomPointBased, and UsdVolFieldBase.

USD_API bool UsdTyped::_IsCompatible ( ) const

overrideprotectedvirtual

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  )

static

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:

UsdTyped(stage->GetPrimAtPath(path));

static USD_API const TfTokenVector& UsdTyped::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 120 of file typed.h.

Member Data Documentation

const UsdSchemaKind UsdTyped::schemaKind = UsdSchemaKind::AbstractBase

static

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

See Also

UsdSchemaKind

Definition at line 67 of file typed.h.

---

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

• pxr/usd/usd/typed.h