usdrt::PhysxSchemaPhysxPhysicsJointInstancer

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

Functions

Variables

class PhysxSchemaPhysxPhysicsJointInstancer : public usdrt::PhysxSchemaPhysxPhysicsInstancer

Physics joint instancer, the prototypes are expected to be UsdPhysicsJoint prim types.

Public Functions

inline explicit PhysxSchemaPhysxPhysicsJointInstancer(const UsdPrim &prim = UsdPrim())

Construct a PhysxSchemaPhysxPhysicsJointInstancer on UsdPrim prim. Equivalent to PhysxSchemaPhysxPhysicsJointInstancer::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxPhysicsJointInstancer(const UsdSchemaBase &schemaObj)

Construct a PhysxSchemaPhysxPhysicsJointInstancer on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxPhysicsJointInstancer(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxPhysicsJointInstancer()

Destructor.

inline operator bool() const

Boolean operator.

Returns

Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

inline UsdAttribute GetPhysicsBody0IndicesAttr() const

Optional property. Only applicable if body0s is a point instancer. An index specifies the per-instance body0 rel as the rigid body at the body0s-instancer’s protoIndices[index].

Declaration

int[] physics:body0Indices

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreatePhysicsBody0IndicesAttr() const

See GetPhysicsBody0IndicesAttr(), 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.

inline UsdAttribute GetPhysicsBody1IndicesAttr() const

Optional property. Only applicable if body0s is a point instancer. An index specifies the per-instance body0 rel as the rigid body at the body0s-instancer’s protoIndices[index].

Declaration

int[] physics:body1Indices

C++ Type

VtArray<int>

Usd Type

SdfValueTypeNames->IntArray

inline UsdAttribute CreatePhysicsBody1IndicesAttr() const

See GetPhysicsBody1IndicesAttr(), 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.

inline UsdAttribute GetPhysicsLocalPos0sAttr() const

Required property. Per-instance localPos0. This transformation is added on top of the joint localPos0.

Declaration

point3f[] physics:localPos0s

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreatePhysicsLocalPos0sAttr() const

See GetPhysicsLocalPos0sAttr(), 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.

inline UsdAttribute GetPhysicsLocalRot0sAttr() const

Required property. Per-instance localRot0. This transformation is added on top of the joint localPos0.

Declaration

quath[] physics:localRot0s

C++ Type

VtArray<GfQuath>

Usd Type

SdfValueTypeNames->QuathArray

inline UsdAttribute CreatePhysicsLocalRot0sAttr() const

See GetPhysicsLocalRot0sAttr(), 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.

inline UsdAttribute GetPhysicsLocalPos1sAttr() const

Required property. Per-instance localPos1. This transformation is added on top of the joint localPos1.

Declaration

point3f[] physics:localPos1s

C++ Type

VtArray<GfVec3f>

Usd Type

SdfValueTypeNames->Point3fArray

inline UsdAttribute CreatePhysicsLocalPos1sAttr() const

See GetPhysicsLocalPos1sAttr(), 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.

inline UsdAttribute GetPhysicsLocalRot1sAttr() const

Required property. Per-instance localRot1. This transformation is added on top of the joint localPos0.

Declaration

quath[] physics:localRot1s

C++ Type

VtArray<GfQuath>

Usd Type

SdfValueTypeNames->QuathArray

inline UsdAttribute CreatePhysicsLocalRot1sAttr() const

See GetPhysicsLocalRot1sAttr(), 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.

inline UsdRelationship GetPhysicsBody0sRel() const

Required property. The rel must contain either exactly one UsdGeomPointInstancer that instances rigid bodies; or one or more rigid-body prims in the stage. If the rel is to a point instancer, the body0Indices must be specified.

inline UsdRelationship CreatePhysicsBody0sRel() const

See GetPhysicsBody0sRel(), and also Create vs Get Property Methods for when to use Get vs Create.

inline UsdRelationship GetPhysicsBody1sRel() const

Required property. The rel must contain either exactly one UsdGeomPointInstancer that instances rigid bodies; or one or more rigid-body prims in the stage. If the rel is to a point instancer, the body0Indices must be specified.

inline UsdRelationship CreatePhysicsBody1sRel() const

See GetPhysicsBody1sRel(), and also Create vs Get Property Methods for when to use Get vs Create.

inline 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

inline UsdAttribute CreatePhysicsProtoIndicesAttr() const

See GetPhysicsProtoIndicesAttr(), 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.

inline 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.

inline UsdRelationship CreatePhysicsPrototypesRel() const

See GetPhysicsPrototypesRel(), and also Create vs Get Property Methods for when to use Get vs Create.

inline UsdAttribute GetVisibilityAttr() const

Visibility is meant to be the simplest form of “pruning” visibility that is supported by most DCC apps. Visibility is animatable, allowing a sub-tree of geometry to be present for some segment of a shot, and absent from others; unlike the action of deactivating geometry prims, invisible geometry is still available for inspection, for positioning, for defining volumes, etc.

Declaration

token visibility = "inherited"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Allowed Values

inherited, invisible

inline UsdAttribute CreateVisibilityAttr() const

See GetVisibilityAttr(), 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.

inline UsdAttribute GetPurposeAttr() const

Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.

See UsdGeom_ImageablePurpose for more detail about how purpose is computed and used.

Declaration

uniform token purpose = "default"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Variability

SdfVariabilityUniform

Allowed Values

default, render, proxy, guide

inline UsdAttribute CreatePurposeAttr() const

See GetPurposeAttr(), 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.

inline UsdRelationship GetProxyPrimRel() const

The proxyPrim relationship allows us to link a prim whose purpose is “render” to its (single target) purpose=”proxy” prim. This is entirely optional, but can be useful in several scenarios:

  • In a pipeline that does pruning (for complexity management) by deactivating prims composed from asset references, when we deactivate a purpose=”render” prim, we will be able to discover and additionally deactivate its associated purpose=”proxy” prim, so that preview renders reflect the pruning accurately.

  • DCC importers may be able to make more aggressive optimizations for interactive processing and display if they can discover the proxy for a given render prim.

  • With a little more work, a Hydra-based application will be able to map a picked proxy prim back to its render geometry for selection.

Note

It is only valid to author the proxyPrim relationship on prims whose purpose is “render”.

inline UsdRelationship CreateProxyPrimRel() const

See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create.

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 PhysxSchemaPhysxPhysicsJointInstancer Define(const UsdStageRefPtr &stage, const SdfPath &path)

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped

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

See also

UsdSchemaType