Struct VelocityBoundary

pub struct VelocityBoundary {
    pub direction: Dir3,
    /* private fields */
}

An indication that a character was knocked back and “struggles” to get back to its original velocity.

Fields

direction: Dir3

Implementations

impl VelocityBoundary

pub fn new( disruption_from: Vector3, disruption_to: Vector3, no_push_timeout: f32, ) -> Option<Self>

pub fn update(&mut self, velocity: Vector3, frame_duration: Duration)

Call this every frame to update the velocity boundary.

This methos takes care of “clearing” the boundary when it gets “pushed” (the character’s actual velocity goes past the boundary).

This method does not detect when the boundary is cleared - use is_cleared for that purpose

This method does not apply the boundary - it only updates it. To apply the boundary, use calc_boost_part_on_boundary_axis_after_limit to determine how to alter the acceleration.

Arguments:

• velocity - the velocity as reported by the physics backend. This is the data tracked in the TnuaRigidBodyTracker, so a typical basis or action will get it from TnuaBasisContext::tracker.
• frame_duration - the duration of the current frame, in seconds.

pub fn is_cleared(&self) -> bool

pub fn calc_boost_part_on_boundary_axis_after_limit( &self, current_velocity: Vector3, regular_boost: Vector3, boost_limit_inside_barrier: Float, barrier_strength_diminishing: Float, ) -> Option<(Dir3, Float)>

Calculate how a boost needs to be adjusted according to the boundary.

Note that the returned value is the boost limit only on the axis of the returned direction. The other axes should remain the same (unless the caller has a good reason to modify them). The reason why this method doesn’t simply return the final boost is that the caller may be using TnuaVelChange which combines acceleration and impulse, and if so then it is the caller’s responsibility to amend the result of this method to match that scheme.

Arguments:

• current_velocity - the velocity of the character before the boost.
• regular_boost - the boost that the caller would have applied to the character before taking the boundary into account.
• boost_limit_inside_barrier - the maximum boost allowed inside a fully strength barrier, assuming it goes directly against the direction of the boundary.
• barrier_strength_diminishing - an exponent describing how the boundary strength diminishes when the barrier gets cleared. For best results, set it to values larger than 1.0.

Trait Implementations

impl Clone for VelocityBoundary

fn clone(&self) -> VelocityBoundary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VelocityBoundary

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

Formats the value using the given formatter.