mathutils module

Vector, Quaternion and Matrix classes

Matrix3

class modo.mathutils.Matrix3(other=None)

Matrix3 class

__eq__(other)

Test for equality against other Matrix

Parameters:other – Returns:

__getitem__(index)

Parameters:index (Int) – Row-index Returns list:A row from the Matrix

__init__(other=None)

Initializes a Matrix object

Parameters:other (Matrix3) – Copies from other Matrix3 (optional)

returns: Matrix3

__len__()

Returns int:The size of the Matrix

__mul__(other)

Multiply with other matrix

Parameters:other (Matrix3) – Matrix to multiply with

__repr__()

Returns basestring:  String representation of the Matrix

__setitem__(index, value)

Parameters:index (Int) – Row-index

__weakref__

list of weak references to the object (if defined)

asEuler(degrees=False, order='zxy')

Returns euler values from the Matrix

Parameters:

• degrees (bool) – If True, the values are returned as degrees, otherwise as radians
• order (basestring) – The rotation order to return values for.

Return list:

Euler values

copy()

Returns:A copy of this Matrix

invert()

Inverts this Matrix in place

inverted()

Returns Matrix:An inverted copy of this Matrix

set(other, transpose=True)

Copy values from other Matrix

Parameters:other (Matrix) – Source Matrix

setIdentity()

Set this matrix to it’s identity

transpose()

This function transposes a matrix, by flipping it across it’s main diagonal.

transposed()

This function transposes a matrix, by flipping it across it’s main diagonal. It returns a new transposed matrix.

Matrix4

class modo.mathutils.Matrix4(other=None, position=None)

Bases: modo.mathutils.Matrix3

Matrix class

__init__(other=None, position=None)

Initializes a Matrix object

Parameters:

• other (Matrix4) – Copies from other Matrix4 (optional)
• position (iterable) – Translation value to set (optional)

returns: Matrix4

asRotateMatrix()

Removes the translation part of this Matrix

position

Getter:Returns the translation part of this matrix Return type:tuple Setter:Sets the translation part of this matrix Parameters:position (iterable) – Position

Vector3

class modo.mathutils.Vector3(*a)

Vector3 class

__add__(other)

Vector Addition

__div__(other)

Vector division

__eq__(other)

Returns if this vector is equivalent to another vector

__init__(*a)

Parameters:a (float) – Three float values Return Vector3:The initialized Vector3 object

__len__()

Returns the number of vector components

__mul__(other)

Vector multiplication

Parameters:other – Can be another Vector3, a Matrix4 or a float value.

When other is a Vector3 the result is a component-wise multiplication

__repr__()

Returns a string representation of this vector

__sub__(other)

Vector Subtraction

__weakref__

list of weak references to the object (if defined)

angle(other)

Returns the angle between this and another vector

cross(other)

Returns a new vector with the result of crossing this vector with another

distanceBetweenPoints(other)

Returns the distance between this and another point

equals(other, tolerance=None)

Returns if this vector is equivalent to another vector

length()

Returns the length of this vector

lerp(other, t)

Perform linear blending between this and other Vector3

Parameters:

• other (Vector3) – Other vector
• t (float) – Parameter between 0.0 and 1.0

mulByMatrixAsPoint(other)

Transform this point’s position by a Matrix4 in place.

Parameters:other (Matrix4) – Other Matrix

normal()

Returns a normalized copy of this vector

normalize()

Normalizes this vector in place

rotateByAxisAngle(axis, angle)

Rotates this vector by a given axis and angle

Parameters:

• axis (Vector3) – This axis to rotate about
• angle (float) – The angle in radians to rotate by

rotateByQuat(other)

Rotate this vector by a quaternion

setLength(value)

Sets the length of this vector

x

Quick access to the x component of the vector

y

Quick access to the y component of the vector

z

Quick access to the z component of the vector

Quaternion

class modo.mathutils.Quaternion(values=None)

Minimal quaternion class

__repr__()

Returns a string representation of this Quaternion

__weakref__

list of weak references to the object (if defined)

copy()

Returns a copy of this quaternion object

fromMatrix3(input)

This function converts a matrix into a quaternion, containing the same rotation.

Parameters:

• input (Matrix3) –
• output (Quaternion) –

fromMatrix4(input)

This function converts a matrix into a quaternion, containing the same rotation.

Parameters:input (Matrix4) –

getAxisAngle()

Returns the axis and angle of this quaternion

Returns tuple:Axis [tuple] and angle [float]

length()

Returns the length of this quaternion

normalize()

Normalizes the quaternion in place

setAxisAngle(axis, angle)

This function takes an axis and an angle, and calculates a quaternion that encodes that rotation.

Parameters:

• angle (float) – Angle in radians
• axis (Vector3) – Axis

toMatrix3()

This function converts a quaternion into a Matrix3, containing the same rotation.

Return Matrix3:Result

toMatrix4()

Returns Matrix4:  This quaternion as Matrix4, containing the same rotation

w

Quick access to the w component of the quaternion

x

Quick access to the x component of the quaternion

y

Quick access to the y component of the quaternion

z

Quick access to the z component of the quaternion