Quaternion Structure

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Defines a four dimensional mathematical quaternion.

Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax

[SerializableAttribute]
public struct Quaternion : IEquatable<Quaternion>

The Quaternion type exposes the following members.

Constructors

  NameDescription
Public methodQuaternion(Vector3, Single)
Initializes a new instance of the Quaternion structure.
Public methodQuaternion(Single, Single, Single, Single)
Initializes a new instance of the Quaternion structure.
Top
Properties

  NameDescription
Public propertyAngle
Gets the angle of the quaternion. The quaternion must be normalized.
Public propertyAxis
Gets the axis components of the quaternion. The quaternion must be normalized.
Public propertyStatic memberIdentity
Gets the identity Quaternion (0, 0, 0, 1).
Public propertyIsIdentity
Gets a value indicating whether this instance is an identity Quaternion.
Top
Methods

  NameDescription
Public methodStatic memberAdd(Quaternion, Quaternion)
Adds two quaternions.
Public methodStatic memberAdd(Quaternion, Quaternion, Quaternion)
Adds two quaternions.
Public methodStatic memberBarycentric(Quaternion, Quaternion, Quaternion, Single, Single)
Returns a Quaternion containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.
Public methodStatic memberBarycentric(Quaternion, Quaternion, Quaternion, Single, Single, Quaternion)
Returns a Quaternion containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.
Public methodConjugate
Conjugates the quaternion.
Public methodStatic memberConjugate(Quaternion)
Conjugates a quaternion.
Public methodStatic memberConjugate(Quaternion, Quaternion)
Conjugates a quaternion.
Public methodStatic memberDivide(Quaternion, Quaternion)
Divides a quaternion by another.
Public methodStatic memberDivide(Quaternion, Quaternion, Quaternion)
Divides a quaternion by another.
Public methodStatic memberDot
Calculates the dot product of two quaternions.
Public methodEquals(Object)
Returns a value that indicates whether the current instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(Quaternion)
Returns a value that indicates whether the current instance is equal to the specified object.
Public methodStatic memberEquals(Quaternion, Quaternion)
Determines whether the specified object instances are considered equal.
Public methodStatic memberExponential(Quaternion)
Exponentiates a quaternion.
Public methodStatic memberExponential(Quaternion, Quaternion)
Exponentiates a quaternion.
Public methodStatic memberFromAxes
Public methodStatic memberFromRotation
Public methodGetAxes
Public methodGetAxis
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodInvert
Conjugates and renormalizes the quaternion.
Public methodStatic memberInvert(Quaternion)
Conjugates and renormalizes the quaternion.
Public methodStatic memberInvert(Quaternion, Quaternion)
Conjugates and renormalizes the quaternion.
Public methodLength
Calculates the length of the quaternion.
Public methodLengthSquared
Calculates the squared length of the quaternion.
Public methodStatic memberLerp(Quaternion, Quaternion, Single)
Performs a linear interpolation between two quaternion.
Public methodStatic memberLerp(Quaternion, Quaternion, Single, Quaternion)
Performs a linear interpolation between two quaternions.
Public methodStatic memberLogarithm(Quaternion)
Calculates the natural logarithm of the specified quaternion.
Public methodStatic memberLogarithm(Quaternion, Quaternion)
Calculates the natural logarithm of the specified quaternion.
Public methodStatic memberMultiply(Quaternion, Quaternion)
Modulates a quaternion by another.
Public methodStatic memberMultiply(Quaternion, Single)
Scales a quaternion by the given value.
Public methodStatic memberMultiply(Quaternion, Quaternion, Quaternion)
Modulates a quaternion by another.
Public methodStatic memberMultiply(Quaternion, Single, Quaternion)
Scales a quaternion by the given value.
Public methodStatic memberNegate(Quaternion)
Reverses the direction of a given quaternion.
Public methodStatic memberNegate(Quaternion, Quaternion)
Reverses the direction of a given quaternion.
Public methodNormalize
Converts the quaternion into a unit quaternion.
Public methodStatic memberNormalize(Quaternion)
Converts the quaternion into a unit quaternion.
Public methodStatic memberNormalize(Quaternion, Quaternion)
Converts the quaternion into a unit quaternion.
Public methodStatic memberRotationAxis(Vector3, Single)
Creates a quaternion given a rotation and an axis.
Public methodStatic memberRotationAxis(Vector3, Single, Quaternion)
Creates a quaternion given a rotation and an axis.
Public methodStatic memberRotationMatrix(Matrix)
Creates a quaternion given a rotation matrix.
Public methodStatic memberRotationMatrix(Matrix, Quaternion)
Creates a quaternion given a rotation matrix.
Public methodStatic memberRotationYawPitchRoll(Single, Single, Single)
Creates a quaternion given a yaw, pitch, and roll value.
Public methodStatic memberRotationYawPitchRoll(Single, Single, Single, Quaternion)
Creates a quaternion given a yaw, pitch, and roll value.
Public methodStatic memberSlerp(Quaternion, Quaternion, Single)
Interpolates between two quaternions, using spherical linear interpolation.
Public methodStatic memberSlerp(Quaternion, Quaternion, Single, Quaternion)
Interpolates between two quaternions, using spherical linear interpolation.
Public methodStatic memberSquad(Quaternion, Quaternion, Quaternion, Quaternion, Single)
Interpolates between quaternions, using spherical quadrangle interpolation.
Public methodStatic memberSquad(Quaternion, Quaternion, Quaternion, Quaternion, Single, Quaternion)
Interpolates between quaternions, using spherical quadrangle interpolation.
Public methodStatic memberSquadSetup
Sets up control points for spherical quadrangle interpolation.
Public methodStatic memberSubtract(Quaternion, Quaternion)
Subtracts two quaternions.
Public methodStatic memberSubtract(Quaternion, Quaternion, Quaternion)
Subtracts two quaternions.
Public methodToRotation
Public methodToString
Converts the value of the object to its equivalent string representation.
(Overrides ValueTypeToString.)
Public methodToVector
Top
Operators

  NameDescription
Public operatorStatic memberAddition
Adds two quaternions.
Public operatorStatic memberDivision
Divides a quaternion by another.
Public operatorStatic memberEquality
Tests for equality between two objects.
Public operatorStatic memberInequality
Tests for inequality between two objects.
Public operatorStatic memberMultiply(Single, Quaternion)
Scales a quaternion by the given value.
Public operatorStatic memberMultiply(Quaternion, Quaternion)
Multiplies a quaternion by another.
Public operatorStatic memberMultiply(Quaternion, Single)
Scales a quaternion by the given value.
Public operatorStatic memberSubtraction
Subtracts two quaternions.
Public operatorStatic memberUnaryNegation
Reverses the direction of a given quaternion.
Top
Fields

  NameDescription
Public fieldW
Gets or sets the W component of the quaternion.
Public fieldX
Gets or sets the X component of the quaternion.
Public fieldY
Gets or sets the Y component of the quaternion.
Public fieldZ
Gets or sets the Z component of the quaternion.
Top
See Also

Reference