Packageaway3d.core.base
Classpublic class Face
InheritanceFace Inheritance Element Inheritance flash.events.EventDispatcher

A triangle element used in the mesh object

See also

away3d.core.base.Mesh
Public Properties
 PropertyDefined by
  area : Number
[read-only] Returns the calculated 2 dimensional area of the face.
Face
  back : Material
Defines the optional back material of the face.
Face
  bitmapRect : Rectangle
Face
 Inheritedcommands : Array
Returns an array of drawing command strings that make up the 3d element.
Element
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties.
Element
  faceVO : FaceVO
Face
  isBack : Boolean
Face
  material : Material
Defines the material of the face.
Face
  maxX : Number
[read-only] Returns the maximum x value of the face
Face
  maxY : Number
[read-only] Returns the maximum y value of the face
Face
  maxZ : Number
[read-only] Returns the maximum zx value of the face
Face
  minX : Number
[read-only] Returns the minimum x value of the face
Face
  minY : Number
[read-only] Returns the minimum y value of the face
Face
  minZ : Number
[read-only] Returns the minimum z value of the face
Face
  normal : Number3D
[read-only] Returns the normal vector of the face.
Face
  normalDirty : Boolean
[write-only] Forces the recalculation of the face normal
Face
 Inheritedparent : Geometry
Defines the parent 3d object of the segment.
Element
 InheritedpathCommands : Array
Returns an array of drawing command objects that are used by the face.
Element
  plane : Plane3D
[read-only] used in BSP
Face
  radius2 : Number
[read-only] Returns the squared bounding radius of the face.
Face
  uv0 : UV
Defines the uv0 coordinate of the face.
Face
  uv1 : UV
Defines the uv1 coordinate of the face.
Face
  uv2 : UV
Defines the uv2 coordinate of the face.
Face
  uvs : Array
[read-only] Returns an array of uv objects that are used by the face.
Face
  v0 : Vertex
Defines the v0 vertex of the face.
Face
  v1 : Vertex
Defines the v1 vertex of the face.
Face
  v2 : Vertex
Defines the v2 vertex of the face.
Face
 InheritedvertexDirty : Boolean
Element
 Inheritedvertices : Array
Returns an array of vertex objects that make up the 3d element.
Element
 Inheritedvisible : Boolean
Determines whether the 3d element is visible in the scene.
Element
Protected Properties
 PropertyDefined by
 Inherited_commands : Array
Element
 Inherited_index : int
Element
 Inherited_lastAddedVertex : Vertex
Element
 Inherited_pathCommands : Array
Element
 Inherited_vertices : Array
Element
Public Methods
 MethodDefined by
  
Face
(v0:Vertex = null, v1:Vertex = null, v2:Vertex = null, material:Material = null, uv0:UV = null, uv1:UV = null, uv2:UV = null)
Creates a new Face object.
Face
 Inherited
addOnMappingChange(listener:Function):void
Default method for adding a mappingchanged event listener
Element
 Inherited
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
Element
 Inherited
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
Element
 Inherited
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
Element
  
Produces a clone of the face.
Face
  
curveTo(cx:Number, cy:Number, cz:Number, ex:Number, ey:Number, ez:Number):void
Face
  
hasEdgeOnPlane(plane:Plane3D, epsilon:Number = 0.001):Boolean
Tests if an edge of the face lies on a given plane
Face
  
invert():void
Inverts the geometry of the face object by swapping the v1, v2 and uv1, uv2 points.
Face
  
lineTo(x:Number, y:Number, z:Number):void
Face
  
moveTo(x:Number, y:Number, z:Number):void
Face
 Inherited
offset(x:Number, y:Number, z:Number):void
Offsets the vertices of the face by given amounts in x, y and z.
Element
 Inherited
removeOnMappingChange(listener:Function):void
Default method for removing a mappingchanged event listener
Element
 Inherited
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
Element
 Inherited
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
Element
 Inherited
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
Element
  
scaleAboutCenter(scale:Number):void
Scales the face by a given factor about its unweighed center.
Face
Events
 EventSummaryDefined by
   Dispatched when the uv mapping of the face changes.Face
   Dispatched when the material of the face changes.Face
 Inherited Dispatched when the vertex of a 3d element changes.Element
 Inherited Dispatched when the vertex value of a 3d element changes.Element
 Inherited Dispatched when the visiblity of a 3d element changes.Element
Property detail
areaproperty
area:Number  [read-only]

Returns the calculated 2 dimensional area of the face.

Implementation
    public function get area():Number
backproperty 
back:Material  [read-write]

Defines the optional back material of the face. Displays when the face is pointing away from the camera.

Implementation
    public function get back():Material
    public function set back(value:Material):void
bitmapRectproperty 
public var bitmapRect:Rectangle
faceVOproperty 
public var faceVO:FaceVO
isBackproperty 
public var isBack:Boolean
materialproperty 
material:Material  [read-write]

Defines the material of the face.

Implementation
    public function get material():Material
    public function set material(value:Material):void
maxXproperty 
maxX:Number  [read-only]

Returns the maximum x value of the face

Implementation
    public function get maxX():Number

See also

maxYproperty 
maxY:Number  [read-only]

Returns the maximum y value of the face

Implementation
    public function get maxY():Number

See also

maxZproperty 
maxZ:Number  [read-only]

Returns the maximum zx value of the face

Implementation
    public function get maxZ():Number

See also

minXproperty 
minX:Number  [read-only]

Returns the minimum x value of the face

Implementation
    public function get minX():Number

See also

minYproperty 
minY:Number  [read-only]

Returns the minimum y value of the face

Implementation
    public function get minY():Number

See also

minZproperty 
minZ:Number  [read-only]

Returns the minimum z value of the face

Implementation
    public function get minZ():Number

See also

normalproperty 
normal:Number3D  [read-only]

Returns the normal vector of the face.

Implementation
    public function get normal():Number3D
normalDirtyproperty 
normalDirty:Boolean  [write-only]

Forces the recalculation of the face normal

Implementation
    public function set normalDirty(value:Boolean):void
_planeproperty 
arcane var _plane:Plane3D
planeproperty 
plane:Plane3D  [read-only]

used in BSP

Implementation
    public function get plane():Plane3D
radius2property 
radius2:Number  [read-only]

Returns the squared bounding radius of the face.

Implementation
    public function get radius2():Number
uv0property 
uv0:UV  [read-write]

Defines the uv0 coordinate of the face.

Implementation
    public function get uv0():UV
    public function set uv0(value:UV):void
uv1property 
uv1:UV  [read-write]

Defines the uv1 coordinate of the face.

Implementation
    public function get uv1():UV
    public function set uv1(value:UV):void
uv2property 
uv2:UV  [read-write]

Defines the uv2 coordinate of the face.

Implementation
    public function get uv2():UV
    public function set uv2(value:UV):void
uvsproperty 
uvs:Array  [read-only]

Returns an array of uv objects that are used by the face.

Implementation
    public function get uvs():Array
v0property 
v0:Vertex  [read-write]

Defines the v0 vertex of the face.

Implementation
    public function get v0():Vertex
    public function set v0(value:Vertex):void
v1property 
v1:Vertex  [read-write]

Defines the v1 vertex of the face.

Implementation
    public function get v1():Vertex
    public function set v1(value:Vertex):void
v2property 
v2:Vertex  [read-write]

Defines the v2 vertex of the face.

Implementation
    public function get v2():Vertex
    public function set v2(value:Vertex):void
Constructor detail
Face()constructor
public function Face(v0:Vertex = null, v1:Vertex = null, v2:Vertex = null, material:Material = null, uv0:UV = null, uv1:UV = null, uv2:UV = null)Parameters
v0:Vertex (default = null) — The first vertex object of the triangle
 
v1:Vertex (default = null) — The second vertex object of the triangle
 
v2:Vertex (default = null) — The third vertex object of the triangle
 
material:Material (default = null) — [optional] The material used by the triangle to render
 
uv0:UV (default = null) — [optional] The first uv object of the triangle
 
uv1:UV (default = null) — [optional] The second uv object of the triangle
 
uv2:UV (default = null) — [optional] The third uv object of the triangle
Init Parameters

See also

Method detail
clone()method
public function clone():Face

Produces a clone of the face. NOTE: Supports only irregular faces for now.

Returns
Face — [Face] The cloned face.
curveTo()method 
public function curveTo(cx:Number, cy:Number, cz:Number, ex:Number, ey:Number, ez:Number):void Parameters
cx:Number
 
cy:Number
 
cz:Number
 
ex:Number
 
ey:Number
 
ez:Number
hasEdgeOnPlane()method 
public function hasEdgeOnPlane(plane:Plane3D, epsilon:Number = 0.001):Boolean

Tests if an edge of the face lies on a given plane

Parameters
plane:Plane3D — The plane to test against
 
epsilon:Number (default = 0.001)

Returns
Boolean — Whether or not an edge of this Face lies on the plane
invert()method 
public function invert():void

Inverts the geometry of the face object by swapping the v1, v2 and uv1, uv2 points.

lineTo()method 
public function lineTo(x:Number, y:Number, z:Number):void Parameters
x:Number
 
y:Number
 
z:Number
moveTo()method 
public function moveTo(x:Number, y:Number, z:Number):void Parameters
x:Number
 
y:Number
 
z:Number
scaleAboutCenter()method 
public function scaleAboutCenter(scale:Number):void

Scales the face by a given factor about its unweighed center. NOTE: Supports only irregular faces for now.

Parameters
scale:Number — [Number] The amount factor to scale the face.
Event detail
mappingChangedevent 
Event object type: away3d.events.FaceEvent

Dispatched when the uv mapping of the face changes.

materialChangedevent  
Event object type: away3d.events.FaceEvent

Dispatched when the material of the face changes.

Wiki link
Click to go to the wiki page for 'away3d.core.base.Face'

Code examples

Comments