PhysxSchemaPhysxPhysicsAttachment Class Reference

Represents attachments between physics actors, for example, between a rigid body and a deformable body, or a deformable body and a particle cloth. More...

Inherits UsdTyped.

Public Member Functions
	PhysxSchemaPhysxPhysicsAttachment (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxPhysicsAttachment on UsdPrim prim . More...
	PhysxSchemaPhysxPhysicsAttachment (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxPhysicsAttachment on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxPhysicsAttachment ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetAttachmentEnabledAttr () const
	Enable or disable the attachment. More...
PHYSXSCHEMA_API UsdAttribute	CreateAttachmentEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAttachmentEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPoints0Attr () const
	Attachment points in Actor 0 local space, defined in the actor's rest state, if it is deformable. More...
PHYSXSCHEMA_API UsdAttribute	CreatePoints0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPoints0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPoints1Attr () const
	Attachment points in Actor 1 local space, defined in the actor's rest state, if it is deformable. More...
PHYSXSCHEMA_API UsdAttribute	CreatePoints1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPoints1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCollisionFilterIndices0Attr () const
	Indices to geometry of Actor 0 that should not generate collisions with Actor 1 as specified by filterType0. More...
PHYSXSCHEMA_API UsdAttribute	CreateCollisionFilterIndices0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionFilterIndices0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetFilterType0Attr () const
	Specify if indices in collisionFilterIndices0 correspond to vertices; or mesh cell-geometry, i.e. More...
PHYSXSCHEMA_API UsdAttribute	CreateFilterType0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFilterType0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCollisionFilterIndices1Attr () const
	Indices to mesh triangle/tet/hex/etc. More...
PHYSXSCHEMA_API UsdAttribute	CreateCollisionFilterIndices1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionFilterIndices1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetFilterType1Attr () const
	Specify if indices in collisionFilterIndices1 correspond to vertices; or mesh cell-geometry, i.e. More...
PHYSXSCHEMA_API UsdAttribute	CreateFilterType1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFilterType1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetActor0Rel () const
	Reference to the first actor. More...
PHYSXSCHEMA_API UsdRelationship	CreateActor0Rel () const
	See GetActor0Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetActor1Rel () const
	Reference to the second actor. More...
PHYSXSCHEMA_API UsdRelationship	CreateActor1Rel () const
	See GetActor1Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetPointsAttr (int index) const
	Helper attribute access via index in [0,1]. More...
PHYSXSCHEMA_API UsdAttribute	GetCollisionFilterIndicesAttr (int index) const
	Helper attribute access via index in [0,1]. More...
PHYSXSCHEMA_API UsdAttribute	GetFilterTypeAttr (int index) const
	Helper attribute access via index in [0,1]. More...
PHYSXSCHEMA_API UsdRelationship	GetActorRel (int index) const
	Helper attribute access via index in [0,1]. 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 PhysxSchemaPhysxPhysicsAttachment	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxPhysicsAttachment holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxPhysicsAttachment	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 UsdSchemaType	schemaType = UsdSchemaType::ConcreteTyped
	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

Detailed Description

Represents attachments between physics actors, for example, between a rigid body and a deformable body, or a deformable body and a particle cloth.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in PhysxSchemaTokens. So to set an attribute to the value "rightHanded", use PhysxSchemaTokens->rightHanded as the value.

Definition at line 62 of file physxPhysicsAttachment.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxPhysicsAttachment ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxPhysicsAttachment on UsdPrim prim .

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

Definition at line 74 of file physxPhysicsAttachment.h.

PhysxSchemaPhysxPhysicsAttachment ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxPhysicsAttachment on the prim held by schemaObj .

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

Definition at line 82 of file physxPhysicsAttachment.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxPhysicsAttachment ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also

UsdSchemaType

PHYSXSCHEMA_API UsdRelationship CreateActor0Rel

(

)

const

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

PHYSXSCHEMA_API UsdRelationship CreateActor1Rel

(

)

const

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

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

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

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

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

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

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

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

See GetPoints1Attr(), 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 PhysxSchemaPhysxPhysicsAttachment 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 PhysxSchemaPhysxPhysicsAttachment Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

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

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

PHYSXSCHEMA_API UsdRelationship GetActor0Rel

(

)

const

Reference to the first actor.

PHYSXSCHEMA_API UsdRelationship GetActor1Rel

(

)

const

Reference to the second actor.

PHYSXSCHEMA_API UsdRelationship GetActorRel

(

int

index

)

const

Helper attribute access via index in [0,1].

See GetActor0Rel() and GetActor1Rel()

PHYSXSCHEMA_API UsdAttribute GetAttachmentEnabledAttr

(

)

const

Enable or disable the attachment.

Declaration	bool attachmentEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndices0Attr

(

)

const

Indices to geometry of Actor 0 that should not generate collisions with Actor 1 as specified by filterType0.

Ignored for rigid bodies.

Declaration	uint[] collisionFilterIndices0
C++ Type	VtArray<unsigned int>
Usd Type	SdfValueTypeNames->UIntArray

PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndices1Attr

(

)

const

Indices to mesh triangle/tet/hex/etc.

of Actor 1 that should not generate collisions with Actor 0. Ignored for rigid bodies.

Declaration	uint[] collisionFilterIndices1
C++ Type	VtArray<unsigned int>
Usd Type	SdfValueTypeNames->UIntArray

PHYSXSCHEMA_API UsdAttribute GetCollisionFilterIndicesAttr

(

int

index

)

const

Helper attribute access via index in [0,1].

See GetCollisionFilterIndices0Attr() and GetCollisionFilterIndices1Attr()

PHYSXSCHEMA_API UsdAttribute GetFilterType0Attr

(

)

const

Specify if indices in collisionFilterIndices0 correspond to vertices; or mesh cell-geometry, i.e.

triangles, tetrahedrons, etc.

Declaration	uniform token filterType0
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	Vertices, Geometry

PHYSXSCHEMA_API UsdAttribute GetFilterType1Attr

(

)

const

Specify if indices in collisionFilterIndices1 correspond to vertices; or mesh cell-geometry, i.e.

triangles, tetrahedrons, etc.

Declaration	uniform token filterType1
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	Vertices, Geometry

PHYSXSCHEMA_API UsdAttribute GetFilterTypeAttr

(

int

index

)

const

Helper attribute access via index in [0,1].

See GetFilterType0Attr() and GetFilterType1Attr()

PHYSXSCHEMA_API UsdAttribute GetPoints0Attr

(

)

const

Attachment points in Actor 0 local space, defined in the actor's rest state, if it is deformable.

Elements correspond one-to-one to elements in points1 attribute.

Declaration	point3f[] points0
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

PHYSXSCHEMA_API UsdAttribute GetPoints1Attr

(

)

const

Attachment points in Actor 1 local space, defined in the actor's rest state, if it is deformable.

Elements correspond one-to-one to elements in points0 attribute.

Declaration	point3f[] points1
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

PHYSXSCHEMA_API UsdAttribute GetPointsAttr

(

int

index

)

const

Helper attribute access via index in [0,1].

See GetPoints0Attr() and GetPoints1Attr()

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 UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped

static

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

See Also

UsdSchemaType

Definition at line 68 of file physxPhysicsAttachment.h.

---

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

• W:/919a5455eee1e83c/src/physxSchema/physxPhysicsAttachment.h