IC Python API:RLPy RVector3
From Reallusion Wiki!
Revision as of 03:03, 25 March 2019 by Chuck (RL) (Talk | contribs)
- Main article: Modules.
Detailed Description
This class represent the 3D vector.
Member Functions
AlmostTheSame
RLPy.RVector3.AlmostTheSame ( self, vV )
Determine the two vectors are the same with tolerance.
Returns
- true if the vector is almost the same - bool
AlmostZero
RLPy.RVector3.AlmostZero ( self)
Determine the vector is zero vector.
Returns
- true if the vector is zero vector - bool
Cross
RLPy.RVector3.Cross ( self, vV )
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
RLPy.RVector3.Distance ( self, vV )
Distance of the two vectors.
Parameters
- vV[IN] The vector - RLPy.RVector3
Returns
- the distance - float
Dot
RLPy.RVector3.Dot ( self, vV )
Calculate dot production of the two vectors.
Parameters
- vV[IN] The vector - RLPy.RVector3
Returns
- the value of the dot production - float
Interpolate
RLPy.RVector3.Interpolate ( self, vRatio, vV )
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
RLPy.RVector3.Inverse ( self)
Inverse this vector.
Returns
- the inversed vector - RLPy.RVector3
Length
RLPy.RVector3.Length ( self)
Length of the vector.
Returns
- the length of this vector - float
Normalize
RLPy.RVector3.Normalize ( self)
Normalizes this vector.
Returns
- the normalized vector - float
SetX
RLPy.RVector3.SetX ( self, tX )
Set the value of the x-axis.
Parameters
- tX[IN] the value of the x-axis - float
SetXYZ
RLPy.RVector3.SetXYZ ( self, tX, tY, tZ )
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
RLPy.RVector3.SetY ( self, tY )
Set the value of the y-axis.
Parameters
- tX[IN] the value of the y-axis.
SetZ
RLPy.RVector3.SetZ ( self, tZ )
Set the value of the z-axis.
Parameters
- tX[IN] the value of the z-axis.
SquaredDistance
RLPy.RVector3.SquaredDistance ( self, vV )
Squared distance of the two vectors.
Parameters
- vV[IN] The vector - RLPy.RVector3
Returns
- the Squared distance - float
SquaredLength
RLPy.RVector3.SquaredLength ( self)
Squared length of the vector.
Returns
- the squared length of this vector - float
X
RLPy.RVector3.X ( self, args )
Get the value of the x-axis.
Returns
- the value of the x-axis - float
XY
RLPy.RVector3.XY ( self)
Get the element of the 2D vector.
Returns
- Return the 2D vector - RLPy.RVector2
Y
RLPy.RVector3.Y ( self, args )
Get the value of the y-axis.
Returns
- the value of the y-axis - float
Z
RLPy.RVector3.Z ( self, args )
Get the value of the z-axis.
Returns
- the value of the z-axis - float