Math utility functions, constants and global vector definitions

Defines commonly used math utility functions, constants and global vectors.

Global Vectors

The following globals should be used to avoid temporary Lua memory allocations:

Constants

Vector Functions

• #IsNullVector
• #IsNotNullVector
• #LengthSqVector
• #LengthVector
• #DistanceSqVectors
• #DistanceSqVectors2d
• #DistanceVectors
• #dotproduct3d
• #dotproduct2d
• #LogVec
• #ZeroVector
• #CopyVector
• #SumVectors
• #NegVector
• #SubVectors
• #FastSumVectors
• #DifferenceVectors
• #FastDifferenceVectors
• #ProductVectors
• #FastProductVectors
• #ScaleVector
• #ScaleVectorInPlace
• #NormalizeVector
• #FastScaleVector
• VecRotate90_Z
• VecRotateMinus90_Z
• #crossproduct3d
• #RotateVectorAroundR
• #ProjectVector

Utility Functions

• #LerpColors
• #Lerp
• __max
• __min
• #clamp
• #Interpolate
• #sgn
• #sgnnz
• #sqr
• #randomF
• #iff
• #DistanceLineAndPoint
• #random

IsNullVector( a )

Returns true if all vector components of the given vector a are null.

IsNullVector( a )

Returns true if any vector components of the given vector a is not null.

LengthSqVector( a )

Returns the squared length of the given vector a.

LengthVector( a )

Returns the length of the given vector a.

DistanceSqVectors( a, b )

Returns the squared distance between vector a and vector b.

DistanceSqVectors2d( a, b )

Returns the squared distance between vector a and vector b in 2D space (without z-component).

DistanceVectors( a, b )

Returns the distance between vector a and vector b.

dotproduct3d( a, b )

Returns the dot product between vector a and vector b.

dotproduct2d( a, b )

Returns the dot product between vector a and vector b in 2D space (without z-component).

LogVec( name, v )

Logs a given vector to console.

Example:

LogVec("Local Actor Position", g_localActor:GetPos())

Console output:
<Lua> Local Actor Position = (1104.018066 1983.247925 112.769440)

ZeroVector( dest )

Sets all vector components of the given vector dest to zero.

CopyVector( dest, src )

Copies the components of the vector src to the vector dest.

SumVectors( a, b)

Adds up the components of vector a and vector b.

NegVector( a )

Negates all components of the given vector a.

SubVectors( dest, a, b )

Copies the componentwise subtraction of vector b and vector a to vector dest.

FastSumVectors( dest, a, b )

Copies the componentwise addition of vector b and vector a to vector dest.

DifferenceVectors( a, b )

Returns the difference between vector a and vector b.

FastDifferenceVectors( dest, a, b )

Copies the componentwise difference between vector a and vector b to vector dest.

ProductVectors( a, b )

Returns the product of vector a and vector b.

FastProductVectors( dest, a, b )

Copies the product of vector a and vector b to vector dest.

ScaleVector( a, b )

Scales the given vector a by the factor of b.

ScaleVectorInPlace( a, b )

Returns a new vector based on a copy of the scaled vector a by the factor b.

ScaleVectorInPlace( dest, a, b )

Copies the scaled vector a by the factor of b to vector dest.

NormalizeVector( a )

Returns the normalized vector a.

VecRotate90_Z( v )

Rotates vector v by 90 degree around the z-axis.

VecRotateMinus90_Z( v )

Rotates vector v by -90 degree around the z-axis.

crossproduct3d( dest, p, q )

Copies the result of the cross product between vector p and vector q to vector dest.

RotateVectorAroundR( dest, p, r, angle )

Copies the result of the vector rotation of vector p around vector r by the given angle to vector dest.

ProjectVector( dest, P, N )

Copies the result of the vector projection of vector P to the surface with the given normal N to vector dest.

DistanceLineAndPoint( a, p, q )

Returns the distance between the point a and the line between p and q.

LerpColors( a, b, k )

Linear interpolation between color/vector a and color/vector b with the factor of k.

Lerp( a, b, k )

Linear interpolation between scalar a and scalar b with the factor of k.

__max( a, b )

Returns the maximum of a and b.

__min( a, b )

Returns the minimum of a and b.

clamp( _n, _min, _max )

Clamps the number _n between _min and _max.

Interpolate( actual, goal, speed )

Interpolates the given number actual to the given goal by the given speed.

sgn( a )

Returns the sign of a given number (0 returns 0).

sgnnz( a )

Returns the sign of a given number (0 returns 1).

sqr( a )

Returns the square of a given number.

randomF( a, b )

Returns a random float between a and b.

iff( c, a, b )

Returns a if c is not nil, otherwise it returns b.