IC Python API:RLPy RVector3

Description

This class represent the 3D vector (x, y, z). This class provides access to RLPy's internal 3D vector math library allowing 3D vectors to be handled easily, in a manner compatible with internal RLPy data structures. It also supports operators and provides some constants for your convenience:

Constant	Description
RVector3.ZERO	3D zero vector: (0, 0, 0)
RVector3.UNIT_X	3D x unit vector: (1, 0, 0)
RVector3.UNIT_Y	3D y unit vector: (0, 1, 0)
RVector3.UNIT_Z	3D z unit vector: (0, 0, 1)
RVector3.UNIT_XY	3D vector: (1, 1, 0)
RVector3.UNIT_YZ	3D vector: (0, 1, 1)
RVector3.UNIT_XZ	3D vector: (1, 0, 1)
RVector3.UNIT_XYZ	3D vector: (1, 1, 1)

Constructor & Destructor

init ( self )

a = RLPy.RVector3()

init ( self, x, y, z )

Parameters

x [IN] A numerical value for x coordinate - float or int

y [IN] A numerical value for y coordinate - float or int

z [IN] A numerical value for z coordinate - float or int

a = RLPy.RVector3(1, 2, 3)

init ( self, args )

The constructor. Initialize a new RVector3object with another RVector3object: args. This new RVector3object has the same value as args.

Parameters

args [IN] a RVector3object - RVector3

a = RLPy.RVector3(1, 2, 3)
b = RLPy.RVector3(a)

Operators

==

The "equal to" operator.

!=

The "not equal to" operator.

<

The "less than" operator. Similar to string comparison: Returns True upon the first match that is less than and False if it is greater than. If the current comparison is equal, continue onto the next element. If all elements are equal then return False.

>

The "greater than" operator. Similar to string comparison: Returns True upon the first match that is greater than and False if it is less than. If the current comparison is equal, continue onto the next element. If all elements are equal then return False.

<=

The "less than or equal" operator. Similar to string comparison: Returns True upon the first match that is less than and False if it is greater than. If the current comparison is equal, continue onto the next element. If all elements are equal then return True.

>=

The "greater than or equal" operator. Similar to string comparison: Returns True upon the first match that is greater than and False if it is less than. If the current comparison is equal, continue onto the next element. If all elements are equal then return True.

+

The "addition" operator. Perform 3D vector addition.

-

The "subtraction" operator. Perform 3D vector subtraction.

*

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

/

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

-

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

a = RLPy.RVector3(1, 2, 3)
b = -a

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

+=

The "addition assignment" operator.

-=

The "subtraction assignment" operator.

*=

The "multiplication assignment" operator. For calculation method, refer to the * operator.

/=

The "division assignment" operator. For calculation method, refer to the / operator.

Member Functions

AlmostTheSame ( self, vV )

Determine if this and another 3D vector is the equivalent withing a tolerance.

Returns

True if the 3D vectors are almost the same, else False - bool

a = RLPy.RVector3(1, 2, 3)
b = RLPy.RVector3(1, 2, 3.000000001)
c = RLPy.RVector3(1, 2, 3.00001)

if a.AlmostTheSame(b):  #True
    print("a ≈ b")
if a.AlmostTheSame(c):  #False
    print("a ≈ c")

AlmostZero ( self )

Determine if this 3D vector is a zeroed 3D vector.

Returns

True if this 3D vector is a zeroed 3D vector, else False - bool

a = RLPy.RVector3(0.00000001, 0, 0.00000003)
b = RLPy.RVector3(0.00001, 0, 0)

if a.AlmostZero():                 #True
    print("a is ZERO vector.")
if b.AlmostZero():                 #False
    print("a is ZERO vector.")

Cross ( self, vV )

Calculate the cross production of this and another 3D vector.

Parameters

vV [IN] The vector - RVector3

Returns

New 3D vector which is the cross product of this and another 3D vector - RVector3

a = RLPy.RVector3(1, 0, 0)
b = RLPy.RVector3(0, 1, 0)
c = a.Cross(b)

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

Distance ( self, vV )

Calculate the distance between this and another 3D vector.

Parameters

vV [IN] The vector - RVector3

Returns

The distance between this and another 3D vector - float

a = RLPy.RVector3(3, 0, 0)
b = RLPy.RVector3(0, 4, 0)

print(a.Distance(b))    # 5.0

Dot (self, vV)

Calculate the dot production of this and another 3D vector.

Parameters

vV [IN] The 3D vector with which to compute the dot product - RVector3

Returns

The value of the dot product - float

a = RLPy.RVector3(1, 2, 3)
b = RLPy.RVector3(1, 2, 3)

print(a.Dot(b)) # 14.0

Interpolate ( self, vRatio, vV )

Calculate the interpolate of this and another 3D vector.

Parameters

vRatio [IN] ratio value - float

vV [IN] Another 3D vector - RVector3

Returns

New vector which is the cross product this and another vector - RVector3

a = RLPy.RVector3(10, 20, 30)
b = RLPy.RVector3(1, 2, 3)
c = a.Interpolate(0.1, b)

print(str(c.x) + ', ' + str(c.y) + ', ' + str(c.z))   # 9.100000381469727, 18.200000762939453, 27.299999237060547

Inverse ( self )

Invert all the elements of this 3D vector.

Returns

The inverse of this 3D vector - RVector3

a = RLPy.RVector3(1, 2, 3)
b = a.Inverse()
print(str(b.x) + ', ' + str(b.y) + ', ' + str(b.z))  # 1.0, 0.5, 0.3333333432674408

Length ( self )

Length of the vector.

Returns

Length of this vector - float

a = RLPy.RVector3(1, 1, 1)

print(a.Length())   # 1.7320507764816284

Normalize ( self )

Normalize this 3D vector.

Returns

The normalized 3D vector - float

a = RLPy.RVector3(1, 1, 1)

print(a.Normalize())    #1.7320507764816284
print(str(a.x) + ', ' + str(a.y) + ', ' + str(a.z))   # 0.5773502588272095, 0.5773502588272095, 0.5773502588272095

SetX ( self, tX )

Set the value of the x-axis for this 3D vector.

Parameters

tX [IN] The value of the x-axis - float

a = RLPy.RVector3(1, 1, 1)
a.SetX(10)

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

SetXYZ ( self, tX, tY, tZ )

Set the value of the all axes for this 3D vector.

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

a = RLPy.RVector3(1, 1, 1)
a.SetXYZ(10, 20, 30)

print(str(a.x) + ', ' + str(a.y) + ', ' + str(a.z)) # 10.0, 20.0, 30.0

SetY ( self, tY )

Set the value of the y-axis for this 3D vector.

Parameters

tX [IN] the value of the y-axis.

a = RLPy.RVector3(1, 1, 1)
a.SetY(10)

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

SetZ ( self, tZ )

Set the value of the z-axis for this 3D vector.

Parameters

tX[IN] The value for the z-axis.

a = RLPy.RVector3(1, 1, 1)
a.SetZ(10)

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

SquaredDistance ( self, vV )

Get the squared distance between this and another 3D vector.

Parameters

vV [IN] The vector - RVector3

Returns

The squared distance of this and another 3D vector - float

a = RLPy.RVector3(1, 1, 1)

print(a.SquaredLength())        # 3.0

SquaredLength ( self )

Get the squared length of this 3D vector.

Returns

The squared length of this vector - float

a = RLPy.RVector3(1, 1, 1)

print(a.SquaredLength())    # 3.0

XY ( self )

Get the x and y elements of this 3D vector.

Returns

A 2D vector composed of this 3D vector's x and y elements - RVector2

a = RLPy.RVector3(1, 2, 3)
b = a.XY()

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

IC Python API:RLPy RVector3

Contents

Description

Constructor & Destructor

__init__ ( self )

__init__ ( self, x, y, z )

Parameters

__init__ ( self, args )

Parameters

Operators

==

!=

<

>

<=

>=

+

-

*

/

-

+=

-=

*=

/=

Member Functions

AlmostTheSame ( self, vV )

Returns

AlmostZero ( self )

Returns

Cross ( self, vV )

Parameters

Returns

Distance ( self, vV )

Parameters

Returns

Dot (self, vV)

Parameters

Returns

Interpolate ( self, vRatio, vV )

Parameters

Returns

Inverse ( self )

Returns

Length ( self )

Returns

Normalize ( self )

Returns

SetX ( self, tX )

Parameters

SetXYZ ( self, tX, tY, tZ )

Parameters

SetY ( self, tY )

Parameters

SetZ ( self, tZ )

Parameters

SquaredDistance ( self, vV )

Parameters

Returns

SquaredLength ( self )

Returns

XY ( self )

Returns

Navigation menu

Search

init ( self )

init ( self, x, y, z )

init ( self, args )