p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity
p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity
#Overview
name: p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity
This variable is created as a Console Variable (cvar).
- type:
Var - help:
Set the collision Max Depenetration Velocity (if >= 0)
It is referenced in 3 C++ source files.
#Summary
#Usage in the C++ source code
The purpose of p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity is to set the maximum depenetration velocity for collision handling in the Chaos Immediate Physics system. This setting is used to control how quickly intersecting objects are separated during collision resolution.
This setting variable is primarily used in the Chaos physics engine, which is part of Unreal Engine’s physics system. Specifically, it’s used in the Immediate Physics simulation module within the Chaos framework.
The value of this variable is set through a console variable (CVar) system, which allows runtime modification of the value. It’s initialized in the C++ code and can be changed via console commands or configuration files.
The associated variable ChaosImmediate_Collision_MaxDepenetrationVelocity directly interacts with p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity. They share the same value, with the CVar acting as an interface for runtime modification.
Developers should be aware that:
- The value is only applied if it’s greater than or equal to 0.
- This setting can significantly impact the behavior of colliding objects in the simulation.
- It’s part of a group of collision-related settings that work together to define collision behavior.
Best practices when using this variable include:
- Carefully tuning the value to balance between realistic collision response and performance.
- Testing the effects of different values in various collision scenarios.
- Considering the interplay between this and other collision-related settings.
- Using the console variable system to experiment with different values during runtime for easier tweaking.
Regarding the associated variable ChaosImmediate_Collision_MaxDepenetrationVelocity:
- Its purpose is to store the actual value used by the physics simulation.
- It’s used directly in the Chaos Immediate Physics simulation code.
- Its value is set by the CVar system, allowing for runtime modification.
- It interacts directly with the p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity CVar.
- Developers should be aware that modifying this variable directly in code may be overridden by the CVar system.
- Best practice is to use the CVar system to modify this value rather than changing it directly in code, to ensure consistency across the engine.
#References in C++ code
#Callsites
This variable is referenced in the following C++ source code:
#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/PhysicsEngine/ImmediatePhysics/ImmediatePhysicsChaos/ImmediatePhysicsSimulation_Chaos.cpp:82
Scope: file
Source code excerpt:
FAutoConsoleVariableRef CVarChaosImmPhysCollisionPriority(TEXT("p.Chaos.ImmPhys.Collision.Priority"), ChaosImmediate_Collision_Priority, TEXT("Set the Collision constraint sort order (Joints have priority 0)"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionCullDistance(TEXT("p.Chaos.ImmPhys.Collision.CullDistance"), ChaosImmediate_Collision_CullDistance, TEXT("Set the collision CullDistance (if >= 0)"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionMaxDepenetrationVelocity(TEXT("p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity"), ChaosImmediate_Collision_MaxDepenetrationVelocity, TEXT("Set the collision Max Depenetration Velocity (if >= 0)"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionRestitutionThresholdMultiplier(TEXT("p.Chaos.ImmPhys.Collision.RestitutionThresholdMultiplier"), ChaosImmediate_Collision_RestitutionThresholdMultiplier, TEXT("Collision Restitution Threshold (Acceleration) = Multiplier * Gravity"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionRestitutionEnabled(TEXT("p.Chaos.ImmPhys.Collision.RestitutionEnabled"), ChaosImmediate_Collision_RestitutionEnabled, TEXT("Collision Restitution Enable/Disable"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionDeferNarrowPhase(TEXT("p.Chaos.ImmPhys.Collision.DeferNarrowPhase"), ChaosImmediate_Collision_DeferNarrowPhase, TEXT("[Legacy Solver] Create contacts for all broadphase pairs, perform NarrowPhase later."));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionUseManifolds(TEXT("p.Chaos.ImmPhys.Collision.UseManifolds"), ChaosImmediate_Collision_UseManifolds, TEXT("[Legacy Solver] Enable/Disable use of manifoldes in collision."));
Chaos::FRealSingle ChaosImmediate_Joint_SwingTwistAngleTolerance = 1.0e-6f;
#Associated Variable and Callsites
This variable is associated with another variable named ChaosImmediate_Collision_MaxDepenetrationVelocity. They share the same value. See the following C++ source code.
#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/PhysicsEngine/ImmediatePhysics/ImmediatePhysicsChaos/ImmediatePhysicsSimulation_Chaos.cpp:74
Scope: file
Source code excerpt:
int32 ChaosImmediate_Collision_Priority = 1;
Chaos::FRealSingle ChaosImmediate_Collision_CullDistance = -1.0f;
Chaos::FRealSingle ChaosImmediate_Collision_MaxDepenetrationVelocity = -1.0f;
Chaos::FRealSingle ChaosImmediate_Collision_RestitutionThresholdMultiplier = 1.5f;
int32 ChaosImmediate_Collision_RestitutionEnabled = true;
int32 ChaosImmediate_Collision_DeferNarrowPhase = 1;
int32 ChaosImmediate_Collision_UseManifolds = 0;
FAutoConsoleVariableRef CVarChaosImmPhysCollisionDisable(TEXT("p.Chaos.ImmPhys.Collision.Enabled"), ChaosImmediate_Collision_Enabled, TEXT("Enable/Disable collisions in Immediate Physics."));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionPriority(TEXT("p.Chaos.ImmPhys.Collision.Priority"), ChaosImmediate_Collision_Priority, TEXT("Set the Collision constraint sort order (Joints have priority 0)"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionCullDistance(TEXT("p.Chaos.ImmPhys.Collision.CullDistance"), ChaosImmediate_Collision_CullDistance, TEXT("Set the collision CullDistance (if >= 0)"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionMaxDepenetrationVelocity(TEXT("p.Chaos.ImmPhys.Collision.MaxDepenetrationVelocity"), ChaosImmediate_Collision_MaxDepenetrationVelocity, TEXT("Set the collision Max Depenetration Velocity (if >= 0)"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionRestitutionThresholdMultiplier(TEXT("p.Chaos.ImmPhys.Collision.RestitutionThresholdMultiplier"), ChaosImmediate_Collision_RestitutionThresholdMultiplier, TEXT("Collision Restitution Threshold (Acceleration) = Multiplier * Gravity"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionRestitutionEnabled(TEXT("p.Chaos.ImmPhys.Collision.RestitutionEnabled"), ChaosImmediate_Collision_RestitutionEnabled, TEXT("Collision Restitution Enable/Disable"));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionDeferNarrowPhase(TEXT("p.Chaos.ImmPhys.Collision.DeferNarrowPhase"), ChaosImmediate_Collision_DeferNarrowPhase, TEXT("[Legacy Solver] Create contacts for all broadphase pairs, perform NarrowPhase later."));
FAutoConsoleVariableRef CVarChaosImmPhysCollisionUseManifolds(TEXT("p.Chaos.ImmPhys.Collision.UseManifolds"), ChaosImmediate_Collision_UseManifolds, TEXT("[Legacy Solver] Enable/Disable use of manifoldes in collision."));
Chaos::FRealSingle ChaosImmediate_Joint_SwingTwistAngleTolerance = 1.0e-6f;
#Loc: <Workspace>/Engine/Source/Runtime/Engine/Private/PhysicsEngine/ImmediatePhysics/ImmediatePhysicsChaos/ImmediatePhysicsSimulation_Chaos.cpp:863
Scope (from outer to inner):
file
namespace ImmediatePhysics_Chaos
function void FSimulation::Simulate
Source code excerpt:
ChaosImmediate_Evolution_FixedStepTime,
ChaosImmediate_Collision_CullDistance,
ChaosImmediate_Collision_MaxDepenetrationVelocity,
ChaosImmediate_Joint_UseLinearSolver,
ChaosImmediate_Evolution_PositionIterations,
ChaosImmediate_Evolution_VelocityIterations,
ChaosImmediate_Evolution_ProjectionIterations);
FPBDJointSolverSettings JointsSettings = Implementation->Joints.GetSettings();