PhysX cooked data storage. More...
Inherits UsdAPISchemaBase.
Public Member Functions | |||||||||
PhysxSchemaPhysxCookedDataAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken()) | |||||||||
Construct a PhysxSchemaPhysxCookedDataAPI on UsdPrim prim with name name . More... | |||||||||
PhysxSchemaPhysxCookedDataAPI (const UsdSchemaBase &schemaObj, const TfToken &name) | |||||||||
Construct a PhysxSchemaPhysxCookedDataAPI on the prim held by schemaObj with name name . More... | |||||||||
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxCookedDataAPI () | ||||||||
Destructor. More... | |||||||||
TfToken | GetName () const | ||||||||
Returns the name of this multiple-apply schema instance. More... | |||||||||
PHYSXSCHEMA_API UsdAttribute | GetBufferAttr () const | ||||||||
| |||||||||
PHYSXSCHEMA_API UsdAttribute | CreateBufferAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const | ||||||||
See GetBufferAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |||||||||
Static Public Member Functions | |
static PHYSXSCHEMA_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true, const TfToken instanceName=TfToken()) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxCookedDataAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxCookedDataAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxCookedDataAPI | Get (const UsdPrim &prim, const TfToken &name) |
Return a PhysxSchemaPhysxCookedDataAPI with name name holding the prim prim . More... | |
static PHYSXSCHEMA_API bool | IsSchemaPropertyBaseName (const TfToken &baseName) |
Checks if the given name baseName is the base name of a property of PhysxCookedDataAPI. More... | |
static PHYSXSCHEMA_API bool | IsPhysxCookedDataAPIPath (const SdfPath &path, TfToken *name) |
Checks if the given path path is of an API schema of type PhysxCookedDataAPI. More... | |
static PHYSXSCHEMA_API 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 . More... | |
Static Public Attributes | |
static const UsdSchemaType | schemaType = UsdSchemaType::MultipleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
PhysX cooked data storage.
Definition at line 57 of file physxCookedDataAPI.h.
|
inlineexplicit |
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
Definition at line 74 of file physxCookedDataAPI.h.
|
inlineexplicit |
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.
Definition at line 83 of file physxCookedDataAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
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'.
PHYSXSCHEMA_API UsdAttribute CreateBufferAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetBufferAttr(), and also Usd_Create_Or_Get_Property 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
.
|
static |
Return a PhysxSchemaPhysxCookedDataAPI 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. path
must be of the format <path>.physxCookedData:name .
This is shorthand for the following:
|
static |
Return a PhysxSchemaPhysxCookedDataAPI with name name
holding the prim prim
.
Shorthand for PhysxSchemaPhysxCookedDataAPI(prim, name);
PHYSXSCHEMA_API UsdAttribute GetBufferAttr | ( | ) | const |
Declaration | uchar[] buffer |
C++ Type | VtArray<unsigned char> |
Usd Type | SdfValueTypeNames->UCharArray |
|
inline |
Returns the name of this multiple-apply schema instance.
Definition at line 103 of file physxCookedDataAPI.h.
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.
Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.
|
static |
Checks if the given path path
is of an API schema of type PhysxCookedDataAPI.
If so, it stores the instance name of the schema in name
and returns true. Otherwise, it returns false.
|
static |
Checks if the given name baseName
is the base name of a property of PhysxCookedDataAPI.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 63 of file physxCookedDataAPI.h.