net.risingworld.api.utils

Class Utils.MathUtils

java.lang.Object

net.risingworld.api.utils.Utils.MathUtils

Enclosing class:

Utils

public abstract static class Utils.MathUtils
extends java.lang.Object

Contains useful math functions. Unlike the regular Java Math class, this class uses float values and an improved random number generator, resulting in better performance. Unless you really need double precision, it's highly recommendable to use this class.

See Also:

Math

Field Summary

Fields

Modifier and Type	Field and Description
static float	HALF_PI Half PI value as a float (90 degrees).
static float	PI PI value as a float (180 degrees).
static float	QUARTER_PI Quarter PI value as a float (45 degrees).
static float	TWO_PI Two PI value as a float (360 degrees).

Constructor Summary

Constructors

Constructor and Description
MathUtils()

Method Summary

Modifier and Type	Method and Description
static float	abs(float value) Gets the absolute value of a float value.
static int	absInt(int value) Gets the absolute value of an int value.
static float	clamp(float min, float max, float value) Clamps the value between min and max.
static float	degreeToRadian(float degree) Converts a degree value to radians.
static int	getGCD(int... input) Gets the greatest common divisor of several int values.
static int	getGCD(int a, int b) Gets the greatest common divisor of two int values.
static boolean	nextRandomBoolean() Gets a random boolean value (true or false).
static float	nextRandomFloat() Gets a random float value between 0 and 1
static int	nextRandomInt(int min, int max) Gets a random int value between min (inclusive) and max (inclusive).
static float	radianToDegree(float radian) Converts a radian value to degree.
static float	round(float value, int digit) Rounds a float value to a given decimal place.
static float	smoothstep(float min, float max, float value) Performs a smooth Hermite interpolation between 0 and 1.
static float	sqr(float value) Gets the value squared (value ^ 2).
static float	sqrt(float value) Gets the square root of a given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PI

public static final float PI

PI value as a float (180 degrees).

See Also:

Constant Field Values

HALF_PI

public static final float HALF_PI

Half PI value as a float (90 degrees).

See Also:

Constant Field Values

QUARTER_PI

public static final float QUARTER_PI

Quarter PI value as a float (45 degrees).

See Also:

Constant Field Values

TWO_PI

public static final float TWO_PI

Two PI value as a float (360 degrees).

See Also:

Constant Field Values

Constructor Detail

MathUtils

public MathUtils()

Method Detail

abs

public static float abs(float value)

Gets the absolute value of a float value.

Parameters:

value - the argument whose absolute value is to be determined.

Returns:

the absolute value.

absInt

public static int absInt(int value)

Gets the absolute value of an int value.

Parameters:

value - the argument whose absolute value is to be determined.

Returns:

the absolute value.

sqr

public static float sqr(float value)

Gets the value squared (value ^ 2).

Parameters:

value - the value to square.

Returns:

the square value.

sqrt

public static float sqrt(float value)

Gets the square root of a given value.

Parameters:

value - the value you want to get the square root of.

Returns:

the square root value.

See Also:

Math.sqrt(double)

degreeToRadian

public static float degreeToRadian(float degree)

Converts a degree value to radians.

Parameters:

degree - the degree value.

Returns:

the degree value in radians.

radianToDegree

public static float radianToDegree(float radian)

Converts a radian value to degree.

Parameters:

radian - the radian value.

Returns:

the radian value in degree.

clamp

public static float clamp(float min,
                          float max,
                          float value)

Clamps the value between min and max.

Parameters:

min - the min value.

max - the max value.

value - the value you want to clamp.

Returns:

the clamped value.

smoothstep

public static float smoothstep(float min,
                               float max,
                               float value)

Performs a smooth Hermite interpolation between 0 and 1.

Parameters:

min - the lower edge value.

max - the upper edge value.

value - the source value for interpolation.

Returns:

the interpolated value between 0 and 1. If the value is smaller than min, 0 will be returned. If the value is greater than max, 1 will be returned. Between those values you get an interpolated value.

See Also:

https://en.wikipedia.org/wiki/Smoothstep

getGCD

public static int getGCD(int... input)

Gets the greatest common divisor of several int values.

Parameters:

input - multiple int values you want to calculate the GCD of.

Returns:

the greatest common divisor.

getGCD

public static int getGCD(int a,
                         int b)

Gets the greatest common divisor of two int values.

Parameters:

a - first int value.

b - second int value.

Returns:

the greatest common divisor of the two values.

round

public static float round(float value,
                          int digit)

Rounds a float value to a given decimal place.

Parameters:

value - the value you want to round.

digit - the decimal places.

Returns:

the rounded value.

nextRandomFloat

public static float nextRandomFloat()

Gets a random float value between 0 and 1

Returns:

a pseudorandom float value.

nextRandomInt

public static int nextRandomInt(int min,
                                int max)

Gets a random int value between min (inclusive) and max (inclusive).

Parameters:

min - the lower bound (inclusive)

max - the upper bound (inclusive)

Returns:

a pseudorandom int value.

nextRandomBoolean

public static boolean nextRandomBoolean()

Gets a random boolean value (true or false).

Returns:

a pseudorandom boolean value.