Difference between revisions of "IC Python API:RLPy RVector2"

From Reallusion Wiki!
Jump to: navigation, search
m
m
Line 2: Line 2:
 
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
 
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
 
{{last_modified}}
 
{{last_modified}}
−
==Description==
+
 
−
2D vector2 math class for float values. This class provides access to RLPy's internal vector2 math library allowing vectors to be handled effortlessly, and in a manner compatible with internal RLPy data structures. It also supports operators and vector2 related functions.
+
== Description ==
 +
 
 +
2D vector2 math class for float values. This class provides access to RLPy's internal vector2 math library allowing vectors to be handled effortlessly, and in a manner compatible with internal RLPy data structures. It also supports operators and vector2 related functions.
 
RVector2 also provides some constants for your convenience:
 
RVector2 also provides some constants for your convenience:
 
{|class = "wikitable"
 
{|class = "wikitable"
Line 21: Line 23:
 
|2D unit vector2: (1, 1)
 
|2D unit vector2: (1, 1)
 
|}
 
|}
−
==Constructors & Destructors==
+
 
−
===__init__===
+
== Constructors & Destructors ==
 +
 
 +
=== __init__ ===
 +
 
 
Initialize a new RVector2 object as a 2D zero vector2: (0, 0).
 
Initialize a new RVector2 object as a 2D zero vector2: (0, 0).
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2()
 
a = RLPy.RVector2()
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
−
===__init__( self, x, y )===
+
=== __init__( self, x, y ) ===
 +
 
 
Initialize a new RVector2 object as a 2D vector2: (x, y).
 
Initialize a new RVector2 object as a 2D vector2: (x, y).
 +
 +
==== Parameters ====
 +
:'''x''' [IN] a numerical value for x coordinate - float or int
 +
:'''y''' [IN] a numerical value for y coordinate - float or int
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Parameters====
+
 
−
x  [IN]    a numerical value for x coordinate - float or int<br/>
+
=== __init__( self, args ) ===
−
y  [IN]    a numerical value for y coordinate - float or int<br/>
+
 
−
----
+
−
===__init__( self, args )===
+
 
Initialize a new RVector2 object with another RVector2 object: args. This new RVector2 object has the same value as args.
 
Initialize a new RVector2 object with another RVector2 object: args. This new RVector2 object has the same value as args.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
 
b = RLPy.RVector2(a)
 
b = RLPy.RVector2(a)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
==Operators==
+
 
 +
== Operators ==
 +
 
 
=== == ===
 
=== == ===
 +
 
The "equal to" operator.
 
The "equal to" operator.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
 
b = a
 
b = a
−
print(a == b)                         #True
+
 
 +
print(a == b) #True
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== != ===
 
=== != ===
 +
 
The "not equal to" operator.
 
The "not equal to" operator.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2()
 
a = RLPy.RVector2()
 
b = RLPy.RVector2(1, 2)
 
b = RLPy.RVector2(1, 2)
−
print(a != b)                         #True
+
 
 +
print(a != b) #True
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== < ===
 
=== < ===
−
The "less than" operator. Similar to string comparison: If first element (x) less than, return '''True''', if greater than, return '''False''', if equal then compare the second element (y). When (y) is greater than or equal return '''False''' else return '''True'''.
+
 
 +
The "less than" operator. Similar to string comparison: If first element (x) less than, return '''True''', if greater than, return '''False''', if equal then compare the second element (y). When (y) is greater than or equal return '''False''' else return '''True'''.
 +
 
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 0)
 
a = RLPy.RVector2(0, 0)
Line 67: Line 88:
 
c = RLPy.RVector2(1, 0)
 
c = RLPy.RVector2(1, 0)
 
d = RLPy.RVector2(0, 0)
 
d = RLPy.RVector2(0, 0)
−
print(a < b)                       #True
+
 
−
print(b < c)                       #True
+
print(a< b) #True
−
print(a < d)                       #False
+
print(b< c) #True
 +
print(a< d) #False
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== > ===
 
=== > ===
−
The "greater than" operator. Similar to string comparison: If element (x) is greater than, return '''True''', if less than, return '''False''', if equal then compare the second element (y). If (y) is greater than or equal, return '''False''', else return '''True'''.  
+
 
 +
The "greater than" operator. Similar to string comparison: If element (x) is greater than, return '''True''', if less than, return '''False''', if equal then compare the second element (y). If (y) is greater than or equal, return '''False''', else return '''True'''.
 +
 
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 0)
 
a = RLPy.RVector2(0, 0)
Line 79: Line 103:
 
c = RLPy.RVector2(1, 0)
 
c = RLPy.RVector2(1, 0)
 
d = RLPy.RVector2(0, 0)
 
d = RLPy.RVector2(0, 0)
−
print(b > a)                       #True
+
 
−
print(c > b)                       #True
+
print(b >a) #True
−
print(d > a)                       #False
+
print(c >b) #True
 +
print(d >a) #False
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== <= ===
 
=== <= ===
 +
 
The "less than or equal to" operator. Similar to string comparison: If element (x) is less than, return '''True''', if greater than, return '''False''', if equal then compare the second element (y). If (y) is greater than, return '''False''', else return '''True'''.
 
The "less than or equal to" operator. Similar to string comparison: If element (x) is less than, return '''True''', if greater than, return '''False''', if equal then compare the second element (y). If (y) is greater than, return '''False''', else return '''True'''.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 0)
 
a = RLPy.RVector2(0, 0)
Line 91: Line 118:
 
c = RLPy.RVector2(1, 0)
 
c = RLPy.RVector2(1, 0)
 
d = RLPy.RVector2(0, 0)
 
d = RLPy.RVector2(0, 0)
−
print(a <= b)                     #True
+
 
−
print(b <= c)                     #True
+
print(a<= b) #True
−
print(a <= d)                     #True
+
print(b<= c) #True
 +
print(a<= d) #True
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== >= ===
 
=== >= ===
−
The "greater than or equal to" operator. Similar to string comparison: If element (x) is greater than, return '''True''', if less than, return '''False''', if equal then compare the second element (y). If (y) is less than, return '''False''', else return '''True'''.  
+
 
 +
The "greater than or equal to" operator. Similar to string comparison: If element (x) is greater than, return '''True''', if less than, return '''False''', if equal then compare the second element (y). If (y) is less than, return '''False''', else return '''True'''.
 +
 
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 0)
 
a = RLPy.RVector2(0, 0)
Line 103: Line 133:
 
c = RLPy.RVector2(1, 0)
 
c = RLPy.RVector2(1, 0)
 
d = RLPy.RVector2(0, 0)
 
d = RLPy.RVector2(0, 0)
−
print(b >= a)                       #True
+
 
−
print(c >= b)                       #True
+
print(b >= a) #True
−
print(d >= a)                       #True
+
print(c >= b) #True
 +
print(d >= a) #True
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== + ===
 
=== + ===
 +
 
The "addition" operator. Perform 2D vector2 addition.
 
The "addition" operator. Perform 2D vector2 addition.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 1)
 
a = RLPy.RVector2(0, 1)
 
b = RLPy.RVector2(1, 2)
 
b = RLPy.RVector2(1, 2)
 
c = a + b
 
c = a + b
−
print(str(c.x) + ', ' + str(c.y))       #1.0, 3.0
+
 
 +
print(str(c.x) + ', ' + str(c.y)) #1.0, 3.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== - ===
 
=== - ===
 +
 
The "subtraction" operator. Perform 2D vector2 subtraction.
 
The "subtraction" operator. Perform 2D vector2 subtraction.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 1)
 
a = RLPy.RVector2(0, 1)
 
b = RLPy.RVector2(1, 3)
 
b = RLPy.RVector2(1, 3)
−
c = b - a  
+
c = b - a
−
print(str(c.x) + ', ' + str(c.y))       #1.0, 2.0
+
 
 +
print(str(c.x) + ', ' + str(c.y)) #1.0, 2.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== * ===
 
=== * ===
−
The "multiplication" operator. Perform a scalar multiplication when the second element is an integer or float. If the second operand is another vector2, then the respective x, y elements are multiplied.
+
 
 +
The "multiplication" operator. Perform a scalar multiplication when the second element is an integer or float. If the second operand is another vector2, then the respective x, y elements are multiplied.
 +
 
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
Line 133: Line 172:
 
c = RLPy.RVector2(2, 3)
 
c = RLPy.RVector2(2, 3)
 
d = a * c
 
d = a * c
−
print(str(b.x) + ', ' + str(b.y))     #2.0, 4.0
+
 
−
print(str(d.x) + ', ' + str(d.y))     #2.0, 6.0
+
print(str(b.x) + ', ' + str(b.y)) #2.0, 4.0
 +
print(str(d.x) + ', ' + str(d.y)) #2.0, 6.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== / ===
 
=== / ===
−
The "division" operator. Perform a scalar division when the second operand is an integer or float. If the second operand is another vector2, then the respective x,y elements are divided.  
+
 
 +
The "division" operator. Perform a scalar division when the second operand is an integer or float. If the second operand is another vector2, then the respective x,y elements are divided.
 +
 
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
Line 144: Line 186:
 
c = RLPy.RVector2(2, 3)
 
c = RLPy.RVector2(2, 3)
 
d = a / c
 
d = a / c
−
print(str(b.x) + ', ' + str(b.y))   #0.5, 1.0
+
 
−
print(str(d.x) + ', ' + str(d.y))   #0.5, 0.6666666865348816
+
print(str(b.x) + ', ' + str(b.y)) #0.5, 1.0
 +
print(str(d.x) + ', ' + str(d.y)) #0.5, 0.6666666865348816
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== - ===
 
=== - ===
 +
 
The "unary minus" operator. Inverse the sign of each element.
 
The "unary minus" operator. Inverse the sign of each element.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
 
b = -a
 
b = -a
−
print(str(b.x) + ', ' + str(b.y))     #-1.0, -2.0
+
 
 +
print(str(b.x) + ', ' + str(b.y)) #-1.0, -2.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== += ===
 
=== += ===
 +
 
The "addition assignment" operator.
 
The "addition assignment" operator.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 1)
 
a = RLPy.RVector2(0, 1)
 
b = RLPy.RVector2(1, 2)
 
b = RLPy.RVector2(1, 2)
 
a += b
 
a += b
−
print(str(a.x) + ', ' + str(a.y))     #1.0, 3.0
+
 
 +
print(str(a.x) + ', ' + str(a.y)) #1.0, 3.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
---- 
+
 
 
=== -= ===
 
=== -= ===
 +
 
The "subtraction assignment" operator.
 
The "subtraction assignment" operator.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 1)
 
a = RLPy.RVector2(0, 1)
 
b = RLPy.RVector2(1, 2)
 
b = RLPy.RVector2(1, 2)
 
a -= b
 
a -= b
−
print(str(a.x) + ', ' + str(a.y))     #-1.0, -1.0
+
 
 +
print(str(a.x) + ', ' + str(a.y)) #-1.0, -1.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== *= ===
 
=== *= ===
−
The "multiplication assignment" operator. Please refer to '''*''' operator for calculation method.  
+
 
 +
The "multiplication assignment" operator. Please refer to '''*''' operator for calculation method.
 +
 
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
Line 182: Line 236:
 
c = RLPy.RVector2(2, 3)
 
c = RLPy.RVector2(2, 3)
 
b *= c
 
b *= c
−
print(str(a.x) + ', ' + str(a.y))     #2.0, 4.0
+
 
−
print(str(b.x) + ', ' + str(b.y))     #2.0, 6.0
+
print(str(a.x) + ', ' + str(a.y)) #2.0, 4.0
 +
print(str(b.x) + ', ' + str(b.y)) #2.0, 6.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
----
+
 
 
=== /= ===
 
=== /= ===
 +
 
The "division assignment" operator. Please refer to '''/''' operator for calculation method.
 
The "division assignment" operator. Please refer to '''/''' operator for calculation method.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
Line 194: Line 251:
 
c = RLPy.RVector2(2, 3)
 
c = RLPy.RVector2(2, 3)
 
b /= c
 
b /= c
−
print(str(a.x) + ', ' + str(a.y))     #0.5, 1.0
+
 
−
print(str(b.x) + ', ' + str(b.y))     #0.5, 0.6666666865348816
+
print(str(a.x) + ', ' + str(a.y)) #0.5, 1.0
 +
print(str(b.x) + ', ' + str(b.y)) #0.5, 0.6666666865348816
 
</syntaxhighlight>
 
</syntaxhighlight>
−
==Member Functions==
+
 
−
===AddWithWeight===
+
== Member Functions ==
 +
 
 +
=== AddWithWeight ===
 +
 
 
Add a vector2 with weight.
 
Add a vector2 with weight.
 +
 +
==== Parameters ====
 +
:'''vSrc''' [IN] The vector2 to add - RLPy.RVector2
 +
:'''fWeight''' [IN] The value of weight - float
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0, 1)
 
a = RLPy.RVector2(0, 1)
 
b = RLPy.RVector2(1, 2)
 
b = RLPy.RVector2(1, 2)
 
a.AddWithWeight(b, 2)
 
a.AddWithWeight(b, 2)
−
print(str(a.x) + ', ' + str(a.y))     #2.0, 5.0
+
 
 +
print(str(a.x) + ', ' + str(a.y)) #2.0, 5.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Parameters====
+
 
−
<div style="margin-left: 2em;">
+
=== Dot ===
−
'''vSrc''' [IN] The vector2 to add - RLPy.RVector2
+
 
−
'''fWeight''' [IN] The value of weight - float
+
−
</div>
+
−
-----
+
−
===Dot===
+
 
Calculate dot production of the two vectors.
 
Calculate dot production of the two vectors.
 +
 +
==== Parameters ====
 +
:'''vV''' [IN] The vector2 to compute dot product - RLPy.RVector2
 +
 +
==== Returns ====
 +
:The value of the dot product - float
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 2)
 
a = RLPy.RVector2(1, 2)
 
dot = a.Dot( RLPy.RVector2(3, 5) )
 
dot = a.Dot( RLPy.RVector2(3, 5) )
−
print(dot)                       #13.0
+
 
 +
print(dot) #13.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Parameters====
+
 
−
<div style="margin-left: 2em;">
+
=== Inverse ===
−
'''vV''' [IN] The vector2 to compute dot product - RLPy.RVector2
+
 
−
</div>
+
−
====Returns====
+
−
<div style="margin-left: 2em;">
+
−
The value of the dot product - float
+
−
</div>
+
−
-----
+
−
===Inverse===
+
 
Return the inverse of a given vector2 by inverting the x, y elements.
 
Return the inverse of a given vector2 by inverting the x, y elements.
 +
 +
==== Returns ====
 +
:The inversed vector2 - RLPy.RVector2
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(0.5, 4)
 
a = RLPy.RVector2(0.5, 4)
 
b = a.Inverse()
 
b = a.Inverse()
−
print(str(b.x) + ', ' + str(b.y))       #2.0, 0.25
+
 
 +
print(str(b.x) + ', ' + str(b.y)) #2.0, 0.25
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Returns====
+
 
−
<div style="margin-left: 2em;">
+
=== Length ===
−
The inversed vector2 - RLPy.RVector2
+
 
−
</div>
+
−
-----
+
−
===Length===
+
 
Length of the vector2.
 
Length of the vector2.
 +
 +
==== Returns ====
 +
:The length of this vector2 - float
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(3, 4)
 
a = RLPy.RVector2(3, 4)
−
print( str(a.Length()) )             #5.0
+
 
 +
print( str(a.Length()) ) #5.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Returns====
+
 
−
<div style="margin-left: 2em;">
+
=== Normalize ===
−
The length of this vector2 - float
+
 
−
</div>
+
−
-----
+
−
===Normalize===
+
 
Normalize a given vector2.
 
Normalize a given vector2.
 +
 +
==== Returns ====
 +
:Returns the length of the vector2 before normalization - float
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 1)
 
a = RLPy.RVector2(1, 1)
 
b = a.Normalize()
 
b = a.Normalize()
−
print(str(a.x) + ', ' + str(a.y))
+
 
−
                        #0.7071067690849304, 0.7071067690849304
+
print(str(a.x) + ', ' + str(a.y)) #0.7071067690849304, 0.7071067690849304
−
print(b)               #1.4142135381698608
+
print(b) #1.4142135381698608
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Returns====
+
 
−
<div style="margin-left: 2em;">
+
=== SetX ===
−
Returns the length of the vector2 before normalization - float
+
 
−
</div>
+
−
-----
+
−
===SetX===
+
 
Set the value of the x-axis.
 
Set the value of the x-axis.
 +
 +
==== Parameters ====
 +
:'''tX''' [IN] the value of the x-axis - float
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 1)
 
a = RLPy.RVector2(1, 1)
 
a.SetX(10)
 
a.SetX(10)
−
print(str(a.x) + ', ' + str(a.y))   #10.0, 1.0
+
 
 +
print(str(a.x) + ', ' + str(a.y)) #10.0, 1.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Parameters====
+
 
−
<div style="margin-left: 2em;">
+
=== SetY ===
−
'''tX''' [IN] the value of the x-axis - float
+
 
−
</div>
+
−
-----
+
−
===SetY===
+
 
Set the value of the y-axis.
 
Set the value of the y-axis.
 +
 +
==== Parameters ====
 +
:'''tX''' [IN] the value of the y-axis.
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 1)
 
a = RLPy.RVector2(1, 1)
 
a.SetY(10)
 
a.SetY(10)
−
print(str(a.x) + ', ' + str(a.y))   #1.0, 10.0
+
 
 +
print(str(a.x) + ', ' + str(a.y)) #1.0, 10.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Parameters====
+
 
−
<div style="margin-left: 2em;">
+
=== SquaredLength ===
−
'''tX''' [IN] the value of the y-axis.
+
 
−
</div>
+
−
-----
+
−
===SquaredLength===
+
 
Squared length of the vector2.
 
Squared length of the vector2.
 +
 +
==== Returns ====
 +
:The squared length of this vector2 - float
 +
 
<syntaxhighlight lang="Python">
 
<syntaxhighlight lang="Python">
 
a = RLPy.RVector2(1, 1)
 
a = RLPy.RVector2(1, 1)
−
print(a.SquaredLength())         #2.0
+
 
 +
print(a.SquaredLength()) #2.0
 
</syntaxhighlight>
 
</syntaxhighlight>
−
====Returns====
 
−
<div style="margin-left: 2em;">
 
−
The squared length of this vector2 - float
 
−
</div>
 
−
-----
 

Revision as of 23:09, 23 February 2020

Main article: Modules.
Last modified: 02/23/2020

Description

2D vector2 math class for float values. This class provides access to RLPy's internal vector2 math library allowing vectors to be handled effortlessly, and in a manner compatible with internal RLPy data structures. It also supports operators and vector2 related functions. RVector2 also provides some constants for your convenience:

Constant Description
RVector2.ZERO 2D zero vector2: (0, 0)
RVector2.UNIT_X 2D x unit vector2: (1, 0)
RVector2.UNIT_Y 2D y unit vector2: (0, 1)
RVector2.UNIT_XY 2D unit vector2: (1, 1)

Constructors & Destructors

__init__

Initialize a new RVector2 object as a 2D zero vector2: (0, 0). 

a = RLPy.RVector2()

__init__( self, x, y )

Initialize a new RVector2 object as a 2D vector2: (x, y).

Parameters

x [IN] a numerical value for x coordinate - float or int
y [IN] a numerical value for y coordinate - float or int
a = RLPy.RVector2(1, 2)

__init__( self, args )

Initialize a new RVector2 object with another RVector2 object: args. This new RVector2 object has the same value as args. 

a = RLPy.RVector2(1, 2)
b = RLPy.RVector2(a)

Operators

==

The "equal to" operator. 

a = RLPy.RVector2(1, 2)
b = a

print(a == b) #True

!=

The "not equal to" operator. 

a = RLPy.RVector2()
b = RLPy.RVector2(1, 2)

print(a != b) #True

<

The "less than" operator. Similar to string comparison: If first element (x) less than, return True, if greater than, return False, if equal then compare the second element (y). When (y) is greater than or equal return False else return True. 

a = RLPy.RVector2(0, 0)
b = RLPy.RVector2(0, 1)
c = RLPy.RVector2(1, 0)
d = RLPy.RVector2(0, 0)

print(a< b) #True
print(b< c) #True
print(a< d) #False

>

The "greater than" operator. Similar to string comparison: If element (x) is greater than, return True, if less than, return False, if equal then compare the second element (y). If (y) is greater than or equal, return False, else return True. 

a = RLPy.RVector2(0, 0)
b = RLPy.RVector2(0, 1)
c = RLPy.RVector2(1, 0)
d = RLPy.RVector2(0, 0)

print(b >a) #True
print(c >b) #True
print(d >a) #False

<=

The "less than or equal to" operator. Similar to string comparison: If element (x) is less than, return True, if greater than, return False, if equal then compare the second element (y). If (y) is greater than, return False, else return True. 

a = RLPy.RVector2(0, 0)
b = RLPy.RVector2(0, 1)
c = RLPy.RVector2(1, 0)
d = RLPy.RVector2(0, 0)

print(a<= b) #True
print(b<= c) #True
print(a<= d) #True

>=

The "greater than or equal to" operator. Similar to string comparison: If element (x) is greater than, return True, if less than, return False, if equal then compare the second element (y). If (y) is less than, return False, else return True. 

a = RLPy.RVector2(0, 0)
b = RLPy.RVector2(0, 1)
c = RLPy.RVector2(1, 0)
d = RLPy.RVector2(0, 0)

print(b >= a) #True
print(c >= b) #True
print(d >= a) #True

+

The "addition" operator. Perform 2D vector2 addition. 

a = RLPy.RVector2(0, 1)
b = RLPy.RVector2(1, 2)
c = a + b

print(str(c.x) + ', ' + str(c.y)) #1.0, 3.0

-

The "subtraction" operator. Perform 2D vector2 subtraction. 

a = RLPy.RVector2(0, 1)
b = RLPy.RVector2(1, 3)
c = b - a

print(str(c.x) + ', ' + str(c.y)) #1.0, 2.0

*

The "multiplication" operator. Perform a scalar multiplication when the second element is an integer or float. If the second operand is another vector2, then the respective x, y elements are multiplied. 

a = RLPy.RVector2(1, 2)
b = a * 2
c = RLPy.RVector2(2, 3)
d = a * c

print(str(b.x) + ', ' + str(b.y)) #2.0, 4.0
print(str(d.x) + ', ' + str(d.y)) #2.0, 6.0

/

The "division" operator. Perform a scalar division when the second operand is an integer or float. If the second operand is another vector2, then the respective x,y elements are divided. 

a = RLPy.RVector2(1, 2)
b = a / 2
c = RLPy.RVector2(2, 3)
d = a / c

print(str(b.x) + ', ' + str(b.y)) #0.5, 1.0
print(str(d.x) + ', ' + str(d.y)) #0.5, 0.6666666865348816

-

The "unary minus" operator. Inverse the sign of each element. 

a = RLPy.RVector2(1, 2)
b = -a

print(str(b.x) + ', ' + str(b.y)) #-1.0, -2.0

+=

The "addition assignment" operator. 

a = RLPy.RVector2(0, 1)
b = RLPy.RVector2(1, 2)
a += b

print(str(a.x) + ', ' + str(a.y)) #1.0, 3.0

-=

The "subtraction assignment" operator. 

a = RLPy.RVector2(0, 1)
b = RLPy.RVector2(1, 2)
a -= b

print(str(a.x) + ', ' + str(a.y)) #-1.0, -1.0

*=

The "multiplication assignment" operator. Please refer to * operator for calculation method. 

a = RLPy.RVector2(1, 2)
a *= 2
b = RLPy.RVector2(1, 2)
c = RLPy.RVector2(2, 3)
b *= c

print(str(a.x) + ', ' + str(a.y)) #2.0, 4.0
print(str(b.x) + ', ' + str(b.y)) #2.0, 6.0

/=

The "division assignment" operator. Please refer to / operator for calculation method. 

a = RLPy.RVector2(1, 2)
a /= 2
b = RLPy.RVector2(1, 2)
c = RLPy.RVector2(2, 3)
b /= c

print(str(a.x) + ', ' + str(a.y)) #0.5, 1.0
print(str(b.x) + ', ' + str(b.y)) #0.5, 0.6666666865348816

Member Functions

AddWithWeight

Add a vector2 with weight.

Parameters

vSrc [IN] The vector2 to add - RLPy.RVector2
fWeight [IN] The value of weight - float
a = RLPy.RVector2(0, 1)
b = RLPy.RVector2(1, 2)
a.AddWithWeight(b, 2)

print(str(a.x) + ', ' + str(a.y)) #2.0, 5.0

Dot

Calculate dot production of the two vectors.

Parameters

vV [IN] The vector2 to compute dot product - RLPy.RVector2

Returns

The value of the dot product - float
a = RLPy.RVector2(1, 2)
dot = a.Dot( RLPy.RVector2(3, 5) )

print(dot) #13.0

Inverse

Return the inverse of a given vector2 by inverting the x, y elements.

Returns

The inversed vector2 - RLPy.RVector2
a = RLPy.RVector2(0.5, 4)
b = a.Inverse()

print(str(b.x) + ', ' + str(b.y)) #2.0, 0.25

Length

Length of the vector2.

Returns

The length of this vector2 - float
a = RLPy.RVector2(3, 4)

print( str(a.Length()) ) #5.0

Normalize

Normalize a given vector2.

Returns

Returns the length of the vector2 before normalization - float
a = RLPy.RVector2(1, 1)
b = a.Normalize()

print(str(a.x) + ', ' + str(a.y)) #0.7071067690849304, 0.7071067690849304
print(b) #1.4142135381698608

SetX

Set the value of the x-axis.

Parameters

tX [IN] the value of the x-axis - float
a = RLPy.RVector2(1, 1)
a.SetX(10)

print(str(a.x) + ', ' + str(a.y)) #10.0, 1.0

SetY

Set the value of the y-axis.

Parameters

tX [IN] the value of the y-axis.
a = RLPy.RVector2(1, 1)
a.SetY(10)

print(str(a.x) + ', ' + str(a.y)) #1.0, 10.0

SquaredLength

Squared length of the vector2.

Returns

The squared length of this vector2 - float
a = RLPy.RVector2(1, 1)

print(a.SquaredLength()) #2.0
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RVector2&oldid=4229"