Packageorg.flintparticles.threeD.geom
Classpublic class Quaternion


Public Properties
 PropertyDefined by
  conjugate : Quaternion
[read-only] The conjugate of this quaternion.
Quaternion
  IDENTITY : Quaternion
[static]
Quaternion
  inverse : Quaternion
[read-only] The inverse of this quaternion.
Quaternion
  magnitude : Number
[read-only] The magnitude of this quaternion.
Quaternion
  magnitudeSquared : Number
[read-only] The square of the magnitude of this quaternion.
Quaternion
  w : Number
The w coordinate of the quaternion.
Quaternion
  x : Number
The x coordinate of the quaternion.
Quaternion
  y : Number
The y coordinate of the quaternion.
Quaternion
  z : Number
The z coordinate of the quaternion.
Quaternion
  ZERO : Quaternion
[static]
Quaternion
Public Methods
 MethodDefined by
  
Quaternion(w:Number = 1, x:Number = 0, y:Number = 0, z:Number = 0)
Constructor
Quaternion
  
add(q:Quaternion):Quaternion
Adds another quaternion to this one, returning a new quaternion.
Quaternion
  
assign(q:Quaternion):Quaternion
Copies another quaternion into this one.
Quaternion
  
clone():Quaternion
Makes a copy of this Quaternion object.
Quaternion
  
createFromAxisRotation(axis:Vector3D, angle:Number):Quaternion
[static] Create a new unit quaternion that represents a rotation about an axis in 3D space.
Quaternion
  
decrementBy(q:Quaternion):Quaternion
Subtract another quaternion from this one.
Quaternion
  
dotProduct(q:Quaternion):Number
Calculate the dot product of this quaternion with another.
Quaternion
  
equals(q:Quaternion):Boolean
Compare this quaternion to another.
Quaternion
  
incrementBy(q:Quaternion):Quaternion
Add another quaternion to this one.
Quaternion
  
invert():Quaternion
Set this quaternion to its inverse.
Quaternion
  
makeConjugate():Quaternion
Set this quaternion equal to its conjugate.
Quaternion
  
nearEquals(q:Quaternion, e:Number):Boolean
Compare this quaternion to another.
Quaternion
  
normalize():Quaternion
Convert this quaternion to have magnitude 1.
Quaternion
  
postMultiply(q:Quaternion):Quaternion
Post multiply this quaternion by another quaternion, returning a new quaternion.
Quaternion
  
postMultiplyBy(q:Quaternion):Quaternion
Post multiply this quaternion by another quaternion
Quaternion
  
preMultiply(q:Quaternion):Quaternion
Pre multiply this quaternion by another quaternion, returning a new quaternion.
Quaternion
  
preMultiplyBy(q:Quaternion):Quaternion
Pre multiply this quaternion by another quaternion
Quaternion
  
reset(w:Number = 0, x:Number = 0, y:Number = 0, z:Number = 0):Quaternion
Assigns new coordinates to this quaternion
Quaternion
  
scalarMultiply(s:Number):Quaternion
Quaternion
  
scaleBy(s:Number):Quaternion
Multiply this quaternion by a number.
Quaternion
  
setFromAxisRotation(axis:Vector3D, angle:Number):Quaternion
Set this quaternion to a unit quaternion that represents a rotation about an axis in 3D space.
Quaternion
  
subtract(q:Quaternion):Quaternion
Subtract another quaternion from this one, returning a new quaternion.
Quaternion
  
toAxisRotation():Vector3D
Convert this quaternion to an axis/angle rotation, returning the result in a Vector3D where x, y, z represent the axis and w represents the angle, in radians.
Quaternion
  
toMatrixTransformation():Matrix3D
Convert this quaternion to a matrix transformation.
Quaternion
  
toString():String
Get a string representation of this quaternion
Quaternion
  
unit():Quaternion
Create a unit quaternion in the same direction as this one.
Quaternion
Property detail
conjugateproperty
conjugate:Quaternion  [read-only]

The conjugate of this quaternion.

Implementation
    public function get conjugate():Quaternion
IDENTITYproperty 
public static var IDENTITY:Quaternion
inverseproperty 
inverse:Quaternion  [read-only]

The inverse of this quaternion.

Implementation
    public function get inverse():Quaternion
magnitudeproperty 
magnitude:Number  [read-only]

The magnitude of this quaternion.

Implementation
    public function get magnitude():Number
magnitudeSquaredproperty 
magnitudeSquared:Number  [read-only]

The square of the magnitude of this quaternion.

Implementation
    public function get magnitudeSquared():Number
wproperty 
public var w:Number

The w coordinate of the quaternion.

xproperty 
public var x:Number

The x coordinate of the quaternion.

yproperty 
public var y:Number

The y coordinate of the quaternion.

zproperty 
public var z:Number

The z coordinate of the quaternion.

ZEROproperty 
public static var ZERO:Quaternion
Constructor detail
Quaternion()constructor
public function Quaternion(w:Number = 1, x:Number = 0, y:Number = 0, z:Number = 0)

Constructor

Parameters
w:Number (default = 1) — the x coordinate of the quaternion
 
x:Number (default = 0) — the y coordinate of the quaternion
 
y:Number (default = 0) — the z coordinate of the quaternion
 
z:Number (default = 0) — the w coordinate of the quaternion
Method detail
add()method
public function add(q:Quaternion):Quaternion

Adds another quaternion to this one, returning a new quaternion.

Parameters
q:Quaternion — the quaternion to add

Returns
Quaternion — the result of the addition
assign()method 
public function assign(q:Quaternion):Quaternion

Copies another quaternion into this one.

Parameters
q:Quaternion — The quaternion to copy

Returns
Quaternion — a reference to this Quaternion object
clone()method 
public function clone():Quaternion

Makes a copy of this Quaternion object.

Returns
Quaternion — A copy of this Quaternion
createFromAxisRotation()method 
public static function createFromAxisRotation(axis:Vector3D, angle:Number):Quaternion

Create a new unit quaternion that represents a rotation about an axis in 3D space.

Parameters
axis:Vector3D — The axis of the rotation.
 
angle:Number — The angle, in radians, of the rotation. If no value is set, the w coordinate of the axis Vector3D is used.

Returns
Quaternion — A Quaternion representing the rotation.
decrementBy()method 
public function decrementBy(q:Quaternion):Quaternion

Subtract another quaternion from this one.

Parameters
q:Quaternion — The quaternion to subtract

Returns
Quaternion — A reference to this Quaternion object.
dotProduct()method 
public function dotProduct(q:Quaternion):Number

Calculate the dot product of this quaternion with another.

Parameters
q:Quaternion — The quaternion to calculate the dot product with

Returns
Number — The dot product of the two quaternions
equals()method 
public function equals(q:Quaternion):Boolean

Compare this quaternion to another.

Parameters
q:Quaternion — The quaternion to compare with.

Returns
Boolean — true if the quaternions have the same coordinates, false otherwise.
incrementBy()method 
public function incrementBy(q:Quaternion):Quaternion

Add another quaternion to this one.

Parameters
q:Quaternion — The quaternion to add

Returns
Quaternion — A reference to this Quaternion object.
invert()method 
public function invert():Quaternion

Set this quaternion to its inverse.

Returns
Quaternion — A reference to this quaternion.
makeConjugate()method 
public function makeConjugate():Quaternion

Set this quaternion equal to its conjugate.

Returns
Quaternion — A reference to this quaternion.
nearEquals()method 
public function nearEquals(q:Quaternion, e:Number):Boolean

Compare this quaternion to another.

Parameters
q:Quaternion — The quaternion to compare with.
 
e:Number — The distance allowed between the coordinates of the two quaternions.

Returns
Boolean — true if the quaternions are within distance e of each other, false otherwise
normalize()method 
public function normalize():Quaternion

Convert this quaternion to have magnitude 1.

Returns
Quaternion — A reference to this Vector3D object.
postMultiply()method 
public function postMultiply(q:Quaternion):Quaternion

Post multiply this quaternion by another quaternion, returning a new quaternion.

Parameters
q:Quaternion — The quaternion to multiply by.

Returns
Quaternion — A result of the multiplication.
postMultiplyBy()method 
public function postMultiplyBy(q:Quaternion):Quaternion

Post multiply this quaternion by another quaternion

Parameters
q:Quaternion — The quaternion to multiply by

Returns
Quaternion — A reference to this Quaternion object.
preMultiply()method 
public function preMultiply(q:Quaternion):Quaternion

Pre multiply this quaternion by another quaternion, returning a new quaternion.

Parameters
q:Quaternion — The quaternion to multiply by.

Returns
Quaternion — A result of the multiplication.
preMultiplyBy()method 
public function preMultiplyBy(q:Quaternion):Quaternion

Pre multiply this quaternion by another quaternion

Parameters
q:Quaternion — The quaternion to multiply by

Returns
Quaternion — A reference to this Quaternion object.
reset()method 
public function reset(w:Number = 0, x:Number = 0, y:Number = 0, z:Number = 0):Quaternion

Assigns new coordinates to this quaternion

Parameters
w:Number (default = 0) — The new x coordinate
 
x:Number (default = 0) — The new y coordinate
 
y:Number (default = 0) — The new z coordinate
 
z:Number (default = 0) — The new w coordinate

Returns
Quaternion — a reference to this Quaternion object
scalarMultiply()method 
public function scalarMultiply(s:Number):QuaternionParameters
s:Number

Returns
Quaternion
scaleBy()method 
public function scaleBy(s:Number):Quaternion

Multiply this quaternion by a number.

Parameters
s:Number — The number to multiply by

Returns
Quaternion — A reference to this Quaternion object.
setFromAxisRotation()method 
public function setFromAxisRotation(axis:Vector3D, angle:Number):Quaternion

Set this quaternion to a unit quaternion that represents a rotation about an axis in 3D space.

Parameters
axis:Vector3D — The axis of the rotation.
 
angle:Number — The angle, in radians, of the rotation. If no value is set, the w coordinate of the axis Vector3D is used.

Returns
Quaternion — A reference to this Quaternion.
subtract()method 
public function subtract(q:Quaternion):Quaternion

Subtract another quaternion from this one, returning a new quaternion.

Parameters
q:Quaternion — The quaternion to subtract

Returns
Quaternion — The result of the subtraction
toAxisRotation()method 
public function toAxisRotation():Vector3D

Convert this quaternion to an axis/angle rotation, returning the result in a Vector3D where x, y, z represent the axis and w represents the angle, in radians.

Returns
Vector3D — The axis/angle rotation.
toMatrixTransformation()method 
public function toMatrixTransformation():Matrix3D

Convert this quaternion to a matrix transformation.

Returns
Matrix3D — The matrix transformation.
toString()method 
public function toString():String

Get a string representation of this quaternion

Returns
String — a string representation of this quaternion
unit()method 
public function unit():Quaternion

Create a unit quaternion in the same direction as this one.

Returns
Quaternion — A unit quaternion in the same direction as this one.



© Big Room Ventures Ltd. 2008