Axmol Engine 2.4.0-258ceca
Loading...
Searching...
No Matches
MathUtil Class Reference

Defines a math utility class. More...

#include <MathUtil.h>

Static Public Member Functions

static void smooth (float *x, float target, float elapsedTime, float responseTime)
 Updates the given scalar towards the given target using a smoothing function.
 
static void smooth (float *x, float target, float elapsedTime, float riseTime, float fallTime)
 Updates the given scalar towards the given target using a smoothing function.
 
static float lerp (float from, float to, float alpha)
 Linearly interpolates between from value to to value by alpha which is in the range [0,1].
 

Detailed Description

Defines a math utility class.

This is primarily used for optimized internal math operations.

Member Function Documentation

◆ smooth() [1/2]

static void smooth ( float * x,
float target,
float elapsedTime,
float responseTime )
static

Updates the given scalar towards the given target using a smoothing function.

The given response time determines the amount of smoothing (lag). A longer response time yields a smoother result and more lag. To force the scalar to follow the target closely, provide a response time that is very small relative to the given elapsed time.

Parameters
xthe scalar to update.
targettarget value.
elapsedTimeelapsed time between calls.
responseTimeresponse time (in the same units as elapsedTime).

◆ smooth() [2/2]

static void smooth ( float * x,
float target,
float elapsedTime,
float riseTime,
float fallTime )
static

Updates the given scalar towards the given target using a smoothing function.

The given rise and fall times determine the amount of smoothing (lag). Longer rise and fall times yield a smoother result and more lag. To force the scalar to follow the target closely, provide rise and fall times that are very small relative to the given elapsed time.

Parameters
xthe scalar to update.
targettarget value.
elapsedTimeelapsed time between calls.
riseTimeresponse time for rising slope (in the same units as elapsedTime).
fallTimeresponse time for falling slope (in the same units as elapsedTime).

◆ lerp()

static float lerp ( float from,
float to,
float alpha )
static

Linearly interpolates between from value to to value by alpha which is in the range [0,1].

Parameters
fromthe from value.
tothe to value.
alphathe alpha value between [0,1]
Returns
interpolated float value

The documentation for this class was generated from the following file: