FRigPhysicsSolverSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/ControlRigPhysics

Configuration/settings for the physics solver


Name	FRigPhysicsSolverSettings
Type	struct
Header File	/Engine/Plugins/Experimental/ControlRigPhysics/Source/ControlRigPhysics/Public/RigPhysicsData.h
Include Path	#include "RigPhysicsData.h"

Syntax

USTRUCT (BlueprintType )  
struct FRigPhysicsSolverSettings

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bAutomaticallyAddPhysicsComponents	bool	If true, then any physics component below (the element owning this one) will be automatically added to this solver, if its UseAutomaticSolver flag is set.	RigPhysicsData.h	EditAnywhere Category=SolverSettings
BoundsVelocityMultiplier	float	Expands the shape bounds to detect potentially active contacts when moving.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
bSolveJointPositionsLast	bool	When solving joints, whether to solve the positions last (as opposed to the orientations)	RigPhysicsData.h	EditAnywhere Category=SolverSettings
bUseLinearJointSolver	bool	Whether to use the linear or non-linear solver for RBAN Joints.	RigPhysicsData.h	EditAnywhere Category=SolverSettings
bUseManifolds	bool	It enables the use of multi-point contact manifolds, which are created only once at the start of each tick.	RigPhysicsData.h	EditAnywhere Category=CollisionSettings
Collision	FRigPhysicsCollision	The collision shapes defined in the collision space - e.g. for representing a ground etc.	RigPhysicsData.h	BlueprintReadOnly EditAnywhere Category=SolverSettings Meta=(ShowOnlyInnerProperties)
CollisionBoundsExpansion	float	This is the distance margin around shapes used to detect collisions.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
CollisionSpace	ERigPhysicsSimulationSpace	The space in which collision shapes are defined.	RigPhysicsData.h	BlueprintReadOnly EditAnywhere Category=SolverSettings
FixedTimeStep	float	The recommended fixed timestep for the RBAN solver.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
Gravity	FVector		RigPhysicsData.h	EditAnywhere Category=SolverSettings
KinematicAccelerationThresholdForReset	float	If any kinematic object in the simulation exceeds this acceleration, we will reset the velocities of all objects in the simulation.This is to detect problems - for example if the target animation has teleports etc.	RigPhysicsData.h	EditAnywhere Category=Settings Meta=(ClampMin="0.0")
KinematicSpeedThresholdForReset	float	If any kinematic object in the simulation exceeds this speed, we will reset the velocities of all objects in the simulation.This is to detect problems - for example if the target animation has teleports etc.	RigPhysicsData.h	EditAnywhere Category=Settings Meta=(ClampMin="0.0")
MaxDeltaTime	float	If a variable timestep is in use, this is the maximum delta time that can be used.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
MaxDepenetrationVelocity	float	When bodies are penetrating, this is the maximum velocity delta that can be applied in one frame.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
MaxNumRollingAverageStepTimes	int32	This sets how or if the step size should be smoothed.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=1)
MaxTimeSteps	int32	The maximum number of solver steps that can be made.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=1)
MaxVelocityBoundsExpansion	float	The maximum margin added due to movement.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
PositionIterations	int32	The number of position iterations to run.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
PositionThresholdForReset	float	If any object in the simulation exceeds this distance from the simulation origin, we will reset the pose and velocity of the entire simulation.	RigPhysicsData.h	EditAnywhere Category=Settings Meta=(ClampMin="0.0")
ProjectionIterations	int32	The number of projection iterations to run.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
SimulationSpace	ERigPhysicsSimulationSpace		RigPhysicsData.h	BlueprintReadOnly EditAnywhere Category=SolverSettings
SpaceBone	FRigElementKey	The bone to use for the collision or simulation space (only relevant if one is set to BoneSpace)	RigPhysicsData.h	BlueprintReadOnly EditAnywhere Category=SolverSettings
VelocityIterations	int32	The number of velocity iterations to run.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=0)
WorldCollisionBoundsExpansion	float	Scales up the volume used to collect world objects for collision.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=1)
WorldCollisionExpiryFrames	int32	Keeps world objects for a few frames even if they go out of bounds, to avoid rapid creation/destruction.	RigPhysicsData.h	EditAnywhere Category=SolverSettings Meta=(ClampMin=1)
WorldCollisionType	ERigPhysicsWorldCollisionType	Overlap type used to collect world objects. If set to None then there will be no world collisions.	RigPhysicsData.h	EditAnywhere Category=SolverSettings

Navigation

Syntax

Variables

Public