Struct MoveShapeOptions

pub struct MoveShapeOptions {
    pub up: Vect,
    pub offset: CharacterLength,
    pub slide: bool,
    pub autostep: Option<CharacterAutostep>,
    pub max_slope_climb_angle: Real,
    pub min_slope_slide_angle: Real,
    pub apply_impulse_to_dynamic_bodies: bool,
    pub snap_to_ground: Option<CharacterLength>,
    pub normal_nudge_factor: Real,
}

Options for moving a shape using RapierContext::move_shape.

Fields

up: Vect

The direction that goes “up”. Used to determine where the floor is, and the floor’s angle.

offset: CharacterLength

A small gap to preserve between the character and its surroundings.

This value should not be too large to avoid visual artifacts, but shouldn’t be too small (must not be zero) to improve numerical stability of the character controller.

slide: bool

Should the character try to slide against the floor if it hits it?

autostep: Option<CharacterAutostep>

Should the character automatically step over small obstacles?

max_slope_climb_angle: Real

The maximum angle (radians) between the floor’s normal and the up vector that the character is able to climb.

min_slope_slide_angle: Real

The minimum angle (radians) between the floor’s normal and the up vector before the character starts to slide down automatically.

apply_impulse_to_dynamic_bodies: bool

Should the character apply forces to dynamic bodies in its path?

snap_to_ground: Option<CharacterLength>

Should the character be automatically snapped to the ground if the distance between the ground and its feet are smaller than the specified threshold?

normal_nudge_factor: Real

Increase this number if your character appears to get stuck when sliding against surfaces.

This is a small distance applied to the movement toward the contact normals of shapes hit by the character controller. This helps shape-casting not getting stuck in an always-penetrating state during the sliding calculation.

This value should remain fairly small since it can introduce artificial “bumps” when sliding along a flat surface.

Trait Implementations

impl Clone for MoveShapeOptions

fn clone(&self) -> MoveShapeOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MoveShapeOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MoveShapeOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for MoveShapeOptions

fn eq(&self, other: &MoveShapeOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for MoveShapeOptions

impl StructuralPartialEq for MoveShapeOptions