Class Coords

Namespace

Elegy.Common.Maths

Assembly

Elegy.Common.dll

Elegy's coordinate system.

public static class Coords

Inheritance

object

Coords

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

Back

The global back vector.

public static readonly Vector3 Back

Field Value

Vector3

Deg2Rad

Factor that converts degrees into radians.

public const float Deg2Rad = 0.017453292

Field Value

float

Deg2RadD

Factor that converts degrees into radians.

public const double Deg2RadD = 0.017453293005625408

Field Value

double

Down

The global down vector.

public static readonly Vector3 Down

Field Value

Vector3

Forward

The global forward vector.

public static readonly Vector3 Forward

Field Value

Vector3

Left

The global left vector.

public static readonly Vector3 Left

Field Value

Vector3

Rad2Deg

Factor that converts radians into degrees.

public const float Rad2Deg = 57.295776

Field Value

float

Rad2DegD

Factor that converts radians into degrees.

public const double Rad2DegD = 57.29577791868205

Field Value

double

Right

The global right vector.

public static readonly Vector3 Right

Field Value

Vector3

Turn

One full turn i.e. 360 degrees.

public static readonly float Turn

Field Value

float

TurnDown

One full turn downwards i.e. about the Right axis in reverse.

public static readonly Vector3 TurnDown

Field Value

Vector3

TurnLeft

One full turn to the left i.e. about the Up axis in reverse.

public static readonly Vector3 TurnLeft

Field Value

Vector3

TurnRight

One full turn to the right i.e. about the Up axis.

public static readonly Vector3 TurnRight

Field Value

Vector3

TurnTwistLeft

One full twist counterclockwise i.e. about the Forward axis in reverse.

public static readonly Vector3 TurnTwistLeft

Field Value

Vector3

TurnTwistRight

One full twist clockwise i.e. a turn about the Forward axis.

public static readonly Vector3 TurnTwistRight

Field Value

Vector3

TurnUp

One full turn upwards i.e. about the Right axis.

public static readonly Vector3 TurnUp

Field Value

Vector3

Up

The global up vector.

public static readonly Vector3 Up

Field Value

Vector3

Methods

CreatePerspectiveMatrix(float, float, float, float)

public static Matrix4x4 CreatePerspectiveMatrix(float fov, float aspectRatio, float nearZ, float farZ)

Parameters

fov float

aspectRatio float

nearZ float

farZ float

Returns

Matrix4x4

CreateViewMatrix(Vector3, Vector3, Vector3)

Constructs a view matrix that you can use for 3D camera transformations.

public static Matrix4x4 CreateViewMatrix(Vector3 position, Vector3 forward, Vector3 up)

Parameters

position Vector3

The position. Identity is Zero.

forward Vector3

The forward matrix. Identity is Forward.

up Vector3

The forward matrix. Identity is Up.

Returns

Matrix4x4

CreateViewMatrixDegrees(Vector3, Vector3)

public static Matrix4x4 CreateViewMatrixDegrees(Vector3 position, Vector3 angles)

Parameters

position Vector3

angles Vector3

Returns

Matrix4x4

CreateViewMatrixRadians(Vector3, Vector3)

public static Matrix4x4 CreateViewMatrixRadians(Vector3 position, Vector3 angles)

Parameters

position Vector3

angles Vector3

Returns

Matrix4x4

CreateWorldMatrix(Vector3, Vector3, Vector3)

public static Matrix4x4 CreateWorldMatrix(Vector3 position, Vector3 forward, Vector3 up)

Parameters

position Vector3

forward Vector3

up Vector3

Returns

Matrix4x4

CreateWorldMatrixDegrees(Vector3, Vector3)

public static Matrix4x4 CreateWorldMatrixDegrees(Vector3 position, Vector3 angles)

Parameters

position Vector3

angles Vector3

Returns

Matrix4x4

CreateWorldMatrixQuaternion(Vector3, Quaternion)

public static Matrix4x4 CreateWorldMatrixQuaternion(Vector3 position, Quaternion orientation)

Parameters

position Vector3

orientation Quaternion

Returns

Matrix4x4

CreateWorldMatrixRadians(Vector3, Vector3)

public static Matrix4x4 CreateWorldMatrixRadians(Vector3 position, Vector3 angles)

Parameters

position Vector3

angles Vector3

Returns

Matrix4x4

DirectionsFromDegrees(Vector3, out Vector3, out Vector3)

Calculates forward and up vectors from angles, provided in degrees. You can obtain a right vector by cross-producing forward and up.

public static void DirectionsFromDegrees(Vector3 angles, out Vector3 outForward, out Vector3 outUp)

Parameters

angles Vector3

outForward Vector3

outUp Vector3

DirectionsFromQuat(Quaternion, out Vector3, out Vector3)

public static void DirectionsFromQuat(Quaternion orientation, out Vector3 outForward, out Vector3 outUp)

Parameters

orientation Quaternion

outForward Vector3

outUp Vector3

DirectionsFromRadians(Vector3, out Vector3, out Vector3)

Calculates forward and up vectors from angles, provided in radians. You can obtain a right vector by cross-producing forward and up.

public static void DirectionsFromRadians(Vector3 angles, out Vector3 outForward, out Vector3 outUp)

Parameters

angles Vector3

outForward Vector3

outUp Vector3

ForwardFromQuat(Quaternion)

public static Vector3 ForwardFromQuat(Quaternion orientation)

Parameters

orientation Quaternion

Returns

Vector3

LocalQuatFromDegrees(Vector3)

public static Quaternion LocalQuatFromDegrees(Vector3 eulerAngles)

Parameters

eulerAngles Vector3

Returns

Quaternion

LocalQuatFromRadians(Vector3)

public static Quaternion LocalQuatFromRadians(Vector3 eulerAngles)

Parameters

eulerAngles Vector3

Returns

Quaternion

PlaneFromPoints(Vector3, Vector3, Vector3)

public static Plane PlaneFromPoints(Vector3 a, Vector3 b, Vector3 c)

Parameters

a Vector3

b Vector3

c Vector3

Returns

Plane

QuatAboutForward(float)

public static Quaternion QuatAboutForward(float angle)

Parameters

angle float

Returns

Quaternion

QuatAboutRight(float)

public static Quaternion QuatAboutRight(float angle)

Parameters

angle float

Returns

Quaternion

QuatAboutUp(float)

public static Quaternion QuatAboutUp(float angle)

Parameters

angle float

Returns

Quaternion

QuatFromAxisAngle(Vector3, float)

public static Quaternion QuatFromAxisAngle(Vector3 axis, float angle)

Parameters

axis Vector3

angle float

Returns

Quaternion

RightFromQuat(Quaternion)

public static Vector3 RightFromQuat(Quaternion orientation)

Parameters

orientation Quaternion

Returns

Vector3

UpFromQuat(Quaternion)

public static Vector3 UpFromQuat(Quaternion orientation)

Parameters

orientation Quaternion

Returns

Vector3

WorldQuatFromDegrees(Vector3)

public static Quaternion WorldQuatFromDegrees(Vector3 eulerAngles)

Parameters

eulerAngles Vector3

Returns

Quaternion

WorldQuatFromRadians(Vector3)

public static Quaternion WorldQuatFromRadians(Vector3 eulerAngles)

Parameters

eulerAngles Vector3

Returns

Quaternion