Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api"
Line 6: | Line 6: | ||
{{note|It is STRONGLY recommended to use the functions via [[HPL3/Scripting/Setting up CodeLite|CodeLite]] as it provides documentation and is much easier to navigate and use.}} | {{note|It is STRONGLY recommended to use the functions via [[HPL3/Scripting/Setting up CodeLite|CodeLite]] as it provides documentation and is much easier to navigate and use.}} | ||
<br> | <br> | ||
− | == | + | ==Constant Summary== |
− | {{ | + | {{CodeDocSummaryTop}} |
− | {| | + | {{CodeDocSummaryItem|[[../cColor|cColor]]|[[#cColor_Blue|cColor_Blue]]|The RGBA value of blue.}} |
− | + | {{CodeDocSummaryItem|[[../cColor|cColor]]|[[#cColor_Green|cColor_Green]]|The RGBA value of green.}} | |
− | | | + | {{CodeDocSummaryItem|[[../cColor|cColor]]|[[#cColor_Red|cColor_Red]]|The RGBA value of red.}} |
− | | | + | {{CodeDocSummaryItem|[[../cColor|cColor]]|[[#cColor_White|cColor_White]]|The RGBA value of white.}} |
− | |- | + | {{CodeDocSummaryItem|float|[[#cMath_Epsilon|cMath_Epsilon]]|The value of correction for small floating point numbers.}} |
− | | | + | {{CodeDocSummaryItem|float|[[#cMath_Pi|cMath_Pi]]|Approximate value of pi.}} |
− | |- | + | {{CodeDocSummaryItem|float|[[#cMath_PiDiv2|cMath_PiDiv2]]|Approximate value of pi divided by 2.}} |
− | | | + | {{CodeDocSummaryItem|float|[[#cMath_PiDiv4|cMath_PiDiv4]]|Approximate value of pi divided by 4.}} |
− | |- | + | {{CodeDocSummaryItem|float|[[#cMath_PiMul2|cMath_PiMul2]]|Approximate value of pi multiplied by 2.}} |
− | | | + | {{CodeDocSummaryItem|float|[[#cMath_Sqrt2|cMath_Sqrt2]]|Approximate value of the square root of 2}} |
− | |} | + | {{CodeDocSummaryItem|[[../cMatrixf|cMatrixf]]|[[#cMatrixf_Identity|cMatrixf_Identity]]|The identity matrix.}} |
− | {{ | + | {{CodeDocSummaryItem|[[../cMatrixf|cMatrixf]]|[[#cMatrixf_Zero|cMatrixf_Zero]]|A zero-filled matrix.}} |
+ | {{CodeDocSummaryItem|[[../cQuaternion|cQuaternion]]|[[#cQuaternion_Identity|cQuaternion_Identity]]|The quaternion identity.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_Down|cVector2f_Down]]|The down-facing 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_Left|cVector2f_Left]]|The left-facing 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_MinusOne|cVector2f_MinusOne]]|A negative-one-filled 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_One|cVector2f_One]]|A one-filled 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_Right|cVector2f_Right]]|The right-facing 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_Up|cVector2f_Up]]|The up-facing 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2f|cVector2f]]|[[#cVector2f_Zero|cVector2f_Zero]]|A zero-filled 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector2l|cVector2l]]|[[#cVector2l_MinusOne|cVector2l_MinusOne]]|A negative-one-filled 2D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Back|cVector3f_Back]]|The backward-facing 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Down|cVector3f_Down]]|The down-facing 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Forward|cVector3f_Forward]]|The forward-facing 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Left|cVector3f_Left]]|The left-facing 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_MinusOne|cVector3f_MinusOne]]|A negative-one-filled 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_One|cVector3f_One]]|A one-filled 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Right|cVector3f_Right]]|The right-facing 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Up|cVector3f_Up]]|The up-facing 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#cVector3f_Zero|cVector3f_Zero]]|A zero-filled 3D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector4f|cVector4f]]|[[#cVector4f_MinusOne|cVector4f_MinusOne]]|A negative-one-filled 4D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector4f|cVector4f]]|[[#cVector4f_One|cVector4f_One]]|A one-filled 4D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../cVector4f|cVector4f]]|[[#cVector4f_Zero|cVector4f_Zero]]|A zero-filled 4D vector.}} | ||
+ | {{CodeDocSummaryItem|[[../tID|tID]]|[[#tID_Invalid|tID_Invalid]]|The static value of an invalid tID.}} | ||
+ | {{CodeDocSummaryBottom}} | ||
− | + | ==Constant Detail== | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | {{ | + | {{CodeDocDetailTop|cColor_Blue}} |
− | + | <syntaxhighlight lang="c++">const cColor cColor_Blue = cColor(0.0, 0.0, 1.0, 1.0)</syntaxhighlight> | |
− | + | {{CodeDocDetailBody|The RGBA value of blue.}} | |
− | + | {{CodeDocDetailBottom}} | |
− | |||
− | | | ||
− | |||
− | |||
− | {{ | ||
− | {{ | + | {{CodeDocDetailTop|cColor_Green}} |
− | + | <syntaxhighlight lang="c++">const cColor cColor_Green = cColor(0.0, 1.0, 0.0, 1.0)</syntaxhighlight> | |
− | + | {{CodeDocDetailBody|The RGBA value of green.}} | |
− | + | {{CodeDocDetailBottom}} | |
− | |||
− | |} | ||
− | {{ | ||
− | {{ | + | {{CodeDocDetailTop|cColor_Red}} |
− | + | <syntaxhighlight lang="c++">const cColor cColor_Red = cColor(1.0, 0.0, 0.0, 1.0)</syntaxhighlight> | |
− | + | {{CodeDocDetailBody|The RGBA value of red.}} | |
− | + | {{CodeDocDetailBottom}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | {{ | ||
− | {{ | + | {{CodeDocDetailTop|cColor_White}} |
− | + | <syntaxhighlight lang="c++">const cColor cColor_White = cColor(1.0, 1.0, 1.0, 1.0)</syntaxhighlight> | |
− | + | {{CodeDocDetailBody|The RGBA value of white.}} | |
− | + | {{CodeDocDetailBottom}} | |
− | |||
− | |} | ||
− | {{ | ||
− | {{ | + | {{CodeDocDetailTop|cMath_Epsilon}} |
− | + | <syntaxhighlight lang="c++">const float cMath_Epsilon = 0.0001</syntaxhighlight> | |
− | + | {{CodeDocDetailBody|<nowiki>The value of correction for small floating point numbers.</nowiki> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | <nowiki>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.</nowiki>}} | |
− | + | {{CodeDocDetailBottom}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | {{ | ||
− | {{ | + | {{CodeDocDetailTop|cMath_Pi}} |
− | {| | + | <syntaxhighlight lang="c++">const float cMath_Pi = 3.141593</syntaxhighlight> |
− | + | {{CodeDocDetailBody|Approximate value of pi.}} | |
− | |- | + | {{CodeDocDetailBottom}} |
− | | | + | |
− | |} | + | {{CodeDocDetailTop|cMath_PiDiv2}} |
− | {{ | + | <syntaxhighlight lang="c++">const float cMath_PiDiv2</syntaxhighlight> |
+ | {{CodeDocDetailBody|Approximate value of pi divided by 2.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cMath_PiDiv4}} | ||
+ | <syntaxhighlight lang="c++">const float cMath_PiDiv4</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|Approximate value of pi divided by 4.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cMath_PiMul2}} | ||
+ | <syntaxhighlight lang="c++">const float cMath_PiMul2</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|Approximate value of pi multiplied by 2.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cMath_Sqrt2}} | ||
+ | <syntaxhighlight lang="c++">const float cMath_Sqrt2</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|Approximate value of the square root of 2.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cMatrixf_Identity}} | ||
+ | <syntaxhighlight lang="c++">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)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The identity matrix.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cMatrixf_Zero}} | ||
+ | <syntaxhighlight lang="c++">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)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A zero-filled matrix.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cQuaternion_Identity}} | ||
+ | <syntaxhighlight lang="c++">const cQuaternion cQuaternion_Identity = cQuaternion(0.0, 0.0, 0.0, 1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The quaternion identity.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_Down}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_Down = cVector2f(0.0, -1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The down-facing 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_Left}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_Left = cVector2f(-1.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The left-facing 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_MinusOne}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_MinusOne = cVector2f(-1.0, -1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A negative-one-filled 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_One}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_One = cVector2f(1.0, 1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A one-filled 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_Right}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_Right = cVector2f(1.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The right-facing 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_Up}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_Up = cVector2f(0.0, 1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The up-facing 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2f_Zero}} | ||
+ | <syntaxhighlight lang="c++">const cVector2f cVector2f_Zero = cVector2f(0.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A zero-filled 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector2l_MinusOne}} | ||
+ | <syntaxhighlight lang="c++">const cVector2l cVector2l_MinusOne = cVector2l(-1, -1)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A negative-one-filled 2D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Back}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Back = cVector3f(0.0, 0.0, -1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The backward-facing 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Down}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Down = cVector3f(0.0, -1.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The down-facing 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Forward}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Forward = cVector3f(0.0, 0.0, 1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The forward-facing 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Left}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Left = cVector3f(-1.0, 0.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The left-facing 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_MinusOne}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_MinusOne = cVector3f(-1.0, -1.0, -1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A negative-one-filled 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_One}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_One = cVector3f(1.0, 1.0, 1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A one-filled 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Right}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Right = cVector3f(1.0, 0.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The right-facing 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Up}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Up = cVector3f(0.0, 1.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The up-facing 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector3f_Zero}} | ||
+ | <syntaxhighlight lang="c++">const cVector3f cVector3f_Zero = cVector3f(0.0, 0.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A zero-filled 3D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector4f_MinusOne}} | ||
+ | <syntaxhighlight lang="c++">const cVector4f cVector4f_MinusOne = cVector4f(-1.0, -1.0, -1.0, -1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A negative-one-filled 4D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector4f_One}} | ||
+ | <syntaxhighlight lang="c++">const cVector4f cVector4f_One = cVector4f(1.0, 1.0, 1.0, 1.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A one-filled 4D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|cVector4f_Zero}} | ||
+ | <syntaxhighlight lang="c++">const cVector4f cVector4f_Zero = cVector4f(0.0, 0.0, 0.0, 0.0)</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|A zero-filled 4D vector.}} | ||
+ | {{CodeDocDetailBottom}} | ||
+ | |||
+ | {{CodeDocDetailTop|tID_Invalid}} | ||
+ | <syntaxhighlight lang="c++">const tID tID_Invalid</syntaxhighlight> | ||
+ | {{CodeDocDetailBody|The static value of an invalid tID.}} | ||
+ | {{CodeDocDetailBottom}} | ||
==Functions== | ==Functions== |
Revision as of 23:19, 11 August 2020
To do: Add description for all of the functions
The HPL3 SOMA Scripting Api provides general - purpose engine functions which are exposed for the user to use. The functions / constants in this article are divided into topics.


Contents
- 1 Constant Summary
- 2 Constant Detail
- 2.1 cColor_Blue
- 2.2 cColor_Green
- 2.3 cColor_Red
- 2.4 cColor_White
- 2.5 cMath_Epsilon
- 2.6 cMath_Pi
- 2.7 cMath_PiDiv2
- 2.8 cMath_PiDiv4
- 2.9 cMath_PiMul2
- 2.10 cMath_Sqrt2
- 2.11 cMatrixf_Identity
- 2.12 cMatrixf_Zero
- 2.13 cQuaternion_Identity
- 2.14 cVector2f_Down
- 2.15 cVector2f_Left
- 2.16 cVector2f_MinusOne
- 2.17 cVector2f_One
- 2.18 cVector2f_Right
- 2.19 cVector2f_Up
- 2.20 cVector2f_Zero
- 2.21 cVector2l_MinusOne
- 2.22 cVector3f_Back
- 2.23 cVector3f_Down
- 2.24 cVector3f_Forward
- 2.25 cVector3f_Left
- 2.26 cVector3f_MinusOne
- 2.27 cVector3f_One
- 2.28 cVector3f_Right
- 2.29 cVector3f_Up
- 2.30 cVector3f_Zero
- 2.31 cVector4f_MinusOne
- 2.32 cVector4f_One
- 2.33 cVector4f_Zero
- 2.34 tID_Invalid
- 3 Functions
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.
Functions
Expand Billboard
|
---|
Expand Body
|
---|
Expand Button
|
---|
Expand cAI
|
---|
Expand cEngine
|
---|
Expand cGenerate
|
---|
Expand cGraphics
|
---|
Expand cGui
|
---|
Expand cInput
|
---|
Expand cLux
|
---|
Expand cMath
|
---|
Expand cPhysics
|
---|
Expand cResources
|
---|
Expand cScene
|
---|
Expand cScript
|
---|
Expand cSound
|
---|
Expand cString
|
---|
Expand cSystem
|
---|
Expand EnergySource
|
---|
Expand Entity
|
---|
Expand Error
|
---|
Expand FatalError
|
---|
Expand FogArea
|
---|
Expand Grab
|
---|
Expand H32
|
---|
Expand H64
|
---|
Expand IrradianceSet
|
---|
Expand Joint
|
---|
Expand Lamp
|
---|
Expand LensFlare
|
---|
Expand LevelDoor
|
---|
Expand Lever
|
---|
Expand Light
|
---|
Expand Log
|
---|
Expand LogNewLine
|
---|
Expand Map
|
---|
Expand Material
|
---|
Expand Math
|
---|
Expand Meter
|
---|
Expand MoveObject
|
---|
Expand MovingButton
|
---|
Expand ParticleSystem
|
---|
Expand PhysicsSlideDoor
|
---|
Expand Prop
|
---|
Expand Readable
|
---|
Expand Slide
|
---|
Expand SlideDoor
|
---|
Expand String
|
---|
Expand SwingDoor
|
---|
Expand Terminal
|
---|
Expand Tool
|
---|
Expand Warning
|
---|
Expand Wheel
|
---|