usdrt::UsdModelAPI

Defined in usdrt/scenegraph/usd/usd/modelAPI.h

Functions

usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdModelAPI::UsdModelAPI: Construct a UsdModelAPI on the prim held by schemaObj . Should be preferred over UsdModelAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdModelAPI::UsdModelAPI: Construct a UsdModelAPI on UsdPrim prim . Equivalent to UsdModelAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdModelAPI::operator bool: Boolean operator.
usdrt::UsdModelAPI::~UsdModelAPI: Destructor.

Variables

usdrt::UsdModelAPI::schemaType: Compile time constant representing what kind of schema this class is.

class UsdModelAPI : public usdrt::UsdAPISchemaBase 

UsdModelAPI is an API schema that provides an interface to a prim’s model qualities, if it does, in fact, represent the root prim of a model.

The first and foremost model quality is its kind, i.e. the metadata that establishes it as a model (See KindRegistry). UsdModelAPI provides various methods for setting and querying the prim’s kind, as well as queries (also available on UsdPrim) for asking what category of model the prim is. See Kind and Model-ness.

UsdModelAPI also provides access to a prim’s assetInfo data. While any prim can host assetInfo, it is common that published (referenced) assets are packaged as models, therefore it is convenient to provide access to the one from the other.

Todo:

establish an _IsCompatible() override that returns IsModel()

GetModelInstanceName()

Public Functions

inline explicit UsdModelAPI(const UsdPrim &prim = UsdPrim()): Construct a UsdModelAPI on UsdPrim prim. Equivalent to UsdModelAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdModelAPI(const UsdSchemaBase &schemaObj): Construct a UsdModelAPI on the prim held by schemaObj . Should be preferred over UsdModelAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdModelAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::NonAppliedAPI 

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