 |
|
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. More...
#include <typed.h>
Inheritance diagram for UsdTyped:Public Member Functions | |
| UsdTyped (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdTyped on UsdPrim prim . | |
| UsdTyped (const UsdSchemaBase &schemaObj) | |
Construct a UsdTyped on the prim held by schemaObj . | |
| virtual USD_API | ~UsdTyped () |
| Destructor. | |
| Public Member Functions inherited from UsdSchemaBase | |
| bool | IsConcrete () const |
| Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. | |
| bool | IsTyped () const |
| Returns whether or not this class inherits from UsdTyped. | |
| bool | IsAPISchema () const |
| Returns whether this is an API schema or not. | |
| bool | IsAppliedAPISchema () const |
| Returns whether this is an applied API schema or not. | |
| bool | IsMultipleApplyAPISchema () const |
| Returns whether this is an applied API schema or not. | |
| UsdSchemaKind | GetSchemaKind () const |
| Returns the kind of schema this class is. | |
| USD_API | UsdSchemaBase (const UsdPrim &prim=UsdPrim()) |
Construct and store prim as the held prim. | |
| USD_API | UsdSchemaBase (const UsdSchemaBase &otherSchema) |
Construct and store for the same prim held by otherSchema. | |
| virtual USD_API | ~UsdSchemaBase () |
| Destructor. | |
| UsdPrim | GetPrim () const |
| Return this schema object's held prim. | |
| SdfPath | GetPath () const |
| Shorthand for GetPrim()->GetPath(). | |
| USD_API const UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
| Return the prim definition associated with this schema instance if one exists, otherwise return null. | |
| USD_API | operator bool () const |
| Return true if this schema object is compatible with its held prim, false otherwise. | |
Static Public Member Functions | |
| static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
| static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdTyped holding the prim adhering to this schema at path on stage. | |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Compile time constant representing what kind of schema this class is. | |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Compile time constant representing what kind of schema this class is. | |
Protected Member Functions | |
| USD_API UsdSchemaKind | _GetSchemaKind () const override |
| Returns the kind of schema this class belongs to. | |
| USD_API bool | _IsCompatible () const override |
| Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. | |
| 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 |
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.
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
|
inlineexplicit |
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdSchemaBase.
Reimplemented in UsdGeomBasisCurves, UsdGeomBoundable, UsdGeomCamera, UsdGeomCapsule, UsdGeomCapsule_1, UsdGeomCone, UsdGeomCube, UsdGeomCurves, UsdGeomCylinder, UsdGeomCylinder_1, UsdGeomGprim, UsdGeomHermiteCurves, UsdGeomImageable, UsdGeomMesh, UsdGeomNurbsCurves, UsdGeomNurbsPatch, UsdGeomPlane, UsdGeomPointBased, UsdGeomPointInstancer, UsdGeomPoints, UsdGeomScope, UsdGeomSphere, UsdGeomSubset, UsdGeomTetMesh, UsdGeomXform, UsdGeomXformable, UsdLuxBoundableLightBase, UsdLuxCylinderLight, UsdLuxDiskLight, UsdLuxDistantLight, UsdLuxDomeLight, UsdLuxDomeLight_1, UsdLuxGeometryLight, UsdLuxLightFilter, UsdLuxNonboundableLightBase, UsdLuxPluginLight, UsdLuxPluginLightFilter, UsdLuxPortalLight, UsdLuxRectLight, UsdLuxSphereLight, UsdMediaSpatialAudio, UsdPhysicsCollisionGroup, UsdPhysicsDistanceJoint, UsdPhysicsFixedJoint, UsdPhysicsJoint, UsdPhysicsPrismaticJoint, UsdPhysicsRevoluteJoint, UsdPhysicsScene, UsdPhysicsSphericalJoint, UsdProcGenerativeProcedural, UsdRenderPass, UsdRenderProduct, UsdRenderSettings, UsdRenderSettingsBase, UsdRenderVar, UsdShadeMaterial, UsdShadeNodeGraph, UsdShadeShader, UsdSkelAnimation, UsdSkelBlendShape, UsdSkelRoot, UsdSkelSkeleton, UsdUIBackdrop, UsdVolField3DAsset, UsdVolFieldAsset, UsdVolFieldBase, UsdVolOpenVDBAsset, and UsdVolVolume.
|
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.
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 |
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.
|
friend |
|
static |
Compile time constant representing what kind of schema this class is.
1.9.6 
