Detailed Description

An efficient mathematical representation for three dimensional rotations.

Inherits IEquatable.

Public Member Functions
	Quaternion (float x, float y, float z, float w)
	Constructs a quaternion with X, Y, Z and W from four values.
	Quaternion (Vector3 value, float w)
	Constructs a quaternion with X, Y, Z from Vector3 and rotation component from a scalar.
	Quaternion (Vector4 value)
	Constructs a quaternion from Vector4.
void	Conjugate ()
	Transforms this quaternion into its conjugated version.
override bool	Equals (object obj)
	Compares whether current instance is equal to specified Object.
bool	Equals (Quaternion other)
	Compares whether current instance is equal to specified Quaternion.
override int	GetHashCode ()
	Gets the hash code of this Quaternion.
float	Length ()
	Returns the magnitude of the quaternion components.
float	LengthSquared ()
	Returns the squared magnitude of the quaternion components.
void	Normalize ()
	Scales the quaternion magnitude to unit length.
override string	ToString ()
	Returns a String representation of this Quaternion in the format: {X:[X] Y:[Y] Z:[Z] W:[W]}.
Vector4	ToVector4 ()
	Gets a Vector4 representation for this object.
void	Deconstruct (out float x, out float y, out float z, out float w)

Static Public Member Functions
static Quaternion	Add (Quaternion quaternion1, Quaternion quaternion2)
	Creates a new Quaternion that contains the sum of two quaternions.
static void	Add (ref Quaternion quaternion1, ref Quaternion quaternion2, out Quaternion result)
	Creates a new Quaternion that contains the sum of two quaternions.
static Quaternion	Concatenate (Quaternion value1, Quaternion value2)
	Creates a new Quaternion that contains concatenation between two quaternion.
static void	Concatenate (ref Quaternion value1, ref Quaternion value2, out Quaternion result)
	Creates a new Quaternion that contains concatenation between two quaternion.
static Quaternion	Conjugate (Quaternion value)
	Creates a new Quaternion that contains conjugated version of the specified quaternion.
static void	Conjugate (ref Quaternion value, out Quaternion result)
	Creates a new Quaternion that contains conjugated version of the specified quaternion.
static Quaternion	CreateFromAxisAngle (Vector3 axis, float angle)
	Creates a new Quaternion from the specified axis and angle.
static void	CreateFromAxisAngle (ref Vector3 axis, float angle, out Quaternion result)
	Creates a new Quaternion from the specified axis and angle.
static Quaternion	CreateFromRotationMatrix (Matrix matrix)
	Creates a new Quaternion from the specified Matrix.
static void	CreateFromRotationMatrix (ref Matrix matrix, out Quaternion result)
	Creates a new Quaternion from the specified Matrix.
static Quaternion	CreateFromYawPitchRoll (float yaw, float pitch, float roll)
	Creates a new Quaternion from the specified yaw, pitch and roll angles.
static void	CreateFromYawPitchRoll (float yaw, float pitch, float roll, out Quaternion result)
	Creates a new Quaternion from the specified yaw, pitch and roll angles.
static Quaternion	Divide (Quaternion quaternion1, Quaternion quaternion2)
	Divides a Quaternion by the other Quaternion.
static void	Divide (ref Quaternion quaternion1, ref Quaternion quaternion2, out Quaternion result)
	Divides a Quaternion by the other Quaternion.
static float	Dot (Quaternion quaternion1, Quaternion quaternion2)
	Returns a dot product of two quaternions.
static void	Dot (ref Quaternion quaternion1, ref Quaternion quaternion2, out float result)
	Returns a dot product of two quaternions.
static float	AngleBetween (Quaternion quaternion1, Quaternion quaternion2)
	Returns the angle in radians between two unit quaternions (the rotation they share).
static Quaternion	Inverse (Quaternion quaternion)
	Returns the inverse quaternion which represents the opposite rotation.
static void	Inverse (ref Quaternion quaternion, out Quaternion result)
	Returns the inverse quaternion which represents the opposite rotation.
static Quaternion	Lerp (Quaternion quaternion1, Quaternion quaternion2, float amount)
	Performs a linear blend between two quaternions.
static void	Lerp (ref Quaternion quaternion1, ref Quaternion quaternion2, float amount, out Quaternion result)
	Performs a linear blend between two quaternions.
static Quaternion	Slerp (Quaternion quaternion1, Quaternion quaternion2, float amount)
	Performs a spherical linear blend between two quaternions.
static void	Slerp (ref Quaternion quaternion1, ref Quaternion quaternion2, float amount, out Quaternion result)
	Performs a spherical linear blend between two quaternions.
static Quaternion	Subtract (Quaternion quaternion1, Quaternion quaternion2)
	Creates a new Quaternion that contains subtraction of one Quaternion from another.
static void	Subtract (ref Quaternion quaternion1, ref Quaternion quaternion2, out Quaternion result)
	Creates a new Quaternion that contains subtraction of one Quaternion from another.
static Quaternion	Multiply (Quaternion quaternion1, Quaternion quaternion2)
	Creates a new Quaternion that contains a multiplication of two quaternions.
static Quaternion	Multiply (Quaternion quaternion1, float scaleFactor)
	Creates a new Quaternion that contains a multiplication of Quaternion and a scalar.
static void	Multiply (ref Quaternion quaternion1, float scaleFactor, out Quaternion result)
	Creates a new Quaternion that contains a multiplication of Quaternion and a scalar.
static void	Multiply (ref Quaternion quaternion1, ref Quaternion quaternion2, out Quaternion result)
	Creates a new Quaternion that contains a multiplication of two quaternions.
static Quaternion	Negate (Quaternion quaternion)
	Flips the sign of the all the quaternion components.
static void	Negate (ref Quaternion quaternion, out Quaternion result)
	Flips the sign of the all the quaternion components.
static Quaternion	Normalize (Quaternion quaternion)
	Scales the quaternion magnitude to unit length.
static void	Normalize (ref Quaternion quaternion, out Quaternion result)
	Scales the quaternion magnitude to unit length.
static Quaternion	operator+ (Quaternion quaternion1, Quaternion quaternion2)
	Adds two quaternions.
static Quaternion	operator/ (Quaternion quaternion1, Quaternion quaternion2)
	Divides a Quaternion by the other Quaternion.
static bool	operator== (Quaternion quaternion1, Quaternion quaternion2)
	Compares whether two Quaternion instances are equal.
static bool	operator!= (Quaternion quaternion1, Quaternion quaternion2)
	Compares whether two Quaternion instances are not equal.
static Quaternion	operator* (Quaternion quaternion1, Quaternion quaternion2)
	Multiplies two quaternions.
static Quaternion	operator* (Quaternion quaternion1, float scaleFactor)
	Multiplies the components of quaternion by a scalar.
static Quaternion	operator- (Quaternion quaternion1, Quaternion quaternion2)
	Subtracts a Quaternion from a Quaternion.
static Quaternion	operator- (Quaternion quaternion)
	Flips the sign of the all the quaternion components.

Public Attributes
float	X
	The x coordinate of this Quaternion.
float	Y
	The y coordinate of this Quaternion.
float	Z
	The z coordinate of this Quaternion.
float	W
	The rotation component of this Quaternion.

Properties
static Quaternion	Identity `[get]`
	Returns a quaternion representing no rotation.
string	DebugDisplayString `[get]`

Static Private Attributes
static readonly Quaternion	_identity = new Quaternion(0, 0, 0, 1)

Constructor & Destructor Documentation

◆ Quaternion() [1/3]

Nebula.Quaternion.Quaternion	(	float	x,
		float	y,
		float	z,
		float	w )

inline

Constructs a quaternion with X, Y, Z and W from four values.

Parameters

x	The x coordinate in 3d-space.
y	The y coordinate in 3d-space.
z	The z coordinate in 3d-space.
w	The rotation component.

◆ Quaternion() [2/3]

Nebula.Quaternion.Quaternion	(	Vector3	value,
		float	w )

inline

Constructs a quaternion with X, Y, Z from Vector3 and rotation component from a scalar.

Parameters

value	The x, y, z coordinates in 3d-space.
w	The rotation component.

◆ Quaternion() [3/3]

Nebula.Quaternion.Quaternion ( Vector4 value )

inline

Constructs a quaternion from Vector4.

Parameters

value The x, y, z coordinates in 3d-space and the rotation component.

Member Function Documentation

◆ Add() [1/2]

Quaternion Nebula.Quaternion.Add	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Creates a new Quaternion that contains the sum of two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.

Returns: The result of the quaternion addition.

◆ Add() [2/2]

void Nebula.Quaternion.Add	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion that contains the sum of two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
result	The result of the quaternion addition as an output parameter.

◆ AngleBetween()

float Nebula.Quaternion.AngleBetween	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Returns the angle in radians between two unit quaternions (the rotation they share).

Parameters

quaternion1	Source Quaternion, unit length.
quaternion2	Source Quaternion, unit length.

Returns: The angle between the two quaternions in radians, in the range [0, π].

Implemented as 2 * acos(|dot|). No normalization is performed; inputs are expected to be unit length.

◆ Concatenate() [1/2]

Quaternion Nebula.Quaternion.Concatenate	(	Quaternion	value1,
		Quaternion	value2 )

inlinestatic

Creates a new Quaternion that contains concatenation between two quaternion.

Parameters

value1	The first Quaternion to concatenate.
value2	The second Quaternion to concatenate.

Returns: The result of rotation of value1 followed by value2 rotation.

◆ Concatenate() [2/2]

void Nebula.Quaternion.Concatenate	(	ref Quaternion	value1,
		ref Quaternion	value2,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion that contains concatenation between two quaternion.

Parameters

value1	The first Quaternion to concatenate.
value2	The second Quaternion to concatenate.
result	The result of rotation of value1 followed by value2 rotation as an output parameter.

◆ Conjugate() [1/3]

void Nebula.Quaternion.Conjugate ( )

inline

Transforms this quaternion into its conjugated version.

◆ Conjugate() [2/3]

Quaternion Nebula.Quaternion.Conjugate ( Quaternion value )

inlinestatic

Creates a new Quaternion that contains conjugated version of the specified quaternion.

Parameters

value The quaternion which values will be used to create the conjugated version.

Returns: The conjugate version of the specified quaternion.

◆ Conjugate() [3/3]

void Nebula.Quaternion.Conjugate	(	ref Quaternion	value,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion that contains conjugated version of the specified quaternion.

Parameters

value	The quaternion which values will be used to create the conjugated version.
result	The conjugated version of the specified quaternion as an output parameter.

◆ CreateFromAxisAngle() [1/2]

void Nebula.Quaternion.CreateFromAxisAngle	(	ref Vector3	axis,
		float	angle,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion from the specified axis and angle.

Parameters

axis	The axis of rotation.
angle	The angle in radians.
result	The new quaternion builded from axis and angle as an output parameter.

◆ CreateFromAxisAngle() [2/2]

Quaternion Nebula.Quaternion.CreateFromAxisAngle	(	Vector3	axis,
		float	angle )

inlinestatic

Creates a new Quaternion from the specified axis and angle.

Parameters

axis	The axis of rotation.
angle	The angle in radians.

Returns: The new quaternion builded from axis and angle.

◆ CreateFromRotationMatrix() [1/2]

Quaternion Nebula.Quaternion.CreateFromRotationMatrix ( Matrix matrix )

inlinestatic

Creates a new Quaternion from the specified Matrix.

Parameters

matrix The rotation matrix.

Returns: A quaternion composed from the rotation part of the matrix.

◆ CreateFromRotationMatrix() [2/2]

void Nebula.Quaternion.CreateFromRotationMatrix	(	ref Matrix	matrix,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion from the specified Matrix.

Parameters

matrix	The rotation matrix.
result	A quaternion composed from the rotation part of the matrix as an output parameter.

◆ CreateFromYawPitchRoll() [1/2]

Quaternion Nebula.Quaternion.CreateFromYawPitchRoll	(	float	yaw,
		float	pitch,
		float	roll )

inlinestatic

Creates a new Quaternion from the specified yaw, pitch and roll angles.

Parameters

yaw	Yaw around the y axis in radians.
pitch	Pitch around the x axis in radians.
roll	Roll around the z axis in radians.

Returns: A new quaternion from the concatenated yaw, pitch, and roll angles.

◆ CreateFromYawPitchRoll() [2/2]

void Nebula.Quaternion.CreateFromYawPitchRoll	(	float	yaw,
		float	pitch,
		float	roll,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion from the specified yaw, pitch and roll angles.

Parameters

yaw	Yaw around the y axis in radians.
pitch	Pitch around the x axis in radians.
roll	Roll around the z axis in radians.
result	A new quaternion from the concatenated yaw, pitch, and roll angles as an output parameter.

◆ Deconstruct()

void Nebula.Quaternion.Deconstruct	(	out float	x,
		out float	y,
		out float	z,
		out float	w )

inline

◆ Divide() [1/2]

Quaternion Nebula.Quaternion.Divide	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Divides a Quaternion by the other Quaternion.

Parameters

quaternion1	Source Quaternion.
quaternion2	Divisor Quaternion.

Returns: The result of dividing the quaternions.

◆ Divide() [2/2]

void Nebula.Quaternion.Divide	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		out Quaternion	result )

inlinestatic

Divides a Quaternion by the other Quaternion.

Parameters

quaternion1	Source Quaternion.
quaternion2	Divisor Quaternion.
result	The result of dividing the quaternions as an output parameter.

◆ Dot() [1/2]

float Nebula.Quaternion.Dot	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Returns a dot product of two quaternions.

Parameters

quaternion1	The first quaternion.
quaternion2	The second quaternion.

Returns: The dot product of two quaternions.

◆ Dot() [2/2]

void Nebula.Quaternion.Dot	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		out float	result )

inlinestatic

Returns a dot product of two quaternions.

Parameters

quaternion1	The first quaternion.
quaternion2	The second quaternion.
result	The dot product of two quaternions as an output parameter.

◆ Equals() [1/2]

override bool Nebula.Quaternion.Equals ( object obj )

inline

Compares whether current instance is equal to specified Object.

Parameters

obj	The Object to compare.

Returns: true if the instances are equal; false otherwise.

◆ Equals() [2/2]

bool Nebula.Quaternion.Equals ( Quaternion other )

inline

Compares whether current instance is equal to specified Quaternion.

Parameters

other The Quaternion to compare.

Returns: true if the instances are equal; false otherwise.

◆ GetHashCode()

override int Nebula.Quaternion.GetHashCode ( )

inline

Gets the hash code of this Quaternion.

Returns: Hash code of this Quaternion.

◆ Inverse() [1/2]

Quaternion Nebula.Quaternion.Inverse ( Quaternion quaternion )

inlinestatic

Returns the inverse quaternion which represents the opposite rotation.

Parameters

quaternion Source Quaternion.

Returns: The inverse quaternion.

◆ Inverse() [2/2]

void Nebula.Quaternion.Inverse	(	ref Quaternion	quaternion,
		out Quaternion	result )

inlinestatic

Returns the inverse quaternion which represents the opposite rotation.

Parameters

quaternion	Source Quaternion.
result	The inverse quaternion as an output parameter.

◆ Length()

float Nebula.Quaternion.Length ( )

inline

Returns the magnitude of the quaternion components.

Returns: The magnitude of the quaternion components.

◆ LengthSquared()

float Nebula.Quaternion.LengthSquared ( )

inline

Returns the squared magnitude of the quaternion components.

Returns: The squared magnitude of the quaternion components.

◆ Lerp() [1/2]

Quaternion Nebula.Quaternion.Lerp	(	Quaternion	quaternion1,
		Quaternion	quaternion2,
		float	amount )

inlinestatic

Performs a linear blend between two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
amount	The blend amount where 0 returns quaternion1 and 1 quaternion2 .

Returns: The result of linear blending between two quaternions.

◆ Lerp() [2/2]

void Nebula.Quaternion.Lerp	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		float	amount,
		out Quaternion	result )

inlinestatic

Performs a linear blend between two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
amount	The blend amount where 0 returns quaternion1 and 1 quaternion2 .
result	The result of linear blending between two quaternions as an output parameter.

◆ Multiply() [1/4]

Quaternion Nebula.Quaternion.Multiply	(	Quaternion	quaternion1,
		float	scaleFactor )

inlinestatic

Creates a new Quaternion that contains a multiplication of Quaternion and a scalar.

Parameters

quaternion1	Source Quaternion.
scaleFactor	Scalar value.

Returns: The result of the quaternion multiplication with a scalar.

◆ Multiply() [2/4]

Quaternion Nebula.Quaternion.Multiply	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Creates a new Quaternion that contains a multiplication of two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.

Returns: The result of the quaternion multiplication.

◆ Multiply() [3/4]

void Nebula.Quaternion.Multiply	(	ref Quaternion	quaternion1,
		float	scaleFactor,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion that contains a multiplication of Quaternion and a scalar.

Parameters

quaternion1	Source Quaternion.
scaleFactor	Scalar value.
result	The result of the quaternion multiplication with a scalar as an output parameter.

◆ Multiply() [4/4]

void Nebula.Quaternion.Multiply	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion that contains a multiplication of two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
result	The result of the quaternion multiplication as an output parameter.

◆ Negate() [1/2]

Quaternion Nebula.Quaternion.Negate ( Quaternion quaternion )

inlinestatic

Flips the sign of the all the quaternion components.

Parameters

quaternion Source Quaternion.

Returns: The result of the quaternion negation.

◆ Negate() [2/2]

void Nebula.Quaternion.Negate	(	ref Quaternion	quaternion,
		out Quaternion	result )

inlinestatic

Flips the sign of the all the quaternion components.

Parameters

quaternion	Source Quaternion.
result	The result of the quaternion negation as an output parameter.

◆ Normalize() [1/3]

void Nebula.Quaternion.Normalize ( )

inline

Scales the quaternion magnitude to unit length.

◆ Normalize() [2/3]

Quaternion Nebula.Quaternion.Normalize ( Quaternion quaternion )

inlinestatic

Scales the quaternion magnitude to unit length.

Parameters

quaternion Source Quaternion.

Returns: The unit length quaternion.

◆ Normalize() [3/3]

void Nebula.Quaternion.Normalize	(	ref Quaternion	quaternion,
		out Quaternion	result )

inlinestatic

Scales the quaternion magnitude to unit length.

Parameters

quaternion	Source Quaternion.
result	The unit length quaternion an output parameter.

◆ operator!=()

bool Nebula.Quaternion.operator!=	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Compares whether two Quaternion instances are not equal.

Parameters

quaternion1	Quaternion instance on the left of the not equal sign.
quaternion2	Quaternion instance on the right of the not equal sign.

Returns: true if the instances are not equal; false otherwise.

◆ operator*() [1/2]

Quaternion Nebula.Quaternion.operator*	(	Quaternion	quaternion1,
		float	scaleFactor )

inlinestatic

Multiplies the components of quaternion by a scalar.

Parameters

quaternion1	Source Vector3 on the left of the mul sign.
scaleFactor	Scalar value on the right of the mul sign.

Returns: Result of the quaternion multiplication with a scalar.

◆ operator*() [2/2]

Quaternion Nebula.Quaternion.operator*	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Multiplies two quaternions.

Parameters

quaternion1	Source Quaternion on the left of the mul sign.
quaternion2	Source Quaternion on the right of the mul sign.

Returns: Result of the quaternions multiplication.

◆ operator+()

Quaternion Nebula.Quaternion.operator+	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Adds two quaternions.

Parameters

quaternion1	Source Quaternion on the left of the add sign.
quaternion2	Source Quaternion on the right of the add sign.

Returns: Sum of the vectors.

◆ operator-() [1/2]

Quaternion Nebula.Quaternion.operator- ( Quaternion quaternion )

inlinestatic

Flips the sign of the all the quaternion components.

Parameters

quaternion Source Quaternion on the right of the sub sign.

Returns: The result of the quaternion negation.

◆ operator-() [2/2]

Quaternion Nebula.Quaternion.operator-	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Subtracts a Quaternion from a Quaternion.

Parameters

quaternion1	Source Vector3 on the left of the sub sign.
quaternion2	Source Vector3 on the right of the sub sign.

Returns: Result of the quaternion subtraction.

◆ operator/()

Quaternion Nebula.Quaternion.operator/	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Divides a Quaternion by the other Quaternion.

Parameters

quaternion1	Source Quaternion on the left of the div sign.
quaternion2	Divisor Quaternion on the right of the div sign.

Returns: The result of dividing the quaternions.

◆ operator==()

bool Nebula.Quaternion.operator==	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Compares whether two Quaternion instances are equal.

Parameters

quaternion1	Quaternion instance on the left of the equal sign.
quaternion2	Quaternion instance on the right of the equal sign.

Returns: true if the instances are equal; false otherwise.

◆ Slerp() [1/2]

Quaternion Nebula.Quaternion.Slerp	(	Quaternion	quaternion1,
		Quaternion	quaternion2,
		float	amount )

inlinestatic

Performs a spherical linear blend between two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
amount	The blend amount where 0 returns quaternion1 and 1 quaternion2 .

Returns: The result of spherical linear blending between two quaternions.

◆ Slerp() [2/2]

void Nebula.Quaternion.Slerp	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		float	amount,
		out Quaternion	result )

inlinestatic

Performs a spherical linear blend between two quaternions.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
amount	The blend amount where 0 returns quaternion1 and 1 quaternion2 .
result	The result of spherical linear blending between two quaternions as an output parameter.

◆ Subtract() [1/2]

Quaternion Nebula.Quaternion.Subtract	(	Quaternion	quaternion1,
		Quaternion	quaternion2 )

inlinestatic

Creates a new Quaternion that contains subtraction of one Quaternion from another.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.

Returns: The result of the quaternion subtraction.

◆ Subtract() [2/2]

void Nebula.Quaternion.Subtract	(	ref Quaternion	quaternion1,
		ref Quaternion	quaternion2,
		out Quaternion	result )

inlinestatic

Creates a new Quaternion that contains subtraction of one Quaternion from another.

Parameters

quaternion1	Source Quaternion.
quaternion2	Source Quaternion.
result	The result of the quaternion subtraction as an output parameter.

◆ ToString()

override string Nebula.Quaternion.ToString ( )

inline

Returns a String representation of this Quaternion in the format: {X:[X] Y:[Y] Z:[Z] W:[W]}.

Returns: A String representation of this Quaternion.

◆ ToVector4()

Vector4 Nebula.Quaternion.ToVector4 ( )

inline

Gets a Vector4 representation for this object.

Returns: A Vector4 representation for this object.

Member Data Documentation

◆ _identity

readonly Quaternion Nebula.Quaternion._identity = new Quaternion(0, 0, 0, 1)

staticprivate

◆ W

float Nebula.Quaternion.W

The rotation component of this Quaternion.

◆ X

float Nebula.Quaternion.X

The x coordinate of this Quaternion.

◆ Y

float Nebula.Quaternion.Y

The y coordinate of this Quaternion.

◆ Z

float Nebula.Quaternion.Z

The z coordinate of this Quaternion.

Property Documentation

◆ DebugDisplayString

string Nebula.Quaternion.DebugDisplayString

getpackage

◆ Identity

Quaternion Nebula.Quaternion.Identity

staticget

Returns a quaternion representing no rotation.

The documentation for this struct was generated from the following file:

/github/workspace/code/addons/nsharp/NebulaEngine/mathf/Quaternion.cs

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Static Private Attributes

Constructor & Destructor Documentation

◆ Quaternion() [1/3]

◆ Quaternion() [2/3]

◆ Quaternion() [3/3]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AngleBetween()

◆ Concatenate() [1/2]

◆ Concatenate() [2/2]

◆ Conjugate() [1/3]

◆ Conjugate() [2/3]

◆ Conjugate() [3/3]

◆ CreateFromAxisAngle() [1/2]

◆ CreateFromAxisAngle() [2/2]

◆ CreateFromRotationMatrix() [1/2]

◆ CreateFromRotationMatrix() [2/2]

◆ CreateFromYawPitchRoll() [1/2]

◆ CreateFromYawPitchRoll() [2/2]

◆ Deconstruct()

◆ Divide() [1/2]

◆ Divide() [2/2]

◆ Dot() [1/2]

◆ Dot() [2/2]

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ Inverse() [1/2]

◆ Inverse() [2/2]

◆ Length()

◆ LengthSquared()

◆ Lerp() [1/2]

◆ Lerp() [2/2]

◆ Multiply() [1/4]

◆ Multiply() [2/4]

◆ Multiply() [3/4]

◆ Multiply() [4/4]

◆ Negate() [1/2]

◆ Negate() [2/2]

◆ Normalize() [1/3]

◆ Normalize() [2/3]

◆ Normalize() [3/3]

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator/()

◆ operator==()

◆ Slerp() [1/2]

◆ Slerp() [2/2]

◆ Subtract() [1/2]

◆ Subtract() [2/2]

◆ ToString()

◆ ToVector4()

Member Data Documentation

◆ _identity

◆ W

◆ X

◆ Y

◆ Z

Property Documentation

◆ DebugDisplayString

◆ Identity