usdrt::UsdGeomPrimvarsAPI

Defined in usdrt/scenegraph/usd/usdGeom/primvarsAPI.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::UsdGeomPrimvarsAPI::UsdGeomPrimvarsAPI: Construct a UsdGeomPrimvarsAPI on the prim held by schemaObj . Should be preferred over UsdGeomPrimvarsAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdGeomPrimvarsAPI::UsdGeomPrimvarsAPI: Construct a UsdGeomPrimvarsAPI on UsdPrim prim . Equivalent to UsdGeomPrimvarsAPI::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::UsdGeomPrimvarsAPI::operator bool: Boolean operator.
usdrt::UsdGeomPrimvarsAPI::~UsdGeomPrimvarsAPI: Destructor.

Variables

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

class UsdGeomPrimvarsAPI : public usdrt::UsdAPISchemaBase 

UsdGeomPrimvarsAPI encodes geometric “primitive variables”, as UsdGeomPrimvar, which interpolate across a primitive’s topology, can override shader inputs, and inherit down namespace.

Which Method to Use to Retrieve Primvars

While creating primvars is unambiguous (CreatePrimvar()), there are quite a few methods available for retrieving primvars, making it potentially confusing knowing which one to use. Here are some guidelines:

If you are populating a GUI with the primvars already available for authoring values on a prim, use GetPrimvars().
If you want all of the “useful” (e.g. to a renderer) primvars available at a prim, including those inherited from ancestor prims, use FindPrimvarsWithInheritance(). Note that doing so individually for many prims will be inefficient.
To find a particular primvar defined directly on a prim, which may or may not provide a value, use GetPrimvar().
To find a particular primvar defined on a prim or inherited from ancestors, which may or may not provide a value, use FindPrimvarWithInheritance().
To efficiently query for primvars using the overloads of FindPrimvarWithInheritance() and FindPrimvarsWithInheritance(), one must first cache the results of FindIncrementallyInheritablePrimvars() for each non-leaf prim on the stage.

Public Functions

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

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

inline virtual ~UsdGeomPrimvarsAPI(): 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.