usdrt::PhysxSchemaPhysxSceneAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxSceneAPI.h

Functions

Variables

class PhysxSchemaPhysxSceneAPI : public usdrt::UsdAPISchemaBase

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.

Public Functions

inline explicit PhysxSchemaPhysxSceneAPI(const UsdPrim &prim = UsdPrim())

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.

inline explicit PhysxSchemaPhysxSceneAPI(const UsdSchemaBase &schemaObj)

Construct a PhysxSchemaPhysxSceneAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxSceneAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxSceneAPI()

Destructor.

inline operator bool() const

Boolean operator.

Returns

Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline 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

inline UsdAttribute CreateBounceThresholdAttr() const

See GetBounceThresholdAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateFrictionOffsetThresholdAttr() const

See GetFrictionOffsetThresholdAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateFrictionCorrelationDistanceAttr() const

See GetFrictionCorrelationDistanceAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateMaxBiasCoefficientAttr() const

See GetMaxBiasCoefficientAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateCollisionSystemAttr() const

See GetCollisionSystemAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateSolverTypeAttr() const

See GetSolverTypeAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateBroadphaseTypeAttr() const

See GetBroadphaseTypeAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateFrictionTypeAttr() const

See GetFrictionTypeAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateEnableCCDAttr() const

See GetEnableCCDAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetEnableStabilizationAttr() const

Enables additional stabilization pass in solver.

Declaration

bool physxScene:enableStabilization = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableStabilizationAttr() const

See GetEnableStabilizationAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateUpdateTypeAttr() const

See GetUpdateTypeAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateEnableGPUDynamicsAttr() const

See GetEnableGPUDynamicsAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetEnableEnhancedDeterminismAttr() const

Provides improved determinism at the expense of performance.

Declaration

bool physxScene:enableEnhancedDeterminism = 0

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableEnhancedDeterminismAttr() const

See GetEnableEnhancedDeterminismAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetEnableSceneQuerySupportAttr() const

Enables scene query support for collision shapes.

Declaration

bool physxScene:enableSceneQuerySupport = 1

C++ Type

bool

Usd Type

SdfValueTypeNames->Bool

inline UsdAttribute CreateEnableSceneQuerySupportAttr() const

See GetEnableSceneQuerySupportAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateTimeStepsPerSecondAttr() const

See GetTimeStepsPerSecondAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuTempBufferCapacityAttr() const

Gpu temp buffer capacity.

Declaration

uint physxScene:gpuTempBufferCapacity = 16777216

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuTempBufferCapacityAttr() const

See GetGpuTempBufferCapacityAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuMaxRigidContactCountAttr() const

Gpu max rigid contact count.

Declaration

uint physxScene:gpuMaxRigidContactCount = 524288

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuMaxRigidContactCountAttr() const

See GetGpuMaxRigidContactCountAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuMaxRigidPatchCountAttr() const

Gpu max rigid patch count.

Declaration

uint physxScene:gpuMaxRigidPatchCount = 81920

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuMaxRigidPatchCountAttr() const

See GetGpuMaxRigidPatchCountAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuHeapCapacityAttr() const

Gpu heap capacity.

Declaration

uint physxScene:gpuHeapCapacity = 67108864

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuHeapCapacityAttr() const

See GetGpuHeapCapacityAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuFoundLostPairsCapacityAttr() const

Gpu found lost pairs capacity.

Declaration

uint physxScene:gpuFoundLostPairsCapacity = 262144

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuFoundLostPairsCapacityAttr() const

See GetGpuFoundLostPairsCapacityAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuFoundLostAggregatePairsCapacityAttr() const

Gpu found lost aggregate pairs capacity.

Declaration

uint physxScene:gpuFoundLostAggregatePairsCapacity = 1024

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuFoundLostAggregatePairsCapacityAttr() const

See GetGpuFoundLostAggregatePairsCapacityAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuTotalAggregatePairsCapacityAttr() const

Gpu total aggregate pairs capacity.

Declaration

uint physxScene:gpuTotalAggregatePairsCapacity = 1024

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuTotalAggregatePairsCapacityAttr() const

See GetGpuTotalAggregatePairsCapacityAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuMaxSoftBodyContactsAttr() const

Gpu max soft body contacts.

Declaration

uint physxScene:gpuMaxSoftBodyContacts = 1048576

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuMaxSoftBodyContactsAttr() const

See GetGpuMaxSoftBodyContactsAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuMaxDeformableSurfaceContactsAttr() const

Gpu max deformable surface contacts.

Declaration

uint physxScene:gpuMaxDeformableSurfaceContacts = 1048576

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuMaxDeformableSurfaceContactsAttr() const

See GetGpuMaxDeformableSurfaceContactsAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuMaxParticleContactsAttr() const

Gpu max particle contacts.

Declaration

uint physxScene:gpuMaxParticleContacts = 1048576

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuMaxParticleContactsAttr() const

See GetGpuMaxParticleContactsAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuMaxHairContactsAttr() const

Gpu max hair contacts.

Declaration

uint physxScene:gpuMaxHairContacts = 1048576

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuMaxHairContactsAttr() const

See GetGpuMaxHairContactsAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateGpuMaxNumPartitionsAttr() const

See GetGpuMaxNumPartitionsAttr(), and also Create vs Get Property Methods 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.

inline UsdAttribute GetGpuCollisionStackSizeAttr() const

Gpu collision stack size.

Declaration

uint physxScene:gpuCollisionStackSize = 67108864

C++ Type

unsigned int

Usd Type

SdfValueTypeNames->UInt

inline UsdAttribute CreateGpuCollisionStackSizeAttr() const

See GetGpuCollisionStackSizeAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateInvertCollisionGroupFilterAttr() const

See GetInvertCollisionGroupFilterAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateReportKinematicKinematicPairsAttr() const

See GetReportKinematicKinematicPairsAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateReportKinematicStaticPairsAttr() const

See GetReportKinematicStaticPairsAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateMinIterationCountAttr() const

See GetMinIterationCountAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateMaxIterationCountAttr() const

See GetMaxIterationCountAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const

Return this schema object’s held prim.

SdfPath GetPath() const

Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxSceneAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.