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
[read-only] Returns an array of all elements contained in the geometry object.
Geometry
  faces : Vector
[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
[read-only] 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
[read-only] Returns an array of the segments contained in the geometry object.
Geometry
  sprites : Vector
[read-only] Returns an array of the 3d sprites contained in the geometry object.
Geometry
  useWeightedVertexNormals : Boolean
Geometry
  vertices : Vector
Returns an array of all vertices contained in the geometry object
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
  
addOnDimensionsUpdate(listener:Function):void
Default method for adding a dimensionsChanged event listener
Geometry
  
addOnGeometryChange(listener:Function):void
Default method for adding a geometryChanged event listener
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
  
invertFaces():void
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
  
quarterFaces():void
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
  
removeOnDimensionsUpdate(listener:Function):void
Default method for removing a dimensionsChanged event listener
Geometry
  
removeOnGeometryChange(listener:Function):void
Default method for removing a geometryChanged event listener
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
  
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
 EventSummaryDefined 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  [read-only]

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

Implementation
    public function get elements():Vector
facesproperty 
faces:Vector  [read-only]

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

Implementation
    public function get faces():Vector
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 
materialDictionary:Dictionary  [read-only]

An dictionary containing all the materials included in the geometry.

Implementation
    public function get materialDictionary():Dictionary
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  [read-only]

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

Implementation
    public function get segments():Vector
spritesproperty 
sprites:Vector  [read-only]

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

Implementation
    public function get sprites():Vector
useWeightedVertexNormalsproperty 
public var useWeightedVertexNormals:Boolean
verticesproperty 
vertices:Vector  [read-write]

Returns an array of all vertices contained in the geometry object

Implementation
    public function get vertices():Vector
    public function set vertices(value:Vector):void
Constructor detail
Geometry()constructor
public function Geometry() Init Parameters
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.
addOnDimensionsUpdate()method 
public function addOnDimensionsUpdate(listener:Function):void

Default method for adding a dimensionsChanged event listener

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

Default method for adding a geometryChanged event listener

Parameters
listener:Function — The listener function
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.
removeOnDimensionsUpdate()method 
public function removeOnDimensionsUpdate(listener:Function):void

Default method for removing a dimensionsChanged event listener

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

Default method for removing a geometryChanged event listener

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

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 — v The vertex object to update
 
x:Number — x The new x value for the vertex
 
y:Number — y The new y value for the vertex
 
z:Number — z The new z value for the vertex
 
refreshNormals:Boolean (default = false) — refreshNormals [optional] Defines whether normals should be recalculated
Event detail
cycleevent 
Event object type: away3d.events.AnimationEvent

Dispatched when a single animation in a sequence completes.

dimensionsChangedevent  
Event object type: away3d.events.GeometryEvent

Dispatched when the bounding dimensions of the geometry object change.

sequenceDoneevent  
Event object type: away3d.events.AnimationEvent

Dispatched when a sequence of animations completes.

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

Code examples

Comments