HPL3/SOMA/Scripting/Scripting Api/Constants

Constant Summary

Return Type	Function and Description
cColor	cColor_Blue The RGBA value of blue.
cColor	cColor_Green The RGBA value of green.
cColor	cColor_Red The RGBA value of red.
cColor	cColor_White The RGBA value of white.
float	cMath_Epsilon The value of correction for small floating point numbers.
float	cMath_Pi Approximate value of pi.
float	cMath_PiDiv2 Approximate value of pi divided by 2.
float	cMath_PiDiv4 Approximate value of pi divided by 4.
float	cMath_PiMul2 Approximate value of pi multiplied by 2.
float	cMath_Sqrt2 Approximate value of the square root of 2
cMatrixf	cMatrixf_Identity The identity matrix.
cMatrixf	cMatrixf_Zero A zero-filled matrix.
cQuaternion	cQuaternion_Identity The quaternion identity.
cVector2f	cVector2f_Down The down-facing 2D vector.
cVector2f	cVector2f_Left The left-facing 2D vector.
cVector2f	cVector2f_MinusOne A negative-one-filled 2D vector.
cVector2f	cVector2f_One A one-filled 2D vector.
cVector2f	cVector2f_Right The right-facing 2D vector.
cVector2f	cVector2f_Up The up-facing 2D vector.
cVector2f	cVector2f_Zero A zero-filled 2D vector.
cVector2l	cVector2l_MinusOne A negative-one-filled 2D vector.
cVector3f	cVector3f_Back The backward-facing 3D vector.
cVector3f	cVector3f_Down The down-facing 3D vector.
cVector3f	cVector3f_Forward The forward-facing 3D vector.
cVector3f	cVector3f_Left The left-facing 3D vector.
cVector3f	cVector3f_MinusOne A negative-one-filled 3D vector.
cVector3f	cVector3f_One A one-filled 3D vector.
cVector3f	cVector3f_Right The right-facing 3D vector.
cVector3f	cVector3f_Up The up-facing 3D vector.
cVector3f	cVector3f_Zero A zero-filled 3D vector.
cVector4f	cVector4f_MinusOne A negative-one-filled 4D vector.
cVector4f	cVector4f_One A one-filled 4D vector.
cVector4f	cVector4f_Zero A zero-filled 4D vector.
tID	tID_Invalid The static value of an invalid tID.

Constant Detail

cColor_Blue

const cColor cColor_Blue = cColor(0.0, 0.0, 1.0, 1.0)

The RGBA value of blue.

cColor_Green

const cColor cColor_Green = cColor(0.0, 1.0, 0.0, 1.0)

The RGBA value of green.

cColor_Red

const cColor cColor_Red = cColor(1.0, 0.0, 0.0, 1.0)

The RGBA value of red.

cColor_White

const cColor cColor_White = cColor(1.0, 1.0, 1.0, 1.0)

The RGBA value of white.

cMath_Epsilon

const float cMath_Epsilon = 0.0001

The value of correction for small floating point numbers.

When two floats are subtracted, floating point errors can make the result not exact. (i.e. 3.0 - 2.0 == 1.0 may not strictly be true.) As such, if the difference between two floats is less than the value of cMath_Epsilon, those two floats can be considered equal.

cMath_Pi

const float cMath_Pi = 3.141593

Approximate value of pi.

cMath_PiDiv2

const float cMath_PiDiv2

Approximate value of pi divided by 2.

cMath_PiDiv4

const float cMath_PiDiv4

Approximate value of pi divided by 4.

cMath_PiMul2

const float cMath_PiMul2

Approximate value of pi multiplied by 2.

cMath_Sqrt2

const float cMath_Sqrt2

Approximate value of the square root of 2.

cMatrixf_Identity

const cMatrixf cMatrixf_Identity = cMatrixf(1.0, 0.0, 0.0, 0.0,
                                            0.0, 1.0, 0.0, 0.0,
                                            0.0, 0.0, 1.0, 0.0,
                                            0.0, 0.0, 0.0, 1.0)

The identity matrix.

cMatrixf_Zero

const cMatrixf cMatrixf_Zero = cMatrixf(0.0, 0.0, 0.0, 0.0,
                                        0.0, 0.0, 0.0, 0.0,
                                        0.0, 0.0, 0.0, 0.0,
                                        0.0, 0.0, 0.0, 0.0)

A zero-filled matrix.

cQuaternion_Identity

const cQuaternion cQuaternion_Identity = cQuaternion(0.0, 0.0, 0.0, 1.0)

The quaternion identity.

cVector2f_Down

const cVector2f cVector2f_Down = cVector2f(0.0, -1.0)

The down-facing 2D vector.

cVector2f_Left

const cVector2f cVector2f_Left = cVector2f(-1.0, 0.0)

The left-facing 2D vector.

cVector2f_MinusOne

const cVector2f cVector2f_MinusOne = cVector2f(-1.0, -1.0)

A negative-one-filled 2D vector.

cVector2f_One

const cVector2f cVector2f_One = cVector2f(1.0, 1.0)

A one-filled 2D vector.

cVector2f_Right

const cVector2f cVector2f_Right = cVector2f(1.0, 0.0)

The right-facing 2D vector.

cVector2f_Up

const cVector2f cVector2f_Up = cVector2f(0.0, 1.0)

The up-facing 2D vector.

cVector2f_Zero

const cVector2f cVector2f_Zero = cVector2f(0.0, 0.0)

A zero-filled 2D vector.

cVector2l_MinusOne

const cVector2l cVector2l_MinusOne = cVector2l(-1, -1)

A negative-one-filled 2D vector.

cVector3f_Back

const cVector3f cVector3f_Back = cVector3f(0.0, 0.0, -1.0)

The backward-facing 3D vector.

cVector3f_Down

const cVector3f cVector3f_Down = cVector3f(0.0, -1.0, 0.0)

The down-facing 3D vector.

cVector3f_Forward

const cVector3f cVector3f_Forward = cVector3f(0.0, 0.0, 1.0)

The forward-facing 3D vector.

cVector3f_Left

const cVector3f cVector3f_Left = cVector3f(-1.0, 0.0, 0.0)

The left-facing 3D vector.

cVector3f_MinusOne

const cVector3f cVector3f_MinusOne = cVector3f(-1.0, -1.0, -1.0)

A negative-one-filled 3D vector.

cVector3f_One

const cVector3f cVector3f_One = cVector3f(1.0, 1.0, 1.0)

A one-filled 3D vector.

cVector3f_Right

const cVector3f cVector3f_Right = cVector3f(1.0, 0.0, 0.0)

The right-facing 3D vector.

cVector3f_Up

const cVector3f cVector3f_Up = cVector3f(0.0, 1.0, 0.0)

The up-facing 3D vector.

cVector3f_Zero

const cVector3f cVector3f_Zero = cVector3f(0.0, 0.0, 0.0)

A zero-filled 3D vector.

cVector4f_MinusOne

const cVector4f cVector4f_MinusOne = cVector4f(-1.0, -1.0, -1.0, -1.0)

A negative-one-filled 4D vector.

cVector4f_One

const cVector4f cVector4f_One = cVector4f(1.0, 1.0, 1.0, 1.0)

A one-filled 4D vector.

cVector4f_Zero

const cVector4f cVector4f_Zero = cVector4f(0.0, 0.0, 0.0, 0.0)

A zero-filled 4D vector.

tID_Invalid

const tID tID_Invalid

The static value of an invalid tID.