Click or drag to resize

Quaternion Structure

An efficient mathematical representation for three dimensional rotations.
Inheritance Hierarchy
SystemObject
  SystemValueType
    CFX.Structures.GeometryQuaternion

Namespace: CFX.Structures.Geometry
Assembly: CFX (in CFX.dll) Version: 1.7.3
Syntax
[SerializableAttribute]
public struct Quaternion : IEquatable<Quaternion>

The Quaternion type exposes the following members.

Constructors
 NameDescription
Public methodQuaternion(Vector3, Double) Constructs a quaternion with X, Y, Z from Vector3 and rotation component from a scalar.
Public methodQuaternion(Double, Double, Double, Double) Constructs a quaternion with X, Y, Z and W from four values.
Top
Properties
 NameDescription
Public propertyStatic memberIdentity Returns a quaternion representing no rotation.
Top
Methods
 NameDescription
Public methodStatic memberAdd(Quaternion, Quaternion) Creates a new Quaternion that contains the sum of two quaternions.
Public methodStatic memberAdd(Quaternion, Quaternion, Quaternion) Creates a new Quaternion that contains the sum of two quaternions.
Public methodStatic memberConcatenate(Quaternion, Quaternion) Creates a new Quaternion that contains concatenation between two quaternion.
Public methodStatic memberConcatenate(Quaternion, Quaternion, Quaternion) Creates a new Quaternion that contains concatenation between two quaternion.
Public methodConjugate Transforms this quaternion into its conjugated version.
Public methodStatic memberConjugate(Quaternion) Creates a new Quaternion that contains conjugated version of the specified quaternion.
Public methodStatic memberConjugate(Quaternion, Quaternion) Creates a new Quaternion that contains conjugated version of the specified quaternion.
Public methodStatic memberCreateFromAxisAngle(Vector3, Double) Creates a new Quaternion from the specified axis and angle.
Public methodStatic memberCreateFromAxisAngle(Vector3, Double, Quaternion) Creates a new Quaternion from the specified axis and angle.
Public methodStatic memberCreateFromRotationMatrix(Matrix44) Creates a new Quaternion from the specified Matrix44.
Public methodStatic memberCreateFromRotationMatrix(Matrix44, Quaternion) Creates a new Quaternion from the specified Matrix44.
Public methodStatic memberCreateFromYawPitchRoll(Double, Double, Double) Creates a new Quaternion from the specified yaw, pitch and roll angles.
Public methodStatic memberCreateFromYawPitchRoll(Double, Double, Double, Quaternion) Creates a new Quaternion from the specified yaw, pitch and roll angles.
Public methodStatic memberDivide(Quaternion, Quaternion) Divides a Quaternion by the other Quaternion.
Public methodStatic memberDivide(Quaternion, Quaternion, Quaternion) Divides a Quaternion by the other Quaternion.
Public methodStatic memberDot(Quaternion, Quaternion) Returns a dot product of two quaternions.
Public methodStatic memberDot(Quaternion, Quaternion, Double) Returns a dot product of two quaternions.
Public methodEquals(Object) Compares whether current instance is equal to specified Object.
(Overrides ValueTypeEquals(Object))
Public methodEquals(Quaternion) Compares whether current instance is equal to specified Quaternion.
Public methodGetHashCode Gets the hash code of this Quaternion.
(Overrides ValueTypeGetHashCode)
Public methodStatic memberInverse(Quaternion) Returns the inverse quaternion which represents the opposite rotation.
Public methodStatic memberInverse(Quaternion, Quaternion) Returns the inverse quaternion which represents the opposite rotation.
Public methodLength Returns the magnitude of the quaternion components.
Public methodLengthSquared Returns the squared magnitude of the quaternion components.
Public methodStatic memberLerp(Quaternion, Quaternion, Double) Performs a linear blend between two quaternions.
Public methodStatic memberLerp(Quaternion, Quaternion, Double, Quaternion) Performs a linear blend between two quaternions.
Public methodStatic memberMultiply(Quaternion, Quaternion) Creates a new Quaternion that contains a multiplication of two quaternions.
Public methodStatic memberMultiply(Quaternion, Double) Creates a new Quaternion that contains a multiplication of Quaternion and a scalar.
Public methodStatic memberMultiply(Quaternion, Quaternion, Quaternion) Creates a new Quaternion that contains a multiplication of two quaternions.
Public methodStatic memberMultiply(Quaternion, Double, Quaternion) Creates a new Quaternion that contains a multiplication of Quaternion and a scalar.
Public methodStatic memberNegate(Quaternion) Flips the sign of the all the quaternion components.
Public methodStatic memberNegate(Quaternion, Quaternion) Flips the sign of the all the quaternion components.
Public methodNormalize Scales the quaternion magnitude to unit length.
Public methodStatic memberNormalize(Quaternion) Scales the quaternion magnitude to unit length.
Public methodStatic memberNormalize(Quaternion, Quaternion) Scales the quaternion magnitude to unit length.
Public methodStatic memberSlerp(Quaternion, Quaternion, Double) Performs a spherical linear blend between two quaternions.
Public methodStatic memberSlerp(Quaternion, Quaternion, Double, Quaternion) Performs a spherical linear blend between two quaternions.
Public methodStatic memberSubtract(Quaternion, Quaternion) Creates a new Quaternion that contains subtraction of one Quaternion from another.
Public methodStatic memberSubtract(Quaternion, Quaternion, Quaternion) Creates a new Quaternion that contains subtraction of one Quaternion from another.
Public methodToString Returns a String representation of this Quaternion in the format: {X:[X] Y:[Y] Z:[Z] W:[W]}
(Overrides ValueTypeToString)
Top
Operators
 NameDescription
Public operatorStatic memberAddition(Quaternion, Quaternion) Adds two quaternions.
Public operatorStatic memberDivision(Quaternion, Quaternion) Divides a Quaternion by the other Quaternion.
Public operatorStatic memberEquality(Quaternion, Quaternion) Compares whether two Quaternion instances are equal.
Public operatorStatic memberInequality(Quaternion, Quaternion) Compares whether two Quaternion instances are not equal.
Public operatorStatic memberMultiply(Quaternion, Quaternion) Multiplies two quaternions.
Public operatorStatic memberMultiply(Quaternion, Double) Multiplies the components of quaternion by a scalar.
Public operatorStatic memberSubtraction(Quaternion, Quaternion) Subtracts a Quaternion from a Quaternion.
Public operatorStatic memberUnaryNegation(Quaternion) Flips the sign of the all the quaternion components.
Top
Fields
 NameDescription
Public fieldW The rotation component of this Quaternion.
Public fieldX The x coordinate of this Quaternion.
Public fieldY The y coordinate of this Quaternion.
Public fieldZ The z coordinate of this Quaternion.
Top
See Also