Packageaway3d.core.math
Classpublic class Matrix3DUtils
InheritanceMatrix3DUtils Inheritance Object

Matrix3DUtils provides additional Matrix3D math functions.


Public Methods
 MethodDefined By
  
compare(m1:Matrix3D, m2:Matrix3D):Boolean
[static] Returns a boolean value representing whether there is any significant difference between the two given 3d matrices.
Matrix3DUtils
  
getForward(m:Matrix3D, v:Vector3D = null):Vector3D
[static] Returns a normalised Vector3D object representing the forward vector of the given matrix.
Matrix3DUtils
  
getRight(m:Matrix3D, v:Vector3D = null):Vector3D
[static] Returns a normalised Vector3D object representing the right vector of the given matrix.
Matrix3DUtils
  
getUp(m:Matrix3D, v:Vector3D = null):Vector3D
[static] Returns a normalised Vector3D object representing the up vector of the given matrix.
Matrix3DUtils
  
lookAt(matrix:Matrix3D, pos:Vector3D, dir:Vector3D, up:Vector3D):void
[static]
Matrix3DUtils
  
quaternion2matrix(quarternion:Quaternion, m:Matrix3D = null):Matrix3D
[static] Fills the 3d matrix object with values representing the transformation made by the given quaternion.
Matrix3DUtils
  
reflection(plane:Plane3D, target:Matrix3D = null):Matrix3D
[static]
Matrix3DUtils
Public Constants
 ConstantDefined By
  CALCULATION_MATRIX : Matrix3D
[static]
Matrix3DUtils
  RAW_DATA_CONTAINER : Vector.<Number>
[static] A reference to a Vector to be used as a temporary raw data container, to prevent object creation.
Matrix3DUtils
Method Detail
compare()method
public static function compare(m1:Matrix3D, m2:Matrix3D):Boolean

Returns a boolean value representing whether there is any significant difference between the two given 3d matrices.

Parameters

m1:Matrix3D
 
m2:Matrix3D

Returns
Boolean
getForward()method 
public static function getForward(m:Matrix3D, v:Vector3D = null):Vector3D

Returns a normalised Vector3D object representing the forward vector of the given matrix.

Parameters

m:Matrix3D — The Matrix3D object to use to get the forward vector
 
v:Vector3D (default = null) — [optional] A vector holder to prevent make new Vector3D instance if already exists. Default is null.

Returns
Vector3D — The forward vector
getRight()method 
public static function getRight(m:Matrix3D, v:Vector3D = null):Vector3D

Returns a normalised Vector3D object representing the right vector of the given matrix.

Parameters

m:Matrix3D — The Matrix3D object to use to get the right vector
 
v:Vector3D (default = null) — [optional] A vector holder to prevent make new Vector3D instance if already exists. Default is null.

Returns
Vector3D — The right vector
getUp()method 
public static function getUp(m:Matrix3D, v:Vector3D = null):Vector3D

Returns a normalised Vector3D object representing the up vector of the given matrix.

Parameters

m:Matrix3D — The Matrix3D object to use to get the up vector
 
v:Vector3D (default = null) — [optional] A vector holder to prevent make new Vector3D instance if already exists. Default is null.

Returns
Vector3D — The up vector
lookAt()method 
public static function lookAt(matrix:Matrix3D, pos:Vector3D, dir:Vector3D, up:Vector3D):void

Parameters

matrix:Matrix3D
 
pos:Vector3D
 
dir:Vector3D
 
up:Vector3D

quaternion2matrix()method 
public static function quaternion2matrix(quarternion:Quaternion, m:Matrix3D = null):Matrix3D

Fills the 3d matrix object with values representing the transformation made by the given quaternion.

Parameters

quarternion:Quaternion — The quarterion object to convert.
 
m:Matrix3D (default = null)

Returns
Matrix3D
reflection()method 
public static function reflection(plane:Plane3D, target:Matrix3D = null):Matrix3D

Parameters

plane:Plane3D
 
target:Matrix3D (default = null)

Returns
Matrix3D
Constant Detail
CALCULATION_MATRIXConstant
public static const CALCULATION_MATRIX:Matrix3D

RAW_DATA_CONTAINERConstant 
public static const RAW_DATA_CONTAINER:Vector.<Number>

A reference to a Vector to be used as a temporary raw data container, to prevent object creation.





Tue May 7 2013, 10:42 PM +01:00