Package | away3d.core.base |
Class | public class BaseMesh |
Inheritance | BaseMesh ![]() ![]() |
Subclasses | Mesh, WireMesh |
Mesh
or WireMesh
.
Property | Defined by | ||
---|---|---|---|
![]() | alpha : Number
An optional alpha value that can be applied to the 3d object.
| Object3D | |
![]() | blendMode : String
An optional blend mode that can be applied to the 3d object.
| Object3D | |
boundingRadius : Number [read-only]
Returns the bounding radius of the 3d object
| BaseMesh | ||
elements : Array [read-only]
Returns an array of the elements contained in the mesh object
| BaseMesh | ||
![]() | extra : Object
An optional untyped object that can contain used-defined properties
| Object3D | |
![]() | filters : Array
An optional array of filters that can be applied to the 3d object.
| Object3D | |
fps : int [write-only]
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 [read-only]
Indicates whether the animation has a cycle event listener
| BaseMesh | ||
hasSequenceEvent : Boolean [read-only]
Indicates whether the animation has a sequencedone event listener
| BaseMesh | ||
![]() | inverseSceneTransform : Matrix3D | Object3D | |
isRunning : Boolean [read-only]
Indicates whether the animation is currently running.
| BaseMesh | ||
loop : Boolean [write-only]
Determines whether the animation will loop.
| BaseMesh | ||
maxX : Number [read-only]
Returns the maximum x value of the 3d object
| BaseMesh | ||
maxY : Number [read-only]
Returns the maximum y value of the 3d object
| BaseMesh | ||
maxZ : Number [read-only]
Returns the maximum z value of the 3d object
| BaseMesh | ||
minX : Number [read-only]
Returns the minimum x value of the 3d object
| BaseMesh | ||
minY : Number [read-only]
Returns the minimum y value of the 3d object
| BaseMesh | ||
minZ : Number [read-only]
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 | |
![]() | 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 [write-only]
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 [read-only]
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 | ||
---|---|---|---|
BaseMesh
(init:Object = null)
Creates a new
BaseMesh object. | BaseMesh | ||
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 | |
![]() |
clone(object:* = null):*
Duplicates the 3d object's properties to another
Object3D object
| Object3D | |
![]() |
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 | ||
![]() |
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 | |
![]() |
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
| BaseMesh | ||
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 |
Method | Defined by | ||
---|---|---|---|
Adds an element to the mesh object.
| BaseMesh | ||
Removes an element to the mesh object.
| BaseMesh | ||
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
| BaseMesh |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the animation object completes a single sequence cycle. | BaseMesh | |||
![]() | Dispatched when the bounding dimensions of the 3d object changes. | Object3D | ||
![]() | Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. | Object3D | ||
![]() | Dispatched when a user moves the cursor while it is over the 3d object. | Object3D | ||
![]() | Dispatched when a user moves the cursor away from the 3d object. | Object3D | ||
![]() | Dispatched when a user moves the cursor over the 3d object. | Object3D | ||
![]() | Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. | Object3D | ||
![]() | Dispatched when the bounding radius of the 3d object changes. | Object3D | ||
![]() | Dispatched when the parent scene of the 3d object changes | Object3D | ||
![]() | Dispatched when the scene transform matrix of the 3d object changes. | Object3D | ||
Dispatched when the animation object completes all frame sequences. | BaseMesh | |||
![]() | Dispatched when the local transform matrix of the 3d object changes. | Object3D |
boundingRadius | property |
boundingRadius:Number
[read-only]Returns the bounding radius of the 3d object
Implementation public function get boundingRadius():Number
elements | property |
elements:Array
[read-only]Returns an array of the elements contained in the mesh object
Implementation public function get elements():Array
— Not implemented
|
fps | property |
fps:int
[write-only]Determines the frames per second at which the animation will run.
Implementation public function set fps(value:int):void
frame | property |
frame:int
[read-write]Indicates the current frame of animation
Implementation public function get frame():int
public function set frame(value:int):void
framenames | property |
public var framenames:Dictionary
A dictionary containing all frame names of the mesh
frames | property |
public var frames:Dictionary
A dictionary containing all frames of the mesh
hasCycleEvent | property |
hasCycleEvent:Boolean
[read-only]Indicates whether the animation has a cycle event listener
Implementation public function get hasCycleEvent():Boolean
hasSequenceEvent | property |
hasSequenceEvent:Boolean
[read-only]Indicates whether the animation has a sequencedone event listener
Implementation public function get hasSequenceEvent():Boolean
isRunning | property |
isRunning:Boolean
[read-only]Indicates whether the animation is currently running.
Implementation public function get isRunning():Boolean
loop | property |
loop:Boolean
[write-only]Determines whether the animation will loop.
Implementation public function set loop(value:Boolean):void
maxX | property |
maxX:Number
[read-only]Returns the maximum x value of the 3d object
Implementation public function get maxX():Number
maxY | property |
maxY:Number
[read-only]Returns the maximum y value of the 3d object
Implementation public function get maxY():Number
maxZ | property |
maxZ:Number
[read-only]Returns the maximum z value of the 3d object
Implementation public function get maxZ():Number
minX | property |
minX:Number
[read-only]Returns the minimum x value of the 3d object
Implementation public function get minX():Number
minY | property |
minY:Number
[read-only]Returns the minimum y value of the 3d object
Implementation public function get minY():Number
minZ | property |
minZ:Number
[read-only]Returns the minimum z value of the 3d object
Implementation public function get minZ():Number
pushback | property |
public var pushback:Boolean
Elements use their furthest point from the camera when z-sorting
pushfront | property |
public var pushfront:Boolean
Elements use their nearest point to the camera when z-sorting
smooth | property |
smooth:Boolean
[write-only]Determines whether the animation will smooth motion (interpolate) between frames.
Implementation public function set smooth(value:Boolean):void
type | property |
public var type:String
String defining the type of class used to generate the mesh. Used to display information in the stats panel
See also
url | property |
public var url:String
String defining the source of the mesh. If the mesh has been created internally, the string is used to display the package name of the creating object. Used to display information in the stats panel
See also
vertices | property |
vertices:Array
[read-only]Returns an array of the vertices contained in the mesh object
Implementation public function get vertices():Array
BaseMesh | () | constructor |
public function BaseMesh(init:Object = null)
Parameters
init:Object (default = null ) — [optional] An initialisation object for specifying default instance properties
|
addElement | () | method |
protected function addElement(element:IMeshElement):void
Adds an element to the mesh object.
Parameterselement:IMeshElement — The element to be added to the mesh.
|
addOnCycle | () | method |
public function addOnCycle(listener:Function):void
Default method for adding a cycle event listener
Parameterslistener:Function — The listener function
|
addOnSequenceDone | () | method |
public function addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
Parameterslistener:Function — The listener function
|
gotoAndPlay | () | method |
public function gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
Parametersvalue: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.
Parametersvalue:int — A number representing the frame number.
|
play | () | method |
public function play(sequence:AnimationSequence):void
Plays a sequence of frames
Parameterssequence:AnimationSequence — The animationsequence to play
|
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
removeElement | () | method |
protected function removeElement(element:IMeshElement):void
Removes an element to the mesh object.
Parameterselement:IMeshElement — The element to be removed from the mesh.
|
removeOnCycle | () | method |
public function removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
Parameterslistener:Function — The listener function
|
removeOnSequenceDone | () | method |
public function removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
Parameterslistener:Function — The listener function
|
scale | () | method |
public override function scale(scale:Number):void
Scales the contents of the mesh.
Parametersscale:Number — The scaling value
|
scaleAnimation | () | method |
public function scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
Parametersscale:Number — The scaling value
|
scaleX | () | method |
public function scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
ParametersscaleX:Number — The scaling value
|
scaleXYZ | () | method |
protected function scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
ParametersscaleX:Number — The scaling value along the x-axis
|
|
scaleY:Number — The scaling value along the y-axis
|
|
scaleZ:Number — The scaling value along the z-axis
|
scaleY | () | method |
public function scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
ParametersscaleY:Number — The scaling value
|
scaleZ | () | method |
public function scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
ParametersscaleZ:Number — The scaling value
|
setPlaySequences | () | method |
public function setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
Parametersplaylist:Array — An array of animationsequence objects.
|
|
loopLast:Boolean (default = false ) — [optional] Determines whether the last sequence will loop. Defaults to false.
|
tick | () | method |
public override function tick(time:int):void
Called by the TickTraverser
.
updates the animation object
time:int — The absolute time at the start of the render cycle
|
See also
cycle | event |
away3d.events.AnimationEvent
Dispatched when the animation object completes a single sequence cycle.
sequencedone | event |
away3d.events.AnimationEvent
Dispatched when the animation object completes all frame sequences.