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 : ITriangleMaterial
Defines the optional back material of the face.
Face
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties.
Element
  faceVO : FaceVO
Face
  material : ITriangleMaterial
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
  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
  vertices : Array
[read-only] Returns an array of vertex objects that are used by the face.
Face
 Inheritedvisible : Boolean
Determines whether the 3d element is visible in the scene.
Element
Public Methods
 MethodDefined by
  
Face
(v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial = null, uv0:UV = null, uv1:UV = null, uv2:UV = null)
Creates a new Face object.
Face
  
addOnMappingChange(listener:Function):void
Default method for adding a mappingchanged event listener
Face
 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
  
invert():void
Inverts the geometry of the face object by swapping the v1, v2 and uv1, uv2 points.
Face
  
removeOnMappingChange(listener:Function):void
Default method for removing a mappingchanged event listener
Face
 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
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:ITriangleMaterial  [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():ITriangleMaterial
    public function set back(value:ITriangleMaterial):void
faceVOproperty 
public var faceVO:FaceVO
materialproperty 
material:ITriangleMaterial  [read-write]

Defines the material of the face.

Implementation
    public function get material():ITriangleMaterial
    public function set material(value:ITriangleMaterial):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
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
verticesproperty 
vertices:Array  [read-only]

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

Implementation
    public function get vertices():Array
Constructor detail
Face()constructor
public function Face(v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial = null, uv0:UV = null, uv1:UV = null, uv2:UV = null)Parameters
v0:Vertex — The first vertex object of the triangle
 
v1:Vertex — The second vertex object of the triangle
 
v2:Vertex — The third vertex object of the triangle
 
material:ITriangleMaterial (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
addOnMappingChange()method
public function addOnMappingChange(listener:Function):void

Default method for adding a mappingchanged event listener

Parameters
listener:Function — The listener function
invert()method 
public function invert():void

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

removeOnMappingChange()method 
public function removeOnMappingChange(listener:Function):void

Default method for removing a mappingchanged event listener

Parameters
listener:Function — The listener function
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