Vector

This type represents a 2D vector. Most mathematical operators such as equality, addition, subtraction, multiplication and division are provided, so you can use vec2 data types similarly to how you use numerical types. In addition there are a number of methods, such as v:dot( vec2 ) that can be called on vec2 types, please see the related items below.

This method returns the scalar dot product between two vec2 types

This method returns a normalized version of the vector

This method returns the distance between two vec2 types

This method returns the squared distance between two vec2 types

This method returns the length of a vec2

This method returns the squared length of a vec2

This method returns the cross product between two vec2 types

This method returns a rotated copy of a vec2 type. The angle is assumed to be radians.

This method returns a copy of a vec2 type, rotated 90 degrees.

This method returns the angle between this vec2 and v in radians.

This method returns each of a vector's components as separate values. It is useful for inputting vector types into functions which accept scalar values.

This type represents a 3D vector. Most mathematical operators such as equality, addition, subtraction, multiplication and division are provided, so you can use vec3 data as you would normally use numerical types. In addition there are a number of methods, such as v:dot( vec3 ) that can be called on vec3 types, please see the related items below.

This method returns the scalar dot product between two vec3 types

This method returns a normalized version of the vector

This method returns the distance between two vec3 types

This method returns the squared distance between two vec3 types

This method returns the length of a vec3

This method returns the squared length of a vec3

This method returns the cross product between two vec3 types

This method returns each of a vector's components as separate values. It is useful for inputting vector types into functions which accept scalar values.

This type represents a 4D vector. Most mathematical operators such as equality, addition, subtraction, multiplication and division are provided, so you can use vec3 data as you would normally use numerical types. In addition there are a number of methods, such as v:dot( vec4 ) that can be called on vec4 types, please see the related items below.

This method returns the scalar dot product between two vec4 types

This method returns a normalized version of the vector

This method returns the distance between two vec4 types

This method returns the squared distance between two vec4 types

This method returns the length of a vec4

This method returns the squared length of a vec4

This method returns each of a vector's components as separate values. It is useful for inputting vector types into functions which accept scalar values.

A geometric utility type representing the rectangular bounding volume. Create a new bounds by giving it a minimum and maximum range as vec3s

This method has two variants, the first bounds.intersects(other) checks to see whether two bounds values intersect

The second form, bounds.intersects(origin, dir) returns true if the given ray (specified by origin, dir intersects the bounds

This will expand the current bounds to include the given point (vec3)

Translate (move) the bounds by the specified offset

Reset the bounds using the specified min and max values

This type represents a 4x4 column-major matrix. This matrix type is used to represent transformations in Codea, and can be used with functions such as modelMatrix() and viewMatrix(). The matrix type supports the following arithmetic operators: multiplication (between two matrices), multiplication by scalar, division by scalar, equality, and element-wise addition and subtraction.

Because this type is used to represent transformations it also provides a number of 3D transformation methods such as matrix:translate(x,y,z), matrix:rotate(angle,x,y,z). See the related items for a full list.

Constructing a matrix with no parameters returns the identity matrix. Passing 16 numbers when constructing a matrix will assign those values to the elements of the matrix. Individual matrix elements can be accessed by their index, for example m[1] for the first element and m[16] for the last element. Entries are defined such that the x,y,z translation components are stored in elements 13, 14, and 15 respectively.

This method returns the matrix multiplied by a rotation matrix defining a rotation of angle degrees around the x,y,z axis or (0,0,1) if no axis is given.

This method returns the matrix multiplied by a translation matrix defining a translation of x, y, z.

This method returns the matrix scaled by a translation matrix defining a scaling to each axis.

This method returns the inverse of the given matrix, if such an inverse exists. If no inverse exists, the result is a matrix of NaN values. The inverse of a matrix is a matrix such that m * mInv = I, where I is the identity matrix.

This method returns the transpose of the given matrix. The transpose of a matrix is a matrix that is flipped on the major diagonal (ie, elements 1,6,11,16). For example element 2 and element 5 are swapped, etc.

This method returns the determinant of the given matrix. This has various uses for determining characteristics of a matrix, especially whether it is invertible or not.

This type represents a quaternion.

Creates a new quaternion using 3 euler angles given in degrees.

Creates a new quaternion using an angle and axis.

Creates a new quaternion that 'looks' in a specified direction.

Creates a new quaternion that rotates between two directions.

Performs spherical interpolation (slerp) from this quaternion to another.

Extracts the euler angles from a quaternion and returns them as a vec3 in degrees.

Returns a normalized copy of this quaternion

Normalize this quaternion

Return the conjugation of this quaternion

Return the length of this quaternion

Return the squared length of this quaternion