Package | away3d.core.base |
Class | public class Mesh |
Inheritance | Mesh ![]() ![]() ![]() |
Implements | IPrimitiveProvider |
Subclasses | AbstractPrimitive, Animator, Lathe, SeaTurtle, SegmentsExtrude, SkinExtrude, Skybox, Skybox6, Triangle |
Property | Defined by | ||
---|---|---|---|
![]() | alpha : 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 | ||
![]() | blendMode : 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 | ||
![]() | boundingRadius : 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 | ||
![]() | extra : 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 | ||
![]() | filters : Array
An optional array of filters that can be applied to the 3d object.
| Object3D | |
![]() | fps : int
Determines the frames per second at which the animation will run.
| BaseMesh | |
![]() | frame : int
Indicates the current frame of animation
| BaseMesh | |
![]() | framenames : Dictionary
A dictionary containing all frame names of the mesh
| BaseMesh | |
![]() | frames : Dictionary
A dictionary containing all frames of the mesh
| BaseMesh | |
![]() | hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
| BaseMesh | |
![]() | hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
| BaseMesh | |
indexes : Array | Mesh | ||
![]() | inverseSceneTransform : Matrix3D | Object3D | |
![]() | isRunning : Boolean
Indicates whether the animation is currently running.
| BaseMesh | |
![]() | loop : Boolean
Determines whether the animation will loop.
| BaseMesh | |
material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
| Mesh | ||
![]() | maxX : Number
Returns the maximum x value of the 3d object
| BaseMesh | |
![]() | maxY : Number
Returns the maximum y value of the 3d object
| BaseMesh | |
![]() | maxZ : Number
Returns the maximum z value of the 3d object
| BaseMesh | |
![]() | minX : Number
Returns the minimum x value of the 3d object
| BaseMesh | |
![]() | minY : Number
Returns the minimum y value of the 3d object
| BaseMesh | |
![]() | minZ : Number
Returns the minimum z value of the 3d object
| BaseMesh | |
![]() | mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
| Object3D | |
![]() | name : 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 | ||
![]() | ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
| Object3D | |
![]() | ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
| Object3D | |
![]() | parent : ObjectContainer3D
Defines the parent of the 3d object.
| Object3D | |
![]() | position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | projection : Projection | Object3D | |
![]() | pushback : Boolean
Elements use their furthest point from the camera when z-sorting
| BaseMesh | |
![]() | pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
| BaseMesh | |
![]() | rotationX : 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 | |
![]() | rotationY : 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 | |
![]() | rotationZ : 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 | |
![]() | scene : Scene3D
Returns the parent scene of the 3d object
| Object3D | |
![]() | scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the
Scene3D . | Object3D | |
![]() | sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the
Scene3D . | Object3D | |
![]() | sceneTransformed : Boolean | Object3D | |
![]() | session : AbstractRenderSession
The render session used by the 3d object
| Object3D | |
![]() | smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
| BaseMesh | |
![]() | transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | type : String
String defining the type of class used to generate the mesh.
| BaseMesh | |
![]() | url : String
String defining the source of the mesh.
| BaseMesh | |
![]() | useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
| Object3D | |
![]() | vertices : Array
Returns an array of the vertices contained in the mesh object
| BaseMesh | |
![]() | viewTransform : Matrix3D | Object3D | |
![]() | visible : Boolean = true
Defines whether the 3d object is visible in the scene
| Object3D | |
![]() | x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() | z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent
ObjectContainer3D . | Object3D |
Method | Defined by | ||
---|---|---|---|
Mesh
(init:Object = null)
Creates a new
BaseMesh object. | Mesh | ||
Adds a face object to the mesh object.
| Mesh | ||
![]() |
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
| BaseMesh | |
![]() |
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
| Object3D | |
![]() |
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
| Object3D | |
![]() |
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
| Object3D | |
![]() |
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
| Object3D | |
![]() |
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
| Object3D | |
![]() |
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
| Object3D | |
![]() |
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
| Object3D | |
![]() |
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
| Object3D | |
![]() |
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
| Object3D | |
![]() |
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
| BaseMesh | |
![]() |
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 | ||
![]() |
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | |
![]() |
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
| BaseMesh | |
![]() |
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 | ||
![]() |
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent
ObjectContainer3D . | Object3D | |
![]() |
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
| Object3D | |
![]() |
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
| Object3D | |
![]() |
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
| Object3D | |
![]() |
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 | ||
![]() |
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | |
![]() |
Moves the 3d object directly to a point in space
| Object3D | |
![]() |
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
| Object3D | |
![]() |
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | |
![]() |
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 | ||
Removes a face object from the mesh object.
| Mesh | ||
![]() |
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
| BaseMesh | |
![]() |
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
| Object3D | |
![]() |
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
| Object3D | |
![]() |
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
| Object3D | |
![]() |
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
| Object3D | |
![]() |
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
| Object3D | |
![]() |
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
| Object3D | |
![]() |
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
| Object3D | |
![]() |
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
| Object3D | |
![]() |
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
| Object3D | |
![]() |
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
| BaseMesh | |
![]() |
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
| Object3D | |
![]() |
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
![]() |
Rotates the 3d object around an axis by a defined angle
| Object3D | |
![]() |
scale(scale:Number):void
Scales the contents of the mesh.
| BaseMesh | |
![]() |
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
| BaseMesh | |
![]() |
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
| BaseMesh | |
![]() |
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
| BaseMesh | |
![]() |
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
| BaseMesh | |
![]() |
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
| BaseMesh | |
![]() |
tick(time:int):void
Called by the
TickTraverser . | BaseMesh | |
![]() |
toString():String
Used to trace the values of a 3d object.
| Object3D | |
![]() |
Moves the 3d object along a vector by a defined length
| Object3D | |
![]() |
Used when traversing the scenegraph
| Object3D | |
![]() |
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D |
back | property |
public var back:ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
bothsides | property |
public var bothsides:Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
debugbb | property |
public var debugbb:Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
elements | property |
elements:Array
[read-only]Returns an array of the elements contained in the mesh object.
Implementation public function get elements():Array
faces | property |
faces:Array
[read-only]Returns an array of the faces contained in the mesh object.
Implementation public function get faces():Array
indexes | property |
public var indexes:Array
material | property |
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
outline | property |
public var outline:ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
Mesh | () | constructor |
public function Mesh(init:Object = null)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties.
|
addFace | () | method |
public function addFace(face:Face):void
Adds a face object to the mesh object.
Parametersface: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.
Parametersclassname: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.
|
String — A string to be pasted into a new .as file
|
asXML | () | method |
public function asXML():XML
Returns an xml representation of the mesh
ReturnsXML — An xml object containing mesh information
|
clone | () | method |
public override function clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
Parametersobject:* (default = null ) — [optional] The new object instance into which all properties are copied. The default is Mesh .
|
* — The new object instance with duplicated properties applied.
|
invertFaces | () | method |
public function invertFaces():void
Inverts the geometry of all face objects.
See also
movePivot | () | method |
public function movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
Parametersdx: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
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
removeFace | () | method |
public function removeFace(face:Face):void
Removes a face object from the mesh object.
Parametersface:Face — The face object to be removed.
|