Packageorg.papervision3d.core.math
Classpublic class Number3D

The Number3D class represents a value in a three-dimensional coordinate system. Properties x, y and z represent the horizontal, vertical and z the depth axes respectively.



Public Properties
 PropertyDefined by
  modulo : Number
[read-only] Modulo
Number3D
  moduloSquared : Number
[read-only]
Number3D
  toDEGREES : Number
[static]
Number3D
  toRADIANS : Number
[static]
Number3D
  x : Number
The horizontal coordinate value.
Number3D
  y : Number
The vertical coordinate value.
Number3D
  z : Number
The depth coordinate value.
Number3D
  ZERO : Number3D
[static][read-only] Returns a Number3D object with x, y and z properties set to zero.
Number3D
Public Methods
 MethodDefined by
  
Number3D(x:Number = 0, y:Number = 0, z:Number = 0)
Creates a new Number3D object whose three-dimensional values are specified by the x, y and z parameters.
Number3D
  
[static] Add
Number3D
  
Returns a new Number3D object that is a clone of the original instance with the same three-dimensional values.
Number3D
  
Copies the values of this Number3d to the passed Number3d.
Number3D
  
copyTo(n:Number3D):void
Copies the values of this Number3d to the passed Number3d.
Number3D
  
cross(v:Number3D, w:Number3D, targetN:Number3D = null):Number3D
[static] Cross product.
Number3D
  
dot(v:Number3D, w:Number3D):Number
[static] Dot product.
Number3D
  
isModuloEqualTo(v:Number):Boolean
Number3D
  
isModuloGreaterThan(v:Number):Boolean
Number3D
  
isModuloLessThan(v:Number):Boolean
Super fast modulo(length, magnitude) comparisons.
Number3D
  
minusEq(v:Number3D):void
Subtracts the vector passed to this vector.
Number3D
  
multiplyEq(n:Number):void
Multiplies the vector by a number.
Number3D
  
normalize():void
Normalize.
Number3D
  
plusEq(v:Number3D):void
Adds the vector passed to this vector.
Number3D
  
reset(newx:Number = 0, newy:Number = 0, newz:Number = 0):void
Quick way to set the properties of the Number3D
Number3D
  
rotateX(angle:Number):void
Number3D
  
rotateY(angle:Number):void
Number3D
  
rotateZ(angle:Number):void
Number3D
  
[static] Subtract.
Number3D
  
toString():String
Returns a string value representing the three-dimensional values in the specified Number3D object.
Number3D
Property detail
moduloproperty
modulo:Number  [read-only]

Modulo

Implementation
    public function get modulo():Number
moduloSquaredproperty 
moduloSquared:Number  [read-only]Implementation
    public function get moduloSquared():Number
toDEGREESproperty 
public static var toDEGREES:Number
toRADIANSproperty 
public static var toRADIANS:Number
xproperty 
public var x:Number

The horizontal coordinate value.

yproperty 
public var y:Number

The vertical coordinate value.

zproperty 
public var z:Number

The depth coordinate value.

ZEROproperty 
ZERO:Number3D  [read-only]

Returns a Number3D object with x, y and z properties set to zero.

Implementation
    public static function get ZERO():Number3D
Constructor detail
Number3D()constructor
public function Number3D(x:Number = 0, y:Number = 0, z:Number = 0)

Creates a new Number3D object whose three-dimensional values are specified by the x, y and z parameters. If you call this constructor function without parameters, a Number3D with x, y and z properties set to zero is created.

Parameters
x:Number (default = 0) — The horizontal coordinate value. The default value is zero.
 
y:Number (default = 0) — The vertical coordinate value. The default value is zero.
 
z:Number (default = 0) — The depth coordinate value. The default value is zero.
Method detail
add()method
public static function add(v:Number3D, w:Number3D):Number3D

Add

Parameters
v:Number3D
 
w:Number3D

Returns
Number3D
clone()method 
public function clone():Number3D

Returns a new Number3D object that is a clone of the original instance with the same three-dimensional values.

Returns
Number3D — A new Number3D instance with the same three-dimensional values as the original Number3D instance.
copyFrom()method 
public function copyFrom(n:Number3D):void

Copies the values of this Number3d to the passed Number3d.

Parameters
n:Number3D
copyTo()method 
public function copyTo(n:Number3D):void

Copies the values of this Number3d to the passed Number3d.

Parameters
n:Number3D
cross()method 
public static function cross(v:Number3D, w:Number3D, targetN:Number3D = null):Number3D

Cross product. Now optionally takes a target Number3D to put the change into. So we're not constantly making new number3Ds. Maybe make a crossEq function?

Parameters
v:Number3D
 
w:Number3D
 
targetN:Number3D (default = null)

Returns
Number3D
dot()method 
public static function dot(v:Number3D, w:Number3D):Number

Dot product.

Parameters
v:Number3D
 
w:Number3D

Returns
Number
isModuloEqualTo()method 
public function isModuloEqualTo(v:Number):BooleanParameters
v:Number

Returns
Boolean
isModuloGreaterThan()method 
public function isModuloGreaterThan(v:Number):BooleanParameters
v:Number

Returns
Boolean
isModuloLessThan()method 
public function isModuloLessThan(v:Number):Boolean

Super fast modulo(length, magnitude) comparisons.

Parameters
v:Number

Returns
Boolean
minusEq()method 
public function minusEq(v:Number3D):void

Subtracts the vector passed to this vector. The same as the -= operator.

Parameters
v:Number3D
multiplyEq()method 
public function multiplyEq(n:Number):void

Multiplies the vector by a number. The same as the operator

Parameters
n:Number
normalize()method 
public function normalize():void

Normalize.

plusEq()method 
public function plusEq(v:Number3D):void

Adds the vector passed to this vector. The same as the += operator.

Parameters
v:Number3D
reset()method 
public function reset(newx:Number = 0, newy:Number = 0, newz:Number = 0):void

Quick way to set the properties of the Number3D

Parameters
newx:Number (default = 0)
 
newy:Number (default = 0)
 
newz:Number (default = 0)
rotateX()method 
public function rotateX(angle:Number):void

Parameters
angle:Number
rotateY()method 
public function rotateY(angle:Number):voidParameters
angle:Number
rotateZ()method 
public function rotateZ(angle:Number):voidParameters
angle:Number
sub()method 
public static function sub(v:Number3D, w:Number3D):Number3D

Subtract.

Parameters
v:Number3D
 
w:Number3D

Returns
Number3D
toString()method 
public function toString():String

Returns a string value representing the three-dimensional values in the specified Number3D object.

Returns
String — A string.