usdrt::PhysxSchemaPhysxCookedDataAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxCookedDataAPI.h

Functions

usdrt::PhysxSchemaPhysxCookedDataAPI::Apply: Applies this multiple-apply API schema to the given prim along with the given instance name, name .
usdrt::PhysxSchemaPhysxCookedDataAPI::CreateBufferAttr: See GetBufferAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCookedDataAPI::GetBufferAttr
usdrt::PhysxSchemaPhysxCookedDataAPI::GetName: Returns the name of this multiple-apply schema instance.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxCookedDataAPI::PhysxSchemaPhysxCookedDataAPI: Construct a PhysxSchemaPhysxCookedDataAPI on UsdPrim prim with name name . Equivalent to PhysxSchemaPhysxCookedDataAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "physxCookedData:name"));.
usdrt::PhysxSchemaPhysxCookedDataAPI::PhysxSchemaPhysxCookedDataAPI: Construct a PhysxSchemaPhysxCookedDataAPI on the prim held by schemaObj with name name . Should be preferred over PhysxSchemaPhysxCookedDataAPI (schemaObj.GetPrim(), name), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxCookedDataAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxCookedDataAPI::~PhysxSchemaPhysxCookedDataAPI: Destructor.

Variables

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

class PhysxSchemaPhysxCookedDataAPI : public usdrt::UsdAPISchemaBase 

PhysX cooked data storage.

Public Functions

inline explicit PhysxSchemaPhysxCookedDataAPI(const UsdPrim &prim = UsdPrim(), const TfToken &name = TfToken())

Construct a PhysxSchemaPhysxCookedDataAPI on UsdPrim prim with name name . Equivalent to PhysxSchemaPhysxCookedDataAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( “physxCookedData:name”));.

for a valid prim , but will not immediately throw an error for an invalid prim

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

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

inline TfToken GetName() const: Returns the name of this multiple-apply schema instance.

inline UsdAttribute GetBufferAttr() const


Declaration	`uchar[] buffer`
C++ Type	VtArray<unsigned char>
Usd Type	SdfValueTypeNames->UCharArray

inline UsdAttribute CreateBufferAttr() const: See GetBufferAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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 Functions

static inline PhysxSchemaPhysxCookedDataAPI Apply(const UsdPrim &prim, const TfToken &name)

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding “PhysxCookedDataAPI:<i>name</i>” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysxCookedDataAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns: A valid PhysxSchemaPhysxCookedDataAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCookedDataAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::MultipleApplyAPI 

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.