Abion47 at 22:41, 24 August 2020

2020-08-24T22:41:30Z

Abion47: Created page with "==Constant Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryItem|cColor|cColor_Blue|The RGBA value of blue.}} {{CodeDocSummaryItem|../../cC..."

2020-08-24T21:11:35Z

Created page with "==Constant Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryItem|[[../../cColor|cColor]]|cColor_Blue|The RGBA value of blue.}} {{CodeDocSummaryItem|../../cC..."

New page

==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}}

← Older revision		Revision as of 22:41, 24 August 2020
Line 1:		Line 1:
		+	{{ScriptingStub}}
		+
		+	Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
		+
	==Constant Summary==		==Constant Summary==

HPL3/SOMA/Scripting/Scripting Api/Constants - Revision history

Abion47 at 22:41, 24 August 2020

Abion47: Created page with "==Constant Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryItem|cColor|cColor_Blue|The RGBA value of blue.}} {{CodeDocSummaryItem|../../cC..."