WARNING: This is a draft API; the design is not fixed and may change in the future. More...

Inheritance diagram for PhysxSchemaPhysxDeformableSurfaceAPI:

Public Member Functions
	PhysxSchemaPhysxDeformableSurfaceAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxDeformableSurfaceAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxDeformableSurfaceAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxDeformableSurfaceAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxDeformableSurfaceAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetBendingStiffnessScaleAttr () const
	Scales bending stiffness computed from young's modulus and the cloth thickness. More...

PHYSXSCHEMA_API UsdAttribute	CreateBendingStiffnessScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBendingStiffnessScaleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Public Member Functions inherited from PhysxSchemaPhysxDeformableAPI
	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 PhysxSchemaPhysxDeformableSurfaceAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxDeformableSurfaceAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxDeformableSurfaceAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Member Functions inherited from PhysxSchemaPhysxDeformableAPI
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...

Static Public Attributes inherited from PhysxSchemaPhysxDeformableAPI
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...

Protected Member Functions inherited from PhysxSchemaPhysxDeformableAPI
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

WARNING: This is a draft API; the design is not fixed and may change in the future.

Applied to a UsdGeomMesh that is to be simulated as a deformable surface. See PhysxDeformableAPI for information on how to define the deformable surface's material properties.

Definition at line 59 of file physxDeformableSurfaceAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxDeformableSurfaceAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableSurfaceAPI on UsdPrim prim .

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

Definition at line 71 of file physxDeformableSurfaceAPI.h.

PhysxSchemaPhysxDeformableSurfaceAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxDeformableSurfaceAPI on the prim held by schemaObj .

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

Definition at line 79 of file physxDeformableSurfaceAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDeformableSurfaceAPI ( )

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 PhysxSchemaPhysxDeformableSurfaceAPI Apply ( const UsdPrim & prim )

static

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

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

Returns: A valid PhysxSchemaPhysxDeformableSurfaceAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxDeformableSurfaceAPI 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 CreateBendingStiffnessScaleAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetBendingStiffnessScaleAttr ( ) const

Scales bending stiffness computed from young's modulus and the cloth thickness.

Range: [0, inf) Units: dimensionless


Declaration	`float physxDeformable:bendingStiffnessScale = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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::SingleApplyAPI

static

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

See Also: UsdSchemaType

Definition at line 65 of file physxDeformableSurfaceAPI.h.

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

W:/919a5455eee1e83c/src/physxSchema/physxDeformableSurfaceAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation