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

3d object containing face and segment elements

Public Properties
 PropertyDefined by
  activePrefix : String
[read-only] return the prefix of the active animation.
Geometry
  billboards : Array
[read-only] Returns an array of the billboards contained in the geometry object.
Geometry
  cloneElementDictionary : Dictionary
An dictionary containing associations between cloned elements.
Geometry
  elements : Array
[read-only] Returns an array of all elements contained in the geometry object.
Geometry
  faces : Array
[read-only] Returns an array of the faces contained in the geometry object.
Geometry
  fps : int
Determines the frames per second at which the animation will run.
Geometry
  frame : int
Indicates the current frame of animation
Geometry
  framenames : Dictionary
A dictionary containing all frame names of the geometry.
Geometry
  frames : Dictionary
A dictionary containing all frames of the geometry.
Geometry
  graphics : Graphics3D
A graphics element in charge of managing the distribution of vector drawing commands into faces.
Geometry
  hasCycleEvent : Boolean
[read-only] Indicates whether the animation has a cycle event listener
Geometry
  hasSequenceEvent : Boolean
[read-only] Indicates whether the animation has a sequencedone event listener
Geometry
  isRunning : Boolean
[read-only] Indicates whether the animation is currently running.
Geometry
  loop : Boolean
Determines whether the animation will loop.
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 : Array
[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
  smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
Geometry
  transitionValue : Number
Determines how many frames a transition between the actual and the next animationSequence should interpolate together.
Geometry
  vertices : Array
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
  
addBillboard(billboard:Billboard):void
Adds a billboard object to the geometry object.
Geometry
  
addFace(face:Face):void
Adds a face object to the geometry object.
Geometry
  
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
Geometry
  
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionsChanged 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
  
addOnSequenceDone(listener:Function):void
Default method for adding a sequenceDone event listener
Geometry
  
addSegment(segment:Segment):void
Adds a segment object to the geometry object.
Geometry
  
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position values to vertex coordinates.
Geometry
  
applyRotations(rotationX:Number, rotationY:Number, rotationZ:Number):void
Apply the given rotation values to vertex coordinates.
Geometry
  
Duplicates the geometry properties to another geometry object.
Geometry
  
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
Geometry
  
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
Geometry
  
invertFaces():void
Inverts the geometry of all face objects.
Geometry
  
play(sequence:AnimationSequence):void
Plays a sequence of frames
Geometry
  
playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void
Plays a sequence of frames Note that the framenames must be be already existing in the system before you can use this handler
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
  
removeBillboard(billboard:Billboard):void
Removes a segment object to the geometry object.
Geometry
  
removeFace(face:Face):void
Removes a face object from the geometry object.
Geometry
  
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
Geometry
  
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionsChanged 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
  
removeOnSequenceDone(listener:Function):void
Default method for removing a sequenceDone event listener
Geometry
  
removeSegment(segment:Segment):void
Removes a segment object to the geometry object.
Geometry
  
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
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
 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
activePrefixproperty
activePrefix:String  [read-only]

return the prefix of the active animation.

Implementation
    public function get activePrefix():String
billboardsproperty 
billboards:Array  [read-only]

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

Implementation
    public function get billboards():Array
cloneElementDictionaryproperty 
public var cloneElementDictionary:Dictionary

An dictionary containing associations between cloned elements.

elementsproperty 
elements:Array  [read-only]

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

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

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

Implementation
    public function get faces():Array
fpsproperty 
fps:int  [read-write]

Determines the frames per second at which the animation will run.

Implementation
    public function get fps():int
    public function set fps(value:int):void
frameproperty 
frame:int  [read-write]

Indicates the current frame of animation

Implementation
    public function get frame():int
    public function set frame(value:int):void
framenamesproperty 
public var framenames:Dictionary

A dictionary containing all frame names of the geometry.

framesproperty 
public var frames:Dictionary

A dictionary containing all frames of the geometry.

graphicsproperty 
public var graphics:Graphics3D

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

hasCycleEventproperty 
hasCycleEvent:Boolean  [read-only]

Indicates whether the animation has a cycle event listener

Implementation
    public function get hasCycleEvent():Boolean
hasSequenceEventproperty 
hasSequenceEvent:Boolean  [read-only]

Indicates whether the animation has a sequencedone event listener

Implementation
    public function get hasSequenceEvent():Boolean
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.

isRunningproperty 
isRunning:Boolean  [read-only]

Indicates whether the animation is currently running.

Implementation
    public function get isRunning():Boolean
loopproperty 
loop:Boolean  [read-write]

Determines whether the animation will loop.

Implementation
    public function get loop():Boolean
    public function set loop(value:Boolean):void
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:Array  [read-only]

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

Implementation
    public function get segments():Array
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.

smoothproperty 
smooth:Boolean  [read-write]

Determines whether the animation will smooth motion (interpolate) between frames.

Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
transitionValueproperty 
transitionValue:Number  [read-write]

Determines how many frames a transition between the actual and the next animationSequence should interpolate together. must be higher or equal to 1. Default = 10;

Implementation
    public function get transitionValue():Number
    public function set transitionValue(value:Number):void
verticesproperty 
vertices:Array  [read-write]

Returns an array of all vertices contained in the geometry object

Implementation
    public function get vertices():Array
    public function set vertices(value:Array):void
Constructor detail
Geometry()constructor
public function Geometry() Init Parameters
Method detail
addBillboard()method
public function addBillboard(billboard:Billboard):void

Adds a billboard object to the geometry object.

Parameters
billboard:Billboard — The segment object to be added.
addFace()method 
public function addFace(face:Face):void

Adds a face object to the geometry object.

Parameters
face:Face — The face object to be added.
addOnCycle()method 
public function addOnCycle(listener:Function):void

Default method for adding a cycle event listener

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

Default method for adding a dimensionsChanged 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
addOnSequenceDone()method 
public function addOnSequenceDone(listener:Function):void

Default method for adding a sequenceDone event listener

Parameters
listener:Function — The listener function
addSegment()method 
public function addSegment(segment:Segment):void

Adds a segment object to the geometry object.

Parameters
segment:Segment — The segment object to be added.
applyPosition()method 
public function applyPosition(dx:Number, dy:Number, dz:Number):void

Apply the given position values to vertex coordinates.

Parameters
dx:Number
 
dy:Number
 
dz:Number
applyRotations()method 
public function applyRotations(rotationX:Number, rotationY:Number, rotationZ:Number):void

Apply the given rotation values to vertex coordinates.

Parameters
rotationX:Number
 
rotationY:Number
 
rotationZ:Number
clone()method 
public function clone():Geometry

Duplicates the geometry properties to another geometry object.

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

Starts playing the animation at the specified frame.

Parameters
value:int — A number representing the frame number.
gotoAndStop()method 
public function gotoAndStop(value:int):void

Brings the animation to the specifed frame and stops it there.

Parameters
value:int — A number representing the frame number.
invertFaces()method 
public function invertFaces():void

Inverts the geometry of all face objects.

See also

away3d.code.base.Face.invert()
play()method 
public function play(sequence:AnimationSequence):void

Plays a sequence of frames

Parameters
sequence:AnimationSequence — The animationsequence to play
playFrames()method 
public function playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void

Plays a sequence of frames Note that the framenames must be be already existing in the system before you can use this handler

Parameters
prefixes:Array — Array. The list of framenames to be played
 
fps:uint — uint: frames per second
 
smooth:Boolean (default = true) — [optional] Boolean. if the animation must interpolate. Default = true.
 
loop:Boolean (default = false) — [optional] Boolean. if the animation must loop. Default = false.
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
removeBillboard()method 
public function removeBillboard(billboard:Billboard):void

Removes a segment object to the geometry object.

Parameters
billboard:Billboard — The segment object to be removed.
removeFace()method 
public function removeFace(face:Face):void

Removes a face object from the geometry object.

Parameters
face:Face — The face object to be removed.
removeOnCycle()method 
public function removeOnCycle(listener:Function):void

Default method for removing a cycle event listener

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

Default method for removing a dimensionsChanged 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
removeOnSequenceDone()method 
public function removeOnSequenceDone(listener:Function):void

Default method for removing a sequenceDone event listener

Parameters
listener:Function — The listener function
removeSegment()method 
public function removeSegment(segment:Segment):void

Removes a segment object to the geometry object.

Parameters
segment:Segment — The segment object to be removed.
setPlaySequences()method 
public function setPlaySequences(playlist:Array, loopLast:Boolean = false):void

Passes an array of animationsequence objects to be added to the animation.

Parameters
playlist:Array — An array of animationsequence objects.
 
loopLast:Boolean (default = false) — [optional] Determines whether the last sequence will loop. Defaults to false.
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.

updateElements()method 
public function updateElements():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 — 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