Struct heron::rapier_plugin::rapier::dynamics::IntegrationParameters [−]
pub struct IntegrationParameters {}Show fields
pub dt: f32, pub min_ccd_dt: f32, pub erp: f32, pub joint_erp: f32, pub warmstart_coeff: f32, pub warmstart_correction_slope: f32, pub velocity_solve_fraction: f32, pub velocity_based_erp: f32, pub allowed_linear_error: f32, pub prediction_distance: f32, pub allowed_angular_error: f32, pub max_linear_correction: f32, pub max_angular_correction: f32, pub max_velocity_iterations: usize, pub max_position_iterations: usize, pub min_island_size: usize, pub max_ccd_substeps: usize,
Parameters for a time-step of the physics engine.
Fields
dt: f32
The timestep length (default: 1.0 / 60.0
)
min_ccd_dt: f32
Minimum timestep size when using CCD with multiple substeps (default 1.0 / 60.0 / 100.0
)
When CCD with multiple substeps is enabled, the timestep is subdivided
into smaller pieces. This timestep subdivision won’t generate timestep
lengths smaller than min_dt
.
Setting this to a large value will reduce the opportunity to performing CCD substepping, resulting in potentially more time dropped by the motion-clamping mechanism. Setting this to an very small value may lead to numerical instabilities.
erp: f32
The Error Reduction Parameter in [0, 1]
is the proportion of
the positional error to be corrected at each time step (default: 0.2
).
joint_erp: f32
The Error Reduction Parameter for joints in [0, 1]
is the proportion of
the positional error to be corrected at each time step (default: 0.2
).
warmstart_coeff: f32
Each cached impulse are multiplied by this coefficient in [0, 1]
when they are re-used to initialize the solver (default 1.0
).
warmstart_correction_slope: f32
Correction factor to avoid large warmstart impulse after a strong impact (default 10.0
).
velocity_solve_fraction: f32
0-1: how much of the velocity to dampen out in the constraint solver?
(default 1.0
).
velocity_based_erp: f32
0-1: multiplier for how much of the constraint violation (e.g. contact penetration)
will be compensated for during the velocity solve.
If zero, you need to enable the positional solver.
If non-zero, you do not need the positional solver.
A good non-zero value is around 0.2
.
(default 0.0
).
allowed_linear_error: f32
Amount of penetration the engine wont attempt to correct (default: 0.005m
).
prediction_distance: f32
The maximal distance separating two objects that will generate predictive contacts (default: 0.002
).
allowed_angular_error: f32
Amount of angular drift of joint limits the engine wont
attempt to correct (default: 0.001rad
).
max_linear_correction: f32
Maximum linear correction during one step of the non-linear position solver (default: 0.2
).
max_angular_correction: f32
Maximum angular correction during one step of the non-linear position solver (default: 0.2
).
max_velocity_iterations: usize
Maximum number of iterations performed by the velocity constraints solver (default: 4
).
max_position_iterations: usize
Maximum number of iterations performed by the position-based constraints solver (default: 1
).
min_island_size: usize
Minimum number of dynamic bodies in each active island (default: 128
).
max_ccd_substeps: usize
Maximum number of substeps performed by the solver (default: 1
).
Implementations
impl IntegrationParameters
pub fn new(
dt: f32,
erp: f32,
joint_erp: f32,
warmstart_coeff: f32,
allowed_linear_error: f32,
allowed_angular_error: f32,
max_linear_correction: f32,
max_angular_correction: f32,
prediction_distance: f32,
max_velocity_iterations: usize,
max_position_iterations: usize,
max_ccd_substeps: usize
) -> IntegrationParameters
dt: f32,
erp: f32,
joint_erp: f32,
warmstart_coeff: f32,
allowed_linear_error: f32,
allowed_angular_error: f32,
max_linear_correction: f32,
max_angular_correction: f32,
prediction_distance: f32,
max_velocity_iterations: usize,
max_position_iterations: usize,
max_ccd_substeps: usize
) -> IntegrationParameters
Use IntegrationParameters { dt: 60.0, ..Default::default() }
instead
Creates a set of integration parameters with the given values.
pub fn dt(&self) -> f32
You can just read the IntegrationParams::dt
value directly
The current time-stepping length.
pub fn inv_dt(&self) -> f32
The inverse of the time-stepping length, i.e. the steps per seconds (Hz).
This is zero if self.dt
is zero.
pub fn set_dt(&mut self, dt: f32)
You can just set the IntegrationParams::dt
value directly
Sets the time-stepping length.
pub fn set_inv_dt(&mut self, inv_dt: f32)
Sets the inverse time-stepping length (i.e. the frequency).
This automatically recompute self.dt
.
Trait Implementations
impl Clone for IntegrationParameters
pub fn clone(&self) -> IntegrationParameters
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for IntegrationParameters
impl Default for IntegrationParameters
pub fn default() -> IntegrationParameters
impl From<IntegrationParameters> for RapierPlugin
[src]
pub fn from(parameters: IntegrationParameters) -> RapierPlugin
[src]
impl From<IntegrationParameters> for PhysicsPlugin
[src]
fn from(parameters: IntegrationParameters) -> Self
[src]
Auto Trait Implementations
impl RefUnwindSafe for IntegrationParameters
impl Send for IntegrationParameters
impl Sync for IntegrationParameters
impl Unpin for IntegrationParameters
impl UnwindSafe for IntegrationParameters
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Any for T where
T: Any,
T: Any,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CloneAny for T where
T: Any + Clone,
T: Any + Clone,
impl<T> Component for T where
T: 'static + Send + Sync,
T: 'static + Send + Sync,
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> Downcast<T> for T
impl<T> DowncastSync for T where
T: Any + Send + Sync,
T: Any + Send + Sync,
impl<T> From<T> for T
[src]
impl<T> FromWorld for T where
T: Default,
T: Default,
pub fn from_world(_world: &mut World) -> T
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
T: 'static + Send + Sync + Clone,
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
impl<T> Upcast<T> for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,