Core class for instancing physics prims. More...
Inheritance diagram for PhysxSchemaPhysxPhysicsInstancer:Public Member Functions | |
| PhysxSchemaPhysxPhysicsInstancer (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxPhysicsInstancer on UsdPrim prim . More... | |
| PhysxSchemaPhysxPhysicsInstancer (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxPhysicsInstancer on the prim held by schemaObj . More... | |
| virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxPhysicsInstancer () |
| Destructor. More... | |
| PHYSXSCHEMA_API UsdAttribute | GetPhysicsProtoIndicesAttr () const |
| Required property. More... | |
| PHYSXSCHEMA_API UsdAttribute | CreatePhysicsProtoIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
| See GetPhysicsProtoIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
| PHYSXSCHEMA_API UsdRelationship | GetPhysicsPrototypesRel () const |
| Required property. More... | |
| PHYSXSCHEMA_API UsdRelationship | CreatePhysicsPrototypesRel () const |
| See GetPhysicsPrototypesRel(), 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) |
| Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
| static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsInstancer | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxPhysicsInstancer holding the prim adhering to this schema at path on stage. More... | |
| static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsInstancer | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More... | |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
| Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
| PHYSXSCHEMA_API UsdSchemaKind | _GetSchemaKind () const override |
| Returns the kind of schema this class belongs to. More... | |
Friends | |
| class | UsdSchemaRegistry |
Core class for instancing physics prims.
Definition at line 57 of file physxPhysicsInstancer.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxPhysicsInstancer on UsdPrim prim .
Equivalent to PhysxSchemaPhysxPhysicsInstancer::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
Definition at line 69 of file physxPhysicsInstancer.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxPhysicsInstancer on the prim held by schemaObj .
Should be preferred over PhysxSchemaPhysxPhysicsInstancer(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 77 of file physxPhysicsInstancer.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the kind of schema this class belongs to.
| PHYSXSCHEMA_API UsdAttribute CreatePhysicsProtoIndicesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetPhysicsProtoIndicesAttr(), 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.
| PHYSXSCHEMA_API UsdRelationship CreatePhysicsPrototypesRel | ( | ) | const |
See GetPhysicsPrototypesRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
|
static |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.
The given path must be an absolute prim path that does not contain any variant selections.
If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.
Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.
|
static |
Return a PhysxSchemaPhysxPhysicsInstancer 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:
| PHYSXSCHEMA_API UsdAttribute GetPhysicsProtoIndicesAttr | ( | ) | const |
Required property.
Per-instance index into prototypes relationship that identifies what physics prims are instanced. Topology attribute - can be animated, but at a potential performance impact for streaming.
| Declaration | int[] physics:protoIndices |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| PHYSXSCHEMA_API UsdRelationship GetPhysicsPrototypesRel | ( | ) | const |
Required property.
Orders and targets the prototype root prims, which can be located anywhere in the scenegraph that is convenient, although we promote organizing prototypes as children of the PhysxPhysicsInstancer. The position of a prototype in this relationship defines the value an instance would specify in the protoIndices attribute to instance that prototype. Since relationships are uniform, this property cannot be animated.
|
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.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 63 of file physxPhysicsInstancer.h.
1.8.5 
