From d1c812f1162e5fdb13c215792725b2591d7428f5 Mon Sep 17 00:00:00 2001 From: Sheikh Dawood Abdul Ajees Date: Fri, 15 Sep 2017 15:41:57 -0500 Subject: PhysX 3.4.1, APEX 1.4.1 Release @22845541 --- .../PhysXAPI/files/classPxSceneDesc.html | 78 +++++++++++++++++----- 1 file changed, 61 insertions(+), 17 deletions(-) (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneDesc.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneDesc.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneDesc.html index 1eb19437..9ca9930c 100644 --- a/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneDesc.html +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxSceneDesc.html @@ -94,6 +94,9 @@ Collaboration diagram for PxSceneDesc: PxReal ccdMaxSeparation A threshold for speculative CCD. Used to control whether bias, restitution or a combination of the two are used to resolve the contacts.
+PxReal solverOffsetSlop + + A slop value used to zero contact offsets from the body's COM on an axis if the offset along that axis is smaller than this threshold. Can be used to compensate for small numerical errors in contact generation.
PxSceneFlags flags Flags used to select scene options.
@@ -124,6 +127,9 @@ Collaboration diagram for PxSceneDesc: PxU32 maxNbContactDataBlocks Setting to define the maximum number of 16K blocks that can be allocated to store contact, friction, and contact cache data. As the complexity of a scene increases, the SDK may require to allocate new 16k blocks in addition to the blocks it has already allocated. This variable controls the maximum number of blocks that the SDK can allocate.
+PxReal maxBiasCoefficient + + The maximum bias coefficient used in the constraint solver.
PxU32 contactReportStreamBufferSize Size of the contact report stream (in bytes).
@@ -171,7 +177,7 @@ A contact with a relative velocity below this will not bounce. A typical value f Default: 0.2 * PxTolerancesScale::speed

See also:: PxMaterial

Referenced by isValid().

@@ -271,7 +277,7 @@ A threshold for speculative CCD. Used to control whether bias, restitution or a

Note:: This only has any effect on contacting pairs where one of the bodies has PxRigidBodyFlag::eENABLE_SPECULATIVE_CCD raised.

Range: [0, PX_MAX_F32)
Default: 0.04 * PxTolerancesScale::length -

Referenced by isValid().

@@ -312,7 +318,7 @@ The contact report stream buffer is used during the simulation to store all the Default: 8192

Range: (0, PX_MAX_U32]
-

Referenced by isValid().

@@ -331,7 +337,7 @@ The contact report stream buffer is used during the simulation to store all the The CPU task dispatcher for the scene.

See PxCpuDispatcher, PxScene::getCpuDispatcher -

Referenced by isValid().

@@ -371,7 +377,7 @@ This parameter gives a hint on the distribution of the workload for rebuilding t This parameter gives only a hint. The rebuild process might still take more or less time depending on the number of objects involved. Range: [4, PX_MAX_U32)
Default: 100 -

Referenced by isValid().

@@ -411,7 +417,7 @@ The custom filter shader to use for collision filtering.

Note:: This parameter is compulsory. If you don't want to define your own filter shader you can use the default shader PxDefaultSimulationFilterShader which can be found in the PhysX extensions library.

See also:: PxSimulationFilterShader

Referenced by isValid().

@@ -433,7 +439,7 @@ Shared global filter data which will get passed into the filter shader. Default: NULL

See also:: PxSimulationFilterShader PxScene::setFilterShaderData()

Referenced by isValid().

@@ -454,7 +460,7 @@ Size (in bytes) of the shared global filter data

Referenced by isValid().

@@ -474,7 +480,7 @@ Flags used to select scene options.

See also:: PxSceneFlag PxSceneFlags

Referenced by isValid().

@@ -497,7 +503,7 @@ If the aggregated contact offset of a pair of shapes is large it might be desira This parameter can be used to tune the separation distance of contact points at which friction starts to have an effect. Range: [0, PX_MAX_F32)
Default: 0.04 * PxTolerancesScale::length -

Referenced by isValid().

@@ -589,7 +595,7 @@ Limitation for the partitions in the GPU dynamics pipeline. This variable must b .

Referenced by isValid().

@@ -629,8 +635,28 @@ Expected scene limits.

See also:: PxSceneLimits

Referenced by isValid().

+ +

+ + + + +

PxReal PxSceneDesc::maxBiasCoefficient

+ +

+The maximum bias coefficient used in the constraint solver. +

+When geometric errors are found in the constraint solver, either as a result of shapes penetrating or joints becoming separated or violating limits, a bias is introduced in the solver position iterations to correct these errors. This bias is proportional to 1/dt, meaning that the bias becomes increasingly strong as the time-step passed to PxScene::simulate(...) becomes smaller. This coefficient allows the application to restrict how large the bias coefficient is, to reduce how violent error corrections are. This can improve simulation quality in cases where either variable time-steps or extremely small time-steps are used.

+Default: PX_MAX_F32

+ Range [0, PX_MAX_F32]
+

@@ -654,7 +680,7 @@ If a warning is reported to the error stream to indicate the number of 16K block

See also:: nbContactDataBlocks PxScene::setNbContactDataBlocks

Referenced by isValid().

@@ -678,7 +704,7 @@ Setting to define the number of 16K blocks that will be initially reserved to st

See also:: PxPhysics::createScene PxScene::setNbContactDataBlocks

Referenced by isValid().

@@ -699,7 +725,7 @@ The bounds used to sanity check user-set positions of actors and articulation li These bounds are used to check the position values of rigid actors inserted into the scene, and positions set for rigid actors already within the scene.

Range: any valid PxBounds3
Default: (-PX_MAX_BOUNDS_EXTENTS, PX_MAX_BOUNDS_EXTENTS) on each axis -

Referenced by isValid().

@@ -741,6 +767,24 @@ This parameter defines the minimum number of actors required to spawn a separate Default: 128

See also:: PxScene.setSolverBatchSize() PxScene.getSolverBatchSize()

+ +

+ + + + +

PxReal PxSceneDesc::solverOffsetSlop

+ +

+A slop value used to zero contact offsets from the body's COM on an axis if the offset along that axis is smaller than this threshold. Can be used to compensate for small numerical errors in contact generation. +

+Range: [0, PX_MAX_F32)
+ Default: 0.0

@@ -759,7 +803,7 @@ Defines the structure used to store static objects.

Note:: Only PxPruningStructureType::eSTATIC_AABB_TREE and PxPruningStructureType::eDYNAMIC_AABB_TREE are allowed here.

Referenced by isValid().

@@ -799,7 +843,7 @@ Calling wakeUp() on objects which support sleeping will set their wake counter v Default: 0.4 (which corresponds to 20 frames for a time step of 0.02)

See also:: PxRigidDynamic::wakeUp() PxArticulation::wakeUp() PxCloth::wakeUp()

Referenced by isValid().

-- cgit v1.2.3