Packageaway3d.core.draw
Classpublic final class ScreenVertex

representation of a 3d vertex resolved to the view.

Public Properties
 PropertyDefined by
  clipX : Number
The x position of the vertex in clip space
ScreenVertex
  clipY : Number
The y position of the vertex in clip space
ScreenVertex
  clipZ : Number
The z position of the vertex in clip space
ScreenVertex
  num : Number
A number containing user defined properties.
ScreenVertex
  viewTimer : int
ScreenVertex
  visible : Boolean
Indicates whether the vertex is visible after projection.
ScreenVertex
  vx : Number
The view x position of the vertex in the view.
ScreenVertex
  vy : Number
The view y position of the vertex in the view.
ScreenVertex
  x : Number
The screen x position of the vertex in the view.
ScreenVertex
  y : Number
The screen y position of the vertex in the view.
ScreenVertex
  z : Number
The screen z position of the vertex in the view.
ScreenVertex
Public Methods
 MethodDefined by
  
ScreenVertex
(x:Number = 0, y:Number = 0, z:Number = 0)
Creates a new PrimitiveQuadrantTreeNode object.
ScreenVertex
  
deperspective(focus:Number):Vertex
Converts a screen vertex back to a vertex object.
ScreenVertex
  
Calculates the distance between two screen vertex objects.
ScreenVertex
  
Calculates the squared distance between two screen vertex objects.
ScreenVertex
  
distortSqr(b:ScreenVertex, focus:Number):Number
Calculates affine distortion present at the midpoint between two screen vertex objects.
ScreenVertex
  
[static] Returns the median screen vertex between the two given screen vertex objects.
ScreenVertex
  
toString():String
Used to trace the values of a vertex.
ScreenVertex
  
weighted(a:ScreenVertex, b:ScreenVertex, aw:Number, bw:Number, focus:Number):ScreenVertex
[static] Returns a screen vertex with values given by a weighted mean calculation.
ScreenVertex
Property detail
clipXproperty
public var clipX:Number

The x position of the vertex in clip space

clipYproperty 
public var clipY:Number

The y position of the vertex in clip space

clipZproperty 
public var clipZ:Number

The z position of the vertex in clip space

numproperty 
public var num:Number

A number containing user defined properties.

viewTimerproperty 
public var viewTimer:int
visibleproperty 
public var visible:Boolean

Indicates whether the vertex is visible after projection.

vxproperty 
public var vx:Number

The view x position of the vertex in the view.

vyproperty 
public var vy:Number

The view y position of the vertex in the view.

xproperty 
public var x:Number

The screen x position of the vertex in the view.

yproperty 
public var y:Number

The screen y position of the vertex in the view.

zproperty 
public var z:Number

The screen z position of the vertex in the view.

Constructor detail
ScreenVertex()constructor
public function ScreenVertex(x:Number = 0, y:Number = 0, z:Number = 0)Parameters
x:Number (default = 0) — [optional] The x position of the vertex in the view. Defaults to 0.
 
y:Number (default = 0) — [optional] The y position of the vertex in the view. Defaults to 0.
 
z:Number (default = 0) — [optional] The z position of the vertex in the view. Defaults to 0.
Init Parameters
Method detail
deperspective()method
public function deperspective(focus:Number):Vertex

Converts a screen vertex back to a vertex object.

Parameters
focus:Number — The focus value to use for deperspective calulations.

Returns
Vertex — The deperspectived vertex object.
distance()method 
public function distance(b:ScreenVertex):Number

Calculates the distance between two screen vertex objects.

Parameters
b:ScreenVertex — The second screen vertex object to use for the calcation.

Returns
Number — The scalar value of the vector between this and the given screen vertex.
distanceSqr()method 
public function distanceSqr(b:ScreenVertex):Number

Calculates the squared distance between two screen vertex objects.

Parameters
b:ScreenVertex — The screen vertex object to use for the calcation.

Returns
Number — The squared scalar value of the vector between this and the given scren vertex.
distortSqr()method 
public function distortSqr(b:ScreenVertex, focus:Number):Number

Calculates affine distortion present at the midpoint between two screen vertex objects.

Parameters
b:ScreenVertex — The second screen vertex object to use for the calcation.
 
focus:Number — The focus value used for the distortion calulations.

Returns
Number — The scalar value of the vector between this and the given screen vertex.
median()method 
public static function median(a:ScreenVertex, b:ScreenVertex, focus:Number):ScreenVertex

Returns the median screen vertex between the two given screen vertex objects.

Parameters
a:ScreenVertex — The first screen vertex to use for the calculation.
 
b:ScreenVertex — The second screen vertex to use for the calculation.
 
focus:Number — The focus value used for the median calulations.

Returns
ScreenVertex — The resulting screen vertex.
toString()method 
public function toString():String

Used to trace the values of a vertex.

Returns
String — A string representation of the vertex object.
weighted()method 
public static function weighted(a:ScreenVertex, b:ScreenVertex, aw:Number, bw:Number, focus:Number):ScreenVertex

Returns a screen vertex with values given by a weighted mean calculation.

Parameters
a:ScreenVertex — The first screen vertex to use for the calculation.
 
b:ScreenVertex — The second screen vertex to use for the calculation.
 
aw:Number — The first screen vertex weighting.
 
bw:Number — The second screen vertex weighting.
 
focus:Number — The focus value used for the weighting calulations.

Returns
ScreenVertex — The resulting screen vertex.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.ScreenVertex'

Code examples

Comments