PhysxSchemaPhysxPhysicsJointInstancer Class Reference

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

Inheritance diagram for PhysxSchemaPhysxPhysicsJointInstancer:

Public Member Functions
	PhysxSchemaPhysxPhysicsJointInstancer (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxPhysicsJointInstancer on UsdPrim prim . More...
	PhysxSchemaPhysxPhysicsJointInstancer (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxPhysicsJointInstancer on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxPhysicsJointInstancer ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetPhysicsBody0IndicesAttr () const
	Optional property. More...
PHYSXSCHEMA_API UsdAttribute	CreatePhysicsBody0IndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysicsBody0IndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPhysicsBody1IndicesAttr () const
	Optional property. More...
PHYSXSCHEMA_API UsdAttribute	CreatePhysicsBody1IndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysicsBody1IndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPhysicsLocalPos0sAttr () const
	Required property. More...
PHYSXSCHEMA_API UsdAttribute	CreatePhysicsLocalPos0sAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysicsLocalPos0sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPhysicsLocalRot0sAttr () const
	Required property. More...
PHYSXSCHEMA_API UsdAttribute	CreatePhysicsLocalRot0sAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysicsLocalRot0sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPhysicsLocalPos1sAttr () const
	Required property. More...
PHYSXSCHEMA_API UsdAttribute	CreatePhysicsLocalPos1sAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysicsLocalPos1sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPhysicsLocalRot1sAttr () const
	Required property. More...
PHYSXSCHEMA_API UsdAttribute	CreatePhysicsLocalRot1sAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPhysicsLocalRot1sAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetPhysicsBody0sRel () const
	Required property. More...
PHYSXSCHEMA_API UsdRelationship	CreatePhysicsBody0sRel () const
	See GetPhysicsBody0sRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetPhysicsBody1sRel () const
	Required property. More...
PHYSXSCHEMA_API UsdRelationship	CreatePhysicsBody1sRel () const
	See GetPhysicsBody1sRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
Public Member Functions inherited from PhysxSchemaPhysxPhysicsInstancer
	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 PhysxSchemaPhysxPhysicsJointInstancer	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxPhysicsJointInstancer holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsJointInstancer	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 Member Functions inherited from PhysxSchemaPhysxPhysicsInstancer
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...
Static Public Attributes inherited from PhysxSchemaPhysxPhysicsInstancer
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...
Protected Member Functions inherited from PhysxSchemaPhysxPhysicsInstancer
PHYSXSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

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

Definition at line 57 of file physxPhysicsJointInstancer.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxPhysicsJointInstancer ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

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

Definition at line 69 of file physxPhysicsJointInstancer.h.

PhysxSchemaPhysxPhysicsJointInstancer ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxPhysicsJointInstancer on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxPhysicsJointInstancer(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file physxPhysicsJointInstancer.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxPhysicsJointInstancer ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

PHYSXSCHEMA_API UsdAttribute CreatePhysicsBody0IndicesAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

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

(

)

const

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

PHYSXSCHEMA_API UsdAttribute CreatePhysicsBody1IndicesAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

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

(

)

const

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

PHYSXSCHEMA_API UsdAttribute CreatePhysicsLocalPos0sAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetPhysicsLocalPos0sAttr(), 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 UsdAttribute CreatePhysicsLocalPos1sAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetPhysicsLocalPos1sAttr(), 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 UsdAttribute CreatePhysicsLocalRot0sAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetPhysicsLocalRot0sAttr(), 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 UsdAttribute CreatePhysicsLocalRot1sAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetPhysicsLocalRot1sAttr(), 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 PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsJointInstancer Define ( const UsdStagePtr &  stage, const SdfPath &  path  )

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 PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsJointInstancer Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxPhysicsJointInstancer 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:

*  PhysxSchemaPhysxPhysicsJointInstancer(stage->GetPrimAtPath(path));
*  

PHYSXSCHEMA_API 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

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

PHYSXSCHEMA_API 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

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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

static PHYSXSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true )

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.

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also

UsdSchemaKind

Definition at line 63 of file physxPhysicsJointInstancer.h.

---

The documentation for this class was generated from the following file:

• C:/g/19412595/omni/schema/source/physxSchema/physxPhysicsJointInstancer.h