PhysxSchemaPhysxSceneAPI Class Reference

PhysX scene extended parameters. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxSceneAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxSceneAPI on UsdPrim prim . More...
	PhysxSchemaPhysxSceneAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxSceneAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxSceneAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetBounceThresholdAttr () const
	A contact with a relative velocity below this will not bounce. More...
PHYSXSCHEMA_API UsdAttribute	CreateBounceThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBounceThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetFrictionOffsetThresholdAttr () const
	A threshold of contact separation distance used to decide if a contact point will experience friction forces. More...
PHYSXSCHEMA_API UsdAttribute	CreateFrictionOffsetThresholdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFrictionOffsetThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetFrictionCorrelationDistanceAttr () const
	Friction correlation distance used to decide whether contacts are close enough to be merged into a single friction anchor point or not. More...
PHYSXSCHEMA_API UsdAttribute	CreateFrictionCorrelationDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFrictionCorrelationDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxBiasCoefficientAttr () const
	The maximum bias coefficient used in the constraint solver. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxBiasCoefficientAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxBiasCoefficientAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetCollisionSystemAttr () const
	Collision detection system. More...
PHYSXSCHEMA_API UsdAttribute	CreateCollisionSystemAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionSystemAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetSolverTypeAttr () const
	Solver used for the simulation. More...
PHYSXSCHEMA_API UsdAttribute	CreateSolverTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSolverTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetBroadphaseTypeAttr () const
	Broad phase algorithm used in the simulation. More...
PHYSXSCHEMA_API UsdAttribute	CreateBroadphaseTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBroadphaseTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetFrictionTypeAttr () const
	Friction type used in simulation. More...
PHYSXSCHEMA_API UsdAttribute	CreateFrictionTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFrictionTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetEnableCCDAttr () const
	Enables a second broad phase check after integration that makes it possible to prevent objects from tunneling through each other. 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	GetEnableStabilizationAttr () const
	Enables additional stabilization pass in solver. More...
PHYSXSCHEMA_API UsdAttribute	CreateEnableStabilizationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableStabilizationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetUpdateTypeAttr () const
	Type of update for a PhysX scene. More...
PHYSXSCHEMA_API UsdAttribute	CreateUpdateTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetUpdateTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetEnableGPUDynamicsAttr () const
	Enables the GPU dynamics pipeline. More...
PHYSXSCHEMA_API UsdAttribute	CreateEnableGPUDynamicsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableGPUDynamicsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetEnableEnhancedDeterminismAttr () const
	Provides improved determinism at the expense of performance. More...
PHYSXSCHEMA_API UsdAttribute	CreateEnableEnhancedDeterminismAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableEnhancedDeterminismAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetEnableSceneQuerySupportAttr () const
	Enables scene query support for collision shapes. More...
PHYSXSCHEMA_API UsdAttribute	CreateEnableSceneQuerySupportAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetEnableSceneQuerySupportAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetTimeStepsPerSecondAttr () const
	Simulation scene step defined as number of steps per second. More...
PHYSXSCHEMA_API UsdAttribute	CreateTimeStepsPerSecondAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetTimeStepsPerSecondAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuTempBufferCapacityAttr () const
	Gpu temp buffer capacity. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuTempBufferCapacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuTempBufferCapacityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuMaxRigidContactCountAttr () const
	Gpu max rigid contact count. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuMaxRigidContactCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuMaxRigidContactCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuMaxRigidPatchCountAttr () const
	Gpu max rigid patch count. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuMaxRigidPatchCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuMaxRigidPatchCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuHeapCapacityAttr () const
	Gpu heap capacity. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuHeapCapacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuHeapCapacityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuFoundLostPairsCapacityAttr () const
	Gpu found lost pairs capacity. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuFoundLostPairsCapacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuFoundLostPairsCapacityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuFoundLostAggregatePairsCapacityAttr () const
	Gpu found lost aggregate pairs capacity. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuFoundLostAggregatePairsCapacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuFoundLostAggregatePairsCapacityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuTotalAggregatePairsCapacityAttr () const
	Gpu total aggregate pairs capacity. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuTotalAggregatePairsCapacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuTotalAggregatePairsCapacityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuMaxSoftBodyContactsAttr () const
	Gpu max soft body contacts. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuMaxSoftBodyContactsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuMaxSoftBodyContactsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuMaxParticleContactsAttr () const
	Gpu max particle contacts. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuMaxParticleContactsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuMaxParticleContactsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuMaxNumPartitionsAttr () const
	Limitation for the partitions in the GPU dynamics pipeline. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuMaxNumPartitionsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuMaxNumPartitionsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetGpuCollisionStackSizeAttr () const
	Gpu collision stack size. More...
PHYSXSCHEMA_API UsdAttribute	CreateGpuCollisionStackSizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGpuCollisionStackSizeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetInvertCollisionGroupFilterAttr () const
	Boolean attribute indicating whether inverted collision group filtering should be used. More...
PHYSXSCHEMA_API UsdAttribute	CreateInvertCollisionGroupFilterAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetInvertCollisionGroupFilterAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetReportKinematicKinematicPairsAttr () const
	Boolean attribute indicating whether kinematic vs kinematic pairs generate contact reports. More...
PHYSXSCHEMA_API UsdAttribute	CreateReportKinematicKinematicPairsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetReportKinematicKinematicPairsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetReportKinematicStaticPairsAttr () const
	Boolean attribute indicating whether kinematic vs static pairs generate contact reports. More...
PHYSXSCHEMA_API UsdAttribute	CreateReportKinematicStaticPairsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetReportKinematicStaticPairsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMinIterationCountAttr () const
	Minimum iteration count for all actors (rigid bodies, cloth, particles etc). More...
PHYSXSCHEMA_API UsdAttribute	CreateMinIterationCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMinIterationCountAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxIterationCountAttr () const
	Maximum iteration count for all actors (rigid bodies, cloth, particles etc). More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxIterationCountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxIterationCountAttr(), 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 PhysxSchemaPhysxSceneAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxSceneAPI holding the prim adhering to this schema at path on stage. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxSceneAPI	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

PhysX scene extended parameters.

Default PhysX material for the scene can be set by using material bind with purpose physics onto the PhysicsScene prim.

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 63 of file physxSceneAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxSceneAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxSceneAPI on UsdPrim prim .

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

Definition at line 75 of file physxSceneAPI.h.

PhysxSchemaPhysxSceneAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxSceneAPI on the prim held by schemaObj .

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

Definition at line 83 of file physxSceneAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxSceneAPI ( )

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

static

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

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

Returns

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static

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

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

PHYSXSCHEMA_API UsdAttribute GetBounceThresholdAttr

(

)

const

A contact with a relative velocity below this will not bounce.

Range: [0, inf) Default: 0.2 * tolerancesSpeed Units: distance / seconds

Declaration	float physxScene:bounceThreshold = 0.2
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetBroadphaseTypeAttr

(

)

const

Broad phase algorithm used in the simulation.

Declaration	uniform token physxScene:broadphaseType = "GPU"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	GPU, MBP, SAP

PHYSXSCHEMA_API UsdAttribute GetCollisionSystemAttr

(

)

const

Collision detection system.

Declaration	uniform token physxScene:collisionSystem = "PCM"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	PCM, SAT

PHYSXSCHEMA_API UsdAttribute GetEnableCCDAttr

(

)

const

Enables a second broad phase check after integration that makes it possible to prevent objects from tunneling through each other.

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

PHYSXSCHEMA_API UsdAttribute GetEnableEnhancedDeterminismAttr

(

)

const

Provides improved determinism at the expense of performance.

Declaration	bool physxScene:enableEnhancedDeterminism = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetEnableGPUDynamicsAttr

(

)

const

Enables the GPU dynamics pipeline.

Required for GPU only features like deformables.

Declaration	bool physxScene:enableGPUDynamics = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetEnableSceneQuerySupportAttr

(

)

const

Enables scene query support for collision shapes.

Declaration	bool physxScene:enableSceneQuerySupport = 1
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetEnableStabilizationAttr

(

)

const

Enables additional stabilization pass in solver.

Declaration	bool physxScene:enableStabilization = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetFrictionCorrelationDistanceAttr

(

)

const

Friction correlation distance used to decide whether contacts are close enough to be merged into a single friction anchor point or not.

Range: [0, inf) Default: 0.025 * tolerancesLength Units: distance

Declaration	float physxScene:frictionCorrelationDistance = 0.025
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetFrictionOffsetThresholdAttr

(

)

const

A threshold of contact separation distance used to decide if a contact point will experience friction forces.

Range: [0, inf) Default: 0.04 * tolerancesLength Units: distance

Declaration	float physxScene:frictionOffsetThreshold = 0.04
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetFrictionTypeAttr

(

)

const

Friction type used in simulation.

Declaration	uniform token physxScene:frictionType = "patch"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	patch, oneDirectional, twoDirectional

PHYSXSCHEMA_API UsdAttribute GetGpuCollisionStackSizeAttr

(

)

const

Gpu collision stack size.

Declaration	uint physxScene:gpuCollisionStackSize = 67108864
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuFoundLostAggregatePairsCapacityAttr

(

)

const

Gpu found lost aggregate pairs capacity.

Declaration	uint physxScene:gpuFoundLostAggregatePairsCapacity = 1024
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuFoundLostPairsCapacityAttr

(

)

const

Gpu found lost pairs capacity.

Declaration	uint physxScene:gpuFoundLostPairsCapacity = 262144
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuHeapCapacityAttr

(

)

const

Gpu heap capacity.

Declaration	uint physxScene:gpuHeapCapacity = 67108864
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuMaxNumPartitionsAttr

(

)

const

Limitation for the partitions in the GPU dynamics pipeline.

This variable must be a power of 2. A value greater than 32 is currently not supported.

Declaration	uint physxScene:gpuMaxNumPartitions = 8
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuMaxParticleContactsAttr

(

)

const

Gpu max particle contacts.

Declaration	uint physxScene:gpuMaxParticleContacts = 1048576
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuMaxRigidContactCountAttr

(

)

const

Gpu max rigid contact count.

Declaration	uint physxScene:gpuMaxRigidContactCount = 524288
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuMaxRigidPatchCountAttr

(

)

const

Gpu max rigid patch count.

Declaration	uint physxScene:gpuMaxRigidPatchCount = 81920
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuMaxSoftBodyContactsAttr

(

)

const

Gpu max soft body contacts.

Declaration	uint physxScene:gpuMaxSoftBodyContacts = 1048576
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuTempBufferCapacityAttr

(

)

const

Gpu temp buffer capacity.

Declaration	uint physxScene:gpuTempBufferCapacity = 16777216
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetGpuTotalAggregatePairsCapacityAttr

(

)

const

Gpu total aggregate pairs capacity.

Declaration	uint physxScene:gpuTotalAggregatePairsCapacity = 1024
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetInvertCollisionGroupFilterAttr

(

)

const

Boolean attribute indicating whether inverted collision group filtering should be used.

By default two collisions, that do have a collisionGroup set, collide with each other. Adding a collisionGroup into a collisionGroup filtering will mean that the collision between those groups will be disabled. This boolean attribute does invert the default behavior. Hence two collisions with defined collisionGroups will not collide with each other by default and one does enable the collisions between the groups through the "CollisionGroup" filtering.

Declaration	bool physxScene:invertCollisionGroupFilter = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetMaxBiasCoefficientAttr

(

)

const

The maximum bias coefficient used in the constraint solver.

Range: [0, inf) Units: dimensionless

Declaration	float physxScene:maxBiasCoefficient = inf
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxIterationCountAttr

(

)

const

Maximum iteration count for all actors (rigid bodies, cloth, particles etc).

Declaration	uint physxScene:maxIterationCount = 255
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetMinIterationCountAttr

(

)

const

Minimum iteration count for all actors (rigid bodies, cloth, particles etc).

Declaration	uint physxScene:minIterationCount = 0
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetReportKinematicKinematicPairsAttr

(

)

const

Boolean attribute indicating whether kinematic vs kinematic pairs generate contact reports.

Declaration	bool physxScene:reportKinematicKinematicPairs = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdAttribute GetReportKinematicStaticPairsAttr

(

)

const

Boolean attribute indicating whether kinematic vs static pairs generate contact reports.

Declaration	bool physxScene:reportKinematicStaticPairs = 0
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

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 GetSolverTypeAttr

(

)

const

Solver used for the simulation.

Declaration	uniform token physxScene:solverType = "TGS"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	PGS, TGS

PHYSXSCHEMA_API UsdAttribute GetTimeStepsPerSecondAttr

(

)

const

Simulation scene step defined as number of steps per second.

Note that application might cap the number of simulation steps to avoid running more simulations steps with a low frame rate.

Declaration	uint physxScene:timeStepsPerSecond = 60
C++ Type	unsigned int
Usd Type	SdfValueTypeNames->UInt

PHYSXSCHEMA_API UsdAttribute GetUpdateTypeAttr

(

)

const

Type of update for a PhysX scene.

Declaration	uniform token physxScene:updateType = "Synchronous"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	Synchronous, Asynchronous, Disabled

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 69 of file physxSceneAPI.h.

---

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

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