Away3D API Reference: V2.1 ========================== away3d.animation Animator : away3d.blockers ConvexBlock : Convex hull blocking all drawing primitives underneath. away3d.cameras Camera3D : Basic camera used to resolve a view. HoverCamera3D : Extended camera used to hover round a specified target object. TargetCamera3D : Extended camera used to automatically look at a specified target object. away3d.containers ILODObject : Interface for objects that can toggle their visibily depending on view and distance to camera IPhysicsScene : DebugObjectContainer3D : Extension of LODObject : 3d object container that is drawn only if its scaling to perspective falls within a given range. ObjectContainer3D : 3d object container node for other 3d objects in a scene Scene3D : The root container of all 3d objects in a single scene View3D : Sprite container used for storing camera, scene, session, renderer and clip references, and resolving mouse events away3d.core.base IAnimation : Interface for objects that can animate the vertex values in a mesh IFrame : Interface for objects that store the vertex values for a single frame of animation IMeshElement : Interface for objects that define a 3d element of a mesh Animation : Holds information about the current state of a mesh animation. AnimationFrame : Holds information about a single animation frame. AnimationGroup : Holds information about a list of animation sequences. AnimationSequence : Holds information about a sequence of animation frames. BaseMesh : Abstract 3d object containing unspecified elements. BaseMeshElement : Basic 3d element object Not intended for direct use - use Face : A triangle element used in the mesh object Frame : Holds vertexposition information about a single animation frame. Mesh : 3d object containing face and segment elements Morpher : Keyframe animation morpher Object3D : Base class for all 3d objects. Segment : A line element used in the wiremesh and mesh object UV : Texture coordinates value object. Vertex : A vertex coordinate value object. VertexPosition : Vertex position value object. WireMesh : 3d object containing segment elements away3d.core.block IBlockerConsumer : Interface for containers capable of storing blockers. IBlockerProvider : Interface for objects that provide blocker instances for occlusion culling in the renderer. Blocker : Abstract primitive that can block other primitives from drawing BlockerArray : Array for storing blocker objects ConvexBlocker : Convex hull primitive that blocks all primitives behind and contained completely inside. away3d.core.clip Clipping : Base clipping class for no clipping. RectangleClipping : Rectangle clipping away3d.core.draw IPrimitiveConsumer : Interface for containers capable of drawing primitives IPrimitiveProvider : Interface for objects that provide drawing primitives to the rendering process DrawBitmap : Unscaled bitmap drawing primitive DrawDisplayObject : Displayobject container drawing primitive. DrawFog : Fog drawing primitive DrawGroup : Group drawing primitive. DrawPrimitive : Abstract class for all drawing primitives DrawScaledBitmap : Scaled bitmap primitive DrawSegment : Line segment drawing primitive DrawTriangle : Triangle drawing primitive Line2D : Line in 2D space Plane3D : Plane in 3D space PrimitiveArray : Array for storing drawing primitives. PrimitiveQuadrantTree : Quadrant tree for storing drawing primitives PrimitiveQuadrantTreeNode : Quadrant tree node PrimitiveVolumeBlock : Volume block tree for storing drawing primitives PrimitiveVolumeBlockNode : Volume block tree node ScreenVertex : representation of a 3d vertex resolved to the view. away3d.core.filter IPrimitiveFilter : Interface for filters that work on primitive arrays IPrimitiveQuadrantFilter : Interface for filters that work on primitive quadrant trees IPrimitiveVolumeBlockFilter : Interface for filters that work on primitive volume blocks AnotherRivalFilter : Corrects triangle z-sorting FogFilter : Adds fog layers to a view and provides automatic farfield filtering for primitives outside the furthest fog layers. QuadrantRiddleFilter : Splits all intersecting triangles and line segments. ZDepthFilter : Defines a maximum z value for rendering primitives ZSortFilter : Sorts drawing primitives by z coordinate. away3d.core.light ILightConsumer : Interface for containers capable of storing lighting info ILightProvider : Interface for objects that provide lighting to the scene AmbientLight : Ambient light primitive DirectionalLight : Directional light primitive. LightArray : Array for storing light primitives. LightPrimitive : Abstract light primitve. PointLight : Point light primitive away3d.core.math Matrix3D : A 3D transformation 4x3 matrix Number3D : A point in 3D space. Quaternion : A Quaternion object. away3d.core.render IRenderer : Interface for renderers capable of rendering a scene to a view AbstractRenderSession : Abstract Drawing session object containing the method used for drawing the view to screen. BasicRenderer : Default renderer for a view. BitmapRenderSession : Drawing session object that renders all drawing primitives into a FindHit : Finds the object that is rendered under a certain view coordinate. Projection : Data object for camera transform, focus and zoom properties. QuadrantRenderer : Renderer that uses quadrant tree for storing and operating drawing primitives. Renderer : A static class for an easy access to the most useful renderers. SpriteRenderSession : Drawing session object that renders all drawing primitives into a away3d.core.stats Stats : away3d.core.traverse BlockerTraverser : Traverser that gathers blocker primitives for occlusion culling. PrimitiveTraverser : Traverser that gathers drawing primitives to render the scene. ProjectionTraverser : Traverser that resolves the transform tree in a scene, ready for rendering. TickTraverser : Traverser that fires a time-based method for all objects in scene Traverser : Abstract class for all traverser that perform actions on the whole scene. away3d.core.utils IClonable : Interface for object that can be cloned CacheStore : Cast : Helper class for casting assets to usable objects CastError : Color : Static helper class for color manipulations Debug : Class for emmiting debuging messages, warnings and errors DofCache : Provides static pre-blurred bitmap images for depth of field-effect when used together with billboarded sprites, such as particles. FaceDictionaryVO : FaceVO : Init : Convinient object initialization support ValueObject : away3d.events AnimationEvent : Passed as a parameter when an animation event occurs FaceEvent : Passed as a parameter when a face event occurs LoaderEvent : Passed as a parameter when a 3d object loader event occurs MaterialEvent : Passed as a parameter when a material event occurs MeshElementEvent : Passed as a parameter when a meshelement event occurs MouseEvent3D : Passed as a parameter when a 3d mouse event occurs Object3DEvent : Passed as a parameter when a 3d object event occurs SegmentEvent : Passed as a parameter when a segment event occurs away3d.extrusions CollisionMap : Elevation : ElevationReader : Lathe : SegmentsExtrude : SkinExtrude : away3d.lights AmbientLight3D : Lightsource that colors all shaded materials evenly from any angle DirectionalLight3D : Lightsource that colors all shaded materials proportional to the dot product of the offset vector with the normal vector. PointLight3D : Lightsource that colors all shaded materials proportional to the dot product of the distance vector with the normal vector. away3d.loaders Ase : File loader for the ASE file format. Collada : File loader for the Collada file format. CubeLoader : Default loader class used as a placeholder for loading 3d content Kmz : File loader for the KMZ 4 file format (exported from Google Sketchup). Max3DS : File loader for the 3DS file format. Md2 : File loader for the Md2 file format. Md2still : File loader for the Md2 file format (non-animated version). Obj : File loader for the OBJ file format. Object3DLoader : Abstract loader class used as a placeholder for loading 3d content away3d.loaders.data ContainerData : Data class for 3d object containers. FaceData : Data class for a face object. MaterialData : Data class for the material data of a face. MeshData : Data class for the mesh data of a 3d object MeshMaterialData : Data class for teh material of a 3d object ObjectData : Data class for a gneric 3d object away3d.loaders.utils MaterialLibrary : Store for all materials associated with an externally loaded file. TextureLoader : Used to store the name and loader reference of an external texture image. TextureLoadQueue : Creates a queue of textures that load sequentially away3d.materials IFogMaterial : Interface for fog filter materials ILayerMaterial : Interface for materials that can be layered using IMaterial : Interface for all objects that can serve as a material ISegmentMaterial : Interface for materials that are capable of drawing line segments. ITriangleMaterial : Interface for materials that are capable of rendering triangle faces. IUpdatingMaterial : Interface for materials that require updating every render loop IUVMaterial : Interface for materials that use uv texture coordinates AnimatedBitmapMaterial : Bitmap material that allows fast rendering of animations by caching bitmapdata objects for each frame. BitmapFileMaterial : Bitmap material that loads it's texture from an external bitmapasset file. BitmapMaterial : Basic bitmap material BitmapMaterialContainer : Container for caching multiple bitmapmaterial objects. CenterLightingMaterial : Abstract class for materials that calculate lighting for the face's center Not intended for direct use - use ColorMaterial : Material for solid color drawing CompositeMaterial : Container for layering multiple material objects. Dot3BitmapMaterial : Bitmap material with DOT3 shading. Dot3BitmapMaterialCache : Bitmap material with cached DOT3 shading. Dot3MovieMaterial : Animated movie material with DOT3 shading. EnviroBitmapMaterial : Bitmap material with environment shading. EnviroBitmapMaterialCache : Bitmap material with cached environment shading. EnviroColorMaterial : Color material with environment shading. MovieMaterial : Animated movie material. PhongBitmapMaterial : Bitmap material with phong shading. PhongBitmapMaterialCache : Bitmap material with cached phong shading. PhongColorMaterial : Color material with phong shading. PhongColorMaterialCache : Color material with cached phong shading. PhongMovieMaterial : Animated movie material with phong shading. ShadingColorMaterial : Color material with flat shading. TransformBitmapMaterial : Basic bitmap texture material WhiteShadingBitmapMaterial : Bitmap material with flat white lighting WireColorMaterial : Wire material for solid color drawing with optional face border outlining WireframeMaterial : Wire material for face border outlining only away3d.materials.shaders AbstractShader : Base class for shaders. AmbientShader : Shader class for ambient lighting DiffuseDot3Shader : Diffuse Dot3 shader class for directional lighting. DiffusePhongShader : Diffuse shader class for directional lighting. EnviroShader : Shader class for environment lighting. SpecularPhongShader : Specular shader class for directional lighting. away3d.primitives AbstractPrimitive : Creates a 3d cone primitive. AbstractWirePrimitive : Creates a 3d cone primitive. Cone : Creates a 3d cone primitive. Cube : Creates a 3d cube primitive. Cylinder : Creates a 3d cylinder primitive. GeodesicSphere : Creates a 3d geodesic sphere primitive. GridPlane : Creates a 3d grid primitive. LineSegment : Creates a 3d line segment. LogoCube : Creates a 3d cube primitive with the Away3d logo. Plane : Creates a 3d plane primitive. RegularPolygon : Creates a regular polygon. SeaTurtle : Creates a sea turtle model (exported using asAS3Class). Skybox : QTVR-style 360 panorama renderer that is initialized with six images. Skybox6 : QTVR-style 360 panorama renderer that is initialized with one solid image. Sphere : Creates a 3d sphere primitive. Torus : Creates a 3d torus primitive. Triangle : Creates a 3d triangle. Trident : Creates an axis trident. WireCircle : Creates a 3d wire polygon. WireCone : Creates a 3d wire cone primitive. WireCube : Creates a 3d wire cube primitive. WireCylinder : Creates a 3d wire cylinder primitive. WirePlane : Creates a 3d wire plane primitive. WireSphere : Creates a 3d wire sphere primitive. WireTorus : Creates a 3d wire torus primitive. away3d.primitives.data CubeMaterialsData : Data structure for individual materials on the sides of a cube. away3d.sprites DirSprite2D : Spherical billboard (always facing the camera) sprite object that uses an array of bitmapData objects defined with viewing direction vectors. DofSprite2D : Spherical billboard (always facing the camera) sprite object that uses a cached array of bitmapData objects as it's texture. MovieClipSprite : Spherical billboard (always facing the camera) sprite object that uses a movieclip as it's texture. Sprite2D : Spherical billboard (always facing the camera) sprite object that uses a bitmapData object as it's texture. away3d.test BaseDemo : Base class for Away3D demos Button : Simple rounded rectangle button Panel : Simple rounded rectangle panel Slide : Represents a single slide of the demo AbstractPrimitive ================= Package : away3d.primitives Class : public class AbstractPrimitive Inheritance : Mesh, BaseMesh, Object3D Subclasses : Cone, Cube, Cylinder, GeodesicSphere, Plane, RegularPolygon, Sphere, Torus Description : PUBLIC PROPERTIES (^) 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 - 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 - 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 (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 (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePosition : Number3D (Object3D) sceneTransform : Matrix3D (AbstractPrimitive) (^) 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 (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 (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (AbstractPrimitive) (^) addFace(face:Face):void - 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) buildPrimitive():void - Builds the vertex, face and uv objects that make up the 3d primitive. (AbstractPrimitive) (^) clone(object:* = null):* - Duplicates the mesh properties to another 3d object. (Mesh) (^) distanceTo(obj:Object3D):Number - 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) (^) lookAt(target:Number3D, upAxis:Number3D = null):void (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) (^) moveTo(target:Number3D):void - 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) (^) play(sequence:AnimationSequence):void - Plays a sequence of frames (BaseMesh) (^) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (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) (^) 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) (^) rotate(axis:Number3D, angle:Number):void - 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 (BaseMesh) (^) toString():String - Used to trace the values of a 3d object. (Object3D) (^) translate(axis:Number3D, distance:Number):void - Moves the 3d object along a vector by a defined length (Object3D) (^) traverse(traverser:Traverser):void - Used when traversing the scenegraph (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) addElement(element:IMeshElement):void - Adds an element to the mesh object. (BaseMesh) (^) removeElement(element:IMeshElement):void - 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) EVENTS (^) (BaseMesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (BaseMesh) (^) (Object3D) PROPERTY DETAIL sceneTransform:Matrix3D[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D. Implementation public function get sceneTransform():Matrix3D CONSTRUCTOR DETAIL public function AbstractPrimitive(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties METHOD DETAIL public function buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive. CODE EXAMPLES There are currently no examples for this class AbstractRenderSession ===================== Package : away3d.core.render Class : public class AbstractRenderSession Subclasses : BitmapRenderSession, SpriteRenderSession Description : PUBLIC PROPERTIES children : Dictionary - Dictionary of child displayobjects. (AbstractRenderSession) graphics : Graphics - Reference to the current graphics object being used for drawing. (AbstractRenderSession) lightarray : LightArray - Defines the light provider object for the render sesion. (AbstractRenderSession) newLayer : Sprite - Holds the last added layer sprite. (AbstractRenderSession) sessions : Dictionary - Dictionary of child sessions. (AbstractRenderSession) spriteLayers : Array - Dictionary of sprite layers for rendering composite materials. (AbstractRenderSession) view : View3D - Defines the view object used for the render session. (AbstractRenderSession) PUBLIC METHODS addDisplayObject(child:DisplayObject):void - Adds a display object to the render session display list. (AbstractRenderSession) addLayerObject(child:Sprite):void - Adds a layer sprite to the render session display list. (AbstractRenderSession) clear():void - Clears the render session. (AbstractRenderSession) clone():AbstractRenderSession - Duplicates the render session's properties to another render session. (AbstractRenderSession) flush():void - Flushes any cached drawing operations to screen. (AbstractRenderSession) getContainer(view:View3D):DisplayObject - Returns a display object representing the container for the specified view. (AbstractRenderSession) registerChildSession(session:AbstractRenderSession):void - Adds a session as a child of the session object. (AbstractRenderSession) renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void - Draws a non-scaled bitmap into the graphics object. (AbstractRenderSession) renderFogColor(color:int, alpha:Number):void - Draws a fog element into the graphics object. (AbstractRenderSession) renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void - Draws a segment element into the graphics object. (AbstractRenderSession) renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void - Draws a bitmap with a precalculated matrix into the graphics object. (AbstractRenderSession) renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void - Draws a triangle element with a bitmap texture into the graphics object. (AbstractRenderSession) renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void - Draws a triangle element with a fill color into the graphics object. (AbstractRenderSession) renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void - Draws a wire triangle element into the graphics object. (AbstractRenderSession) renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void - Draws a wire triangle element with a fill color into the graphics object. (AbstractRenderSession) PROTECTED METHODS createLayer():void - Creates a new render layer for rendering composite materials. (AbstractRenderSession) PROPERTY DETAIL public var children:Dictionary Dictionary of child displayobjects. arcane var doActive:Array Array for storing added displayobjects to the canvas arcane var doStore:Array Array for storing old displayobjects to the canvas public var graphics:Graphics Reference to the current graphics object being used for drawing. lightarray:LightArray[read-write] Defines the light provider object for the render sesion. Implementation public function get lightarray():LightArray public function set lightarray(value:LightArray):void public var newLayer:Sprite Holds the last added layer sprite. public var sessions:Dictionary Dictionary of child sessions. public var spriteLayers:Array Dictionary of sprite layers for rendering composite materials. See also away3d.materials.CompositeMaterial.renderTriangle() view:View3D[read-write] Defines the view object used for the render session. Implementation public function get view():View3D public function set view(value:View3D):void METHOD DETAIL public function addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list. Parameters child:DisplayObject - The display object to add. public function addLayerObject(child:Sprite):void Adds a layer sprite to the render session display list. Doesn't update graphics so that elements in comosite materials can render in separate layers. Parameters child:Sprite - The display object to add. public function clear():void Clears the render session. public function clone():AbstractRenderSession Duplicates the render session's properties to another render session. Returns AbstractRenderSession - The new render session instance with duplicated properties applied protected function createLayer():void Creates a new render layer for rendering composite materials. See also away3d.materials.CompositeMaterial.renderTriangle() public function flush():void Flushes any cached drawing operations to screen. public function getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view. Parameters view:View3D - The view object being rendered. Returns DisplayObject - The display object container. public function registerChildSession(session:AbstractRenderSession):void Adds a session as a child of the session object. Parameters session:AbstractRenderSession - The session object to be added as a child. public function renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void Draws a non-scaled bitmap into the graphics object. Parameters bitmap:BitmapData v0:ScreenVertex smooth:Boolean (default = false) public function renderFogColor(color:int, alpha:Number):void Draws a fog element into the graphics object. Parameters color:int alpha:Number public function renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object. Parameters v0:ScreenVertex v1:ScreenVertex width:Number color:uint alpha:Number public function renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void Draws a bitmap with a precalculated matrix into the graphics object. Parameters primitive:DrawScaledBitmap bitmap:BitmapData mapping:Matrix smooth:Boolean (default = false) public function renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object. Parameters bitmap:BitmapData map:Matrix v0:ScreenVertex v1:ScreenVertex v2:ScreenVertex smooth:Boolean repeat:Boolean layerGraphics:Graphics (default = null) public function renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a triangle element with a fill color into the graphics object. Parameters color:int alpha:Number v0:ScreenVertex v1:ScreenVertex v2:ScreenVertex public function renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element into the graphics object. Parameters width:Number color:int alpha:Number v0:ScreenVertex v1:ScreenVertex v2:ScreenVertex public function renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element with a fill color into the graphics object. Parameters width:Number color:int alpha:Number wirecolor:int wirealpha:Number v0:ScreenVertex v1:ScreenVertex v2:ScreenVertex CODE EXAMPLES There are currently no examples for this class AbstractShader ============== Package : away3d.materials.shaders Class : public class AbstractShader Inheritance Implements : ILayerMaterial, IUpdatingMaterial Subclasses : AmbientShader, DiffuseDot3Shader, DiffusePhongShader, EnviroShader, SpecularPhongShader Description : PUBLIC PROPERTIES blendMode : String - Defines a blendMode value for the shader bitmap. (AbstractShader) debug : Boolean - Determines if faces with the shader applied are drawn with outlines (AbstractShader) smooth : Boolean - Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen (AbstractShader) visible : Boolean - [read-only] Indicates whether the material is visible (AbstractShader) PROTECTED PROPERTIES 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. (AbstractShader) PUBLIC METHODS (AbstractShader) renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO - Renders a bitmapData surface object for the speficied face. (AbstractShader) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (AbstractShader) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (AbstractShader) PROTECTED METHODS clearFaceDictionary(source:Object3D, view:View3D):void - Clears face value objects when shader requires updating (AbstractShader) getLightingShape(layer:Sprite, light:LightPrimitive):Shape - Returns a shape object for use by light shaders (AbstractShader) getShape(layer:Sprite):Shape - Returns a shape object for use by environment shaders. (AbstractShader) renderShader(face:Face):void - Renders the shader to the specified face. (AbstractShader) PROPERTY DETAIL public var blendMode:String Defines a blendMode value for the shader bitmap. public var debug:Boolean Determines if faces with the shader applied are drawn with outlines 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. public var smooth:Boolean Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen visible:Boolean[read-only] Indicates whether the material is visible Implementation public function get visible():Boolean CONSTRUCTOR DETAIL public function AbstractShader(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters smooth:Boolean (default = false) debug:Boolean (default = false) blendMode:String (default = BlendMode.NORMAL) METHOD DETAIL protected function clearFaceDictionary(source:Object3D, view:View3D):void Clears face value objects when shader requires updating Parameters source:Object3D - The parent 3d object of the face. view:View3D - The view rendering the draw triangle. See also away3d.core.utils.FaceVO protected function getLightingShape(layer:Sprite, light:LightPrimitive):Shape Returns a shape object for use by light shaders Parameters layer:Sprite - The parent layer of the triangle. light:LightPrimitive - The light primitive. Returns Shape - The resolved shape object to use for drawing. protected function getShape(layer:Sprite):Shape Returns a shape object for use by environment shaders. Parameters layer:Sprite - The parent layer of the triangle Returns Shape - The resolved shape object to use for drawing public function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face. Parameters face:Face - The face object onto which the rendered sufrace is applied. containerRect:Rectangle - The rectangle object defining the bounds of the face in uv-space. parentFaceVO:FaceVO - The value object of the preceeding surface. Returns FaceVO public function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle. Parameters tri:DrawTriangle - The drawtriangle used for render information. layer:Sprite - The parent layer into which the triangle is drawn. level:int - Defines the sprite level for the layer. protected function renderShader(face:Face):void Renders the shader to the specified face. Parameters face:Face - The face object being rendered. public function updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible. Parameters source:Object3D view:View3D CODE EXAMPLES There are currently no examples for this class AbstractWirePrimitive ===================== Package : away3d.primitives Class : public class AbstractWirePrimitive Inheritance : WireMesh, BaseMesh, Object3D Subclasses : GridPlane, WireCircle, WireCone, WireCube, WireCylinder, WirePlane, WireSphere, WireTorus Description : PUBLIC PROPERTIES (^) 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 - Returns the bounding radius of the 3d object (BaseMesh) (^) elements : Array - Returns an array of the elements contained in the wiremesh object. (WireMesh) (^) 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 - 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) (^) inverseSceneTransform : Matrix3D - (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (BaseMesh) (^) loop : Boolean - Determines whether the animation will loop. (BaseMesh) (^) material : ISegmentMaterial - Defines the material used to render the segments in the wiremesh object. (WireMesh) (^) 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) (^) 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 (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 (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePosition : Number3D (Object3D) sceneTransform : Matrix3D (AbstractWirePrimitive) (^) sceneTransformed : Boolean - (Object3D) (^) segments : Array - Returns an array of the segments contained in the wiremesh object. (WireMesh) (^) 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 (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 (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (AbstractWirePrimitive) (^) 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) (^) addSegment(segment:Segment):void - Adds a segment object to the wiremesh object. (WireMesh) buildPrimitive():void - Builds the vertex, face and uv objects that make up the 3d primitive. (AbstractWirePrimitive) (^) clone(object:* = null):* (Object3D) (^) distanceTo(obj:Object3D):Number - 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) (^) lookAt(target:Number3D, upAxis:Number3D = null):void (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) (^) moveTo(target:Number3D):void - 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) (^) play(sequence:AnimationSequence):void - Plays a sequence of frames (BaseMesh) (^) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (WireMesh) (^) 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) (^) removeSegment(segment:Segment):void - Removes a segment object to the wiremesh object. (WireMesh) (^) roll(angle:Number):void - Rotates the 3d object around it's local z-axis (Object3D) (^) rotate(axis:Number3D, angle:Number):void - 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 (BaseMesh) (^) toString():String - Used to trace the values of a 3d object. (Object3D) (^) translate(axis:Number3D, distance:Number):void - Moves the 3d object along a vector by a defined length (Object3D) (^) traverse(traverser:Traverser):void - Used when traversing the scenegraph (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) addElement(element:IMeshElement):void - Adds an element to the mesh object. (BaseMesh) (^) removeElement(element:IMeshElement):void - 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) EVENTS (^) (BaseMesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (BaseMesh) (^) (Object3D) PROPERTY DETAIL sceneTransform:Matrix3D[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D. Implementation public function get sceneTransform():Matrix3D CONSTRUCTOR DETAIL public function AbstractWirePrimitive(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties METHOD DETAIL public function buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive. CODE EXAMPLES There are currently no examples for this class AmbientLight ============ Package : away3d.core.light Class : public class AmbientLight Inheritance : LightPrimitive Description : Ambient light primitive PUBLIC PROPERTIES (^) ambient : Number - Coefficient for the ambient light intensity. (LightPrimitive) (^) ambientBitmap : BitmapData - Lightmap for ambient intensity. (LightPrimitive) (^) ambientDiffuseBitmap : BitmapData - Combined lightmap for ambient and diffuse intensities. (LightPrimitive) (^) blue : Number - Blue component level. (LightPrimitive) (^) diffuse : Number - Coefficient for the diffuse light intensity. (LightPrimitive) (^) diffuseBitmap : BitmapData - Lightmap for diffuse intensity. (LightPrimitive) (^) green : Number - Green component level. (LightPrimitive) light : AmbientLight3D (AmbientLight) (^) red : Number - Red component level. (LightPrimitive) (^) specular : Number - Coefficient for the specular light intensity. (LightPrimitive) (^) specularBitmap : BitmapData - Lightmap for specular intensity. (LightPrimitive) PUBLIC METHODS updateAmbientBitmap(ambient:Number):void - Updates the bitmapData object used as the lightmap for ambient light shading. (AmbientLight) PROPERTY DETAIL public var light:AmbientLight3D A reference to the AmbientLight3D object used by the light primitive. METHOD DETAIL public function updateAmbientBitmap(ambient:Number):void Updates the bitmapData object used as the lightmap for ambient light shading. Parameters ambient:Number - The coefficient for ambient light intensity. CODE EXAMPLES There are currently no examples for this class AmbientLight3D ============== Package : away3d.lights Class : public class AmbientLight3D Inheritance : Object3D Implements : IClonable, ILightProvider, IPrimitiveProvider Description : Lightsource that colors all shaded materials evenly from any angle PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) ambient : Number - Defines a coefficient for the ambient light intensity. (AmbientLight3D) (^) blendMode : String - An optional blend mode that can be applied to the 3d object. (Object3D) (^) boundingRadius : Number - Returns the bounding radius of the 3d object (Object3D) color : int - Defines the color of the light object. (AmbientLight3D) debug : Boolean - Toggles debug mode: light object is visualised in the scene. (AmbientLight3D) (^) 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) (^) inverseSceneTransform : Matrix3D - (Object3D) (^) maxX : Number - Returns the maximum x value of the 3d object (Object3D) (^) maxY : Number - Returns the maximum y value of the 3d object (Object3D) (^) maxZ : Number - Returns the maximum z value of the 3d object (Object3D) (^) minX : Number - Returns the minimum x value of the 3d object (Object3D) (^) minY : Number - Returns the minimum y value of the 3d object (Object3D) (^) minZ : Number - Returns the minimum z value of the 3d object (Object3D) (^) 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 (Object3D) (^) projection : Projection - (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) sceneTransformed : Boolean - (Object3D) (^) session : AbstractRenderSession - The render session used by the 3d object (Object3D) (^) transform : Matrix3D (Object3D) (^) useHandCursor : Boolean = false - Defines whether a hand cursor is displayed when the mouse rolls over the 3d object. (Object3D) (^) viewTransform : Matrix3D - (Object3D) (^) visible : Boolean = true - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (AmbientLight3D) (^) 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) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) clone(object:* = null):* (AmbientLight3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) light(consumer:ILightConsumer):void (AmbientLight3D) (^) lookAt(target:Number3D, upAxis:Number3D = null):void (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) (^) moveTo(target:Number3D):void - 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) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (AmbientLight3D) (^) 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) (^) 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) (^) rotate(axis:Number3D, angle:Number):void - Rotates the 3d object around an axis by a defined angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) tick(time:int):void (Object3D) (^) toString():String - Used to trace the values of a 3d object. (Object3D) (^) translate(axis:Number3D, distance:Number):void - Moves the 3d object along a vector by a defined length (Object3D) (^) traverse(traverser:Traverser):void - Used when traversing the scenegraph (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) PROPERTY DETAIL ambient:Number[read-write] Defines a coefficient for the ambient light intensity. Implementation public function get ambient():Number public function set ambient(value:Number):void color:int[read-write] Defines the color of the light object. Implementation public function get color():int public function set color(value:int):void public var debug:Boolean Toggles debug mode: light object is visualised in the scene. CONSTRUCTOR DETAIL public function AmbientLight3D(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters color:Color (default = 0xFFFFFF) ambient:Number (default = 0.5, min:0, max:1) debug:Boolean (default = false) METHOD DETAIL public override function clone(object:* = null):* Duplicates the light object's properties to another AmbientLight3D object Parameters object:* (default = null) - [optional] The new object instance into which all properties are copied Returns * - The new object instance with duplicated properties applied public function light(consumer:ILightConsumer):void Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object Parameters consumer:ILightConsumer - The consumer instance. 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 CODE EXAMPLES There are currently no examples for this class AmbientShader ============= Package : away3d.materials.shaders Class : public class AmbientShader Inheritance : AbstractShader Description : PUBLIC PROPERTIES (^) blendMode : String - Defines a blendMode value for the shader bitmap. (AbstractShader) color : uint - Defines a 24 bit color value used by the shader (AmbientShader) (^) debug : Boolean - Determines if faces with the shader applied are drawn with outlines (AbstractShader) (^) smooth : Boolean - Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen (AbstractShader) (^) visible : Boolean - Indicates whether the material is visible (AbstractShader) PROTECTED PROPERTIES (AmbientShader) (^) renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO - Renders a bitmapData surface object for the speficied face. (AbstractShader) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (AmbientShader) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (AmbientShader) PROTECTED METHODS clearFaceDictionary(source:Object3D, view:View3D):void - Clears face value objects when shader requires updating (AmbientShader) (^) getLightingShape(layer:Sprite, light:LightPrimitive):Shape - Returns a shape object for use by light shaders (AbstractShader) (^) getShape(layer:Sprite):Shape - Returns a shape object for use by environment shaders. (AbstractShader) renderShader(face:Face):void - Renders the shader to the specified face. (AmbientShader) PROPERTY DETAIL public var color:uint Defines a 24 bit color value used by the shader CONSTRUCTOR DETAIL public function AmbientShader(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. METHOD DETAIL protected override function clearFaceDictionary(source:Object3D, view:View3D):void Clears face value objects when shader requires updating Parameters source:Object3D - The parent 3d object of the face. view:View3D - The view rendering the draw triangle. public override function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle. Parameters tri:DrawTriangle - The drawtriangle used for render information. layer:Sprite - The parent layer into which the triangle is drawn. level:int - Defines the sprite level for the layer. protected override function renderShader(face:Face):void Renders the shader to the specified face. Parameters face:Face - The face object being rendered. public override function updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible. Parameters source:Object3D view:View3D CODE EXAMPLES There are currently no examples for this class AnimatedBitmapMaterial ====================== Package : away3d.materials Class : public class AnimatedBitmapMaterial Inheritance : TransformBitmapMaterial, BitmapMaterial Implements : ITriangleMaterial, IUVMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the texture bitmap. (BitmapMaterial) autoplay : Boolean - Indicates whether the animation will start playing on initialisation. (AnimatedBitmapMaterial) (^) bitmap : BitmapData - Returns the bitmapData object being used as the material texture. (BitmapMaterial) (^) blendMode : String - Defines a blendMode value for the texture bitmap. (BitmapMaterial) (^) color : uint - Defines a colored tint for the texture bitmap. (BitmapMaterial) (^) debug : Boolean = false - Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines. (BitmapMaterial) (^) globalProjection : Boolean - Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates. (TransformBitmapMaterial) (^) height : Number - Returns the height of the bitmapData being used as the material texture. (BitmapMaterial) index : int - [write-only] Manually sets the frame index of the animation. (AnimatedBitmapMaterial) loop : Boolean - Indicates whether the animation will loop. (AnimatedBitmapMaterial) (^) offsetX : Number - Offsets the x coordinates of the texture in uv-space (TransformBitmapMaterial) (^) offsetY : Number - Offsets the y coordinates of the texture in uv-space (TransformBitmapMaterial) (^) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) (^) projectionVector : Number3D - Projects the texture in object space, ignoring the uv coordinates of the vertex objects. (TransformBitmapMaterial) (^) repeat : Boolean = false - Determines if texture bitmap will tile in uv-space (BitmapMaterial) (^) rotation : Number - Rotates the texture in uv-space (TransformBitmapMaterial) (^) scaleX : Number - Scales the x coordinates of the texture in uv-space (TransformBitmapMaterial) (^) scaleY : Number - Scales the y coordinates of the texture in uv-space (TransformBitmapMaterial) (^) smooth : Boolean = false - Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (BitmapMaterial) (^) throughProjection : Boolean - Determines whether a projected texture is visble on the faces pointing away from the projection. (TransformBitmapMaterial) (^) transform : Matrix - Transforms the texture in uv-space (TransformBitmapMaterial) (^) visible : Boolean - Indicates whether the material is visible (BitmapMaterial) (^) width : Number - Returns the width of the bitmapData being used as the material texture. (BitmapMaterial) PROTECTED PROPERTIES (AnimatedBitmapMaterial) (^) addOnResize(listener:Function):void - Default method for adding a materialresize event listener (BitmapMaterial) (^) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (TransformBitmapMaterial) play():void - Resumes playback of the animation (AnimatedBitmapMaterial) (^) removeOnResize(listener:Function):void - Default method for removing a materialresize event listener (BitmapMaterial) (^) renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO - Renders a bitmapData surface object for the speficied face. (TransformBitmapMaterial) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (BitmapMaterial) (^) renderTriangle(tri:DrawTriangle):void (TransformBitmapMaterial) setFrames(sources:Array):void - Resets the cached bitmapData objects making up the animation with a pre-defined array. (AnimatedBitmapMaterial) setMovie(movie:MovieClip):void - Resets the movieclip used by the material. (AnimatedBitmapMaterial) stop():void - Halts playback of the animation (AnimatedBitmapMaterial) (^) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (TransformBitmapMaterial) PROTECTED METHODS (^) getMapping(tri:DrawTriangle):Matrix - Calculates the mapping matrix required to draw the triangle texture to screen. (TransformBitmapMaterial) (^) setColorTransform():void (BitmapMaterial) (^) updateRenderBitmap():void (BitmapMaterial) EVENTS (^) (BitmapMaterial) PROPERTY DETAIL public var autoplay:Boolean Indicates whether the animation will start playing on initialisation. If false, only the first frame is displayed. index:int[write-only] Manually sets the frame index of the animation. Implementation public function set index(value:int):void public var loop:Boolean Indicates whether the animation will loop. CONSTRUCTOR DETAIL public function AnimatedBitmapMaterial(movie:MovieClip, init:Object = null) Parameters movie:MovieClip - The movieclip to be bitmap cached for use in the material. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. METHOD DETAIL public function play():void Resumes playback of the animation public function setFrames(sources:Array):void Resets the cached bitmapData objects making up the animation with a pre-defined array. Parameters sources:Array public function setMovie(movie:MovieClip):void Resets the movieclip used by the material. Parameters movie:MovieClip - The movieclip to be bitmap cached for use in the material. public function stop():void Halts playback of the animation CODE EXAMPLES There are currently no examples for this class Animation ========= Package : away3d.core.base Class : public class Animation Inheritance Implements : IAnimation Description : PUBLIC PROPERTIES cycleEvent : Boolean = false - Determines whether the animation will fire cycle events. (Animation) delay : Number = 0 - Determines the delay time between animation cycles if loop is set to true. (Animation) fps : Number = 24 - The frames per second at which the animation will run. (Animation) frame : Number = 0 - The current frame of the animation. (Animation) isRunning : Boolean - [read-only] Indicates whether the animation is currently running. (Animation) latest : uint - [read-only] Returns the number of the latest frame displayed. (Animation) loop : Boolean = false - Determines whether the animation will loop. (Animation) object : BaseMesh - The Mesh on which the animation is occurring. (Animation) sequence : Array - Holds an array of animation frames. (Animation) sequenceEvent : Boolean = false - Determines whether the animation will fire sequence events. (Animation) smooth : Boolean = false - Determines whether the animation will smooth motion (interpolate) between frames. (Animation) PUBLIC METHODS (Animation) start():void - Jumps to the beginning of the animation and start playing (Animation) stop():void - Stops the animation at it's current position. (Animation) update(mesh:BaseMesh):void - Updates the positions of vertex objects in the mesh to the current frame values (Animation) EVENTS (Animation) (Animation) PROPERTY DETAIL public var cycleEvent:Boolean = false Determines whether the animation will fire cycle events. See also away3d.events.AnimationEvent public var delay:Number = 0 Determines the delay time between animation cycles if loop is set to true. See also loop public var fps:Number = 24 The frames per second at which the animation will run. public var frame:Number = 0 The current frame of the animation. isRunning:Boolean[read-only] Indicates whether the animation is currently running. Implementation public function get isRunning():Boolean latest:uint[read-only] Returns the number of the latest frame displayed. Implementation public function get latest():uint public var loop:Boolean = false Determines whether the animation will loop. public var object:BaseMesh The Mesh on which the animation is occurring. public var sequence:Array Holds an array of animation frames. See also away3d.core.base.AnimationFrame public var sequenceEvent:Boolean = false Determines whether the animation will fire sequence events. See also away3d.events.AnimationEvent public var smooth:Boolean = false Determines whether the animation will smooth motion (interpolate) between frames. CONSTRUCTOR DETAIL public function Animation(obj:BaseMesh) Parameters obj:BaseMesh - The mesh object that the animation acts on. METHOD DETAIL public function start():void Jumps to the beginning of the animation and start playing public function stop():void Stops the animation at it's current position. public function update(mesh:BaseMesh):void Updates the positions of vertex objects in the mesh to the current frame values Parameters mesh:BaseMesh - The mesh on which the animation object acts EVENT DETAIL Event object type: away3d.events.AnimationEvent Dispatched when all frame sequences are complete Event object type: away3d.events.AnimationEvent Dispatched when the current frame sequence is complete CODE EXAMPLES There are currently no examples for this class AnimationEvent ============== Package : away3d.events Class : public class AnimationEvent Inheritance PUBLIC PROPERTIES : Animation animation : Animation Description : - A reference to the animation object that is relevant to the event. (AnimationEvent) PUBLIC METHODS (AnimationEvent) clone():Event - Creates a copy of the AnimationEvent object and sets the value of each property to match that of the original. (AnimationEvent) PUBLIC CONSTANTS CYCLE : String = "cycle" - [static] Defines the value of the type property of a cycle event object. (AnimationEvent) SQUENCE_DONE : String = "squencedone" - [static] Defines the value of the type property of a sequence done event object. (AnimationEvent) SQUENCE_UPDATE : String = "squenceupdate" - [static] Defines the value of the type property of a sequence update event object. (AnimationEvent) PROPERTY DETAIL public var animation:Animation A reference to the animation object that is relevant to the event. CONSTRUCTOR DETAIL public function AnimationEvent(type:String, animation:Animation) Parameters type:String - The type of the event. Possible values are: AnimationEvent.CYCLE, AnimationEvent.SQUENCE_UPDATE and AnimationEvent.SQUENCE_DONE. animation:Animation - A reference to the animation object that is relevant to the event. METHOD DETAIL public override function clone():Event Creates a copy of the AnimationEvent object and sets the value of each property to match that of the original. Returns Event CONSTANT DETAIL public static const CYCLE:String = "cycle" Defines the value of the type property of a cycle event object. public static const SQUENCE_DONE:String = "squencedone" Defines the value of the type property of a sequence done event object. public static const SQUENCE_UPDATE:String = "squenceupdate" Defines the value of the type property of a sequence update event object. CODE EXAMPLES There are currently no examples for this class AnimationFrame ============== Package : away3d.core.base Class : public class AnimationFrame PUBLIC PROPERTIES frame : Number - Frame number. (AnimationFrame) sort : String - An optional sort string used to order the animation frames. (AnimationFrame) time : uint - Time from the start of the animation. (AnimationFrame) PUBLIC METHODS (AnimationFrame) PROPERTY DETAIL public var frame:Number Frame number. public var sort:String An optional sort string used to order the animation frames. public var time:uint Time from the start of the animation. CONSTRUCTOR DETAIL public function AnimationFrame(frame:Number, sort:String = null) Parameters frame:Number - The number of the frame in it's sequence. sort:String (default = null) - An optional sort string used to order the animation frames. CODE EXAMPLES There are currently no examples for this class AnimationGroup ============== Package : away3d.core.base Class : public class AnimationGroup PUBLIC PROPERTIES fps : uint - Determines the speed of playback in frames per second. (AnimationGroup) loop : Boolean - Determines whether the animation sequence should loop. (AnimationGroup) loopLast : Boolean - Determines if the last animation sequence should be looped. (AnimationGroup) playlist : Array - An array of animation sequence objects. (AnimationGroup) PUBLIC METHODS (AnimationGroup) PROPERTY DETAIL public var fps:uint Determines the speed of playback in frames per second. public var loop:Boolean Determines whether the animation sequence should loop. public var loopLast:Boolean Determines if the last animation sequence should be looped. public var playlist:Array An array of animation sequence objects. CONSTRUCTOR DETAIL public function AnimationGroup(playlist:Array = null, loopLast:Boolean = false) Parameters playlist:Array (default = null) - An array of animation sequence objects. loopLast:Boolean (default = false) - Determines if the last animation sequence should be looped. CODE EXAMPLES There are currently no examples for this class AnimationSequence ================= Package : away3d.core.base Class : public class AnimationSequence PUBLIC PROPERTIES fps : Number - Determines the speed of playback in frames per second. (AnimationSequence) loop : Boolean - Determines whether the animation sequence should loop. (AnimationSequence) prefix : String - The prefix string defining frames in the sequence. (AnimationSequence) smooth : Boolean - Determines if the animation should be smoothed (interpolated) between frames. (AnimationSequence) PUBLIC METHODS (AnimationSequence) PROPERTY DETAIL public var fps:Number Determines the speed of playback in frames per second. public var loop:Boolean Determines whether the animation sequence should loop. public var prefix:String The prefix string defining frames in the sequence. public var smooth:Boolean Determines if the animation should be smoothed (interpolated) between frames. CONSTRUCTOR DETAIL public function AnimationSequence(prefix:String, smooth:Boolean = false, loop:Boolean = false, fps:Number = 24) Parameters prefix:String - The prefix string defining frames in the sequence. smooth:Boolean (default = false) - Determines if the animation should be smoothed (interpolated) between frames. loop:Boolean (default = false) - Determines whether the animation sequence should loop. fps:Number (default = 24) - Determines the speed of playback in frames per second. CODE EXAMPLES There are currently no examples for this class Animator ======== Package : away3d.animation Class : public class Animator Inheritance : Mesh, BaseMesh, Object3D Description : PUBLIC PROPERTIES (^) 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 - 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 - 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) framelist : Array - [read-only] (Animator) (^) 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 (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 (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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 (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 (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES - (Animator) (^) addFace(face:Face):void - Adds a face object to the mesh object. (Mesh) addFrames(aFrames:Array):void - (Animator) (^) 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) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void - (Animator) (^) 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) (^) lookAt(target:Number3D, upAxis:Number3D = null):void (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) (^) moveTo(target:Number3D):void - 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) (^) play(sequence:AnimationSequence):void - Plays a sequence of frames (BaseMesh) (^) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (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) (^) 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) (^) rotate(axis:Number3D, angle:Number):void - 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 (BaseMesh) (^) toString():String - Used to trace the values of a 3d object. (Object3D) (^) translate(axis:Number3D, distance:Number):void - Moves the 3d object along a vector by a defined length (Object3D) (^) traverse(traverser:Traverser):void - Used when traversing the scenegraph (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) addElement(element:IMeshElement):void - Adds an element to the mesh object. (BaseMesh) (^) removeElement(element:IMeshElement):void - 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) EVENTS (^) (BaseMesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (BaseMesh) (^) (Object3D) PROPERTY DETAIL framelist:Array[read-only] Implementation public function get framelist():Array CONSTRUCTOR DETAIL public function Animator(baseObject:Mesh, aFrames:Array, init:Object = null, doloop:Boolean = false) Parameters baseObject:Mesh aFrames:Array init:Object (default = null) doloop:Boolean (default = false) METHOD DETAIL public function addFrames(aFrames:Array):void Parameters aFrames:Array public function generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void Parameters baseObject:Mesh aFrames:Array doloop:Boolean CODE EXAMPLES There are currently no examples for this class AnotherRivalFilter ================== Package : away3d.core.filter Class : public class AnotherRivalFilter Implements : IPrimitiveQuadrantFilter Description : sorting PUBLIC METHODS (AnotherRivalFilter) filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void - Applies the filter to the quadrant tree. (AnotherRivalFilter) toString():String - Used to trace the values of a filter. (AnotherRivalFilter) CONSTRUCTOR DETAIL public function AnotherRivalFilter(maxdelay:int = 60000) Parameters maxdelay:int (default = 60000) - [optional] The maximum time the filter can take to resolve z-depth before timing out. METHOD DETAIL public function filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void Applies the filter to the quadrant tree. Parameters pritree:PrimitiveQuadrantTree - The quadrant tree to be filtered. scene:Scene3D - The scene to which the quadrant tree belongs. camera:Camera3D - The camera being used in the renderer for the quadrant tree clip:Clipping - The clipping object used in the renderer for the quadrant tree's view. public function toString():String Used to trace the values of a filter. Returns String - A string representation of the filter object. CODE EXAMPLES There are currently no examples for this class Ase === Package : away3d.loaders Class : public class Ase PUBLIC METHODS (Ase) load(url:String, init:Object = null):Object3DLoader - [static] Loads and parses an ase file into a 3d mesh object. (Ase) parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh - [static] Creates a 3d mesh object from the raw ascii data of the ase file. (Ase) CONSTRUCTOR DETAIL public function Ase(data:String, init:Object = null) Parameters data:String - The ascii data of a loaded file. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters scaling:Number (default = 1) See also away3d.loaders.Ase.parse() away3d.loaders.Ase.load() METHOD DETAIL public static function load(url:String, init:Object = null):Object3DLoader Loads and parses an ase file into a 3d mesh object. Parameters url:String - The url location of the file to load. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Returns Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the file is loading. public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh Creates a 3d mesh object from the raw ascii data of the ase file. Parameters data:* - The ascii data of a loaded file. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. loader:Object3DLoader (default = null) - [optional] Not intended for direct use. Returns Mesh - A 3d mesh object representation of the ase file. CODE EXAMPLES There are currently no examples for this class BaseDemo ======== Package : away3d.test Class : public class BaseDemo Inheritance PROTECTED PROPERTIES : HoverCamera3D camera : HoverCamera3D Description : - (BaseDemo) centergroup : Sprite - (BaseDemo) infogroup : Sprite - (BaseDemo) lefttopgroup : Sprite - (BaseDemo) startlabel : TextField - (BaseDemo) statsgroup : Sprite - (BaseDemo) titlegroup : Sprite - (BaseDemo) view : View3D - (BaseDemo) PUBLIC METHODS - (BaseDemo) PROTECTED METHODS addSlide(title:String, text:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession):void - (BaseDemo) PROPERTY DETAIL protected var camera:HoverCamera3D protected var centergroup:Sprite protected var infogroup:Sprite protected var lefttopgroup:Sprite protected var startlabel:TextField protected var statsgroup:Sprite protected var titlegroup:Sprite protected var view:View3D CONSTRUCTOR DETAIL public function BaseDemo(title:String, infogroupheight:Number = 410) Parameters title:String infogroupheight:Number (default = 410) METHOD DETAIL protected function addSlide(title:String, text:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession):void Parameters title:String text:String scene:Scene3D renderer:IRenderer session:AbstractRenderSession CODE EXAMPLES Away3D HelloAway3D.as package { import flash.display.*; import flash.events.*; import flash.utils.*; import away3d.objects.*; import away3d.core.material.*; import away3d.core.proto.*; [SWF(backgroundColor="#222266", frameRate="60", width="600", height="400")] public class HelloAway3D extends Sprite { public var view:View3D; public var sphere:Sphere; public function HelloAway3D() { view = new View3D(); view.x = 300; view.y = 200; addChild(view); sphere = new Sphere(new WireColorMaterial(0xFF7700, 0xCC4400), {radius:250, segmentsW:12, segmentsH:9, y:50}); view.scene.addChild(sphere); view.camera.lookAt(sphere); addEventListener(Event.ENTER_FRAME, onEnterFrame); } private function onEnterFrame(event:Event):void { view.render(); sphere.rotationY = getTimer() / 100; } } } From HelloAway3D.as BaseMesh ======== Package : away3d.core.base Class : public class BaseMesh Inheritance Subclasses : Mesh, WireMesh Description : PUBLIC PROPERTIES (^) 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 (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 (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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 (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 (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (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):* (Object3D) (^) distanceTo(obj:Object3D):Number - 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) (^) lookAt(target:Number3D, upAxis:Number3D = null):void (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) (^) moveTo(target:Number3D):void - 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) play(sequence:AnimationSequence):void - Plays a sequence of frames (BaseMesh) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (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) (^) rotate(axis:Number3D, angle:Number):void - 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 (BaseMesh) (^) toString():String - Used to trace the values of a 3d object. (Object3D) (^) translate(axis:Number3D, distance:Number):void - Moves the 3d object along a vector by a defined length (Object3D) (^) traverse(traverser:Traverser):void - Used when traversing the scenegraph (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS addElement(element:IMeshElement):void - Adds an element to the mesh object. (BaseMesh) removeElement(element:IMeshElement):void - 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) EVENTS (BaseMesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (BaseMesh) (^) (Object3D) PROPERTY DETAIL boundingRadius:Number[read-only] Returns the bounding radius of the 3d object Implementation public function get boundingRadius():Number elements:Array[read-only] Returns an array of the elements contained in the mesh object Implementation public function get elements():Array Throws - Not implemented fps:int[write-only] Determines the frames per second at which the animation will run. Implementation public function set fps(value:int):void frame:int[read-write] Indicates the current frame of animation Implementation public function get frame():int public function set frame(value:int):void public var framenames:Dictionary A dictionary containing all frame names of the mesh public var frames:Dictionary A dictionary containing all frames of the mesh hasCycleEvent:Boolean[read-only] Indicates whether the animation has a cycle event listener Implementation public function get hasCycleEvent():Boolean hasSequenceEvent:Boolean[read-only] Indicates whether the animation has a sequencedone event listener Implementation public function get hasSequenceEvent():Boolean isRunning:Boolean[read-only] Indicates whether the animation is currently running. Implementation public function get isRunning():Boolean loop:Boolean[write-only] Determines whether the animation will loop. Implementation public function set loop(value:Boolean):void maxX:Number[read-only] Returns the maximum x value of the 3d object Implementation public function get maxX():Number maxY:Number[read-only] Returns the maximum y value of the 3d object Implementation public function get maxY():Number maxZ:Number[read-only] Returns the maximum z value of the 3d object Implementation public function get maxZ():Number minX:Number[read-only] Returns the minimum x value of the 3d object Implementation public function get minX():Number minY:Number[read-only] Returns the minimum y value of the 3d object Implementation public function get minY():Number minZ:Number[read-only] Returns the minimum z value of the 3d object Implementation public function get minZ():Number public var pushback:Boolean Elements use their furthest point from the camera when z-sorting public var pushfront:Boolean Elements use their nearest point to the camera when z-sorting smooth:Boolean[write-only] Determines whether the animation will smooth motion (interpolate) between frames. Implementation public function set smooth(value:Boolean):void 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 away3d.core.stats.Stats 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 away3d.core.stats.Stats vertices:Array[read-only] Returns an array of the vertices contained in the mesh object Implementation public function get vertices():Array CONSTRUCTOR DETAIL public function BaseMesh(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties Init Parameters pushback:Boolean (default = false) pushfront:Boolean (default = false) METHOD DETAIL protected function addElement(element:IMeshElement):void Adds an element to the mesh object. Parameters element:IMeshElement - The element to be added to the mesh. public function addOnCycle(listener:Function):void Default method for adding a cycle event listener Parameters listener:Function - The listener function public function addOnSequenceDone(listener:Function):void Default method for adding a squencedone event listener Parameters listener:Function - The listener function public function gotoAndPlay(value:int):void Starts playing the animation at the specified frame. Parameters value:int - A number representing the frame number. 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. public function play(sequence:AnimationSequence):void Plays a sequence of frames Parameters sequence:AnimationSequence - The animationsequence to play 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 away3d.core.traverse.PrimitiveTraverser away3d.core.draw.DrawPrimitive protected function removeElement(element:IMeshElement):void Removes an element to the mesh object. Parameters element:IMeshElement - The element to be removed from the mesh. public function removeOnCycle(listener:Function):void Default method for removing a cycle event listener Parameters listener:Function - The listener function public function removeOnSequenceDone(listener:Function):void Default method for removing a squencedone event listener Parameters listener:Function - The listener function public override function scale(scale:Number):void Scales the contents of the mesh. Parameters scale:Number - The scaling value public function scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames Parameters scale:Number - The scaling value public function scaleX(scaleX:Number):void Scales the contents of the mesh along the x-axis. Parameters scaleX:Number - The scaling value protected function scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void Scales the contents of the mesh using 3 axis values. Parameters scaleX: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 public function scaleY(scaleY:Number):void Scales the contents of the mesh along the y-axis. Parameters scaleY:Number - The scaling value public function scaleZ(scaleZ:Number):void Scales the contents of the mesh along the z-axis. Parameters scaleZ:Number - The scaling value 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. public override function tick(time:int):void Called by the TickTraverser. updates the animation object Parameters time:int - The absolute time at the start of the render cycle See also away3d.core.traverse.TickTraverser away3d.core.basr.Animation.update() EVENT DETAIL Event object type: away3d.events.AnimationEvent Dispatched when the animation object completes a single sequence cycle. Event object type: away3d.events.AnimationEvent Dispatched when the animation object completes all frame sequences. CODE EXAMPLES There are currently no examples for this class BaseMeshElement =============== Package : away3d.core.base Class : public class BaseMeshElement Inheritance Implements : IMeshElement Subclasses : Face, Segment Description : PUBLIC PROPERTIES maxX : Number - [read-only] Returns the maximum x value of the 3d element (BaseMeshElement) maxY : Number - [read-only] Returns the minimum y value of the 3d element (BaseMeshElement) maxZ : Number - [read-only] Returns the minimum z value of the 3d element (BaseMeshElement) minX : Number - [read-only] Returns the minimum x value of the 3d element (BaseMeshElement) minY : Number - [read-only] Returns the maximum y value of the 3d element (BaseMeshElement) minZ : Number - [read-only] Returns the maximum z value of the 3d element (BaseMeshElement) radius2 : Number - [read-only] Returns the squared bounding radius of the 3d element (BaseMeshElement) vertices : Array - [read-only] Returns an array of vertex objects that make up the 3d element. (BaseMeshElement) visible : Boolean - Defines whether the 3d element is visible in the scene. (BaseMeshElement) PUBLIC METHODS addOnVertexChange(listener:Function):void - Default method for adding a vertexchanged event listener (BaseMeshElement) addOnVertexValueChange(listener:Function):void - Default method for adding a vertexvaluechanged event listener (BaseMeshElement) addOnVisibleChange(listener:Function):void - Default method for adding a visiblechanged event listener (BaseMeshElement) removeOnVertexChange(listener:Function):void - Default method for removing a vertexchanged event listener (BaseMeshElement) removeOnVertexValueChange(listener:Function):void - Default method for removing a vertexvaluechanged event listener (BaseMeshElement) removeOnVisibleChange(listener:Function):void - Default method for removing a visiblechanged event listener (BaseMeshElement) EVENTS (BaseMeshElement) (BaseMeshElement) (BaseMeshElement) PROPERTY DETAIL maxX:Number[read-only] Returns the maximum x value of the 3d element Implementation public function get maxX():Number maxY:Number[read-only] Returns the minimum y value of the 3d element Implementation public function get maxY():Number maxZ:Number[read-only] Returns the minimum z value of the 3d element Implementation public function get maxZ():Number minX:Number[read-only] Returns the minimum x value of the 3d element Implementation public function get minX():Number minY:Number[read-only] Returns the maximum y value of the 3d element Implementation public function get minY():Number minZ:Number[read-only] Returns the maximum z value of the 3d element Implementation public function get minZ():Number radius2:Number[read-only] Returns the squared bounding radius of the 3d element Implementation public function get radius2():Number vertices:Array[read-only] Returns an array of vertex objects that make up the 3d element. Implementation public function get vertices():Array visible:Boolean[read-write] Defines whether the 3d element is visible in the scene. Implementation public function get visible():Boolean public function set visible(value:Boolean):void METHOD DETAIL public function addOnVertexChange(listener:Function):void Default method for adding a vertexchanged event listener Parameters listener:Function - The listener function public function addOnVertexValueChange(listener:Function):void Default method for adding a vertexvaluechanged event listener Parameters listener:Function - The listener function public function addOnVisibleChange(listener:Function):void Default method for adding a visiblechanged event listener Parameters listener:Function - The listener function public function removeOnVertexChange(listener:Function):void Default method for removing a vertexchanged event listener Parameters listener:Function - The listener function public function removeOnVertexValueChange(listener:Function):void Default method for removing a vertexvaluechanged event listener Parameters listener:Function - The listener function public function removeOnVisibleChange(listener:Function):void Default method for removing a visiblechanged event listener Parameters listener:Function - The listener function EVENT DETAIL Event object type: away3d.events.MeshElementEvent Dispatched when the vertex of a 3d element changes. Event object type: away3d.events.MeshElementEvent Dispatched when the vertex value of a 3d element changes. Event object type: away3d.events.MeshElementEvent Dispatched when the visiblity of a 3d element changes. CODE EXAMPLES There are currently no examples for this class BasicRenderer ============= Package : away3d.core.render Class : public class BasicRenderer Implements : IRenderer Description : PUBLIC PROPERTIES session : AbstractRenderSession - Defines the render session object used by the renderer. (BasicRenderer) PUBLIC METHODS (BasicRenderer) render(view:View3D):Array - Executes the render pipe that resolves the 3d scene into the view. (BasicRenderer) toString():String - Used to trace the values of a renderer. (BasicRenderer) PROPERTY DETAIL session:AbstractRenderSession[read-write] Defines the render session object used by the renderer. Implementation public function get session():AbstractRenderSession public function set session(value:AbstractRenderSession):void CONSTRUCTOR DETAIL public function BasicRenderer(... filters) Parameters ... filters - [optional] An array of filters to use on projected drawing primitives before rendering them to screen. METHOD DETAIL public function render(view:View3D):Array Executes the render pipe that resolves the 3d scene into the view. Parameters view:View3D Returns Array public function toString():String Used to trace the values of a renderer. Returns String - A string representation of the renderer object. CODE EXAMPLES There are currently no examples for this class BitmapFileMaterial ================== Package : away3d.materials Class : public class BitmapFileMaterial Inheritance : TransformBitmapMaterial, BitmapMaterial Implements : ITriangleMaterial, IUVMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the texture bitmap. (BitmapMaterial) (^) bitmap : BitmapData - Returns the bitmapData object being used as the material texture. (BitmapMaterial) (^) blendMode : String - Defines a blendMode value for the texture bitmap. (BitmapMaterial) (^) color : uint - Defines a colored tint for the texture bitmap. (BitmapMaterial) (^) debug : Boolean = false - Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines. (BitmapMaterial) (^) globalProjection : Boolean - Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates. (TransformBitmapMaterial) (^) height : Number - Returns the height of the bitmapData being used as the material texture. (BitmapMaterial) (^) offsetX : Number - Offsets the x coordinates of the texture in uv-space (TransformBitmapMaterial) (^) offsetY : Number - Offsets the y coordinates of the texture in uv-space (TransformBitmapMaterial) (^) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) (^) projectionVector : Number3D - Projects the texture in object space, ignoring the uv coordinates of the vertex objects. (TransformBitmapMaterial) (^) repeat : Boolean = false - Determines if texture bitmap will tile in uv-space (BitmapMaterial) (^) rotation : Number - Rotates the texture in uv-space (TransformBitmapMaterial) (^) scaleX : Number - Scales the x coordinates of the texture in uv-space (TransformBitmapMaterial) (^) scaleY : Number - Scales the y coordinates of the texture in uv-space (TransformBitmapMaterial) (^) smooth : Boolean = false - Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (BitmapMaterial) (^) throughProjection : Boolean - Determines whether a projected texture is visble on the faces pointing away from the projection. (TransformBitmapMaterial) (^) transform : Matrix - Transforms the texture in uv-space (TransformBitmapMaterial) (^) visible : Boolean - Indicates whether the material is visible (BitmapMaterial) (^) width : Number - Returns the width of the bitmapData being used as the material texture. (BitmapMaterial) PROTECTED PROPERTIES (BitmapFileMaterial) (^) addOnResize(listener:Function):void - Default method for adding a materialresize event listener (BitmapMaterial) (^) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (TransformBitmapMaterial) (^) removeOnResize(listener:Function):void - Default method for removing a materialresize event listener (BitmapMaterial) (^) renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO - Renders a bitmapData surface object for the speficied face. (TransformBitmapMaterial) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (BitmapMaterial) (^) renderTriangle(tri:DrawTriangle):void (TransformB