Physics Settings#

Variables

static constexpr char kSettingAutocreatePhysicsScene[] = "/persistent/physics/autocreatePhysicsScene"#: (bool) See Create Temporary Default PhysicsScene When Needed. Changeable through Physics Preferences.

static constexpr char kSettingResetOnStop[] = "/physics/resetOnStop"#: (bool) See Reset simulation on stop. Changeable through Physics Preferences.

static constexpr char kSettingUseActiveCudaContext[] = "/persistent/physics/useActiveCudaContext"#: (bool) See Use Active CUDA Context. Changeable through Physics Preferences.

static constexpr char kSettingCudaDevice[] = "/physics/cudaDevice"#: (int) Device ordinal of a CUDA-enabled GPU for PhysX to use. -1 will autoselect a device.

static constexpr char kSettingDefaultSimulator[] = "/physics/defaultSimulator"#: (string) Simulation engine name.

static constexpr char kSettingSceneMultiGPUMode[] = "/physics/sceneMultiGPUMode"#: (int) See Simulation on multiple GPUs and Use Physics Scene Multi-GPU Mode. Changeable through Physics Preferences.

static constexpr char kSettingBackwardCompatibilityCheckMode[] = "/persistent/physics/backwardCompatibilityCheckMode"#

(int) See Backward Compatibility Check on Scene Open

0: Disabled
1: Show warnings.
2: Shows a visual prompt.
3: Updates the stage without prompting.

Changeable through Physics Preferences.

static constexpr char kSettingNumThreads[] = "/persistent/physics/numThreads"#: (int) See Num Simulation Threads. Changeable through Physics Preferences.

static constexpr char kSettingMaxNumberOfPhysXErrors[] = "/physics/maxNumberOfPhysXErrors"#: (int) Stop simulation after this number of PhysX errors is reached.

static constexpr char kSettingPhysxDispatcher[] = "/physics/physxDispatcher"#: (bool) See Use PhysX CPU Dispatcher. Changeable through Physics Preferences.

static constexpr char kSettingExposeProfilerData[] = "/physics/exposeProfilerData"#: (bool) See Expose PhysX SDK Profiler Data. Changeable through Physics Preferences.

static constexpr char kSettingExposePrimPathNames[] = "/physics/exposePrimPathNames"#: (bool) Expose the prim path names in PhysX SDK name, this will set the string name for the PhysX SDK objects.

static constexpr char kSettingForceParseOnlySingleScene[] = "/physics/forceParseOnlySingleScene"#

static constexpr char kSettingSimulateEmptyScene[] = "/physics/simulateEmptyScene"#

static constexpr char kSettingDisableSleeping[] = "/physics/disableSleeping"#: (bool) Disable sleeping for all PhysX SDK objects, useful for debugging, should not be used for production.

static constexpr char kSettingSynchronousKernelLaunches[] = "/physics/enableSynchronousKernelLaunches"#: (bool) Enable synchronous CUDA kernel launches. This is very useful if you need to pin point the CUDA kernel that is failing.

static constexpr char kSettingDisableContactProcessing[] = "/physics/disableContactProcessing"#: (bool) Disable contact processing in omni.physx.

static constexpr char kSettingUseLocalMeshCache[] = "/persistent/physics/useLocalMeshCache"#: (bool) See Enable Local Mesh Cache. Changeable through Physics Preferences.

static constexpr char kSettingLocalMeshCacheSizeMB[] = "/persistent/physics/localMeshCacheSizeMB"#: (int) See Local Mesh Cache Size MB. Changeable through Physics Preferences.

static constexpr char kSettingUjitsoCookingDevKey[] = "/physics/cooking/ujitsoCookingDevKey"#

static constexpr char kSettingUjitsoCollisionCooking[] = "/physics/cooking/ujitsoCollisionCooking"#: (bool) See Enable UJITSO Collision Cooking. Changeable through Physics Preferences.

static constexpr char kSettingUjitsoRemoteCacheEnabled[] = "/physics/cooking/ujitsoRemoteCacheEnabled"#: (bool) Controls if PhysX should attempt to use remote caching for UJITSO artifacts. Additional settings must be used to specify the remote cache location. This is a boot-time only setting.

static constexpr char kSettingUjitsoCookingMaxProcessCount[] = "/persistent/physics/cooking/ujitsoCookingMaxProcessCount"#: (int) See UJITSO Cooking Max Process Count. Changeable through Physics Preferences.

static constexpr char kSettingUpdateToUsd[] = "/physics/updateToUsd"#: (bool) See Update to USD. This is a per-stage setting.

static constexpr char kSettingUpdateVelocitiesToUsd[] = "/physics/updateVelocitiesToUsd"#: (int) See Update velocities to USD. This is a per-stage setting.

static constexpr char kSettingOutputVelocitiesLocalSpace[] = "/physics/outputVelocitiesLocalSpace"#: (bool) See Output Velocities in Local space. This is a per-stage setting.

static constexpr char kSettingUpdateParticlesToUsd[] = "/physics/updateParticlesToUsd"#: (bool) See Update Particles to USD. This is a per-stage setting.

static constexpr char kSettingUpdateResidualsToUsd[] = "/physics/updateResidualsToUsd"#: (bool) See Update Residuals to USD. This is a per-stage setting.

static constexpr char kSettingFabricEnabled[] = "/physics/fabricEnabled"#

static constexpr char kSettingMinFrameRate[] = "/persistent/simulation/minFrameRate"#: (int) See Min Simulation Frame Rate. This is a per-stage setting.

static constexpr char kSettingEnableExtendedJointAngles[] = "/physics/enableExtendedJointAngles"#: (bool) Support for joint angle computation in range (-360, 360) for revolute joints and D6 joints that have limits on a rotational degree of freedom. This allows, for example, to define revolute joint rotational limits in range (-360, 360). Affects non-articulation joints only. This is a per-stage setting.

static constexpr char kSettingCollisionApproximateCones[] = "/physics/collisionApproximateCones"#

static constexpr char kSettingCollisionApproximateCylinders[] = "/physics/collisionApproximateCylinders"#

static constexpr char kSettingMouseInteractionEnabled[] = "/physics/mouseInteractionEnabled"#: (bool) See Mouse Interaction Enabled. This is a per-stage setting.

static constexpr char kSettingMouseGrab[] = "/physics/mouseGrab"#: (bool) See Mouse Grab. This is a per-stage setting.

static constexpr char kSettingMouseGrabIgnoreInvisible[] = "/physics/mouseGrabIgnoreInvisible"#: (bool) See Mouse Grab Ignore Invisible. This is a per-stage setting.

static constexpr char kSettingMouseGrabWithForce[] = "/physics/forceGrab"#: (bool) See Mouse Grab With Force. This is a per-stage setting.

static constexpr char kSettingMousePush[] = "/physics/mousePush"#: (float) See Mouse Push Acceleration. This is a per-stage setting.

static constexpr char kSettingMousePickingForce[] = "/physics/pickingForce"#: (float) See Mouse Grab Force Coefficient. This is a per-stage setting.

static constexpr char kSettingPhysicsDevelopmentMode[] = "/physics/developmentMode"#: (bool) Turns on physics development mode that sets up a physics-oriented UI setup making e.g. physics demo or debug windows visible by default.

static constexpr char kSettingLogRobotics[] = "/physics/logRobotics"#: (bool) Enables a robotics-oriented logging channel. Can be switched in the Console window’s filter settings.

static constexpr char kSettingLogSceneMultiGPU[] = "/physics/logSceneMultiGPU"#: (bool) Enables a Simulation on multiple GPUs feature’s logging channel. Can be switched in the Console window’s filter settings.

static constexpr char kSettingDemoAssetsPath[] = "/physics/demoAssetsPath"#: (string) Sets a path prefix to all external asset paths used by the physics demos. When empty it’s set based on the value of /physics/demoDevelopmentMode to point to either S3 or nucleus path.

static constexpr char kSettingTestsAssetsPath[] = "/physics/testsAssetsPath"#: (string) Sets a path prefix for all external test asset paths used by physics tests.

static constexpr char kSettingAddMenuSelectionLimit[] = "/physics/addMenuSelectionLimit"#: (int) Maximal amount of selected prims that will be processed filtering items in the Add menu for relevance. No filtering will be done for selections larger than this limit.

static constexpr char kSettingAddMenuSubtreeLimit[] = "/physics/addMenuSubtreeLimit"#: (int) Maximal amount of prims in a subtree of the selected prims to be processed when filtering items in the Add menu for relevance. No filtering will be done on subtrees over this limit.

static constexpr char kSettingVisualizationCollisionMesh[] = "/persistent/physics/visualizationCollisionMesh"#: (bool) Enables viewport visualization of collision-mesh approximations using solid render meshes. This matches the Physics Debug Window setting Collision Mesh Debug Visualization

static constexpr char kSettingDisplayColliders[] = "/persistent/physics/visualizationDisplayColliders"#

(int) Enables viewport visualization of colliders.

Table 2 Accepted values#
0	Disabled
1	Selected only
2	All

static constexpr char kSettingDisplayColliderNormals[] = "/persistent/physics/visualizationDisplayColliderNormals"#: (bool) Displays normals for collider viewport visualization.

static constexpr char kSettingDisplayMassProperties[] = "/persistent/physics/visualizationDisplayMassProperties"#

(int) Enables display of icons in the viewport for rigid bodies that allow viewing mass property info.

Table 3 Accepted values#
0	Disabled
1	Selected only
2	All

static constexpr char kSettingDisplaySimulationOutput[] = "/persistent/physics/visualizationSimulationOutput"#: (bool) Toggles the display of the Simulation Settings Window.

static constexpr char kSettingDisplaySimulationDataVisualizer[] = "/persistent/physics/visualizationSimulationDataVisualizer"#: (bool) Toggles the display of the Simulation Data Visualizer Window.

static constexpr char kSettingAutoPopupSimulationOutputWindow[] = "/physics/autoPopupSimulationOutputWindow"#: (bool) Automatically enable the Simulation Settings Window whenever Fabric is active

static constexpr char kSettingDisplayTendons[] = "/persistent/physics/visualizationDisplayTendons"#

(int) Enables viewport visualization of tendons for joints.

Table 4 Accepted values#
0	Disabled
1	Selected only
2	All

static constexpr char kSettingDisplayDeformableBodies[] = "/persistent/physics/visualizationDisplayDeformableBodies"#

(int) Enables viewport debug visualization overlay of deformable bodies.

Table 5 Accepted values#
0	Disabled
1	Selected only
2	All

static constexpr char kSettingDisplayDeformableBodyType[] = "/persistent/physics/visualizationDisplayDeformableBodyType"#

(int) Sets the mode for the deformable body debug visualization.

Table 6 Accepted values#
0	Simulation
1	Collision

static constexpr char kSettingDisplayDeformableSurfaces[] = "/physics/visualizationDisplayDeformableSurfaces"#

(int) Enables viewport debug visualization overlay of deformable surfaces.

Table 7 Accepted values#
0	Disabled
1	Selected only
2	All

static constexpr char kSettingDisplayParticles[] = "/persistent/physics/visualizationDisplayParticles"#

(int) Enables viewport debug visualization overlay of particles.

Table 8 Accepted values#
0	Disabled
1	Selected only
2	All

static constexpr char kSettingDisplayParticlesShowDiffuseParticles[] = "/persistent/physics/visualizationDisplayParticlesShowDiffuseParticles"#: (bool) Toggles the display of diffuse particles for the particle viewport debug visualization.

static constexpr char kSettingDisplayParticlesParticlePositions[] = "/persistent/physics/visualizationDisplayParticlesParticlePositions"#

(int) Sets the particle position mode for the particle viewport debug visualization.

Table 9 Accepted values#
0	Show simulation particle positions
1	Show smoothing-post-processed particle positions

static constexpr char kSettingDisplayParticlesParticleRadius[] = "/persistent/physics/visualizationDisplayParticlesParticleRadius"#

(int) Sets the particle radius mode for the particle viewport debug visualization.

Table 10 Accepted values#
0	Particle-nonparticle contact offset
1	Particle-nonparticle rest offset
2	Particle-Particle contact offset
3	Fluid- or solid particle rest offset (applicable radius is auto-determined)
4	Fluid particles anisotropy
5	Render geometry of particle object

static constexpr char kSettingDisplayParticlesClothMeshLines[] = "/persistent/physics/visualizationDisplayParticlesClothMeshLines"#: DEPRECATED, particle cloth will be replaced by new deformable implementation in future release.

static constexpr char kSettingDisplayParticlesShowParticleSetParticles[] = "/persistent/physics/visualizationDisplayParticlesShowParticleSetParticles"#: (bool) Toggles the display of particle sets for the particle viewport debug visualization.

static constexpr char kSettingDisplayParticlesShowFluidSurface[] = "/persistent/physics/visualizationDisplayParticlesShowFluidSurface"#: (bool) Toggles the display of fluid surfaces for the particle viewport debug visualization.

static constexpr char kSettingDisplayParticlesShowDeformableParticles[] = "/persistent/physics/visualizationDisplayParticlesShowDeformableParticles"#: DEPRECATED, will be replaced by new deformable implementation in future release.

static constexpr char kSettingDisplayParticlesShowDeformableMesh[] = "/persistent/physics/visualizationDisplayParticlesShowDeformableMesh"#: DEPRECATED, will be replaced by new deformable implementation in future release.

static constexpr char kSettingDisplayAttachments[] = "/persistent/physics/visualizationDisplayAttachments"#: DEPRECATED.

static constexpr char kSettingDisplayAttachmentsHideActor0[] = "/persistent/physics/visualizationDisplayAttachmentsHideActor0"#: DEPRECATED.

static constexpr char kSettingDisplayAttachmentsHideActor1[] = "/persistent/physics/visualizationDisplayAttachmentsHideActor1"#: DEPRECATED.

static constexpr char kSettingVisualizationGap[] = "/persistent/physics/visualizationGap"#: (float) Sets the relative spacing between tetrahedrals of the deformable body visualization.

static constexpr char kSettingDebugVisSimplifyAtDistance[] = "/persistent/physics/visualizationSimplifyAtDistance"#: (bool) Visualizes colliders as AABBs at the specified distance from the active camera.

static constexpr char kSettingDebugVisQueryUsdrtForTraversal[] = "/persistent/physics/visualizationQueryUsdrtForTraversal"#: (bool) Use USDRT for stage traversal when displaying colliders. Improves performance if USDRT is available.

static constexpr char kSettingMassDistributionManipulator[] = "/persistent/physics/massDistributionManipulator"#: (bool) Toggles the Mass Distribution Manipulator.

static constexpr char kSettingEnableParticleAuthoring[] = "/physics/enableParticleAuthoring"#

static constexpr char kSettingEnableAttachmentAuthoring[] = "/physics/enableAttachmentAuthoring"#

static constexpr char kSettingPVDIPAddress[] = "/persistent/physics/pvdIP"#: (string) Sets the IP address of the consuming networked PVD client.

static constexpr char kSettingPVDStreamToFile[] = "/persistent/physics/pvdStreamToFile"#: (bool) Toggles the output to a file or a network client.

static constexpr char kSettingPVDOutputDirectory[] = "/persistent/physics/pvdOutputDirectory"#: (string) Sets the output directory for the collected PVD files.

static constexpr char kSettingPVDProfile[] = "/persistent/physics/pvdProfile"#: (bool) Toggles the output of profiling data.

static constexpr char kSettingPVDDebug[] = "/persistent/physics/pvdDebug"#: (bool) Toggles the output of debug data.

static constexpr char kSettingPVDMemory[] = "/persistent/physics/pvdMemory"#: (bool) Toggles the output of memory data.

static constexpr char kSettingPVDEnabled[] = "/persistent/physics/pvdEnabled"#: (bool) Toggles collection of PVD telemetry. Only if this setting is true, do the other PVD settings matter.

static constexpr char kOmniPvdOvdRecordingDirectory[] = "/persistent/physics/omniPvdOvdRecordingDirectory"#: (string) Sets the directory for OmniPVD output files.

static constexpr char kOmniPvdOutputEnabled[] = "/physics/omniPvdOutputEnabled"#: (bool) Toggles collection of OmniPVD telemetry. Only if this setting is true, do the other OmniPVD settings matter.

static constexpr char kOmniPvdIsOVDStage[] = "/physics/omniPvdIsOVDStage"#: (bool) Toggles if the Stage is an OmniPVD stage or not. Only non-OmniPVD stages get recorded into OVD files.

static constexpr char kOmniPvdIsRecording[] = "/physics/omniPvdIsRecording"#: (bool) Toggles if the Stage is being recorded into OmniPVD.

static constexpr char kSettingDisplayJoints[] = "/persistent/physics/visualizationDisplayJoints"#: (bool) Enables display of viewport icons and visual authoring for joints.

static constexpr char kSettingJointBodyTransformCheckToleranceDefault[] = "/simulation/jointBodyTransformCheckTolerance"#