View source for IC Python API:RLPy RVector3

{{TOC}}
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
== Detailed Description ==
This class represent the 3D vector.
==Member Functions==

===AlmostTheSame===
<syntaxhighlight lang="Python">
RLPy.RVector3.AlmostTheSame ( self, vV )
</syntaxhighlight>
:Determine the two vectors are the same with tolerance.
====Returns====
Returns true if the vector is almost the same - bool

-----
===AlmostZero===
<syntaxhighlight lang="Python">
RLPy.RVector3.AlmostZero ( self)
</syntaxhighlight>
:Determine the vector is zero vector.
====Returns====
Returns true if the vector is zero vector - bool
-----
===Cross===
<syntaxhighlight lang="Python">
RLPy.RVector3.Cross ( self, vV )
</syntaxhighlight>
:Calculate cross production of the two vectors.
====Parameters====
:vV[IN] The vector - RLPy.RVector3
====Returns====
New vector which is the cross product of the two vectors - RLPy.RVector3
-----
===Distance===
<syntaxhighlight lang="Python">
RLPy.RVector3.Distance ( self, vV )
</syntaxhighlight>
:Distance of the two vectors.
====Parameters====
:vV[IN] The vector - RLPy.RVector3
====Returns====
Returns the distance - float
-----
===Dot===
<syntaxhighlight lang="Python">
RLPy.RVector3.Dot ( self, vV )
</syntaxhighlight>
:Calculate dot production of the two vectors.
====Parameters====
:vV[IN] The vector - RLPy.RVector3
====Returns====
Returns the value of the dot production - float
-----
===Interpolate===
<syntaxhighlight lang="Python">
RLPy.RVector3.Interpolate ( self, vRatio, vV )
</syntaxhighlight>
:Interpolate of the two vectors.
====Parameters====
:vRatio[IN] ratio value - float
:vV[IN] The vector - RLPy.RVector3
====Returns====
New vector which is the cross product of the two vectors - RLPy.RVector3
-----
===Inverse===
<syntaxhighlight lang="Python">
RLPy.RVector3.Inverse ( self)
</syntaxhighlight>
:Inverse this vector.
====Returns====
Returns the inversed vector - RLPy.RVector3
-----
===Length===
<syntaxhighlight lang="Python">
RLPy.RVector3.Length ( self)
</syntaxhighlight>
:Length of the vector.
====Returns====
Returns the length of this vector - float
-----
===Normalize===
<syntaxhighlight lang="Python">
RLPy.RVector3.Normalize ( self)
</syntaxhighlight>
:Normalizes this vector.
====Returns====
Returns the normalized vector - float
-----
===SetX===
<syntaxhighlight lang="Python">
RLPy.RVector3.SetX ( self, tX )
</syntaxhighlight>
:Set the value of the x-axis.
====Parameters====
:tX[IN] the value of the x-axis - float
-----
===SetXYZ===
<syntaxhighlight lang="Python">
RLPy.RVector3.SetXYZ ( self, tX, tY, tZ )
</syntaxhighlight>
:Set the value of the all axes.
====Parameters====
:tX[IN] the value of the x-axis - float
:tY[IN] the value of the y-axis - float
:tZ[IN] the value of the z-axis - float
-----
===SetY===
<syntaxhighlight lang="Python">
RLPy.RVector3.SetY ( self, tY )
</syntaxhighlight>
:Set the value of the y-axis.
====Parameters====
:tX[IN] the value of the y-axis.
-----
===SetZ===
<syntaxhighlight lang="Python">
RLPy.RVector3.SetZ ( self, tZ )
</syntaxhighlight>
:Set the value of the z-axis.
====Parameters====
:tX[IN] the value of the z-axis.
-----
===SquaredDistance===
<syntaxhighlight lang="Python">
RLPy.RVector3.SquaredDistance ( self, vV )
</syntaxhighlight>
:Squared distance of the two vectors.
====Parameters====
:vV[IN] The vector - RLPy.RVector3
====Returns====
Returns the Squared distance - float
-----
===SquaredLength===
<syntaxhighlight lang="Python">
RLPy.RVector3.SquaredLength ( self)
</syntaxhighlight>
:Squared length of the vector.
====Returns====
Returns the squared length of this vector - float
-----
===X===
<syntaxhighlight lang="Python">
RLPy.RVector3.X ( self, args )
</syntaxhighlight>
:Get the value of the x-axis.
====Returns====
Returns the value of the x-axis - float
-----
===XY===
<syntaxhighlight lang="Python">
RLPy.RVector3.XY ( self)
</syntaxhighlight>
:Get the element of the 2D vector.
====Returns====
Return the 2D vector - RLPy.RVector2
-----
===Y===
<syntaxhighlight lang="Python">
RLPy.RVector3.Y ( self, args )
</syntaxhighlight>
:Get the value of the y-axis.
====Returns====
Returns the value of the y-axis - float
-----
===Z===
<syntaxhighlight lang="Python">
RLPy.RVector3.Z ( self, args )
</syntaxhighlight>
:Get the value of the z-axis.
====Returns====
Returns the value of the z-axis - float