Packageaway3d.core.base
Classpublic class Mesh
InheritanceMesh Inheritance BaseMesh Inheritance Object3D Inheritance flash.events.EventDispatcher
ImplementsIPrimitiveProvider
SubclassesAbstractPrimitive, Animator, Lathe, SeaTurtle, SegmentsExtrude, SkinExtrude, Skybox, Skybox6, Triangle

3d object containing face and segment elements

Public Properties
 PropertyDefined by
 Inheritedalpha : Number
An optional alpha value that can be applied to the 3d object.
Object3D
  back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
Mesh
 InheritedblendMode : String
An optional blend mode that can be applied to the 3d object.
Object3D
  bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
Mesh
 InheritedboundingRadius : Number
Returns the bounding radius of the 3d object
BaseMesh
  debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
Mesh
  elements : Array
[read-only] Returns an array of the elements contained in the mesh object.
Mesh
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties
Object3D
  faces : Array
[read-only] Returns an array of the faces contained in the mesh object.
Mesh
 Inheritedfilters : Array
An optional array of filters that can be applied to the 3d object.
Object3D
 Inheritedfps : int
Determines the frames per second at which the animation will run.
BaseMesh
 Inheritedframe : int
Indicates the current frame of animation
BaseMesh
 Inheritedframenames : Dictionary
A dictionary containing all frame names of the mesh
BaseMesh
 Inheritedframes : Dictionary
A dictionary containing all frames of the mesh
BaseMesh
 InheritedhasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
BaseMesh
 InheritedhasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
BaseMesh
  indexes : Array
Mesh
 InheritedinverseSceneTransform : Matrix3D
Object3D
 InheritedisRunning : Boolean
Indicates whether the animation is currently running.
BaseMesh
 Inheritedloop : Boolean
Determines whether the animation will loop.
BaseMesh
  material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
Mesh
 InheritedmaxX : Number
Returns the maximum x value of the 3d object
BaseMesh
 InheritedmaxY : Number
Returns the maximum y value of the 3d object
BaseMesh
 InheritedmaxZ : Number
Returns the maximum z value of the 3d object
BaseMesh
 InheritedminX : Number
Returns the minimum x value of the 3d object
BaseMesh
 InheritedminY : Number
Returns the minimum y value of the 3d object
BaseMesh
 InheritedminZ : Number
Returns the minimum z value of the 3d object
BaseMesh
 InheritedmouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
Object3D
 Inheritedname : String
An optional name string for the 3d object.
Object3D
  outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
Mesh
 InheritedownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
Object3D
 InheritedownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
Object3D
 Inheritedparent : ObjectContainer3D
Defines the parent of the 3d object.
Object3D
 Inheritedposition : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedprojection : Projection
Object3D
 Inheritedpushback : Boolean
Elements use their furthest point from the camera when z-sorting
BaseMesh
 Inheritedpushfront : Boolean
Elements use their nearest point to the camera when z-sorting
BaseMesh
 InheritedrotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedscene : Scene3D
Returns the parent scene of the 3d object
Object3D
 InheritedscenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
Object3D
 InheritedsceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
Object3D
 InheritedsceneTransformed : Boolean
Object3D
 Inheritedsession : AbstractRenderSession
The render session used by the 3d object
Object3D
 Inheritedsmooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
BaseMesh
 Inheritedtransform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedtype : String
String defining the type of class used to generate the mesh.
BaseMesh
 Inheritedurl : String
String defining the source of the mesh.
BaseMesh
 InheriteduseHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
Object3D
 Inheritedvertices : Array
Returns an array of the vertices contained in the mesh object
BaseMesh
 InheritedviewTransform : Matrix3D
Object3D
 Inheritedvisible : Boolean = true
Defines whether the 3d object is visible in the scene
Object3D
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
Protected Properties
 PropertyDefined by
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
Object3D
Public Methods
 MethodDefined by
  
Mesh
(init:Object = null)
Creates a new BaseMesh object.
Mesh
  
addFace(face:Face):void
Adds a face object to the mesh object.
Mesh
 Inherited
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
BaseMesh
 Inherited
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
Object3D
 Inherited
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
Object3D
 Inherited
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
Object3D
 Inherited
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
Object3D
 Inherited
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
Object3D
 Inherited
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
Object3D
 Inherited
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
Object3D
 Inherited
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
Object3D
 Inherited
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
Object3D
 Inherited
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
BaseMesh
 Inherited
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
Object3D
  
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
Mesh
  
asXML():XML
Returns an xml representation of the mesh
Mesh
  
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
Mesh
 Inherited
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
Object3D
 Inherited
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
BaseMesh
 Inherited
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
BaseMesh
  
invertFaces():void
Inverts the geometry of all face objects.
Mesh
 Inherited
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inherited
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Object3D
  
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
Mesh
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
 Inherited
play(sequence:AnimationSequence):void
Plays a sequence of frames
BaseMesh
  
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
Mesh
  
quarterFaces():void
Divides a face object into 4 equal sized face objects.
Mesh
  
removeFace(face:Face):void
Removes a face object from the mesh object.
Mesh
 Inherited
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
BaseMesh
 Inherited
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
Object3D
 Inherited
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
Object3D
 Inherited
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
Object3D
 Inherited
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
Object3D
 Inherited
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
Object3D
 Inherited
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
Object3D
 Inherited
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
Object3D
 Inherited
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
Object3D
 Inherited
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
Object3D
 Inherited
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
BaseMesh
 Inherited
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
Object3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Object3D
 Inherited
scale(scale:Number):void
Scales the contents of the mesh.
BaseMesh
 Inherited
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
BaseMesh
 Inherited
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
BaseMesh
 Inherited
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
BaseMesh
 Inherited
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
BaseMesh
 Inherited
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
BaseMesh
 Inherited
tick(time:int):void
Called by the TickTraverser.
BaseMesh
 Inherited
toString():String
Used to trace the values of a 3d object.
Object3D
 Inherited
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
traverse(traverser:Traverser):void
Used when traversing the scenegraph
Object3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
 Inherited
addElement(element:IMeshElement):void
Adds an element to the mesh object.
BaseMesh
 Inherited
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
BaseMesh
 Inherited
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
BaseMesh
Events
 EventSummaryDefined by
 Inherited Dispatched when the animation object completes a single sequence cycle.BaseMesh
 Inherited Dispatched when the bounding dimensions of the 3d object changes.Object3D
 Inherited Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor while it is over the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor away from the 3d object.Object3D
 Inherited Dispatched when a user moves the cursor over the 3d object.Object3D
 Inherited Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.Object3D
 Inherited Dispatched when the bounding radius of the 3d object changes.Object3D
 Inherited Dispatched when the parent scene of the 3d object changes Object3D
 Inherited Dispatched when the scene transform matrix of the 3d object changes.Object3D
 Inherited Dispatched when the animation object completes all frame sequences.BaseMesh
 Inherited Dispatched when the local transform matrix of the 3d object changes.Object3D
Property detail
backproperty
public var back:ITriangleMaterial

Defines a triangle material to be used for the backface of all faces in the 3d object.

bothsidesproperty 
public var bothsides:Boolean

Indicates whether both the front and reverse sides of a face should be rendered.

debugbbproperty 
public var debugbb:Boolean

Indicates whether a debug bounding box should be rendered around the 3d object.

elementsproperty 
elements:Array  [read-only]

Returns an array of the elements contained in the mesh object.

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

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

Implementation
    public function get faces():Array
indexesproperty 
public var indexes:Array
materialproperty 
material:ITriangleMaterial  [read-write]

Defines the material used to render the faces in the mesh object. Individual material settings on faces will override this setting.

Implementation
    public function get material():ITriangleMaterial
    public function set material(value:ITriangleMaterial):void

See also

outlineproperty 
public var outline:ISegmentMaterial

Defines a segment material to be used for outlining the 3d object.

Constructor detail
Mesh()constructor
public function Mesh(init:Object = null)Parameters
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
####INIT####
Method detail
addFace()method
public function addFace(face:Face):void

Adds a face object to the mesh object.

Parameters
face:Face — The face object to be added.
asAS3Class()method 
public function asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String

Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.

Parameters
classname:String (default = null) — [optional] Defines the class name used in the output string. Defaults to Away3DObject.
 
packagename:String (default = "") — [optional] Defines the package name used in the output string. Defaults to no package.
 
round:Boolean (default = false) — [optional] Rounds all values to 4 decimal places. Defaults to false.
 
animated:Boolean (default = false) — [optional] Defines whether animation data should be saved. Defaults to false.

Returns
String — A string to be pasted into a new .as file
asXML()method 
public function asXML():XML

Returns an xml representation of the mesh

Returns
XML — An xml object containing mesh information
clone()method 
public override function clone(object:* = null):*

Duplicates the mesh properties to another 3d object.

Parameters
object:* (default = null) — [optional] The new object instance into which all properties are copied. The default is Mesh.

Returns
* — The new object 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()
movePivot()method 
public function movePivot(dx:Number, dy:Number, dz:Number):void

Moves the origin point of the mesh without moving the contents.

Parameters
dx:Number — The amount of movement along the local x axis.
 
dy:Number — The amount of movement along the local y axis.
 
dz:Number — The amount of movement along the local z axis.
primitives()method 
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer — The consumer instance
 
session:AbstractRenderSession — The render session of the 3d object

See also

quarterFaces()method 
public function quarterFaces():void

Divides a face object into 4 equal sized face objects. Used to segment a mesh in order to reduce affine persepective distortion.

See also

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

Removes a face object from the mesh object.

Parameters
face:Face — The face object to be removed.
Wiki link
Click to go to the wiki page for ####WIKI####

Code examples

Comments