PhysxSchemaPhysxDeformableAPI Class Reference

Do not apply. More...

Inheritance diagram for PhysxSchemaPhysxDeformableAPI:

Public Member Functions
	PhysxSchemaPhysxDeformableAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxDeformableAPI on UsdPrim prim . More...
	PhysxSchemaPhysxDeformableAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxDeformableAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxDeformableAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetDeformableEnabledAttr () const
	Enable or disable the deformable object. More...
PHYSXSCHEMA_API UsdAttribute	CreateDeformableEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDeformableEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSolverPositionIterationCountAttr () const
	Number of solver position iterations per time step. More...
PHYSXSCHEMA_API UsdAttribute	CreateSolverPositionIterationCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSolverPositionIterationCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetVertexVelocityDampingAttr () const
	Artificial damping on the vertex velocity, which may approximate aerodynamic drag. More...
PHYSXSCHEMA_API UsdAttribute	CreateVertexVelocityDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVertexVelocityDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSleepDampingAttr () const
	Additional damping term if vertex velocity drops below settlingThreshold. More...
PHYSXSCHEMA_API UsdAttribute	CreateSleepDampingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSleepDampingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSleepThresholdAttr () const
	Velocity threshold under which the vertex becomes a candidate for sleeping. More...
PHYSXSCHEMA_API UsdAttribute	CreateSleepThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSleepThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSettlingThresholdAttr () const
	Threshold vertex velocity under which sleep damping is applied in addition to velocity damping. More...
PHYSXSCHEMA_API UsdAttribute	CreateSettlingThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSettlingThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSelfCollisionAttr () const
	Enables self collisions on the deformable, preventing self intersections. More...
PHYSXSCHEMA_API UsdAttribute	CreateSelfCollisionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSelfCollisionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSelfCollisionFilterDistanceAttr () const
	Distance under which self-collisions are disabled. More...
PHYSXSCHEMA_API UsdAttribute	CreateSelfCollisionFilterDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSelfCollisionFilterDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetEnableCCDAttr () const
	Distance based CCD. More...
PHYSXSCHEMA_API UsdAttribute	CreateEnableCCDAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableCCDAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetRestPointsAttr () const
	Rest points of the UsdGeomMesh in local coordinates. More...
PHYSXSCHEMA_API UsdAttribute	CreateRestPointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRestPointsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSimulationVelocitiesAttr () const
	Simulation mesh vertex velocities in local coordinates. More...
PHYSXSCHEMA_API UsdAttribute	CreateSimulationVelocitiesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationVelocitiesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSimulationIndicesAttr () const
	Simulation mesh indices. More...
PHYSXSCHEMA_API UsdAttribute	CreateSimulationIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSimulationIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetSimulationOwnerRel () const
	Single PhysicsScene that simulates this deformable. More...
PHYSXSCHEMA_API UsdRelationship	CreateSimulationOwnerRel () const
	See GetSimulationOwnerRel(), 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 PhysxSchemaPhysxDeformableAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxDeformableAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim. More...

Static Public Attributes
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	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

Do not apply.

Base API that provides attributes common to both deformable bodies and surfaces. Derived APIs are applied to UsdGeomMesh in order to create a deformable physics object. Note that the UsdGeomMesh points attribute becomes a read-only attribute for a deformable as the mesh is driven by the simulation.

Definition at line 60 of file physxDeformableAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxDeformableAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableAPI on UsdPrim prim .

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

Definition at line 72 of file physxDeformableAPI.h.

PhysxSchemaPhysxDeformableAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableAPI on the prim held by schemaObj .

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

Definition at line 80 of file physxDeformableAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also

UsdSchemaType

static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableAPI Apply ( const UsdPrim &  prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxDeformableAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns

A valid PhysxSchemaPhysxDeformableAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxDeformableAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

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

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

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

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

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

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

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

See GetSimulationIndicesAttr(), 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 CreateSimulationOwnerRel

(

)

const

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

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetDeformableEnabledAttr

(

)

const

Enable or disable the deformable object.

Declaration	bool physxDeformable:deformableEnabled = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetEnableCCDAttr

(

)

const

Distance based CCD.

Declaration	bool physxDeformable:enableCCD = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetRestPointsAttr

(

)

const

Rest points of the UsdGeomMesh in local coordinates.

Units: distance

Declaration	point3f[] physxDeformable:restPoints
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

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.

PHYSXSCHEMA_API UsdAttribute GetSelfCollisionAttr

(

)

const

Enables self collisions on the deformable, preventing self intersections.

Declaration	bool physxDeformable:selfCollision = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetSelfCollisionFilterDistanceAttr

(

)

const

Distance under which self-collisions are disabled.

Default value -inf means default is picked by the simulation. Range: [2*physxCollision:contactOffset, max_float] Units: distance

Declaration	float physxDeformable:selfCollisionFilterDistance = -inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSettlingThresholdAttr

(

)

const

Threshold vertex velocity under which sleep damping is applied in addition to velocity damping.

Range: [0, inf] Units: distance/seconds

Declaration	float physxDeformable:settlingThreshold = 0.1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSimulationIndicesAttr

(

)

const

Simulation mesh indices.

Declaration	uniform int[] physxDeformable:simulationIndices
C++ Type	VtArray<int>
Usd Type	SdfValueTypeNames->IntArray
Variability	SdfVariabilityUniform

PHYSXSCHEMA_API UsdRelationship GetSimulationOwnerRel

(

)

const

Single PhysicsScene that simulates this deformable.

By default, this is the first PhysicsScene found in the stage using UsdStage::Traverse().

PHYSXSCHEMA_API UsdAttribute GetSimulationVelocitiesAttr

(

)

const

Simulation mesh vertex velocities in local coordinates.

Units: distance / seconds

Declaration	point3f[] physxDeformable:simulationVelocities
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Point3fArray

PHYSXSCHEMA_API UsdAttribute GetSleepDampingAttr

(

)

const

Additional damping term if vertex velocity drops below settlingThreshold.

Range: [0, inf) Units: 1/seconds

Declaration	float physxDeformable:sleepDamping = 10
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSleepThresholdAttr

(

)

const

Velocity threshold under which the vertex becomes a candidate for sleeping.

Range: [0, inf) Units: distance/seconds

Declaration	float physxDeformable:sleepThreshold = 0.05
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetSolverPositionIterationCountAttr

(

)

const

Number of solver position iterations per time step.

Range: [1, 255]

Declaration	uint physxDeformable:solverPositionIterationCount = 16
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetVertexVelocityDampingAttr

(

)

const

Artificial damping on the vertex velocity, which may approximate aerodynamic drag.

Range: [0, inf) Units: 1/seconds

Declaration	float physxDeformable:vertexVelocityDamping = 0.005
C++ Type	float
Usd Type	SdfValueTypeNames->Float

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

static

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

See Also

UsdSchemaType

Definition at line 66 of file physxDeformableAPI.h.

---

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

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