Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api"
Jump to navigation
Jump to search
Line 5: | Line 5: | ||
==Constants== | ==Constants== | ||
+ | {{Collapse top|cColor}} | ||
{| class="wikitable" | {| class="wikitable" | ||
! Constant Name !! Type !! Value !! Description | ! Constant Name !! Type !! Value !! Description | ||
Line 15: | Line 16: | ||
|- | |- | ||
| cColor_White || [[../cColor|<syntaxhighlight lang="c++" inline>const cColor</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cColor(1.0, 1.0, 1.0, 1.0)</syntaxhighlight> || | | cColor_White || [[../cColor|<syntaxhighlight lang="c++" inline>const cColor</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cColor(1.0, 1.0, 1.0, 1.0)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cMath}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cMath_Epsilon || <syntaxhighlight lang="c++" inline>const float</syntaxhighlight> || <syntaxhighlight lang="c++" inline>0.0001</syntaxhighlight> || When two floats are subtracted, floating point errors can make the result not exact. (i.e. <code>3.0 - 2.0 == 1.0</code> may not strictly be true.) As such, if the difference between two floats is less than the value of <code>cMath_Epsilon</code>, those two floats can be considered equal. | | cMath_Epsilon || <syntaxhighlight lang="c++" inline>const float</syntaxhighlight> || <syntaxhighlight lang="c++" inline>0.0001</syntaxhighlight> || When two floats are subtracted, floating point errors can make the result not exact. (i.e. <code>3.0 - 2.0 == 1.0</code> may not strictly be true.) As such, if the difference between two floats is less than the value of <code>cMath_Epsilon</code>, those two floats can be considered equal. | ||
Line 27: | Line 34: | ||
|- | |- | ||
| cMath_Sqrt2 || <syntaxhighlight lang="c++" inline>const float</syntaxhighlight> || <syntaxhighlight lang="c++" inline>1.414214</syntaxhighlight> || Approximate value of the square root of 2. | | cMath_Sqrt2 || <syntaxhighlight lang="c++" inline>const float</syntaxhighlight> || <syntaxhighlight lang="c++" inline>1.414214</syntaxhighlight> || Approximate value of the square root of 2. | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cMatrixf}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cMatrixf_Identity || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cMatrixf(1.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 1.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 1.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 1.0)</syntaxhighlight> || | | cMatrixf_Identity || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cMatrixf(1.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 1.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 1.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 1.0)</syntaxhighlight> || | ||
|- | |- | ||
| cMatrixf_Zero || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cMatrixf(0.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 0.0)</syntaxhighlight> || | | cMatrixf_Zero || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cMatrixf(0.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 0.0, </syntaxhighlight><br /><syntaxhighlight lang="c++" inline>0.0, 0.0, 0.0, 0.0)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cQuaternion}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cQuaternion_Identity || [[../cQuaternion|<syntaxhighlight lang="c++" inline>const cQuaternion</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cQuaternion(0.0, 0.0, 0.0, 1.0)</syntaxhighlight> || | | cQuaternion_Identity || [[../cQuaternion|<syntaxhighlight lang="c++" inline>const cQuaternion</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cQuaternion(0.0, 0.0, 0.0, 1.0)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cVector2f}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cVector2f_Down || [[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f</syntaxhighlight>]] ||<syntaxhighlight lang="c++" inline>cVector2f(0.0, -1.0)</syntaxhighlight> || | | cVector2f_Down || [[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f</syntaxhighlight>]] ||<syntaxhighlight lang="c++" inline>cVector2f(0.0, -1.0)</syntaxhighlight> || | ||
Line 47: | Line 72: | ||
|- | |- | ||
| cVector2f_Zero || [[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector2f(0.0, 0.0)</syntaxhighlight> || | | cVector2f_Zero || [[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector2f(0.0, 0.0)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cVector2l}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cVector2l_MinusOne || [[../cVector2l|<syntaxhighlight lang="c++" inline>const cVector2l</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector2l(-1, -1)</syntaxhighlight> || | | cVector2l_MinusOne || [[../cVector2l|<syntaxhighlight lang="c++" inline>const cVector2l</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector2l(-1, -1)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cVector3f}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cVector3f_Back || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector3f(0.0, 0.0, -1.0)</syntaxhighlight> || | | cVector3f_Back || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector3f(0.0, 0.0, -1.0)</syntaxhighlight> || | ||
Line 67: | Line 104: | ||
|- | |- | ||
| cVector3f_Zero || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector3f(0.0, 0.0, 0.0)</syntaxhighlight> || | | cVector3f_Zero || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector3f(0.0, 0.0, 0.0)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|cVector4f}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| cVector4f_MinusOne || [[../cVector4f|<syntaxhighlight lang="c++" inline>const cVector4f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector4f(1.0, 1.0, 1.0, 1.0)</syntaxhighlight> || | | cVector4f_MinusOne || [[../cVector4f|<syntaxhighlight lang="c++" inline>const cVector4f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector4f(1.0, 1.0, 1.0, 1.0)</syntaxhighlight> || | ||
Line 73: | Line 116: | ||
|- | |- | ||
| cVector4f_Zero || [[../cVector4f|<syntaxhighlight lang="c++" inline>const cVector4f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector4f(0.0, 0.0, 0.0, 0.0)</syntaxhighlight> || | | cVector4f_Zero || [[../cVector4f|<syntaxhighlight lang="c++" inline>const cVector4f</syntaxhighlight>]] || <syntaxhighlight lang="c++" inline>cVector4f(0.0, 0.0, 0.0, 0.0)</syntaxhighlight> || | ||
+ | |} | ||
+ | {{Collapse bottom}} | ||
+ | |||
+ | {{Collapse top|tID}} | ||
+ | {| class="wikitable" | ||
+ | ! Constant Name !! Type !! Value !! Description | ||
|- | |- | ||
| tID_Invalid || [[../tID|<syntaxhighlight lang="c++" inline>const tID</syntaxhighlight>]] || ''N/A'' || | | tID_Invalid || [[../tID|<syntaxhighlight lang="c++" inline>const tID</syntaxhighlight>]] || ''N/A'' || |
Revision as of 22:12, 6 August 2020
This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete. |
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
Contents
Constants
cColor
| ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
cMath
| ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
cMatrixf
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
cQuaternion
| ||||||||
---|---|---|---|---|---|---|---|---|
|
cVector2f
| ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
cVector2l
| ||||||||
---|---|---|---|---|---|---|---|---|
|
cVector3f
| ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
cVector4f
| ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
tID
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Functions
|