HPL3/SOMA/Scripting/cVector4f - Revision history

Abion47 at 14:23, 6 August 2020

2020-08-06T14:23:49Z

Abion47: /* Remarks */

2020-08-04T00:50:51Z

Remarks

Abion47 at 00:45, 4 August 2020

2020-08-04T00:45:23Z

Abion47: Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Constructors== {| class="wikitable" ! Constructor..."

2020-08-04T00:44:14Z

Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Constructors== {| class="wikitable" ! Constructor..."

New page

{{ScriptingStub}}

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

==Constructors==

{| class="wikitable"
! Constructor !! Description
|-
| <syntaxhighlight lang="c++" inline>cVector4f(float, float, float, float)</syntaxhighlight> || Creates a cVector4f with then given element data.
|}

==Fields==

{| class="wikitable"
! Field Name !! Type !! Description
|-
| w || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The x value of the vector.
|-
| x || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The y value of the vector.
|-
| y || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The z value of the vector.
|-
| z || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The w value of the vector.
|}

==Functions==

{| class="wikitable"
! Return Type !! Function Name !! Parameters !! Description
|-
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetElement || <syntaxhighlight lang="c++" inline>uint64 alIdx</syntaxhighlight> || Gets the value at the given index. (Indices 0, 1, 2, and 3 are equal to x, y, z, and w respectively.)
|-
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || Length || || Returns the length of this vector.
|-
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || Normalize || || Returns the normalization factor for this vector. (See Remarks.)
|-
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetElement || <syntaxhighlight lang="c++" inline>uint64 alIdx</syntaxhighlight>,<br /><syntaxhighlight lang="c++" inline>float</syntaxhighlight> || Sets the value at the given index to the given value. (Indices 0, 1, 2, and 3 are equal to x, y, z, and w respectively.)
|-
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || SqrLength || || Returns the length-squared of this vector.
|}

===Remarks===

A normalized vector is a vector whose length is equal to one, otherwise known as a unit vector. To convert a vector into a unit vector, get the normalization factor by calling the ''Normalize'' function, then divide each of the vector's x, y, z, and w coordinates by that factor.

<syntaxhighlight lang="c++">cVector4f vBaseVector(2.0, 5.0, 3.0, 4.0);
float fNormFactor = vBaseVector.Normalize();
cVector3f vNormalizedVector(vBaseVector.x / fNormFactor,
vBaseVector.y / fNormFactor,
vBaseVector.z / fNormFactor,
vBaseVector.w / fNormFactor);</syntaxhighlight>

{{HPL3SOMAScriptingCategories}}
__FORCETOC__

@@ Line 49: / Line 49: @@
                              vBaseVector.z / fNormFactor,
                              vBaseVector.w / fNormFactor);</syntaxhighlight>
 {{HPL3SOMAScriptingCategories}}
 __FORCETOC__

@@ Line 39: / Line 39: @@
 |}
-===Remarks===
+==Remarks==
 A normalized vector is a vector whose length is equal to one, otherwise known as a unit vector. To convert a vector into a unit vector, get the normalization factor by calling the ''Normalize'' function, then divide each of the vector's x, y, z, and w coordinates by that factor.

@@ Line 1: / Line 1: @@
-{{ScriptingStub}}
+A four dimensional vector unit which stores its elements as floats.
 ==Constructors==
@@ Line 8: / Line 6: @@
 ! Constructor !! Description
 |-
-| <syntaxhighlight lang="c++" inline>cVector4f(float, float, float, float)</syntaxhighlight> || Creates a cVector4f with then given element data.
+| <syntaxhighlight lang="c++" inline>cVector4f(float, float, float, float)</syntaxhighlight> || Creates a <code>cVector4f</code> with the given element data.
 |}