Packageaway3d.core.base
Classpublic class Geometry
InheritanceGeometry Inheritance flash.events.EventDispatcher

3d object containing face and segment elements



Public Properties
 PropertyDefined By
  cloneElementDictionary : Dictionary
An dictionary containing associations between cloned elements.
Geometry
  elements : Vector.<Element>
[read-only] Returns an array of all elements contained in the geometry object.
Geometry
  faces : Vector.<Face>
[read-only] Returns an array of the faces contained in the geometry object.
Geometry
  graphics : Graphics3D
A graphics element in charge of managing the distribution of vector drawing commands into faces.
Geometry
  materialDictionary : Dictionary
An dictionary containing all the materials included in the geometry.
Geometry
  quarterFacesTotal : int
[read-only] Returns the total number of times the geometry has been quartered.
Geometry
  rootBone : Bone
Reference to the root heirarchy of bone controllers for a skin.
Geometry
  segments : Vector.<Segment>
[read-only] Returns an array of the segments contained in the geometry object.
Geometry
  skinControllers : Array
Array of controller objects used to bind vertices with joints in a skin.
Geometry
  skinVertices : Array
Array of vertices used in a skin.
Geometry
  sprites : Vector.<Sprite3D>
[read-only] Returns an array of the 3d sprites contained in the geometry object.
Geometry
  vertices : Vector.<Vertex>
Returns an array of all vertices contained in the geometry object
Geometry
  verts : Vector.<Number>
[read-only]
Geometry
Protected Properties
 PropertyDefined By
  ini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
Geometry
Public Methods
 MethodDefined By
  
Creates a new Geometry object.
Geometry
  
addFace(face:Face):void
Adds a face element to the geometry object.
Geometry
  
addOnGeometryUpdate(listener:Function):void
Default method for adding a geometryUpdated event listener
Geometry
  
addOnMappingChange(listener:Function):void
Default method for adding a mappingChanged event listener
Geometry
  
addOnMaterialUpdate(listener:Function):void
Default method for adding a materialUpdated event listener
Geometry
  
addSegment(segment:Segment):void
Adds a segment element to the geometry object.
Geometry
  
addSprite(sprite3d:Sprite3D):void
Adds a 3d sprite element to the geometry object.
Geometry
  
Duplicates the geometry properties to another geometry object.
Geometry
  
Inverts the geometry of all face objects.
Geometry
  
quarterFace(face:Face, medians:Dictionary = null):void
Divides a face object into 4 equal sized face objects.
Geometry
  
Divides all faces objects of a Mesh into 4 equal sized face objects.
Geometry
  
removeFace(face:Face):void
Removes a face element from the geometry object.
Geometry
  
removeOnGeometryUpdate(listener:Function):void
Default method for removing a geometryUpdated event listener
Geometry
  
removeOnMappingChange(listener:Function):void
Default method for removing a mappingChanged event listener
Geometry
  
removeOnMaterialUpdate(listener:Function):void
Default method for removing a materialUpdated event listener
Geometry
  
removeSegment(segment:Segment):void
Removes a segment element from the geometry object.
Geometry
  
removeSprite(sprite3d:Sprite3D):void
Removes a 3d sprite element from the geometry object.
Geometry
  
splitFace(face:Face, side:int = 0):void
Divides a face object into 2 face objects.
Geometry
  
splitFaces(side:int = 0):void
Divides all faces objects of a Mesh into 2 face objects.
Geometry
  
triFace(face:Face):void
Divides a face object into 3 face objects.
Geometry
  
triFaces():void
Divides all faces objects of a Mesh into 3 face objects.
Geometry
  
Updates the elements in the geometry object
Geometry
  
updateMaterials(source:Object3D, view:View3D):void
Updates the materials in the geometry object
Geometry
  
updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void
update vertex information.
Geometry
Events
 Event Summary Defined By
  Dispatched when a single animation in a sequence completes.Geometry
  Dispatched when the bounding dimensions of the geometry object change.Geometry
  Dispatched when a sequence of animations completes.Geometry
Property Detail
cloneElementDictionaryproperty
public var cloneElementDictionary:Dictionary

An dictionary containing associations between cloned elements.

elementsproperty 
elements:Vector.<Element>  [read-only]

Returns an array of all elements contained in the geometry object.


Implementation
    public function get elements():Vector.<Element>
facesproperty 
faces:Vector.<Face>  [read-only]

Returns an array of the faces contained in the geometry object.


Implementation
    public function get faces():Vector.<Face>
graphicsproperty 
public var graphics:Graphics3D

A graphics element in charge of managing the distribution of vector drawing commands into faces.

iniproperty 
protected var ini:Init

Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.

materialDictionaryproperty 
public var materialDictionary:Dictionary

An dictionary containing all the materials included in the geometry.

quarterFacesTotalproperty 
quarterFacesTotal:int  [read-only]

Returns the total number of times the geometry has been quartered.


Implementation
    public function get quarterFacesTotal():int
rootBoneproperty 
public var rootBone:Bone

Reference to the root heirarchy of bone controllers for a skin.

segmentsproperty 
segments:Vector.<Segment>  [read-only]

Returns an array of the segments contained in the geometry object.


Implementation
    public function get segments():Vector.<Segment>
skinControllersproperty 
public var skinControllers:Array

Array of controller objects used to bind vertices with joints in a skin.

skinVerticesproperty 
public var skinVertices:Array

Array of vertices used in a skin.

spritesproperty 
sprites:Vector.<Sprite3D>  [read-only]

Returns an array of the 3d sprites contained in the geometry object.


Implementation
    public function get sprites():Vector.<Sprite3D>
verticesproperty 
vertices:Vector.<Vertex>

Returns an array of all vertices contained in the geometry object


Implementation
    public function get vertices():Vector.<Vertex>
    public function set vertices(value:Vector.<Vertex>):void
vertsproperty 
verts:Vector.<Number>  [read-only]


Implementation
    public function get verts():Vector.<Number>
Constructor Detail
Geometry()Constructor
public function Geometry()

Creates a new Geometry object.

####INIT####
Method Detail
addFace()method
public function addFace(face:Face):void

Adds a face element to the geometry object.

Parameters

face:Face — The face element to be added.

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

Default method for adding a geometryUpdated event listener

Parameters

listener:Function — The listener function

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

Default method for adding a mappingChanged event listener

Parameters

listener:Function — The listener function

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

Default method for adding a materialUpdated event listener

Parameters

listener:Function — The listener function

addSegment()method 
public function addSegment(segment:Segment):void

Adds a segment element to the geometry object.

Parameters

segment:Segment — The segment element to be added.

addSprite()method 
public function addSprite(sprite3d:Sprite3D):void

Adds a 3d sprite element to the geometry object.

Parameters

sprite3d:Sprite3D — The 3d sprite element to be added.

clone()method 
public function clone():Geometry

Duplicates the geometry properties to another geometry object.

Returns
Geometry — The new geometry instance with duplicated properties applied.
invertFaces()method 
public function invertFaces():void

Inverts the geometry of all face objects.

See also

away3d.code.base.Face.invert()
quarterFace()method 
public function quarterFace(face:Face, medians:Dictionary = null):void

Divides a face object into 4 equal sized face objects.

Parameters

face:Face — The face to split in 4 equal faces.
 
medians:Dictionary (default = null)

quarterFaces()method 
public function quarterFaces():void

Divides all faces objects of a Mesh into 4 equal sized face objects. Used to segment a geometry in order to reduce affine persepective distortion.

See also

away3d.primitives.SkyBox
removeFace()method 
public function removeFace(face:Face):void

Removes a face element from the geometry object.

Parameters

face:Face — The face element to be removed.

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

Default method for removing a geometryUpdated event listener

Parameters

listener:Function — The listener function

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

Default method for removing a mappingChanged event listener

Parameters

listener:Function — The listener function

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

Default method for removing a materialUpdated event listener

Parameters

listener:Function — The listener function

removeSegment()method 
public function removeSegment(segment:Segment):void

Removes a segment element from the geometry object.

Parameters

segment:Segment — The segment element to be removed.

removeSprite()method 
public function removeSprite(sprite3d:Sprite3D):void

Removes a 3d sprite element from the geometry object.

Parameters

sprite3d:Sprite3D — The 3d sprite element to be removed.

splitFace()method 
public function splitFace(face:Face, side:int = 0):void

Divides a face object into 2 face objects.

Parameters

face:Face — The face to split in 2 faces.
 
side:int (default = 0) — The side of the face to split in two. 0 , 1 or 2. (clockwize).

splitFaces()method 
public function splitFaces(side:int = 0):void

Divides all faces objects of a Mesh into 2 face objects.

Parameters

side:int (default = 0) — The side of the faces to split in two. 0 , 1 or 2. (clockwize).

triFace()method 
public function triFace(face:Face):void

Divides a face object into 3 face objects.

Parameters

face:Face — The face to split in 3 faces.

triFaces()method 
public function triFaces():void

Divides all faces objects of a Mesh into 3 face objects.

updateGeometry()method 
public function updateGeometry():void

Updates the elements in the geometry object

See also

away3d.core.traverse.TickTraverser
away3d.core.basr.Animation.update()
updateMaterials()method 
public function updateMaterials(source:Object3D, view:View3D):void

Updates the materials in the geometry object

Parameters

source:Object3D
 
view:View3D

updateVertex()method 
public function updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void

update vertex information.

Parameters

v:Vertex — The vertex object to update
 
x:Number — The new x value for the vertex
 
y:Number — The new y value for the vertex
 
z:Number — The new z value for the vertex
 
refreshNormals:Boolean (default = false) — [optional] Defines whether normals should be recalculated

Event Detail
cycle Event
Event Object Type: away3d.events.AnimationEvent
AnimationEvent.type property = away3d.events.AnimationEvent

Dispatched when a single animation in a sequence completes.

dimensionsChanged Event  
Event Object Type: away3d.events.GeometryEvent
GeometryEvent.type property = away3d.events.GeometryEvent

Dispatched when the bounding dimensions of the geometry object change.

sequenceDone Event  
Event Object Type: away3d.events.AnimationEvent
AnimationEvent.type property = away3d.events.AnimationEvent

Dispatched when a sequence of animations completes.