Scripting/SMath

From sine.space Wiki
Jump to: navigation, search

The SMath class contains common math functions, see also SVector and SQuaternion for Vector and Quaternion related math functions.

Members

Random

float Random ();

Returns a random float between 0 and 1 (inclusive)

No example provided yet

RandomRange

float RandomRange (float min, float max);

Returns a random float between min and max (inclusive)

No example provided yet

RandomInteger

int RandomInteger (int min, int max);

Returns a random float between min (inclusive) and max (exclusive)

No example provided yet

Abs

float Abs (float val);

Returns the absolute value of 'val'

No example provided yet

Abs

int Abs (int val);

Returns the absolute value of 'val'

No example provided yet

Acos

float Acos (float val);

Returns the arc cosine value of 'val'

No example provided yet

Approximately

bool Approximately (float a, float b);

True if the difference between a and b is less than epsilon

No example provided yet

Asin

bool Asin (float val);

Returns the arc sine value of 'val'

No example provided yet

Atan

bool Atan (float val);

Returns the arc tangent value of 'val'

No example provided yet

Atan2

bool Atan2 (float y, float x);

Returns the arc tangent of y/x

No example provided yet

Ceil

int Ceil (float val);

Returns the ceil value of 'val' as an integer

No example provided yet

Clamp

float Clamp (float val, float min, float max);

Clamps val between min and max, and returns the result

No example provided yet

Clamp01

float Clamp01 (float val);

Clamps val between 0 and 1, and returns the result

No example provided yet

ClosestPowerOfTwo

int ClosestPowerOfTwo (int val);

Returns the closest power of two to val

No example provided yet

Cos

float Cos (float val);

Returns the cosine of val

No example provided yet

DeltaAngle

float DeltaAngle (float current, float target);

Returns the difference in degrees between two values (e.g. 350' and 17' returns 27')

No example provided yet

Exp

float Exp (float val);

Returns Exp of val

No example provided yet

Floor

int Floor (float val);

Returns floor of val, converted to an int

No example provided yet

GammaToLinearSpace

float GammaToLinearSpace (float val);

Converts a colour value from Gamma to Linear Space (Pow 2.2)

No example provided yet

InverseLerp

float InverseLerp (float a, float b, float val);

Returns the percentage between a and b that 'val' is on a line (opposite of Lerp)

No example provided yet

IsPowerOfTwo

bool IsPowerOfTwo (int val);

Returns true if val is a power of two

No example provided yet

Lerp

float Lerp (float a, float b, float val);

Interpolates between 'a' and 'b' based on 'val', assuming 'val' is between 0 and 1

No example provided yet

LerpAngle

float LerpAngle (float a, float b, float val);

Interpolates between angles 'a' and 'b' based on 'val', assuming 'val' is between 0 and 1

No example provided yet

LerpUnclamped

float LerpUnclamped (float a, float b, float val);

Interpolates between 'a' and 'b' based on 'val', assuming 'val' is between 0 and 1, but unbounded (allowing higher/lower values)

No example provided yet

GammaToLinearSpace

float GammaToLinearSpace (float val);

Converts a colour value from Linear to Gamma Space (Pow 1/2.2)

No example provided yet

Log

float Log (float val);

Returns the natural logarithm for 'val'

No example provided yet

Log

float Log (float val, float p);

Returns the logarithm of 'p' for 'val'

No example provided yet

Log10

float Log10 (float val);

Returns the Log10 value for 'val'

No example provided yet

Max

float Max (float a, float b);

Returns higher of 'a' or 'b'

No example provided yet

Min

float Min (float a, float b);

Returns lower of 'a' or 'b'

No example provided yet

MoveTowards

float MoveTowards (float value, float target, float delta);

Move value to target, but by no more than delta

No example provided yet

MoveTowardsAngle

float MoveTowardsAngle (float value, float target, float delta);

Move angle value to target, but by no more than delta

No example provided yet

NextPowerOfTwo

int NextPowerOfTwo (int val);

Return the next power of two larger or equal to val

No example provided yet

PerlinNoise

float PerlinNoise (float x, float y);

Return 2D Perlin noise for coordinates x and y

No example provided yet

PingPong

float PingPong (float val, float length);

Return a value between 0 and length that oscillates upwards and back based on the position of 'val'

No example provided yet

Pow

float Pow (float x, float y);

Return x raised to y power

No example provided yet

Repeat

float Repeat (float val, float length);

Return a value between 0 and length that returns to 0 after exceeding length based on 'val'

No example provided yet

Round

int Round (float val);

Returns the nearest integer value to val

No example provided yet

Sign

float Sign (float val);

Returns either 1 or -1 based on the sign of 'val'

No example provided yet

Sin

float Sin (float val);

Returns the sine of val

No example provided yet

SmoothStep

float SmoothStep (float from, float to, float val);

Similar to Lerp but moves slowly closer to the edges ('Spherical Lerp')

No example provided yet

Sqrt

float Sqrt (float val);

Returns the square root of val

No example provided yet

Tan

float Tan (float val);

Returns the tangent value of 'val'

No example provided yet