wiki.sine.space | sinespace

Difference between revisions of "Scripting/SMath"

From wiki.sine.space
Jump to: navigation, search
Line 44: Line 44:
 
{{ScriptFunction|float|Exp|(float val);|Returns e raised to val power.|5=Space.Log('''Space.Math.Exp'''(3.0));<br>''-- prints 20.0855369567871''}}
 
{{ScriptFunction|float|Exp|(float val);|Returns e raised to val power.|5=Space.Log('''Space.Math.Exp'''(3.0));<br>''-- prints 20.0855369567871''}}
  
{{ScriptFunction|int|Floor|(float val);|Returns floor of val, converted to an int|5=Space.Log('''Space.Math.Floor'''(4.0));<br>''-- prints 4''<br><br>Space.Log('''Space.Math.Floor'''(4.2));''-- prints 4''<br><br>Space.Log('''Space.Math.Floor'''(-4.2));<br>''-- prints -5''}}
+
{{ScriptFunction|int|Floor|(float val);|Returns floor of val, converted to an int|5=Space.Log('''Space.Math.Floor'''(4.0));<br>''-- prints 4''<br><br>Space.Log('''Space.Math.Floor'''(4.2));<br>''-- prints 4''<br<br>Space.Log('''Space.Math.Floor'''(-4.2));<br>''-- prints -5''}}
  
 
{{ScriptFunction|float|GammaToLinearSpace|(float val);|Converts a colour value from Gamma to Linear Space (Pow 2.2)}}
 
{{ScriptFunction|float|GammaToLinearSpace|(float val);|Converts a colour value from Gamma to Linear Space (Pow 2.2)}}

Revision as of 01:35, 21 April 2017

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

Fields

Pi

float Pi ;

Returns the constant value of Π (readonly).

Space.Log(Space.Math.Pi);
-- prints 3.14159274101257

Members

Random

float Random ();

Returns a random float between 0 and 1 (inclusive)

local randomNumber = Space.Math.Random();
Space.Log(randomNumber);
-- prints 0.689094245433807

RandomRange

float RandomRange (float min, float max);

Returns a random float between min and max (inclusive)

local min = 100.0;
local max = 500.0;
local randomNumber = Space.Math.RandomRange(min, max );
Space.Log(randomNumber);
-- prints 0206.659149169922

RandomInteger

int RandomInteger (int min, int max);

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

local min = 50;
local max = 75;
local randomInteger = Space.Math.RandomInteger(min, max);
Space.Log(randomInteger);
-- prints 52

Abs

float Abs (float val);

Returns the absolute value of 'val'

local value = -4.2
local absoluteNum = Space.Math.Abs(value);
Space.Log(absoluteNum);
-- prints 4 [BUG] should be 4.2

Abs

int Abs (int val);

Returns the absolute value of 'val'

local value = -4
local absoluteNum = Space.Math.Abs(value);
Space.Log(absoluteNum);
-- prints 4

Acos

float Acos (float val);

Returns the arc cosine value of 'val'

local value = 0.5;
local arcCosine = Space.Math.Acos(value);
Space.Log(arcCosine);
-- prints 1.04719758033752 (radians) which is 60 degrees

Approximately

bool Approximately (float a, float b);

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

local a = 5.0;
local b = 5;
local approx1 = Space.Math.Approximately(a, b);
Space.Log(approx1);
-- prints true

local a = 5.01;
local b = 5.0;
local approx2 = Space.Math.Approximately(a, b);
Space.Log(approx2);
-- prints false

local a = 5.01;
local b = 5.0;
local approx3 = Space.Math.Approximately(a, b);
Space.Log(approx3);
-- prints false

Asin

bool Asin (float val);

Returns the arc sine value of 'val'

local value = 0.5;
local arcSine = Space.Math.Asin(value);
Space.Log(arcSine);
-- prints 0.523598790168762 (radians) which is 30 degrees

Atan

bool Atan (float val);

Returns the arc tangent value of 'val'

local value = 1.732050808;
local arcTangent = Space.Math.Atan(value);
Space.Log(arcTangent);
-- prints 1.04719758033752 (radians) which is 60 degrees

Atan2

bool Atan2 (float y, float x);

Returns the arc tangent of y/x

local x = 0.5;
local y = 0.5;
local arcTangent = Space.Math.Atan2(y, x);
Space.Log(arcTangent);
-- prints 0.785398185253143

Ceil

int Ceil (float val);

Returns the ceil value of 'val' as an integer

Space.Log(Space.Math.Ceil(4.0));
-- prints 4

Space.Log(Space.Math.Ceil(4.2));
-- prints 5

Space.Log(Space.Math.Ceil(-4.2));
-- prints -4

Clamp

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

Clamps val between min and max, and returns the result

local value = 100.0;
local min = 20.0;
local max = 82.0;

local clampedValue = Space.Math.Clamp(value, min, max);
Space.Log(clampedValue);
-- prints 82

Clamp01

float Clamp01 (float val);

Clamps val between 0 and 1, and returns the result

local value = -1.0;

local clampedValue = Space.Math.Clamp01(value);
Space.Log(clampedValue);
-- prints 0

ClosestPowerOfTwo

int ClosestPowerOfTwo (int val);

Returns the closest power of two to val

local value = 33;

local powerOfTwo = Space.Math.ClosestPowerOfTwo(value);
Space.Log(powerOfTwo);
-- prints 32

Cos

float Cos (float val);

Returns the cosine of val

local angle = 1.04719758033752; -- converts to 60 degrees
local cosine = Space.Math.Cos(angle);
Space.Log(cosine);
-- prints 0.499999970197678

local angle2 = Space.Math.Pi/3; -- converts to 60 degrees
local cosine2 = Space.Math.Cos(angle2);
Space.Log(cosine2);
-- prints 0.499999970197678

DeltaAngle

float DeltaAngle (float current, float target);

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

Space.Log(Space.Math.DeltaAngle(350.0, 17.0));
-- prints 27

Exp

float Exp (float val);

Returns e raised to val power.

Space.Log(Space.Math.Exp(3.0));
-- prints 20.0855369567871

Floor

int Floor (float val);

Returns floor of val, converted to an int

Space.Log(Space.Math.Floor(4.0));
-- prints 4

Space.Log(Space.Math.Floor(4.2));
-- prints 4<br
Space.Log(Space.Math.Floor(-4.2));
-- prints -5

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