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 (TransformBitmapMaterial) (^) 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) CONSTRUCTOR DETAIL public function BitmapFileMaterial(url:String = "", init:Object = null) Parameters url:String (default = "") - The location of the bitmapasset to load. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. CODE EXAMPLES There are currently no examples for this class BitmapMaterial ============== Package : away3d.materials Class : public class BitmapMaterial Inheritance Implements : ILayerMaterial, ITriangleMaterial, IUpdatingMaterial, IUVMaterial Subclasses : BitmapMaterialContainer, TransformBitmapMaterial Description : Basic bitmap material PUBLIC PROPERTIES alpha : Number - Defines an alpha value for the texture bitmap. (BitmapMaterial) bitmap : BitmapData - [read-only] 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) height : Number - [read-only] Returns the height of the bitmapData being used as the material texture. (BitmapMaterial) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) repeat : Boolean = false - Determines if texture bitmap will tile in uv-space (BitmapMaterial) smooth : Boolean = false - Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (BitmapMaterial) visible : Boolean - [read-only] Indicates whether the material is visible (BitmapMaterial) width : Number - [read-only] Returns the width of the bitmapData being used as the material texture. (BitmapMaterial) 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. (BitmapMaterial) PUBLIC METHODS (BitmapMaterial) 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. (BitmapMaterial) 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. (BitmapMaterial) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (BitmapMaterial) renderTriangle(tri:DrawTriangle):void (BitmapMaterial) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (BitmapMaterial) PROTECTED METHODS getMapping(tri:DrawTriangle):Matrix - Calculates the mapping matrix required to draw the triangle texture to screen. (BitmapMaterial) setColorTransform():void (BitmapMaterial) updateRenderBitmap():void (BitmapMaterial) EVENTS (BitmapMaterial) PROPERTY DETAIL alpha:Number[read-write] Defines an alpha value for the texture bitmap. Implementation public function get alpha():Number public function set alpha(value:Number):void bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData blendMode:String[read-write] Defines a blendMode value for the texture bitmap. Applies to materials rendered as children of BitmapMaterialContainer or CompositeMaterial. Implementation public function get blendMode():String public function set blendMode(value:String):void See also away3d.materials.BitmapMaterialContainer away3d.materials.CompositeMaterial color:uint[read-write] Defines a colored tint for the texture bitmap. Implementation public function get color():uint public function set color(value:uint):void public var debug:Boolean = false Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines. height:Number[read-only] Returns the height of the bitmapData being used as the material texture. Implementation public function get height():Number 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. precision:Number[read-write] Corrects distortion caused by the affine transformation (non-perpective) of textures. The number refers to the pixel correction value - ie. a value of 2 means a distorion correction to within 2 pixels of the correct perspective distortion. 0 performs no precision. Implementation public function get precision():Number public function set precision(value:Number):void public var repeat:Boolean = false Determines if texture bitmap will tile in uv-space public var smooth:Boolean = false Determines if texture 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 width:Number[read-only] Returns the width of the bitmapData being used as the material texture. Implementation public function get width():Number CONSTRUCTOR DETAIL public function BitmapMaterial(bitmap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's texture. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters smooth:Boolean (default = smooth) debug:Boolean (default = debug) repeat:Boolean (default = repeat) precision:Number (default = 0) blendMode:String (default = BlendMode.NORMAL) alpha:Number (default = _alpha, min:0, max:1) color:Color (default = _color) METHOD DETAIL public function addOnResize(listener:Function):void Default method for adding a materialresize event listener Parameters listener:Function - The listener function protected function getMapping(tri:DrawTriangle):Matrix Calculates the mapping matrix required to draw the triangle texture to screen. Parameters tri:DrawTriangle - The data object holding all information about the triangle to be drawn. Returns Matrix - The required matrix object. public function getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate. Parameters u:Number - The u (horizontal) texture coordinate. v:Number - The v (verical) texture coordinate. Returns uint - The argb pixel value. public function removeOnResize(listener:Function):void Default method for removing a materialresize event listener Parameters listener:Function - The listener function 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. public function renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the DrawTriangle primitive to the render session. Parameters tri:DrawTriangle protected function setColorTransform():void Updates the colortransform object applied to the texture from the color and alpha properties. See also color alpha public function updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible. Parameters source:Object3D view:View3D protected function updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the color and alpha properties. See also color alpha setColorTransform() EVENT DETAIL Event object type: away3d.events.MaterialEvent Dispatched when the bitmapData used for the material texture is resized. CODE EXAMPLES There are currently no examples for this class BitmapMaterialContainer ======================= Package : away3d.materials Class : public class BitmapMaterialContainer Inheritance : BitmapMaterial Implements : ILayerMaterial, ITriangleMaterial, IUpdatingMaterial Subclasses : Dot3BitmapMaterialCache, EnviroBitmapMaterialCache, PhongBitmapMaterialCache, PhongColorMaterialCache 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) cache : Boolean - Defines whether each created bitmapData surface is to be cached, or updated every frame. (BitmapMaterialContainer) (^) 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) (^) height : Number - Returns the height of the bitmapData being used as the material texture. (BitmapMaterial) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (BitmapMaterialContainer) (^) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) (^) repeat : Boolean = false - Determines if texture bitmap will tile in uv-space (BitmapMaterial) (^) smooth : Boolean = false - Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (BitmapMaterial) transparent : Boolean - Defines whether the caching bitmapData objects are transparent (BitmapMaterialContainer) (^) 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 (BitmapMaterialContainer) (^) 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. (BitmapMaterial) (^) 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. (BitmapMaterialContainer) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (BitmapMaterial) (^) renderTriangle(tri:DrawTriangle):void (BitmapMaterial) update():void - Clear and updates the currrent bitmapData surface on all faces. (BitmapMaterialContainer) updateMaterial(source:Object3D, view:View3D):void (BitmapMaterialContainer) PROTECTED METHODS getMapping(tri:DrawTriangle):Matrix - Calculates the mapping matrix required to draw the triangle texture to screen. (BitmapMaterialContainer) (^) setColorTransform():void (BitmapMaterial) updateRenderBitmap():void (BitmapMaterialContainer) EVENTS (^) (BitmapMaterial) PROPERTY DETAIL cache:Boolean[read-write] Defines whether each created bitmapData surface is to be cached, or updated every frame. Updating all bitmapData surface objects is costly, so needs to be used sparingly. Implementation public function get cache():Boolean public function set cache(value:Boolean):void public var materials:Array An array of bitmapmaterial objects to be overlayed sequentially. public var transparent:Boolean Defines whether the caching bitmapData objects are transparent CONSTRUCTOR DETAIL public function BitmapMaterialContainer(width:int, height:int, init:Object = null) Parameters width:int - The containing width of the texture, applied to all child materials. height:int - The containing height of the texture, applied to all child materials. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters materials:Array transparent:Boolean (default = true) cache:Boolean (default = true) METHOD DETAIL protected override function getMapping(tri:DrawTriangle):Matrix Calculates the mapping matrix required to draw the triangle texture to screen. Parameters tri:DrawTriangle - The data object holding all information about the triangle to be drawn. Returns Matrix - The required matrix object. public override 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 update():void Clear and updates the currrent bitmapData surface on all faces. public override function updateMaterial(source:Object3D, view:View3D):void Creates a new BitmapMaterialContainer object. Parameters source:Object3D - The containing width of the texture, applied to all child materials. view:View3D - The containing height of the texture, applied to all child materials. protected override function updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the color and alpha properties. CODE EXAMPLES There are currently no examples for this class BitmapRenderSession =================== Package : away3d.core.render Class : public class BitmapRenderSession Inheritance : AbstractRenderSession 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. (BitmapRenderSession) PUBLIC METHODS (BitmapRenderSession) addDisplayObject(child:DisplayObject):void - Adds a display object to the render session display list. (BitmapRenderSession) addLayerObject(child:Sprite):void - Adds a layer sprite to the render session display list. (BitmapRenderSession) clear():void - Clears the render session. (BitmapRenderSession) clone():AbstractRenderSession - Duplicates the render session's properties to another render session. (BitmapRenderSession) flush():void - Flushes any cached drawing operations to screen. (BitmapRenderSession) getBitmapData(view:View3D):BitmapData - Returns a bitmapData object containing the rendered view. (BitmapRenderSession) getContainer(view:View3D):DisplayObject - Returns a display object representing the container for the specified view. (BitmapRenderSession) (^) 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. (BitmapRenderSession) PROPERTY DETAIL 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 CONSTRUCTOR DETAIL public function BitmapRenderSession(scale:Number = 2) Parameters scale:Number (default = 2) - [optional] Defines the scale of the pixel resolution in base pixels. Default value is 2. METHOD DETAIL public override function addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list. Parameters child:DisplayObject - The display object to add. public override 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 override function clear():void Clears the render session. public override 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 override function createLayer():void Creates a new render layer for rendering composite materials. public override function flush():void Flushes any cached drawing operations to screen. public function getBitmapData(view:View3D):BitmapData Returns a bitmapData object containing the rendered view. Parameters view:View3D - The view object being rendered. Returns BitmapData - The bitmapData object. public override 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. CODE EXAMPLES There are currently no examples for this class Blocker ======= Package : away3d.core.block Class : public class Blocker Inheritance : DrawPrimitive Subclasses : ConvexBlocker Description : Abstract primitive that can block other primitives from drawing PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS block(pri:DrawPrimitive):Boolean - Return value signifies whether the given drawprimitive should be blocked. (Blocker) (^) calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawPrimitive) (^) clear():void - Deletes the data currently held by the drawing primitive. (DrawPrimitive) (^) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawPrimitive) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) (^) render():void - Draws the primitive to the view. (DrawPrimitive) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) METHOD DETAIL public function block(pri:DrawPrimitive):Boolean Return value signifies whether the given drawprimitive should be blocked. Called from the PrimitiveArray object on each blocker in the blockers array. Parameters pri:DrawPrimitive Returns Boolean See also away3d.core.draw.PrimitiveArray CODE EXAMPLES There are currently no examples for this class BlockerArray ============ Package : away3d.core.block Class : public class BlockerArray Implements : IBlockerConsumer Description : Array for storing blocker objects PUBLIC PROPERTIES clip : Clipping - Determines the viewport clipping to be used on blocker primitives. (BlockerArray) PUBLIC METHODS blocker(block:Blocker):void - Adds blocker primitive to the consumer. (BlockerArray) list():Array (BlockerArray) PROPERTY DETAIL clip:Clipping[read-write] Determines the viewport clipping to be used on blocker primitives. Implementation public function get clip():Clipping public function set clip(value:Clipping):void METHOD DETAIL public function blocker(block:Blocker):void Adds blocker primitive to the consumer. Parameters block:Blocker - The blocker primitive to add. public function list():Array Returns a sorted list of blocker primitives for use in BasicRender Returns Array See also away3d.core.render.BasicRender CODE EXAMPLES There are currently no examples for this class BlockerTraverser ================ Package : away3d.core.traverse Class : public class BlockerTraverser Inheritance : Traverser Description : PUBLIC PROPERTIES consumer : IBlockerConsumer - Defines the blocker consumer being used. (BlockerTraverser) view : View3D - Defines the view being used. (BlockerTraverser) PUBLIC METHODS (BlockerTraverser) apply(node:Object3D):void - Executed when the traverser is applied to the node. (BlockerTraverser) (^) enter(node:Object3D):void - Executed when the traverser enters the node. (Traverser) (^) leave(node:Object3D):void - Executed when the traverser leaves the node. (Traverser) match(node:Object3D):Boolean - Determines if the specified node is required to be traversed. (BlockerTraverser) PROPERTY DETAIL public var consumer:IBlockerConsumer Defines the blocker consumer being used. public var view:View3D Defines the view being used. CONSTRUCTOR DETAIL public function BlockerTraverser() METHOD DETAIL public override function apply(node:Object3D):void Executed when the traverser is applied to the node. Parameters node:Object3D public override function match(node:Object3D):Boolean Determines if the specified node is required to be traversed. Parameters node:Object3D - The 3d object to be tested. Returns Boolean - The result of the test. CODE EXAMPLES There are currently no examples for this class Button ====== Package : away3d.test Class : public class Button Inheritance PUBLIC PROPERTIES selected : Boolean = false - (Button) PUBLIC METHODS - (Button) PROPERTY DETAIL public var selected:Boolean = false CONSTRUCTOR DETAIL public function Button(text:String, pwidth:int = 80, pheight:int = 20) Parameters text:String pwidth:int (default = 80) pheight:int (default = 20) CODE EXAMPLES There are currently no examples for this class CacheStore ========== Package : away3d.core.utils Class : public class CacheStore PUBLIC PROPERTIES whiteShadingCache : Dictionary - [static] (CacheStore) PROPERTY DETAIL public static var whiteShadingCache:Dictionary CODE EXAMPLES There are currently no examples for this class Camera3D ======== Package : away3d.cameras Class : public class Camera3D Inheritance : Object3D Subclasses : TargetCamera3D Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) aperture : Number (Camera3D) (^) 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) dof : Boolean (Camera3D) doflevels : Number = 16 (Camera3D) (^) 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) focus : Number - A divisor value for the perspective depth of the view. (Camera3D) (^) inverseSceneTransform : Matrix3D - (Object3D) maxblur : Number = 150 (Camera3D) (^) 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) view : Matrix3D - [read-only] Returns the transformation matrix used to resolve the scene to the view. (Camera3D) (^) 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) zoom : Number - Provides an overall scale value to the view (Camera3D) PROTECTED PROPERTIES (Camera3D) (^) 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):* (Camera3D) disableDof():void (Camera3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) enableDof():void (Camera3D) (^) 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) pan(angle:Number):void - Rotates the camera in its horizontal plane. (Camera3D) (^) pitch(angle:Number):void - Rotates the 3d object around it's local x-axis (Object3D) (^) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (Object3D) (^) 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) screen(object:Object3D, vertex:Vertex = null):ScreenVertex (Camera3D) (^) tick(time:int):void (Object3D) tilt(angle:Number):void - Rotates the camera in its vertical plane. (Camera3D) (^) 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 aperture:Number[read-write] Used in DofSprite2D. Implementation public function get aperture():Number public function set aperture(value:Number):void See also away3d.sprites.DofSprite2D dof:Boolean[read-write] Used in DofSprite2D. Implementation public function get dof():Boolean public function set dof(value:Boolean):void See also away3d.sprites.DofSprite2D public var doflevels:Number = 16 Used in DofSprite2D. See also away3d.sprites.DofSprite2D focus:Number[read-write] A divisor value for the perspective depth of the view. Implementation public function get focus():Number public function set focus(value:Number):void public var maxblur:Number = 150 Used in DofSprite2D. See also away3d.sprites.DofSprite2D view:Matrix3D[read-only] Returns the transformation matrix used to resolve the scene to the view. Used in the ProjectionTraverser class Implementation public function get view():Matrix3D See also away3d.core.traverse.ProjectionTraverser public var zoom:Number Provides an overall scale value to the view CONSTRUCTOR DETAIL public function Camera3D(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters zoom:Number (default = 10) focus:Number (default = 100) aperture:Number (default = 22) maxblur:Number (default = 150) doflevels:Number (default = 16) dof:Boolean (default = false) lookat:Position METHOD DETAIL public override function clone(object:* = null):* Duplicates the camera's properties to another Camera3D 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 disableDof():void Used in DofSprite2D See also away3d.sprites.DofSprite2D public function enableDof():void Used in DofSprite2D. See also away3d.sprites.DofSprite2D public function pan(angle:Number):void Rotates the camera in its horizontal plane. Panning the camera results in a motion similar to someone shaking their head "no". Parameters angle:Number - Angle to pan the camera. public function screen(object:Object3D, vertex:Vertex = null):ScreenVertex Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object. Parameters object:Object3D - The local object for the Vertex. If none exists, use the Scene3D object. vertex:Vertex (default = null) - The vertex to be resolved. Returns ScreenVertex See also away3d.containers.Scene3D public function tilt(angle:Number):void Rotates the camera in its vertical plane. Tilting the camera results in a motion similar to someone nodding their head "yes". Parameters angle:Number - Angle to tilt the camera. CODE EXAMPLES lookAt() an Object camera.lookAt(myObjectA.position); // if mesh it top level object camera.lookAt(myObjectA.worldPosition); // if mesh is in a container Cast ==== Package : away3d.core.utils Class : public class Cast PUBLIC METHODS bitmap(data:*):BitmapData - [static] (Cast) bytearray(data:*):ByteArray - [static] (Cast) color(data:*):uint - [static] (Cast) material(data:*):ITriangleMaterial - [static] (Cast) string(data:*):String - [static] (Cast) tryclass(name:String):Object - [static] (Cast) trycolor(data:*):uint - [static] (Cast) wirematerial(data:*):ISegmentMaterial - [static] (Cast) xml(data:*):XML - [static] (Cast) METHOD DETAIL public static function bitmap(data:*):BitmapData Parameters data:* Returns BitmapData public static function bytearray(data:*):ByteArray Parameters data:* Returns ByteArray public static function color(data:*):uint Parameters data:* Returns uint public static function material(data:*):ITriangleMaterial Parameters data:* Returns ITriangleMaterial public static function string(data:*):String Parameters data:* Returns String public static function tryclass(name:String):Object Parameters name:String Returns Object public static function trycolor(data:*):uint Parameters data:* Returns uint public static function wirematerial(data:*):ISegmentMaterial Parameters data:* Returns ISegmentMaterial public static function xml(data:*):XML Parameters data:* Returns XML CODE EXAMPLES There are currently no examples for this class CastError ========= Package : away3d.core.utils Class : public class CastError Inheritance PUBLIC METHODS - (CastError) CONSTRUCTOR DETAIL public function CastError(message:String) Parameters message:String CODE EXAMPLES There are currently no examples for this class CenterLightingMaterial ====================== Package : away3d.materials Class : public class CenterLightingMaterial Inheritance Implements : ITriangleMaterial, IUpdatingMaterial Subclasses : ShadingColorMaterial, WhiteShadingBitmapMaterial Description : PUBLIC PROPERTIES ak : Number = 20 - Coefficient for shininess level (CenterLightingMaterial) ambient_brightness : Number = 1 - Coefficient for ambient light level (CenterLightingMaterial) diffuse_brightness : Number = 1 - Coefficient for diffuse light level (CenterLightingMaterial) specular_brightness : Number = 1 - Coefficient for specular light level (CenterLightingMaterial) 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. (CenterLightingMaterial) PUBLIC METHODS renderTriangle(tri:DrawTriangle):void (CenterLightingMaterial) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (CenterLightingMaterial) PROPERTY DETAIL public var ak:Number = 20 Coefficient for shininess level public var ambient_brightness:Number = 1 Coefficient for ambient light level public var diffuse_brightness:Number = 1 Coefficient for diffuse light level 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 specular_brightness:Number = 1 Coefficient for specular light level METHOD DETAIL public function renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the DrawTriangle primitive to the render session. Parameters tri:DrawTriangle 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 Clipping ======== Package : away3d.core.clip Class : public class Clipping Subclasses : RectangleClipping Description : PUBLIC PROPERTIES maxX : Number = 1000000 - Maximum allowed x value for primitives (Clipping) maxY : Number = 1000000 - Maximum allowed y value for primitives (Clipping) minX : Number = -1000000 - Minimum allowed x value for primitives (Clipping) minY : Number = -1000000 - Minimum allowed y value for primitives (Clipping) PUBLIC METHODS asRectangleClipping():RectangleClipping - Returns a rectangle clipping object representing the bounding box of the clipping object. (Clipping) check(pri:DrawPrimitive):Boolean - Checks a drawing primitive for clipping. (Clipping) rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean - Checks a bounding rectangle for clipping. (Clipping) screen(container:Sprite):Clipping - Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds. (Clipping) PROPERTY DETAIL public var maxX:Number = 1000000 Maximum allowed x value for primitives public var maxY:Number = 1000000 Maximum allowed y value for primitives public var minX:Number = -1000000 Minimum allowed x value for primitives public var minY:Number = -1000000 Minimum allowed y value for primitives METHOD DETAIL public function asRectangleClipping():RectangleClipping Returns a rectangle clipping object representing the bounding box of the clipping object. Returns RectangleClipping public function check(pri:DrawPrimitive):Boolean Checks a drawing primitive for clipping. Parameters pri:DrawPrimitive - The drawing primitive being checked. Returns Boolean - The clipping result - false for clipped, true for non-clipped. public function rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean Checks a bounding rectangle for clipping. Parameters minX:Number - The x value for the left side of the rectangle. minY:Number - The y value for the top side of the rectangle. maxX:Number - The x value for the right side of the rectangle. maxY:Number - The y value for the bottom side of the rectangle. Returns Boolean - The clipping result - false for clipped, true for non-clipped. public function screen(container:Sprite):Clipping Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds. Parameters container:Sprite Returns Clipping CODE EXAMPLES There are currently no examples for this class Collada ======= Package : away3d.loaders Class : public class Collada PUBLIC PROPERTIES container : ObjectContainer3D - 3d container object used for storing the parsed collada scene. (Collada) containerData : ContainerData - Container data object used for storing the parsed collada data structure. (Collada) materialLibrary : MaterialLibrary - Reference container for all materials used in the collada scene. (Collada) PUBLIC METHODS (Collada) load(url:String, init:Object = null):Object3DLoader - [static] Loads and parses a collada file into a 3d container object. (Collada) loadTextures(data:*, init:Object = null):Object3DLoader - [static] Loads and parses the textures for a collada file into a 3d container object. (Collada) parse(data:*, init:Object = null, loader:Object = null):ObjectContainer3D - [static] Creates a 3d container object from the raw xml data of a collada file. (Collada) PROPERTY DETAIL public var container:ObjectContainer3D 3d container object used for storing the parsed collada scene. public var containerData:ContainerData Container data object used for storing the parsed collada data structure. public var materialLibrary:MaterialLibrary Reference container for all materials used in the collada scene. CONSTRUCTOR DETAIL public function Collada(xml:XML, init:Object = null) Parameters xml:XML - The xml data of a loaded file. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters texturePath:String (default = "") autoLoadTextures:Boolean (default = true) scaling:Number (default = 1) material:Material centerMeshes:Boolean (default = false) materials:Object See also away3d.loaders.Collada.parse() away3d.loaders.Collada.load() METHOD DETAIL public static function load(url:String, init:Object = null):Object3DLoader Loads and parses a collada file into a 3d container 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 loadTextures(data:*, init:Object = null):Object3DLoader Loads and parses the textures for a collada file into a 3d container object. Parameters data:* - The xml data of a loaded file. 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 textures are loading. public static function parse(data:*, init:Object = null, loader:Object = null):ObjectContainer3D Creates a 3d container object from the raw xml data of a collada file. Parameters data:* - The xml data of a loaded file. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. loader:Object (default = null) - [optional] Not intended for direct use. Returns ObjectContainer3D - A 3d container object representation of the collada file. CODE EXAMPLES There are currently no examples for this class CollisionMap ============ Package : away3d.extrusions Class : public class CollisionMap Inheritance PUBLIC PROPERTIES offsetx : Number - [write-only] (CollisionMap) offsety : Number - [write-only] (CollisionMap) PUBLIC METHODS - (CollisionMap) getColorAt(x:Number, y:Number):Number - (CollisionMap) read(x:Number, y:Number):void - (CollisionMap) setColorEvent(color:Number, eventID:String, listener:Function):void - (CollisionMap) PROPERTY DETAIL offsetx:Number[write-only] Implementation public function set offsetx(value:Number):void offsety:Number[write-only] Implementation public function set offsety(value:Number):void CONSTRUCTOR DETAIL public function CollisionMap(source:BitmapData, view:Object, factorX:Number = 0, factorY:Number = 0) Parameters source:BitmapData view:Object factorX:Number (default = 0) factorY:Number (default = 0) METHOD DETAIL public function getColorAt(x:Number, y:Number):Number Parameters x:Number y:Number Returns Number public function read(x:Number, y:Number):void Parameters x:Number y:Number public function setColorEvent(color:Number, eventID:String, listener:Function):void Parameters color:Number eventID:String listener:Function CODE EXAMPLES There are currently no examples for this class Color ===== Package : away3d.core.utils Class : public class Color PUBLIC METHODS add(colora:int, colorb:int):int - [static] (Color) fromFloats(red:Number, green:Number, blue:Number):int - [static] (Color) fromHSV(hue:Number, saturation:Number, value:Number):int - [static] (Color) fromInts(red:int, green:int, blue:int):int - [static] (Color) fromIntsCheck(red:int, green:int, blue:int):int - [static] (Color) inverseAdd(colora:int, colorb:int):int - [static] (Color) multiply(color:int, k:Number):int - [static] (Color) PUBLIC CONSTANTS black : int = 0x000000 - [static] (Color) blue : int = 0x0000FF - [static] (Color) cyan : int = 0x00FFFF - [static] (Color) green : int = 0x00FF00 - [static] (Color) purple : int = 0xFF00FF - [static] (Color) red : int = 0xFF0000 - [static] (Color) white : int = 0xFFFFFF - [static] (Color) yellow : int = 0xFFFF00 - [static] (Color) METHOD DETAIL public static function add(colora:int, colorb:int):int Parameters colora:int colorb:int Returns int public static function fromFloats(red:Number, green:Number, blue:Number):int Parameters red:Number green:Number blue:Number Returns int public static function fromHSV(hue:Number, saturation:Number, value:Number):int Parameters hue:Number saturation:Number value:Number Returns int public static function fromInts(red:int, green:int, blue:int):int Parameters red:int green:int blue:int Returns int public static function fromIntsCheck(red:int, green:int, blue:int):int Parameters red:int green:int blue:int Returns int public static function inverseAdd(colora:int, colorb:int):int Parameters colora:int colorb:int Returns int public static function multiply(color:int, k:Number):int Parameters color:int k:Number Returns int CONSTANT DETAIL public static const black:int = 0x000000 public static const blue:int = 0x0000FF public static const cyan:int = 0x00FFFF public static const green:int = 0x00FF00 public static const purple:int = 0xFF00FF public static const red:int = 0xFF0000 public static const white:int = 0xFFFFFF public static const yellow:int = 0xFFFF00 CODE EXAMPLES There are currently no examples for this class ColorMaterial ============= Package : away3d.materials Class : public class ColorMaterial Implements : IFogMaterial, ITriangleMaterial Description : Material for solid color drawing PUBLIC PROPERTIES alpha : Number - Determines the alpha value of the material (ColorMaterial) color : uint - 24 bit color value representing the material color (ColorMaterial) visible : Boolean - [read-only] Indicates whether the material is visible (ColorMaterial) 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. (ColorMaterial) PUBLIC METHODS (ColorMaterial) clone():IFogMaterial (ColorMaterial) renderFog(fog:DrawFog):void - Sends the material data coupled with data from the DrawFog primitive to the render session (ColorMaterial) renderTriangle(tri:DrawTriangle):void (ColorMaterial) PROPERTY DETAIL alpha:Number[read-write] Determines the alpha value of the material Implementation public function get alpha():Number public function set alpha(value:Number):void public var color:uint 24 bit color value representing the material color 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. visible:Boolean[read-only] Indicates whether the material is visible Implementation public function get visible():Boolean CONSTRUCTOR DETAIL public function ColorMaterial(color:* = null, init:Object = null) Parameters color:* (default = null) - A string, hex value or colorname representing the color of the material. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters alpha:Number (default = 1, min:0, max:1) METHOD DETAIL public function clone():IFogMaterial Duplicates the material's properties to another IFogMaterial object Returns IFogMaterial - The new object instance with duplicated properties applied public function renderFog(fog:DrawFog):void Sends the material data coupled with data from the DrawFog primitive to the render session Parameters fog:DrawFog public function renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the DrawTriangle primitive to the render session. Parameters tri:DrawTriangle CODE EXAMPLES There are currently no examples for this class CompositeMaterial ================= Package : away3d.materials Class : public class CompositeMaterial Implements : ILayerMaterial, ITriangleMaterial, IUpdatingMaterial Subclasses : Dot3BitmapMaterial, Dot3MovieMaterial, EnviroBitmapMaterial, PhongBitmapMaterial, PhongColorMaterial, PhongMovieMaterial Description : PUBLIC PROPERTIES alpha : Number - Defines an alpha value for the layer container. (CompositeMaterial) blendMode : String - Defines a blendMode value for the layer container. (CompositeMaterial) color : uint - Defines a colored tint for the layer container. (CompositeMaterial) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (CompositeMaterial) visible : Boolean - [read-only] Indicates whether the material is visible (CompositeMaterial) 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. (CompositeMaterial) PUBLIC METHODS (CompositeMaterial) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (CompositeMaterial) renderTriangle(tri:DrawTriangle):void (CompositeMaterial) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (CompositeMaterial) PROTECTED METHODS setColorTransform():void (CompositeMaterial) PROPERTY DETAIL alpha:Number[read-write] Defines an alpha value for the layer container. Implementation public function get alpha():Number public function set alpha(value:Number):void public var blendMode:String Defines a blendMode value for the layer container. color:uint[read-write] Defines a colored tint for the layer container. Implementation public function get color():uint public function set color(value:uint):void 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 materials:Array An array of bitmapmaterial objects to be overlayed sequentially. visible:Boolean[read-only] Indicates whether the material is visible Implementation public function get visible():Boolean CONSTRUCTOR DETAIL public function CompositeMaterial(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters materials:Array blendMode:String (default = BlendMode.NORMAL) alpha:Number (default = 1, min:0, max:1) color:Color (default = 0xFFFFFF) METHOD DETAIL 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. public function renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the DrawTriangle primitive to the render session. Parameters tri:DrawTriangle protected function setColorTransform():void Updates the colortransform object applied to the texture from the color and alpha properties. See also color alpha 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 Cone ==== Package : away3d.primitives Class : public class Cone Inheritance : AbstractPrimitive, 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) (^) 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) height : Number - Defines the height of the cone. (Cone) (^) 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) openEnded : Boolean - Defines whether the end of the cone is left open (true) or closed (false). (Cone) (^) 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) radius : Number - Defines the radius of the cone base. (Cone) (^) 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) segmentsH : Number - Defines the number of vertical segments that make up the cone. (Cone) segmentsW : Number - Defines the number of horizontal segments that make up the cone. (Cone) (^) 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) yUp : Boolean - Defines whether the coordinates of the cone points use a yUp orientation (true) or a zUp orientation (false). (Cone) (^) z : Number (Object3D) PROTECTED PROPERTIES (Cone) (^) 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. (Cone) (^) 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) vertex(w:int, h:int):Vertex - Returns the vertex object specified by the grid position of the mesh. (Cone) (^) 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 height:Number[read-write] Defines the height of the cone. Defaults to 200. Implementation public function get height():Number public function set height(value:Number):void openEnded:Boolean[read-write] Defines whether the end of the cone is left open (true) or closed (false). Defaults to false. Implementation public function get openEnded():Boolean public function set openEnded(value:Boolean):void radius:Number[read-write] Defines the radius of the cone base. Defaults to 100. Implementation public function get radius():Number public function set radius(value:Number):void segmentsH:Number[read-write] Defines the number of vertical segments that make up the cone. Defaults to 1. Implementation public function get segmentsH():Number public function set segmentsH(value:Number):void segmentsW:Number[read-write] Defines the number of horizontal segments that make up the cone. Defaults to 8. Implementation public function get segmentsW():Number public function set segmentsW(value:Number):void yUp:Boolean[read-write] Defines whether the coordinates of the cone points use a yUp orientation (true) or a zUp orientation (false). Defaults to true. Implementation public function get yUp():Boolean public function set yUp(value:Boolean):void CONSTRUCTOR DETAIL public function Cone(init:Object = null) Cone constructor takes an init object has a single parameter. The init object can define the 'radius' of the base of the cone, 'height' the height, 'segmentsW' the number of segments around the cone horizontally and 'segmentsH' the number of segments vertically. Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters radius:Number (default = 100, min:0) height:Number (default = 200, min:0) segmentsW:Int (default = 8, min:3) segmentsH:Int (default = 1, min:1) openEnded:Boolean (default = false) yUp:Boolean (default = true) METHOD DETAIL public override function buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive. public function vertex(w:int, h:int):Vertex Returns the vertex from a 2 dimensional representation of the cone's vertex array. I=horizontal reference. J=vertical reference (0 = base of the cone) Returns the vertex object specified by the grid position of the mesh. Parameters w:int - The horizontal position on the primitive mesh. h:int - The vertical position on the primitive mesh. Returns Vertex CODE EXAMPLES Cone Creation // Cone var cone1:Cone = new Cone({name:"Cone1", x:-250, segmentsH:5, segmentsW:20, height:250, material:new WireframeMaterial(0xff000000)}); var cone2:Cone = new Cone({name:"Cone2", x:0, radius:50, material:new ShadingColorMaterial({color:0xaa0000})}); var cone3:Cone = new Cone({name:"Cone3", x:250, segmentsH:10, segmentsW:20, material:new PreciseBitmapMaterial(textureImage)}); var coneContainer:ObjectContainer3D = new ObjectContainer3D({name:"Cone", visible:true}, cone1, cone2, cone3); view.scene.addChild(coneContainer); Source Files : http://www.geepers.oxyuk.net/software/objectexamples.html Simple object creation tutorial ContainerData ============= Package : away3d.loaders.data Class : public class ContainerData Inheritance : ObjectData Description : PUBLIC PROPERTIES children : Array - An array containing the child 3d objects of the container. (ContainerData) (^) name : String - The name of the 3d object used as a unique reference. (ObjectData) (^) transform : Matrix3D - The 3d transformation matrix for the 3d object (ObjectData) PROPERTY DETAIL public var children:Array An array containing the child 3d objects of the container. CODE EXAMPLES There are currently no examples for this class ConvexBlock =========== Package : away3d.blockers Class : public class ConvexBlock Inheritance : Object3D Implements : IBlockerProvider, IPrimitiveProvider 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 (Object3D) debug : Boolean - Toggles debug mode: blocker is visualised in the scene. (ConvexBlock) (^) 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) vertices : Array - Verticies to use for calculating the convex hull. (ConvexBlock) (^) 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 (ConvexBlock) (^) 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) blockers(consumer:IBlockerConsumer):void (ConvexBlock) (^) 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) (^) 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 (ConvexBlock) (^) 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 public var debug:Boolean Toggles debug mode: blocker is visualised in the scene. public var vertices:Array Verticies to use for calculating the convex hull. CONSTRUCTOR DETAIL public function ConvexBlock(vertices:Array, init:Object = null) Parameters vertices:Array - An Array of vertices to use for calculating the convex hull. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters debug:Boolean (default = false) METHOD DETAIL public function blockers(consumer:IBlockerConsumer):void Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object Parameters consumer:IBlockerConsumer - The consumer instance See also away3d.core.traverse.BlockerTraverser away3d.core.block.Blocker 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 CODE EXAMPLES There are currently no examples for this class ConvexBlocker ============= Package : away3d.core.block Class : public class ConvexBlocker Inheritance : Blocker, DrawPrimitive Description : PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) vertices : Array - Defines the vertices used to calulate the convex hull. (ConvexBlocker) PUBLIC METHODS block(pri:DrawPrimitive):Boolean - Return value signifies whether the given drawprimitive should be blocked. (ConvexBlocker) calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (ConvexBlocker) (^) clear():void - Deletes the data currently held by the drawing primitive. (DrawPrimitive) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (ConvexBlocker) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (ConvexBlocker) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var vertices:Array Defines the vertices used to calulate the convex hull. METHOD DETAIL public override function block(pri:DrawPrimitive):Boolean Return value signifies whether the given drawprimitive should be blocked. Called from the PrimitiveArray object on each blocker in the blockers array. Parameters pri:DrawPrimitive Returns Boolean public override function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public override function render():void Draws the primitive to the view. CODE EXAMPLES There are currently no examples for this class Cube ==== Package : away3d.primitives Class : public class Cube Inheritance : AbstractPrimitive, Mesh, BaseMesh, Object3D Subclasses : LogoCube 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) cubeMaterials : CubeMaterialsData - Defines the face materials of the cube. (Cube) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Mesh) depth : Number - Defines the depth of the cube. (Cube) (^) 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) height : Number - Defines the height of the cube. (Cube) (^) 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) width : Number - Defines the width of the cube. (Cube) (^) x : Number (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (Cube) (^) 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. (Cube) (^) 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 cubeMaterials:CubeMaterialsData[read-write] Defines the face materials of the cube. Implementation public function get cubeMaterials():CubeMaterialsData public function set cubeMaterials(value:CubeMaterialsData):void depth:Number[read-write] Defines the depth of the cube. Defaults to 100. Implementation public function get depth():Number public function set depth(value:Number):void height:Number[read-write] Defines the height of the cube. Defaults to 100. Implementation public function get height():Number public function set height(value:Number):void width:Number[read-write] Defines the width of the cube. Defaults to 100. Implementation public function get width():Number public function set width(value:Number):void CONSTRUCTOR DETAIL public function Cube(init:Object = null) Constructor for a cube object. The init object parameters are : 'size' defines all the dimensions of the cube unless overridden, 'width'/'height'/'depth' explicit dimensions for the cube and 'faces' which itself is an init object. The 'faces' object takes the following parameters as materials : 'left', 'right', 'bottom', 'top', 'front' and 'back'. Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters width:Number (default = 100, min:0) height:Number (default = 100, min:0) depth:Number (default = 100, min:0) faces:CubeMaterials cubeMaterials:CubeMaterials METHOD DETAIL public override function buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive. CODE EXAMPLES *Lesson_Basic_02_Primitives.fla // import core library import away3d.core.scene.*; // import geometry primitives import away3d.objects.*; // create a 3D-viewport var view:View3D = new View3D({x:300, y:200}); addChild(view); // create primitives var plane:Object3D = new Plane({material:"yellow#", name:"plane", y:-100, width:1000, height:1000, pushback:true}); var sphere:Object3D = new Sphere({material:"red#", name:"sphere", x: 300, y:160, z: 300, radius:150, segmentsW:12, segmentsH:9}); var cube:Object3D = new Cube({material:"blue#", name:"cube", x: 300, y:160, z: -80, width:200, height:200, depth:200}); var torus:Object3D = new Torus({material:"limegreen#", name:"torus", x:-250, y:160, z:-250, radius:150, tube:60, segmentsR:8, segmentsT:6}); // add primitives to the scene view.scene.addChildren(sphere, cube, plane, torus); // set camera in space view.camera.moveTo(torus.position); view.camera.lookAt(cube.position); view.camera.moveBackward(1500); view.camera.moveUp(1500); view.camera.lookAt(plane.position); // every frame addEventListener(Event.ENTER_FRAME, onEnterFrame); function onEnterFrame(event:Event):void { // rerender viewport on each frame view.render(); } From Lesson_Basic_02_Primitives.fla CubeLoader ========== Package : away3d.loaders Class : public class CubeLoader Inheritance : ObjectContainer3D, Object3D Description : d content 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 (ObjectContainer3D) (^) children : Array - Returns the children of the container as an array of 3d objects (ObjectContainer3D) (^) containerData : ContainerData - Returns the the data container being used by the loaded file. (Object3DLoader) (^) 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) (^) handle : Object3D - Returns a 3d object relating to the currently visible model. (Object3DLoader) (^) inverseSceneTransform : Matrix3D - (Object3D) (^) materialLibrary : MaterialLibrary - Returns the material library being used by the loaded file. (Object3DLoader) (^) maxX : Number - Returns the maximum x value of the 3d object (ObjectContainer3D) (^) maxY : Number - Returns the maximum y value of the 3d object (ObjectContainer3D) (^) maxZ : Number - Returns the maximum z value of the 3d object (ObjectContainer3D) (^) minX : Number - Returns the minimum x value of the 3d object (ObjectContainer3D) (^) minY : Number - Returns the minimum y value of the 3d object (ObjectContainer3D) (^) minZ : Number - Returns the minimum z value of the 3d object (ObjectContainer3D) (^) mode : String - Returns the current loading mode of the 3d object loader. (Object3DLoader) (^) 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) (^) parse : Function - Function placeholder for the parse method from the correct file loader class. (Object3DLoader) (^) 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) (^) texturePath : String - Returns the filepath to the directory where any required texture files are located. (Object3DLoader) (^) transform : Matrix3D (Object3D) (^) url : String - Returns the url string of the file being loaded. (Object3DLoader) (^) 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 (CubeLoader) (^) addChild(child:Object3D):void - Adds a 3d object to the scene as a child of the container (ObjectContainer3D) (^) addChildren(... childarray):void - Adds an array of 3d objects to the scene as children of the container (ObjectContainer3D) (^) addOnDimensionsChange(listener:Function):void - Default method for adding a dimensionschanged event listener (Object3D) (^) addOnError(listener:Function):void - Default method for adding a loaderror event listener (Object3DLoader) (^) 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) (^) addOnSuccess(listener:Function):void - Default method for adding a loadsuccess event listener (Object3DLoader) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) clone(object:* = null):* (ObjectContainer3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) getChildByName(name:String):Object3D - Returns a 3d object specified by name from the child array of the container (ObjectContainer3D) (^) 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 3d object without moving the contents (ObjectContainer3D) (^) 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 (Object3D) (^) removeChild(child:Object3D):void - Removes a 3d object from the child array of the container (ObjectContainer3D) (^) removeChildByName(name:String):void - Removes a 3d object from the child array of the container (ObjectContainer3D) (^) removeOnDimensionsChange(listener:Function):void - Default method for removing a dimensionschanged event listener (Object3D) (^) removeOnError(listener:Function):void - Default method for removing a loaderror event listener (Object3DLoader) (^) 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) (^) removeOnSuccess(listener:Function):void - Default method for removing a loadsuccess event listener (Object3DLoader) (^) 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. (ObjectContainer3D) (^) 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 (ObjectContainer3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) onComplete(event:Event):void - Automatically fired on a complete event (Object3DLoader) onError(event:IOErrorEvent):void - Listener function for an error event. (CubeLoader) onProgress(event:ProgressEvent):void - Listener function for a progress event. (CubeLoader) EVENTS (^) (Object3D) (^) (Object3DLoader) (^) (Object3DLoader) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) PUBLIC CONSTANTS CONSTRUCTOR DETAIL public function CubeLoader(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters loadersize:Number (default = 200) geometrytitle:String (default = "Loading Geometry...") texturetitle:String (default = "Loading Texture...") METHOD DETAIL protected override function onError(event:IOErrorEvent):void Listener function for an error event. Parameters event:IOErrorEvent protected override function onProgress(event:ProgressEvent):void Listener function for a progress event. Parameters event:ProgressEvent CODE EXAMPLES There are currently no examples for this class CubeMaterialsData ================= Package : away3d.primitives.data Class : public class CubeMaterialsData Inheritance PUBLIC PROPERTIES : ITriangleMaterial back : ITriangleMaterial Description : - Defines the material applied to the back side of the cube. (CubeMaterialsData) bottom : ITriangleMaterial - Defines the material applied to the bottom side of the cube. (CubeMaterialsData) front : ITriangleMaterial - Defines the material applied to the front side of the cube. (CubeMaterialsData) left : ITriangleMaterial - Defines the material applied to the left side of the cube. (CubeMaterialsData) right : ITriangleMaterial - Defines the material applied to the right side of the cube. (CubeMaterialsData) top : ITriangleMaterial - Defines the material applied to the top side of the cube. (CubeMaterialsData) 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. (CubeMaterialsData) PUBLIC METHODS (CubeMaterialsData) addOnMaterialChange(listener:Function):void - Default method for adding a materialchanged event listener (CubeMaterialsData) removeOnMaterialChange(listener:Function):void - Default method for removing a materialchanged event listener (CubeMaterialsData) EVENTS (CubeMaterialsData) PROPERTY DETAIL back:ITriangleMaterial[read-write] Defines the material applied to the back side of the cube. Implementation public function get back():ITriangleMaterial public function set back(value:ITriangleMaterial):void bottom:ITriangleMaterial[read-write] Defines the material applied to the bottom side of the cube. Implementation public function get bottom():ITriangleMaterial public function set bottom(value:ITriangleMaterial):void front:ITriangleMaterial[read-write] Defines the material applied to the front side of the cube. Implementation public function get front():ITriangleMaterial public function set front(value:ITriangleMaterial):void 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. left:ITriangleMaterial[read-write] Defines the material applied to the left side of the cube. Implementation public function get left():ITriangleMaterial public function set left(value:ITriangleMaterial):void right:ITriangleMaterial[read-write] Defines the material applied to the right side of the cube. Implementation public function get right():ITriangleMaterial public function set right(value:ITriangleMaterial):void top:ITriangleMaterial[read-write] Defines the material applied to the top side of the cube. Implementation public function get top():ITriangleMaterial public function set top(value:ITriangleMaterial):void CONSTRUCTOR DETAIL public function CubeMaterialsData(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters left:Material right:Material bottom:Material top:Material front:Material back:Material METHOD DETAIL public function addOnMaterialChange(listener:Function):void Default method for adding a materialchanged event listener Parameters listener:Function - The listener function public function removeOnMaterialChange(listener:Function):void Default method for removing a materialchanged event listener Parameters listener:Function - The listener function EVENT DETAIL Event object type: away3d.events.MaterialEvent Dispatched when the cube materials object has one of it's materials updated. CODE EXAMPLES There are currently no examples for this class Cylinder ======== Package : away3d.primitives Class : public class Cylinder Inheritance : AbstractPrimitive, 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) (^) 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) height : Number - Defines the height of the cylinder. (Cylinder) (^) 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) openEnded : Boolean - Defines whether the ends of the cylinder are left open (true) or closed (false). (Cylinder) (^) 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) radius : Number - Defines the radius of the cylinder. (Cylinder) (^) 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) segmentsH : Number - Defines the number of vertical segments that make up the cylinder. (Cylinder) segmentsW : Number - Defines the number of horizontal segments that make up the cylinder. (Cylinder) (^) 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) yUp : Boolean - Defines whether the coordinates of the cylinder points use a yUp orientation (true) or a zUp orientation (false). (Cylinder) (^) z : Number (Object3D) PROTECTED PROPERTIES (Cylinder) (^) 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. (Cylinder) (^) 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) vertex(w:int, h:int):Vertex - Returns the vertex object specified by the grid position of the mesh. (Cylinder) (^) 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 height:Number[read-write] Defines the height of the cylinder. Defaults to 200. Implementation public function get height():Number public function set height(value:Number):void openEnded:Boolean[read-write] Defines whether the ends of the cylinder are left open (true) or closed (false). Defaults to false. Implementation public function get openEnded():Boolean public function set openEnded(value:Boolean):void radius:Number[read-write] Defines the radius of the cylinder. Defaults to 100. Implementation public function get radius():Number public function set radius(value:Number):void segmentsH:Number[read-write] Defines the number of vertical segments that make up the cylinder. Defaults to 1. Implementation public function get segmentsH():Number public function set segmentsH(value:Number):void segmentsW:Number[read-write] Defines the number of horizontal segments that make up the cylinder. Defaults to 8. Implementation public function get segmentsW():Number public function set segmentsW(value:Number):void yUp:Boolean[read-write] Defines whether the coordinates of the cylinder points use a yUp orientation (true) or a zUp orientation (false). Defaults to true. Implementation public function get yUp():Boolean public function set yUp(value:Boolean):void CONSTRUCTOR DETAIL public function Cylinder(init:Object = null) Constructor for a cylinder object. The init object parameters are : 'radius' defines the radius of the cylinder, 'height' defines the height, 'segmentsW' defines how many segments are the circumference is split into and 'segmentsH' how many segments the cylinder is split along its height. Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters radius:Number (default = 100, min:0) height:Number (default = 200, min:0) segmentsW:Int (default = 8, min:3) segmentsH:Int (default = 1, min:1) openEnded:Boolean (default = false) yUp:Boolean (default = true) METHOD DETAIL public override function buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive. public function vertex(w:int, h:int):Vertex Returns the vertex from a 2 dimensional representation of the cylinders's vertex array. I=horizontal reference. J=vertical reference (0 = base of the cylinder) Returns the vertex object specified by the grid position of the mesh. Parameters w:int - The horizontal position on the primitive mesh. h:int - The vertical position on the primitive mesh. Returns Vertex CODE EXAMPLES Creating Elliptical cylinder //add this in Cylinder class constructor var radiusW:Number = init.getNumber("radiusW", radius, {min:0}); var radiusH:Number = init.getNumber("radiusH", radius, {min:0}); //replace the radius property with radiusW and radiusH in the buildCylinder method parameters for (i = 0; i < segmentsW; i++) { var verangle:Number = 2 * i / segmentsW * Math.PI; var x:Number = radiusH * Math.sin(verangle); var y:Number = radiusW * Math.cos(verangle); grid[j][i] = new Vertex(y, z, x); } Debug ===== Package : away3d.core.utils Class : public class Debug PUBLIC PROPERTIES active : Boolean = false - [static] (Debug) warningsAsErrors : Boolean = false - [static] (Debug) PUBLIC METHODS clear():void - [static] (Debug) delimiter():void - [static] (Debug) error(message:Object):void - [static] (Debug) trace(message:Object):void - [static] (Debug) warning(message:Object):void - [static] (Debug) PROPERTY DETAIL public static var active:Boolean = false public static var warningsAsErrors:Boolean = false METHOD DETAIL public static function clear():void public static function delimiter():void public static function error(message:Object):void Parameters message:Object public static function trace(message:Object):void Parameters message:Object public static function warning(message:Object):void Parameters message:Object CODE EXAMPLES There are currently no examples for this class DebugObjectContainer3D ====================== Package : away3d.containers Class : public class DebugObjectContainer3D Inheritance : Object3D Implements : IPrimitiveProvider 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 (ObjectContainer3D) (^) children : Array - Returns the children of the container as an array of 3d objects (ObjectContainer3D) debugbb : Boolean = false - defines whether a bounding box for the child 3d objects is displayed (DebugObjectContainer3D) debugbs : Boolean = false - defines whether a bounding sphere for the child 3d objects is displayed (DebugObjectContainer3D) (^) 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 (ObjectContainer3D) (^) maxY : Number - Returns the maximum y value of the 3d object (ObjectContainer3D) (^) maxZ : Number - Returns the maximum z value of the 3d object (ObjectContainer3D) (^) minX : Number - Returns the minimum x value of the 3d object (ObjectContainer3D) (^) minY : Number - Returns the minimum y value of the 3d object (ObjectContainer3D) (^) minZ : Number - Returns the minimum z value of the 3d object (ObjectContainer3D) (^) 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 (DebugObjectContainer3D) (^) addChild(child:Object3D):void - Adds a 3d object to the scene as a child of the container (ObjectContainer3D) (^) addChildren(... childarray):void - Adds an array of 3d objects to the scene as children of the container (ObjectContainer3D) (^) 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):* (ObjectContainer3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) getChildByName(name:String):Object3D - Returns a 3d object specified by name from the child array of the container (ObjectContainer3D) (^) 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 3d object without moving the contents (ObjectContainer3D) (^) 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 (DebugObjectContainer3D) (^) removeChild(child:Object3D):void - Removes a 3d object from the child array of the container (ObjectContainer3D) (^) removeChildByName(name:String):void - Removes a 3d object from the child array of the container (ObjectContainer3D) (^) 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. (ObjectContainer3D) (^) 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 (ObjectContainer3D) (^) 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 public var debugbb:Boolean = false defines whether a bounding box for the child 3d objects is displayed public var debugbs:Boolean = false defines whether a bounding sphere for the child 3d objects is displayed CONSTRUCTOR DETAIL public function DebugObjectContainer3D(init:Object = null, ... childarray) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties ... childarray - An array of children to be added on instatiation METHOD DETAIL 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 CODE EXAMPLES There are currently no examples for this class DiffuseDot3Shader ================= Package : away3d.materials.shaders Class : public class DiffuseDot3Shader Inheritance : AbstractShader Implements : IUVMaterial Description : PUBLIC PROPERTIES bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the shader DOT3 map. (DiffuseDot3Shader) (^) 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) height : Number - [read-only] Returns the height of the bitmapData being used as the shader DOT3 map. (DiffuseDot3Shader) (^) smooth : Boolean - Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen (AbstractShader) tangentSpace : Boolean - Determines if the DOT3 mapping is rendered in tangent space (true) or object space (false). (DiffuseDot3Shader) (^) visible : Boolean - Indicates whether the material is visible (AbstractShader) width : Number - [read-only] Returns the width of the bitmapData being used as the shader DOT3 map. (DiffuseDot3Shader) PROTECTED PROPERTIES (DiffuseDot3Shader) addOnResize(listener:Function):void - Default method for adding a materialresize event listener (DiffuseDot3Shader) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (DiffuseDot3Shader) removeOnResize(listener:Function):void - Default method for removing a materialresize event listener (DiffuseDot3Shader) (^) 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. (DiffuseDot3Shader) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (DiffuseDot3Shader) PROTECTED METHODS clearFaceDictionary(source:Object3D, view:View3D):void - Clears face value objects when shader requires updating (DiffuseDot3Shader) (^) 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. (DiffuseDot3Shader) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the shader DOT3 map. Implementation public function get bitmap():BitmapData height:Number[read-only] Returns the height of the bitmapData being used as the shader DOT3 map. Implementation public function get height():Number public var tangentSpace:Boolean Determines if the DOT3 mapping is rendered in tangent space (true) or object space (false). width:Number[read-only] Returns the width of the bitmapData being used as the shader DOT3 map. Implementation public function get width():Number CONSTRUCTOR DETAIL public function DiffuseDot3Shader(bitmap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's DOT3 map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters tangentSpace:Boolean (default = false) METHOD DETAIL public function addOnResize(listener:Function):void Default method for adding a materialresize event listener Parameters listener:Function - The listener function 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 function getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate. Parameters u:Number - The u (horizontal) texture coordinate. v:Number - The v (verical) texture coordinate. Returns uint - The argb pixel value. public function removeOnResize(listener:Function):void Default method for removing a materialresize event listener Parameters listener:Function - The listener function 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 DiffusePhongShader ================== Package : away3d.materials.shaders Class : public class DiffusePhongShader Inheritance : AbstractShader 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 - Indicates whether the material is visible (AbstractShader) PROTECTED PROPERTIES (DiffusePhongShader) (^) 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. (DiffusePhongShader) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (DiffusePhongShader) PROTECTED METHODS clearFaceDictionary(source:Object3D, view:View3D):void - Clears face value objects when shader requires updating (DiffusePhongShader) (^) 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. (DiffusePhongShader) CONSTRUCTOR DETAIL public function DiffusePhongShader(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 DirectionalLight ================ Package : away3d.core.light Class : public class DirectionalLight Inheritance : LightPrimitive Description : 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) ambientDiffuseColorTransform : ColorTransform - Color transform used in cached shading materials for combined ambient and diffuse color intensities. (DirectionalLight) (^) blue : Number - Blue component level. (LightPrimitive) colorMatrixTransform : Dictionary - Colormatrix transform used in DOT3 materials for resolving color in the normal map. (DirectionalLight) (^) diffuse : Number - Coefficient for the diffuse light intensity. (LightPrimitive) (^) diffuseBitmap : BitmapData - Lightmap for diffuse intensity. (LightPrimitive) diffuseColorTransform : ColorTransform - Color transform used in cached shading materials for ambient intensities. (DirectionalLight) diffuseTransform : Dictionary - Transform dictionary for the diffuse lightmap used by shading materials. (DirectionalLight) (^) green : Number - Green component level. (LightPrimitive) light : DirectionalLight3D (DirectionalLight) normalMatrixTransform : Dictionary - Colormatrix transform used in DOT3 materials for resolving normal values in the normal map. (DirectionalLight) (^) red : Number - Red component level. (LightPrimitive) (^) specular : Number - Coefficient for the specular light intensity. (LightPrimitive) (^) specularBitmap : BitmapData - Lightmap for specular intensity. (LightPrimitive) specularTransform : Dictionary - Transform dictionary for the specular lightmap used by shading materials. (DirectionalLight) PUBLIC METHODS clearTransform():void - Clears the transform and matrix dictionaries used in the shading materials. (DirectionalLight) setColorMatrixTransform(source:Object3D):void - Updates the color transform matrix. (DirectionalLight) setDiffuseTransform(source:Object3D):void - Updates the transform matrix for the diffuse lightmap. (DirectionalLight) setNormalMatrixTransform(source:Object3D):void - Updates the normal transform matrix. (DirectionalLight) setSpecularTransform(source:Object3D, view:View3D):void - Updates the transform matrix for the specular lightmap. (DirectionalLight) updateAmbientBitmap(ambient:Number):void - Updates the bitmapData object used as the lightmap for ambient light shading. (DirectionalLight) updateAmbientDiffuseBitmap(ambient:Number, diffuse:Number):void - Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading. (DirectionalLight) updateDiffuseBitmap(diffuse:Number):void - Updates the bitmapData object used as the lightmap for diffuse light shading. (DirectionalLight) updateDirection(e:Object3DEvent):void - Updates the direction vector of the directional light. (DirectionalLight) updateSpecularBitmap(specular:Number):void - Updates the bitmapData object used as the lightmap for specular light shading. (DirectionalLight) PROPERTY DETAIL public var ambientDiffuseColorTransform:ColorTransform Color transform used in cached shading materials for combined ambient and diffuse color intensities. public var colorMatrixTransform:Dictionary Colormatrix transform used in DOT3 materials for resolving color in the normal map. public var diffuseColorTransform:ColorTransform Color transform used in cached shading materials for ambient intensities. public var diffuseTransform:Dictionary Transform dictionary for the diffuse lightmap used by shading materials. public var light:DirectionalLight3D A reference to the DirectionalLight3D object used by the light primitive. public var normalMatrixTransform:Dictionary Colormatrix transform used in DOT3 materials for resolving normal values in the normal map. public var specularTransform:Dictionary Transform dictionary for the specular lightmap used by shading materials. METHOD DETAIL public function clearTransform():void Clears the transform and matrix dictionaries used in the shading materials. public function setColorMatrixTransform(source:Object3D):void Updates the color transform matrix. Parameters source:Object3D See also colorMatrixTransform public function setDiffuseTransform(source:Object3D):void Updates the transform matrix for the diffuse lightmap. Parameters source:Object3D See also diffuseTransform public function setNormalMatrixTransform(source:Object3D):void Updates the normal transform matrix. Parameters source:Object3D See also normalMatrixTransform public function setSpecularTransform(source:Object3D, view:View3D):void Updates the transform matrix for the specular lightmap. Parameters source:Object3D view:View3D See also specularTransform 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. public function updateAmbientDiffuseBitmap(ambient:Number, diffuse:Number):void Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading. Parameters ambient:Number - The coefficient for ambient light intensity. diffuse:Number - The coefficient for diffuse light intensity. public function updateDiffuseBitmap(diffuse:Number):void Updates the bitmapData object used as the lightmap for diffuse light shading. Parameters diffuse:Number - The coefficient for diffuse light intensity. public function updateDirection(e:Object3DEvent):void Updates the direction vector of the directional light. Parameters e:Object3DEvent public function updateSpecularBitmap(specular:Number):void Updates the bitmapData object used as the lightmap for specular light shading. Parameters specular:Number - The coefficient for specular light intensity. CODE EXAMPLES There are currently no examples for this class DirectionalLight3D ================== Package : away3d.lights Class : public class DirectionalLight3D Inheritance : Object3D Implements : IClonable, ILightProvider, IPrimitiveProvider Description : 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. (DirectionalLight3D) (^) 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) brightness : Number - Defines a coefficient for the overall light intensity. (DirectionalLight3D) color : int - Defines the color of the light object. (DirectionalLight3D) debug : Boolean - Toggles debug mode: light object is visualised in the scene. (DirectionalLight3D) diffuse : Number - Defines a coefficient for the diffuse light intensity. (DirectionalLight3D) (^) 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) specular : Number - Defines a coefficient for the specular light intensity. (DirectionalLight3D) (^) 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 (DirectionalLight3D) (^) 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):* (DirectionalLight3D) (^) 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 (DirectionalLight3D) (^) 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 (DirectionalLight3D) (^) 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 brightness:Number[read-write] Defines a coefficient for the overall light intensity. Implementation public function get brightness():Number public function set brightness(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. diffuse:Number[read-write] Defines a coefficient for the diffuse light intensity. Implementation public function get diffuse():Number public function set diffuse(value:Number):void specular:Number[read-write] Defines a coefficient for the specular light intensity. Implementation public function get specular():Number public function set specular(value:Number):void CONSTRUCTOR DETAIL public function DirectionalLight3D(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) diffuse:Number (default = 0.5, min:0, max:10) specular:Number (default = 1, min:0, max:1) brightness:Number (default = 1) debug:Boolean (default = false) METHOD DETAIL public override function clone(object:* = null):* Duplicates the light object's properties to another DirectionalLight3D 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 DirSprite2D =========== Package : away3d.sprites Class : public class DirSprite2D Inheritance : Object3D Implements : IPrimitiveProvider 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 (Object3D) deltaZ : Number - An optional offset value added to the z depth used to sort the sprite (DirSprite2D) (^) 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) rotation : Number - Defines the overall 2d rotation of the sprite object (DirSprite2D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) scaling : Number - Defines the overall scaling of the sprite object (DirSprite2D) (^) 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 - Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen (DirSprite2D) (^) 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 (DirSprite2D) add(x:Number, y:Number, z:Number, bitmap:BitmapData):void - Adds a new bitmap definition to the array of directional textures. (DirSprite2D) (^) 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):* (Object3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) 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 (DirSprite2D) (^) 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 public var deltaZ:Number An optional offset value added to the z depth used to sort the sprite public var rotation:Number Defines the overall 2d rotation of the sprite object public var scaling:Number Defines the overall scaling of the sprite object public var smooth:Boolean Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen CONSTRUCTOR DETAIL public function DirSprite2D(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters scaling:Number (default = 1, min:0) rotation:Number (default = 0) smooth:Boolean (default = false) deltaZ:Number (default = 0) bitmaps:Array METHOD DETAIL public function add(x:Number, y:Number, z:Number, bitmap:BitmapData):void Adds a new bitmap definition to the array of directional textures. Parameters x:Number - x The x coordinate of the directional texture. y:Number - y The y coordinate of the directional texture. z:Number - z The z coordinate of the directional texture. bitmap:BitmapData - bitmap The bitmapData object to be used as the directional texture. 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.DrawScaledBitmap CODE EXAMPLES There are currently no examples for this class DofCache ======== Package : away3d.core.utils Class : public class DofCache PUBLIC PROPERTIES aperture : Number = 22 - [static] (DofCache) doflevels : Number = 16 - [static] (DofCache) focus : Number - [static] (DofCache) maxblur : Number = 150 - [static] (DofCache) usedof : Boolean = false - [static] (DofCache) PUBLIC METHODS - (DofCache) getBitmap(depth:Number):BitmapData - (DofCache) getDofCache(bitmap:BitmapData):DofCache - [static] (DofCache) resetDof(enabled:Boolean):void - [static] (DofCache) PROPERTY DETAIL public static var aperture:Number = 22 public static var doflevels:Number = 16 public static var focus:Number public static var maxblur:Number = 150 public static var usedof:Boolean = false CONSTRUCTOR DETAIL public function DofCache(levels:Number, texture:BitmapData) Parameters levels:Number texture:BitmapData METHOD DETAIL public function getBitmap(depth:Number):BitmapData Parameters depth:Number Returns BitmapData public static function getDofCache(bitmap:BitmapData):DofCache Parameters bitmap:BitmapData Returns DofCache public static function resetDof(enabled:Boolean):void Parameters enabled:Boolean CODE EXAMPLES There are currently no examples for this class DofSprite2D =========== Package : away3d.sprites Class : public class DofSprite2D Inheritance : Object3D Implements : IPrimitiveProvider Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) bitmap : BitmapData - Defines the bitmapData object to use for the sprite texture. (DofSprite2D) (^) 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) deltaZ : Number - An optional offset value added to the z depth used to sort the sprite (DofSprite2D) (^) 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) rotation : Number - Defines the overall 2d rotation of the sprite object (DofSprite2D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) scaling : Number - Defines the overall scaling of the sprite object (DofSprite2D) (^) 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 - Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen (DofSprite2D) (^) 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 (DofSprite2D) (^) 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):* (Object3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) 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 (DofSprite2D) (^) 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 public var bitmap:BitmapData Defines the bitmapData object to use for the sprite texture. public var deltaZ:Number An optional offset value added to the z depth used to sort the sprite public var rotation:Number Defines the overall 2d rotation of the sprite object public var scaling:Number Defines the overall scaling of the sprite object public var smooth:Boolean Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen CONSTRUCTOR DETAIL public function DofSprite2D(bitmap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the sprite's texture. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters scaling:Number (default = 1, min:0) rotation:Number (default = 0) smooth:Boolean (default = false) deltaZ:Number (default = 0) METHOD DETAIL 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.DrawScaledBitmap CODE EXAMPLES There are currently no examples for this class Dot3BitmapMaterial ================== Package : away3d.materials Class : public class Dot3BitmapMaterial Inheritance : CompositeMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the layer container. (CompositeMaterial) bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the material texture. (Dot3BitmapMaterial) (^) blendMode : String - Defines a blendMode value for the layer container. (CompositeMaterial) (^) color : uint - Defines a colored tint for the layer container. (CompositeMaterial) (^) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (CompositeMaterial) normalMap : BitmapData - [read-only] Returns the bitmapData object being used as the material normal map. (Dot3BitmapMaterial) shininess : Number - The exponential dropoff value used for specular highlights. (Dot3BitmapMaterial) specular : Number - Coefficient for specular light level. (Dot3BitmapMaterial) (^) visible : Boolean - Indicates whether the material is visible (CompositeMaterial) PROTECTED PROPERTIES (Dot3BitmapMaterial) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (CompositeMaterial) (^) renderTriangle(tri:DrawTriangle):void (CompositeMaterial) (^) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (CompositeMaterial) PROTECTED METHODS (^) setColorTransform():void (CompositeMaterial) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData normalMap:BitmapData[read-only] Returns the bitmapData object being used as the material normal map. Implementation public function get normalMap():BitmapData shininess:Number[read-write] The exponential dropoff value used for specular highlights. Implementation public function get shininess():Number public function set shininess(value:Number):void specular:Number[read-write] Coefficient for specular light level. Implementation public function get specular():Number public function set specular(value:Number):void CONSTRUCTOR DETAIL public function Dot3BitmapMaterial(bitmap:BitmapData, normalMap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's texture. normalMap:BitmapData - The bitmapData object to be used as the material's DOT3 map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters shininess:Number (default = 20) specular:Number (default = 0.7) CODE EXAMPLES There are currently no examples for this class Dot3BitmapMaterialCache ======================= Package : away3d.materials Class : public class Dot3BitmapMaterialCache Inheritance : BitmapMaterialContainer, BitmapMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the texture bitmap. (BitmapMaterial) bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the material texture. (Dot3BitmapMaterialCache) (^) blendMode : String - Defines a blendMode value for the texture bitmap. (BitmapMaterial) (^) cache : Boolean - Defines whether each created bitmapData surface is to be cached, or updated every frame. (BitmapMaterialContainer) (^) 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) (^) height : Number - Returns the height of the bitmapData being used as the material texture. (BitmapMaterial) (^) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (BitmapMaterialContainer) normalMap : BitmapData - [read-only] Returns the bitmapData object being used as the material normal map. (Dot3BitmapMaterialCache) (^) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) (^) repeat : Boolean = false - Determines if texture bitmap will tile in uv-space (BitmapMaterial) shininess : Number - The exponential dropoff value used for specular highlights. (Dot3BitmapMaterialCache) (^) smooth : Boolean = false - Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (BitmapMaterial) specular : Number - Coefficient for specular light level. (Dot3BitmapMaterialCache) (^) transparent : Boolean - Defines whether the caching bitmapData objects are transparent (BitmapMaterialContainer) (^) 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 (Dot3BitmapMaterialCache) (^) 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. (BitmapMaterial) (^) 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. (BitmapMaterialContainer) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (BitmapMaterial) (^) renderTriangle(tri:DrawTriangle):void (BitmapMaterial) (^) update():void - Clear and updates the currrent bitmapData surface on all faces. (BitmapMaterialContainer) (^) updateMaterial(source:Object3D, view:View3D):void (BitmapMaterialContainer) PROTECTED METHODS (^) getMapping(tri:DrawTriangle):Matrix - Calculates the mapping matrix required to draw the triangle texture to screen. (BitmapMaterialContainer) (^) setColorTransform():void (BitmapMaterial) (^) updateRenderBitmap():void (BitmapMaterialContainer) EVENTS (^) (BitmapMaterial) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData normalMap:BitmapData[read-only] Returns the bitmapData object being used as the material normal map. Implementation public function get normalMap():BitmapData shininess:Number[read-write] The exponential dropoff value used for specular highlights. Implementation public function get shininess():Number public function set shininess(value:Number):void specular:Number[read-write] Coefficient for specular light level. Implementation public function get specular():Number public function set specular(value:Number):void CONSTRUCTOR DETAIL public function Dot3BitmapMaterialCache(bitmap:BitmapData, normalMap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's texture. normalMap:BitmapData - The bitmapData object to be used as the material's DOT3 map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters shininess:Number (default = 20) specular:Number (default = 0.7) CODE EXAMPLES There are currently no examples for this class Dot3MovieMaterial ================= Package : away3d.materials Class : public class Dot3MovieMaterial Inheritance : CompositeMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the layer container. (CompositeMaterial) bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the material texture. (Dot3MovieMaterial) (^) blendMode : String - Defines a blendMode value for the layer container. (CompositeMaterial) (^) color : uint - Defines a colored tint for the layer container. (CompositeMaterial) (^) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (CompositeMaterial) normalMap : BitmapData - [read-only] Returns the bitmapData object being used as the material normal map. (Dot3MovieMaterial) shininess : Number - The exponential dropoff value used for specular highlights. (Dot3MovieMaterial) specular : Number - Coefficient for specular light level. (Dot3MovieMaterial) (^) visible : Boolean - Indicates whether the material is visible (CompositeMaterial) PROTECTED PROPERTIES (Dot3MovieMaterial) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (CompositeMaterial) (^) renderTriangle(tri:DrawTriangle):void (CompositeMaterial) (^) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (CompositeMaterial) PROTECTED METHODS (^) setColorTransform():void (CompositeMaterial) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData normalMap:BitmapData[read-only] Returns the bitmapData object being used as the material normal map. Implementation public function get normalMap():BitmapData shininess:Number[read-write] The exponential dropoff value used for specular highlights. Implementation public function get shininess():Number public function set shininess(value:Number):void specular:Number[read-write] Coefficient for specular light level. Implementation public function get specular():Number public function set specular(value:Number):void CONSTRUCTOR DETAIL public function Dot3MovieMaterial(movie:Sprite, normalMap:BitmapData, init:Object = null) Parameters movie:Sprite - The movieclip to be used as the material's texture. normalMap:BitmapData - The bitmapData object to be used as the material's DOT3 map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters shininess:Number (default = 20) specular:Number (default = 0.7) CODE EXAMPLES There are currently no examples for this class DrawBitmap ========== Package : away3d.core.draw Class : public class DrawBitmap Inheritance : DrawPrimitive Description : Unscaled bitmap drawing primitive PUBLIC PROPERTIES bitmap : BitmapData - The bitmapData object used as the bitmap primitive texture. (DrawBitmap) (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) screenvertex : ScreenVertex - (DrawBitmap) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawBitmap) clear():void - Deletes the data currently held by the drawing primitive. (DrawBitmap) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawBitmap) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (DrawBitmap) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var bitmap:BitmapData The bitmapData object used as the bitmap primitive texture. public var screenvertex:ScreenVertex METHOD DETAIL public override function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public override function clear():void Deletes the data currently held by the drawing primitive. public override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public override function render():void Draws the primitive to the view. CODE EXAMPLES There are currently no examples for this class DrawDisplayObject ================= Package : away3d.core.draw Class : public class DrawDisplayObject Inheritance : DrawPrimitive Description : PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) displayobject : DisplayObject - A reference to the displayobject used by the drawing primitive. (DrawDisplayObject) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) screenvertex : ScreenVertex - The screenvertex used to position the drawing primitive in the view. (DrawDisplayObject) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) session : AbstractRenderSession - A reference to the render session used by the drawing primitive. (DrawDisplayObject) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawDisplayObject) clear():void - Deletes the data currently held by the drawing primitive. (DrawDisplayObject) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawDisplayObject) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (DrawDisplayObject) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var displayobject:DisplayObject A reference to the displayobject used by the drawing primitive. public var screenvertex:ScreenVertex The screenvertex used to position the drawing primitive in the view. public var session:AbstractRenderSession A reference to the render session used by the drawing primitive. METHOD DETAIL public override function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public override function clear():void Deletes the data currently held by the drawing primitive. public override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public override function render():void Draws the primitive to the view. CODE EXAMPLES There are currently no examples for this class DrawFog ======= Package : away3d.core.draw Class : public class DrawFog Inheritance : DrawPrimitive Description : Fog drawing primitive PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) material : IFogMaterial - The material used to render the drawing primitive. (DrawFog) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS (^) calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawPrimitive) (^) clear():void - Deletes the data currently held by the drawing primitive. (DrawPrimitive) (^) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawPrimitive) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (DrawFog) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var material:IFogMaterial The material used to render the drawing primitive. METHOD DETAIL public override function render():void Draws the primitive to the view. CODE EXAMPLES There are currently no examples for this class DrawGroup ========= Package : away3d.core.draw Class : public class DrawGroup Inheritance : DrawPrimitive Implements : IPrimitiveConsumer Description : PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) primitives : Array - The primitives contained in the group. (DrawGroup) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS (^) calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawPrimitive) clear():void - Deletes the data currently held by the drawing primitive. (DrawGroup) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawGroup) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) primitive(pri:DrawPrimitive):void - Adds a drawing primitive to the primitive group (DrawGroup) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (DrawGroup) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var primitives:Array The primitives contained in the group. METHOD DETAIL public override function clear():void Deletes the data currently held by the drawing primitive. public override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public function primitive(pri:DrawPrimitive):void Adds a drawing primitive to the primitive group Parameters pri:DrawPrimitive - The drawing primitive to add. public override function render():void Draws the primitive to the view. CODE EXAMPLES There are currently no examples for this class DrawPrimitive ============= Package : away3d.core.draw Class : public class DrawPrimitive Subclasses : Blocker, DrawBitmap, DrawDisplayObject, DrawFog, DrawGroup, DrawScaledBitmap, DrawSegment, DrawTriangle Description : Abstract class for all drawing primitives PUBLIC PROPERTIES create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawPrimitive) clear():void - Deletes the data currently held by the drawing primitive. (DrawPrimitive) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawPrimitive) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (DrawPrimitive) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var create:Function Placeholder function for creating new drawing primitives from a cache of objects. Saves recreating objects and GC problems. public var maxX:Number Indicates the maximum x value of the drawing primitive. public var maxY:Number Indicates the maximum y value of the drawing primitive. public var maxZ:Number Indicates the maximum z value of the drawing primitive. public var minX:Number Indicates the minimum x value of the drawing primitive. public var minY:Number Indicates the minimum y value of the drawing primitive. public var minZ:Number Indicates the minimum z value of the drawing primitive. public var projection:Projection Reference to the last projection object used for the primitive public var quadrant:PrimitiveQuadrantTreeNode Reference to the last quadrant used by the drawing primitive. Used in PrimitiveQuadrantTree See also away3d.core.render.PrimitiveQuadrantTree public var screenZ:Number Indicates the screen z value of the drawing primitive (used for z-sorting). public var source:Object3D The parent 3d object of the drawing primitive. METHOD DETAIL public function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public function clear():void Deletes the data currently held by the drawing primitive. public function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public function getZ(x:Number, y:Number):Number Calulates the screen z value of a precise point on the drawing primitive. Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Number - The screen z value (used in z-sorting). public function quarter(focus:Number):Array Cuts the drawing primitive into 4 equally sized drawing primitives. Used in z-sorting correction. Parameters focus:Number - The focus value of the camera being used in the view. Returns Array See also away3d.cameras.Camera3D public function render():void Draws the primitive to the view. public function toString():String Used to trace the values of a drawing primitive. Returns String - A string representation of the drawing primitive. CODE EXAMPLES There are currently no examples for this class DrawScaledBitmap ================ Package : away3d.core.draw Class : public class DrawScaledBitmap Inheritance : DrawPrimitive Description : Scaled bitmap primitive PUBLIC PROPERTIES bitmap : BitmapData - The bitmapData object used as the scaled bitmap primitive texture. (DrawScaledBitmap) (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) rotation : Number - A rotation value used to rotate the scaled bitmap primitive. (DrawScaledBitmap) scale : Number - A scaling value used to scale the scaled bitmap primitive. (DrawScaledBitmap) screenvertex : ScreenVertex - The screenvertex used to position the scaled bitmap primitive in the view. (DrawScaledBitmap) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) smooth : Boolean - Determines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (DrawScaledBitmap) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawScaledBitmap) clear():void - Deletes the data currently held by the drawing primitive. (DrawScaledBitmap) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawScaledBitmap) (^) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawPrimitive) (^) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawPrimitive) render():void - Draws the primitive to the view. (DrawScaledBitmap) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var bitmap:BitmapData The bitmapData object used as the scaled bitmap primitive texture. public var rotation:Number A rotation value used to rotate the scaled bitmap primitive. public var scale:Number A scaling value used to scale the scaled bitmap primitive. public var screenvertex:ScreenVertex The screenvertex used to position the scaled bitmap primitive in the view. public var smooth:Boolean Determines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen. METHOD DETAIL public override function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public override function clear():void Deletes the data currently held by the drawing primitive. public override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public override function render():void Draws the primitive to the view. CODE EXAMPLES There are currently no examples for this class DrawSegment =========== Package : away3d.core.draw Class : public class DrawSegment Inheritance : DrawPrimitive Description : Line segment drawing primitive PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) length : Number - The screen length of the segment primitive. (DrawSegment) material : ISegmentMaterial - The material of the segment primitive. (DrawSegment) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) v0 : ScreenVertex - The v0 screenvertex of the segment primitive. (DrawSegment) v1 : ScreenVertex - The v1 screenvertex of the segment primitive. (DrawSegment) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawSegment) clear():void - Deletes the data currently held by the drawing primitive. (DrawSegment) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawSegment) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawSegment) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawSegment) render():void - Draws the primitive to the view. (DrawSegment) toString():String - Used to trace the values of a drawing primitive. (DrawSegment) PROPERTY DETAIL public var length:Number The screen length of the segment primitive. public var material:ISegmentMaterial The material of the segment primitive. public var v0:ScreenVertex The v0 screenvertex of the segment primitive. public var v1:ScreenVertex The v1 screenvertex of the segment primitive. METHOD DETAIL public override function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public override function clear():void Deletes the data currently held by the drawing primitive. public override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public override function getZ(x:Number, y:Number):Number Calulates the screen z value of a precise point on the drawing primitive. Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Number - The screen z value (used in z-sorting). public override function quarter(focus:Number):Array Cuts the drawing primitive into 4 equally sized drawing primitives. Used in z-sorting correction. Parameters focus:Number - The focus value of the camera being used in the view. Returns Array public override function render():void Draws the primitive to the view. public override function toString():String Used to trace the values of a drawing primitive. Returns String - A string representation of the drawing primitive. CODE EXAMPLES There are currently no examples for this class DrawTriangle ============ Package : away3d.core.draw Class : public class DrawTriangle Inheritance : DrawPrimitive Description : Triangle drawing primitive PUBLIC PROPERTIES area : Number - The calulated area of the triangle primitive. (DrawTriangle) backface : Boolean = false - Indicates whether the face of the triangle primitive is facing away from the camera. (DrawTriangle) (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) face : Face - A reference to the face object used by the triangle primitive. (DrawTriangle) invtexturemapping : Matrix - The inverse texturemapping matrix of the triangle primitive texture. (DrawTriangle) material : ITriangleMaterial - The bitmapData object used as the triangle primitive texture. (DrawTriangle) (^) maxX : Number - Indicates the maximum x value of the drawing primitive. (DrawPrimitive) (^) maxY : Number - Indicates the maximum y value of the drawing primitive. (DrawPrimitive) (^) maxZ : Number - Indicates the maximum z value of the drawing primitive. (DrawPrimitive) (^) minX : Number - Indicates the minimum x value of the drawing primitive. (DrawPrimitive) (^) minY : Number - Indicates the minimum y value of the drawing primitive. (DrawPrimitive) (^) minZ : Number - Indicates the minimum z value of the drawing primitive. (DrawPrimitive) (^) projection : Projection - Reference to the last projection object used for the primitive (DrawPrimitive) (^) quadrant : PrimitiveQuadrantTreeNode - Reference to the last quadrant used by the drawing primitive. (DrawPrimitive) (^) screenZ : Number - Indicates the screen z value of the drawing primitive (used for z-sorting). (DrawPrimitive) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) texturemapping : Matrix - The texturemapping matrix of the triangle primitive texture. (DrawTriangle) uv0 : UV - The uv0 uv coordinate of the triangle primitive. (DrawTriangle) uv1 : UV - The uv1 uv coordinate of the triangle primitive. (DrawTriangle) uv2 : UV - The uv2 uv coordinate of the triangle primitive. (DrawTriangle) v0 : ScreenVertex - The v0 screenvertex of the triangle primitive. (DrawTriangle) v1 : ScreenVertex - The v1 screenvertex of the triangle primitive. (DrawTriangle) v2 : ScreenVertex - The v2 screenvertex of the triangle primitive. (DrawTriangle) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawTriangle) clear():void - Deletes the data currently held by the drawing primitive. (DrawTriangle) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawTriangle) distanceToCenter(x:Number, y:Number):Number - (DrawTriangle) getUV(x:Number, y:Number):UV - Calulates the uv value of a precise point on the drawing primitive. (DrawTriangle) getZ(x:Number, y:Number):Number - Calulates the screen z value of a precise point on the drawing primitive. (DrawTriangle) quarter(focus:Number):Array - Cuts the drawing primitive into 4 equally sized drawing primitives. (DrawTriangle) render():void - Draws the primitive to the view. (DrawTriangle) toString():String - Used to trace the values of a drawing primitive. (DrawTriangle) transformUV(material:IUVMaterial):Matrix - Calculates from the uv coordinates the mapping matrix required to draw the triangle primitive. (DrawTriangle) PROPERTY DETAIL public var area:Number The calulated area of the triangle primitive. public var backface:Boolean = false Indicates whether the face of the triangle primitive is facing away from the camera. public var face:Face A reference to the face object used by the triangle primitive. public var invtexturemapping:Matrix The inverse texturemapping matrix of the triangle primitive texture. public var material:ITriangleMaterial The bitmapData object used as the triangle primitive texture. public var texturemapping:Matrix The texturemapping matrix of the triangle primitive texture. public var uv0:UV The uv0 uv coordinate of the triangle primitive. public var uv1:UV The uv1 uv coordinate of the triangle primitive. public var uv2:UV The uv2 uv coordinate of the triangle primitive. public var v0:ScreenVertex The v0 screenvertex of the triangle primitive. public var v1:ScreenVertex The v1 screenvertex of the triangle primitive. public var v2:ScreenVertex The v2 screenvertex of the triangle primitive. METHOD DETAIL public override function calc():void Calculates the min, max and screen properties required for rendering the drawing primitive. public override function clear():void Deletes the data currently held by the drawing primitive. public final override function contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Boolean - The result of the test. public final function distanceToCenter(x:Number, y:Number):Number Parameters x:Number y:Number Returns Number public function getUV(x:Number, y:Number):UV Calulates the uv value of a precise point on the drawing primitive. Used to determine the mouse position in interactive materials. Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns UV - The uv value. public final override function getZ(x:Number, y:Number):Number Calulates the screen z value of a precise point on the drawing primitive. Parameters x:Number - The x position of the point to be tested. y:Number - The y position of the point to be tested. Returns Number - The screen z value (used in z-sorting). public final override function quarter(focus:Number):Array Cuts the drawing primitive into 4 equally sized drawing primitives. Used in z-sorting correction. Parameters focus:Number - The focus value of the camera being used in the view. Returns Array public override function render():void Draws the primitive to the view. public override function toString():String Used to trace the values of a drawing primitive. Returns String - A string representation of the drawing primitive. public final function transformUV(material:IUVMaterial):Matrix Calculates from the uv coordinates the mapping matrix required to draw the triangle primitive. Parameters material:IUVMaterial Returns Matrix CODE EXAMPLES There are currently no examples for this class Elevation ========= Package : away3d.extrusions Class : public class Elevation PUBLIC METHODS - (Elevation) generate(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, scalingX:Number = 1, scalingY:Number = 1, elevate:Number = .5):Array - (Elevation) CONSTRUCTOR DETAIL public function Elevation() Class returns a multidimentional array based on pixel information that can be passed to the SkinExtrude class. METHOD DETAIL public function generate(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, scalingX:Number = 1, scalingY:Number = 1, elevate:Number = .5):Array Parameters sourceBmd:BitmapData channel:String (default = "r") subdivisionX:int (default = 10) subdivisionY:int (default = 10) scalingX:Number (default = 1) scalingY:Number (default = 1) elevate:Number (default = .5) Returns Array CODE EXAMPLES There are currently no examples for this class ElevationReader =============== Package : away3d.extrusions Class : public class ElevationReader PUBLIC PROPERTIES source : BitmapData - [read-only] (ElevationReader) PUBLIC METHODS - (ElevationReader) getLevel(x:Number, y:Number, offset:Number = 0):Number - (ElevationReader) traceLevels(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void - (ElevationReader) PROPERTY DETAIL source:BitmapData[read-only] Implementation public function get source():BitmapData CONSTRUCTOR DETAIL public function ElevationReader(smoothness:int = 0) Parameters smoothness:int (default = 0) METHOD DETAIL public function getLevel(x:Number, y:Number, offset:Number = 0):Number Parameters x:Number y:Number offset:Number (default = 0) Returns Number public function traceLevels(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void Parameters sourceBmd:BitmapData channel:String (default = "r") subdivisionX:int (default = 10) subdivisionY:int (default = 10) factorX:Number (default = 1) factorY:Number (default = 1) elevate:Number (default = .5) CODE EXAMPLES There are currently no examples for this class EnviroBitmapMaterial ==================== Package : away3d.materials Class : public class EnviroBitmapMaterial Inheritance : CompositeMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the layer container. (CompositeMaterial) bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the material texture. (EnviroBitmapMaterial) (^) blendMode : String - Defines a blendMode value for the layer container. (CompositeMaterial) (^) color : uint - Defines a colored tint for the layer container. (CompositeMaterial) enviroMap : BitmapData - [read-only] Returns the bitmapData object being used as the material environment map. (EnviroBitmapMaterial) (^) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (CompositeMaterial) mode : String - Setting for possible mapping methods. (EnviroBitmapMaterial) reflectiveness : Number - Coefficient for the reflectiveness of the material. (EnviroBitmapMaterial) (^) visible : Boolean - Indicates whether the material is visible (CompositeMaterial) PROTECTED PROPERTIES (EnviroBitmapMaterial) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (CompositeMaterial) (^) renderTriangle(tri:DrawTriangle):void (CompositeMaterial) (^) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (CompositeMaterial) PROTECTED METHODS (^) setColorTransform():void (CompositeMaterial) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData enviroMap:BitmapData[read-only] Returns the bitmapData object being used as the material environment map. Implementation public function get enviroMap():BitmapData mode:String[read-write] Setting for possible mapping methods. Implementation public function get mode():String public function set mode(value:String):void reflectiveness:Number[read-write] Coefficient for the reflectiveness of the material. Implementation public function get reflectiveness():Number public function set reflectiveness(value:Number):void CONSTRUCTOR DETAIL public function EnviroBitmapMaterial(bitmap:BitmapData, enviroMap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's texture. enviroMap:BitmapData - The bitmapData object to be used as the material's normal map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters mode:String (default = "linear") reflectiveness:Number (default = 0.5, min:0, max:1) CODE EXAMPLES There are currently no examples for this class EnviroBitmapMaterialCache ========================= Package : away3d.materials Class : public class EnviroBitmapMaterialCache Inheritance : BitmapMaterialContainer, BitmapMaterial Description : PUBLIC PROPERTIES (^) alpha : Number - Defines an alpha value for the texture bitmap. (BitmapMaterial) bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the material texture. (EnviroBitmapMaterialCache) (^) blendMode : String - Defines a blendMode value for the texture bitmap. (BitmapMaterial) (^) cache : Boolean - Defines whether each created bitmapData surface is to be cached, or updated every frame. (BitmapMaterialContainer) (^) 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) enviroMap : BitmapData - [read-only] Returns the bitmapData object being used as the material environment map. (EnviroBitmapMaterialCache) (^) height : Number - Returns the height of the bitmapData being used as the material texture. (BitmapMaterial) (^) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (BitmapMaterialContainer) mode : String - Setting for possible mapping methods. (EnviroBitmapMaterialCache) (^) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) reflectiveness : Number - Coefficient for the reflectiveness of the material. (EnviroBitmapMaterialCache) (^) repeat : Boolean = false - Determines if texture bitmap will tile in uv-space (BitmapMaterial) (^) smooth : Boolean = false - Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. (BitmapMaterial) (^) transparent : Boolean - Defines whether the caching bitmapData objects are transparent (BitmapMaterialContainer) (^) 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 (EnviroBitmapMaterialCache) (^) 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. (BitmapMaterial) (^) 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. (BitmapMaterialContainer) (^) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (BitmapMaterial) (^) renderTriangle(tri:DrawTriangle):void (BitmapMaterial) (^) update():void - Clear and updates the currrent bitmapData surface on all faces. (BitmapMaterialContainer) (^) updateMaterial(source:Object3D, view:View3D):void (BitmapMaterialContainer) PROTECTED METHODS (^) getMapping(tri:DrawTriangle):Matrix - Calculates the mapping matrix required to draw the triangle texture to screen. (BitmapMaterialContainer) (^) setColorTransform():void (BitmapMaterial) (^) updateRenderBitmap():void (BitmapMaterialContainer) EVENTS (^) (BitmapMaterial) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData enviroMap:BitmapData[read-only] Returns the bitmapData object being used as the material environment map. Implementation public function get enviroMap():BitmapData mode:String[read-write] Setting for possible mapping methods. Implementation public function get mode():String public function set mode(value:String):void reflectiveness:Number[read-write] Coefficient for the reflectiveness of the material. Implementation public function get reflectiveness():Number public function set reflectiveness(value:Number):void CONSTRUCTOR DETAIL public function EnviroBitmapMaterialCache(bitmap:BitmapData, enviroMap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's texture. enviroMap:BitmapData - The bitmapData object to be used as the material's environment map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters mode:String (default = "linear") reflectiveness:Number (default = 0.5, min:0, max:1) CODE EXAMPLES There are currently no examples for this class EnviroColorMaterial =================== Package : away3d.materials Class : public class EnviroColorMaterial Inheritance Implements : ITriangleMaterial Description : PUBLIC PROPERTIES (^) bitmap : BitmapData - Returns the bitmapData object being used as the shader environment map. (EnviroShader) (^) blendMode : String - Defines a blendMode value for the shader bitmap. (AbstractShader) color : uint - Defines the color of the material. (EnviroColorMaterial) (^) debug : Boolean - Determines if faces with the shader applied are drawn with outlines (AbstractShader) (^) height : Number - Returns the width of the bitmapData being used as the shader environment map. (EnviroShader) (^) mode : String - Setting for possible mapping methods. (EnviroShader) reflectiveness : Number - [write-only] Coefficient for the reflectiveness of the environment map. (EnviroColorMaterial) (^) 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) (^) width : Number - Returns the height of the bitmapData being used as the shader environment map. (EnviroShader) PROTECTED PROPERTIES (EnviroColorMaterial) (^) getMapping(source:Mesh, face:Face):Matrix - (EnviroShader) (^) 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. (EnviroShader) renderTriangle(tri:DrawTriangle):void - Sends the material data coupled with data from the DrawTriangle primitive to the render session. (EnviroColorMaterial) (^) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (EnviroShader) PROTECTED METHODS (^) clearFaceDictionary(source:Object3D, view:View3D):void - Clears face value objects when shader requires updating (EnviroShader) (^) 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. (EnviroShader) PROPERTY DETAIL color:uint[read-write] Defines the color of the material. Implementation public function get color():uint public function set color(value:uint):void reflectiveness:Number[write-only] Coefficient for the reflectiveness of the environment map. Implementation public function set reflectiveness(value:Number):void CONSTRUCTOR DETAIL public function EnviroColorMaterial(color:*, enviroMap:BitmapData, init:Object = null) Parameters color:* - A string, hex value or colorname representing the color of the material. enviroMap:BitmapData - The bitmapData object to be used as the material's environment map. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. METHOD DETAIL public function renderTriangle(tri:DrawTriangle):void Sends the material data coupled with data from the DrawTriangle primitive to the render session. Parameters tri:DrawTriangle CODE EXAMPLES There are currently no examples for this class EnviroShader ============ Package : away3d.materials.shaders Class : public class EnviroShader Inheritance : AbstractShader Subclasses : EnviroColorMaterial Description : PUBLIC PROPERTIES bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the shader environment map. (EnviroShader) (^) 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) height : Number - [read-only] Returns the width of the bitmapData being used as the shader environment map. (EnviroShader) mode : String - Setting for possible mapping methods. (EnviroShader) reflectiveness : Number - Coefficient for the reflectiveness of the environment map. (EnviroShader) (^) 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) width : Number - [read-only] Returns the height of the bitmapData being used as the shader environment map. (EnviroShader) PROTECTED PROPERTIES (EnviroShader) getMapping(source:Mesh, face:Face):Matrix - (EnviroShader) (^) 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. (EnviroShader) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (EnviroShader) PROTECTED METHODS clearFaceDictionary(source:Object3D, view:View3D):void - Clears face value objects when shader requires updating (EnviroShader) (^) 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. (EnviroShader) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the shader environment map. Implementation public function get bitmap():BitmapData height:Number[read-only] Returns the width of the bitmapData being used as the shader environment map. Implementation public function get height():Number public var mode:String Setting for possible mapping methods. reflectiveness:Number[read-write] Coefficient for the reflectiveness of the environment map. Implementation public function get reflectiveness():Number public function set reflectiveness(value:Number):void width:Number[read-only] Returns the height of the bitmapData being used as the shader environment map. Implementation public function get width():Number CONSTRUCTOR DETAIL public function EnviroShader(bitmap:BitmapData, init:Object = null) Parameters bitmap:BitmapData - The bitmapData object to be used as the material's environment map. 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 function getMapping(source:Mesh, face:Face):Matrix Parameters source:Mesh face:Face Returns Matrix 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 Face ==== Package : away3d.core.base Class : public class Face Inheritance : BaseMeshElement Description : PUBLIC PROPERTIES area : Number - [read-only] Returns the calculated 2 dimensional area of the face. (Face) back : ITriangleMaterial - Defines the optional back material of the face. (Face) extra : Object - An optional untyped object that can contain used-defined properties. (Face) material : ITriangleMaterial - Defines the material of the face. (Face) maxU : Number - [read-only] Returns the maximum u value of the face (Face) maxV : Number - [read-only] Returns the maximum v value of the face (Face) maxX : Number - [read-only] Returns the maximum x value of the face (Face) maxY : Number - [read-only] Returns the maximum y value of the face (Face) maxZ : Number - [read-only] Returns the maximum zx value of the face (Face) minU : Number - [read-only] Returns the minimum u value of the face (Face) minV : Number - [read-only] Returns the minimum v value of the face (Face) minX : Number - [read-only] Returns the minimum x value of the face (Face) minY : Number - [read-only] Returns the minimum y value of the face (Face) minZ : Number - [read-only] Returns the minimum z value of the face (Face) normal : Number3D - [read-only] Returns the normal vector of the face. (Face) parent : Mesh - Defines the parent 3d object of the face. (Face) radius2 : Number - [read-only] Returns the squared bounding radius of the face. (Face) uv0 : UV - Defines the uv0 coordinate of the face. (Face) uv1 : UV - Defines the uv1 coordinate of the face. (Face) uv2 : UV - Defines the uv2 coordinate of the face. (Face) uvs : Array - [read-only] Returns an array of uv objects that are used by the face. (Face) v0 : Vertex - Defines the v0 vertex of the face. (Face) v1 : Vertex - Defines the v1 vertex of the face. (Face) v2 : Vertex - Defines the v2 vertex of the face. (Face) vertices : Array - [read-only] Returns an array of vertex objects that are used by the face. (Face) (^) visible : Boolean - Defines whether the 3d element is visible in the scene. (BaseMeshElement) PUBLIC METHODS (Face) addOnMappingChange(listener:Function):void - Default method for adding a mappingchanged event listener (Face) addOnMaterialChange(listener:Function):void - Default method for adding a materialchanged event listener (Face) (^) 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) invert():void (Face) removeOnMappingChange(listener:Function):void - Default method for removing a mappingchanged event listener (Face) removeOnMaterialChange(listener:Function):void - Default method for removing a materialchanged event listener (Face) (^) 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 (Face) (Face) (^) (BaseMeshElement) (^) (BaseMeshElement) (^) (BaseMeshElement) PROPERTY DETAIL area:Number[read-only] Returns the calculated 2 dimensional area of the face. Implementation public function get area():Number back:ITriangleMaterial[read-write] Defines the optional back material of the face. Displays when the face is pointing away from the camera. Implementation public function get back():ITriangleMaterial public function set back(value:ITriangleMaterial):void public var extra:Object An optional untyped object that can contain used-defined properties. material:ITriangleMaterial[read-write] Defines the material of the face. Implementation public function get material():ITriangleMaterial public function set material(value:ITriangleMaterial):void maxU:Number[read-only] Returns the maximum u value of the face Implementation public function get maxU():Number See also away3d.core.base.UV.u maxV:Number[read-only] Returns the maximum v value of the face Implementation public function get maxV():Number See also away3d.core.base.UV.v maxX:Number[read-only] Returns the maximum x value of the face Implementation public function get maxX():Number See also maxY property maxY:Number[read-only] maxY:Number[read-only] Returns the maximum y value of the face Implementation public function get maxY():Number See also maxZ property maxZ:Number[read-only] maxZ:Number[read-only] Returns the maximum zx value of the face Implementation public function get maxZ():Number See also minU property minU:Number[read-only] minU:Number[read-only] Returns the minimum u value of the face Implementation public function get minU():Number See also away3d.core.base.UV.u minV:Number[read-only] Returns the minimum v value of the face Implementation public function get minV():Number See also away3d.core.base.UV.v minX:Number[read-only] Returns the minimum x value of the face Implementation public function get minX():Number See also minY property minY:Number[read-only] minY:Number[read-only] Returns the minimum y value of the face Implementation public function get minY():Number See also minZ property minZ:Number[read-only] minZ:Number[read-only] Returns the minimum z value of the face Implementation public function get minZ():Number See also normal property normal:Number3D[read-only] normal:Number3D[read-only] Returns the normal vector of the face. Implementation public function get normal():Number3D public var parent:Mesh Defines the parent 3d object of the face. radius2:Number[read-only] Returns the squared bounding radius of the face. Implementation public function get radius2():Number uv0:UV[read-write] Defines the uv0 coordinate of the face. Implementation public function get uv0():UV public function set uv0(value:UV):void uv1:UV[read-write] Defines the uv1 coordinate of the face. Implementation public function get uv1():UV public function set uv1(value:UV):void uv2:UV[read-write] Defines the uv2 coordinate of the face. Implementation public function get uv2():UV public function set uv2(value:UV):void uvs:Array[read-only] Returns an array of uv objects that are used by the face. Implementation public function get uvs():Array v0:Vertex[read-write] Defines the v0 vertex of the face. Implementation public function get v0():Vertex public function set v0(value:Vertex):void v1:Vertex[read-write] Defines the v1 vertex of the face. Implementation public function get v1():Vertex public function set v1(value:Vertex):void v2:Vertex[read-write] Defines the v2 vertex of the face. Implementation public function get v2():Vertex public function set v2(value:Vertex):void vertices:Array[read-only] Returns an array of vertex objects that are used by the face. Implementation public function get vertices():Array CONSTRUCTOR DETAIL public function Face(v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial = null, uv0:UV = null, uv1:UV = null, uv2:UV = null) Parameters v0:Vertex - The first vertex object of the triangle v1:Vertex - The second vertex object of the triangle v2:Vertex - The third vertex object of the triangle material:ITriangleMaterial (default = null) - The material used by the triangle to render uv0:UV (default = null) - [optional] The first uv object of the triangle uv1:UV (default = null) - [optional] The second uv object of the triangle uv2:UV (default = null) - [optional] The third uv object of the triangle See also away3d.core.base.Vertex away3d.materials.ITriangleMaterial away3d.core.base.UV METHOD DETAIL public function addOnMappingChange(listener:Function):void Default method for adding a mappingchanged event listener Parameters listener:Function - The listener function public function addOnMaterialChange(listener:Function):void Default method for adding a materialchanged event listener Parameters listener:Function - The listener function public function invert():void Inverts the geometry of the face object by swapping the v1, v2 and uv1, uv2 points. public function removeOnMappingChange(listener:Function):void Default method for removing a mappingchanged event listener Parameters listener:Function - The listener function public function removeOnMaterialChange(listener:Function):void Default method for removing a materialchanged event listener Parameters listener:Function - The listener function EVENT DETAIL Event object type: away3d.events.FaceEvent Dispatched when the uv mapping of the face changes. Event object type: away3d.events.FaceEvent Dispatched when the material of the face changes. CODE EXAMPLES There are currently no examples for this class FaceData ======== Package : away3d.loaders.data Class : public class FaceData PUBLIC PROPERTIES materialData : MaterialData - Holds teh material data for the face. (FaceData) uv0 : int - Index of uv coordinate 0. (FaceData) uv1 : int - Index of uv coordinate 1. (FaceData) uv2 : int - Index of uv coordinate 2. (FaceData) v0 : int - Index of vertex 0. (FaceData) v1 : int - Index of vertex 1. (FaceData) v2 : int - Index of vertex 2. (FaceData) visible : Boolean - Determines whether the face is visible. (FaceData) PROPERTY DETAIL public var materialData:MaterialData Holds teh material data for the face. public var uv0:int Index of uv coordinate 0. public var uv1:int Index of uv coordinate 1. public var uv2:int Index of uv coordinate 2. public var v0:int Index of vertex 0. public var v1:int Index of vertex 1. public var v2:int Index of vertex 2. public var visible:Boolean Determines whether the face is visible. CODE EXAMPLES There are currently no examples for this class FaceDictionaryVO ================ Package : away3d.core.utils Class : public class FaceDictionaryVO PUBLIC PROPERTIES bitmap : BitmapData - (FaceDictionaryVO) dirty : Boolean - (FaceDictionaryVO) PUBLIC METHODS - (FaceDictionaryVO) clear():void - (FaceDictionaryVO) reset(width:Number, height:Number):void - (FaceDictionaryVO) PROPERTY DETAIL public var bitmap:BitmapData public var dirty:Boolean CONSTRUCTOR DETAIL public function FaceDictionaryVO(width:Number = 0, height:Number = 0) Parameters width:Number (default = 0) height:Number (default = 0) METHOD DETAIL public function clear():void public function reset(width:Number, height:Number):void Parameters width:Number height:Number CODE EXAMPLES There are currently no examples for this class FaceEvent ========= Package : away3d.events Class : public class FaceEvent Inheritance PUBLIC PROPERTIES : Face face : Face Description : - A reference to the face object that is relevant to the event. (FaceEvent) PUBLIC METHODS (FaceEvent) clone():Event - Creates a copy of the FaceEvent object and sets the value of each property to match that of the original. (FaceEvent) PUBLIC CONSTANTS MAPPING_CHANGED : String = "mappingchanged" - [static] Defines the value of the type property of a mappingchanged event object. (FaceEvent) MATERIAL_CHANGED : String = "materialchanged" - [static] Defines the value of the type property of a materialchanged event object. (FaceEvent) PROPERTY DETAIL public var face:Face A reference to the face object that is relevant to the event. CONSTRUCTOR DETAIL public function FaceEvent(type:String, face:Face) Parameters type:String - The type of the event. Possible values are: FaceEvent.MAPPING_CHANGED and FaceEvent.MATERIAL_CHANGED. face:Face - A reference to the face object that is relevant to the event. METHOD DETAIL public override function clone():Event Creates a copy of the FaceEvent object and sets the value of each property to match that of the original. Returns Event CONSTANT DETAIL public static const MAPPING_CHANGED:String = "mappingchanged" Defines the value of the type property of a mappingchanged event object. public static const MATERIAL_CHANGED:String = "materialchanged" Defines the value of the type property of a materialchanged event object. CODE EXAMPLES There are currently no examples for this class FaceVO ====== Package : away3d.core.utils Class : public class FaceVO PUBLIC PROPERTIES backface : Boolean = false - (FaceVO) bitmap : BitmapData - (FaceVO) cleared : Boolean = true - (FaceVO) color : uint - (FaceVO) height : int - (FaceVO) invalidated : Boolean = true - (FaceVO) mapping : Matrix - (FaceVO) resized : Boolean - (FaceVO) source : Object3D - (FaceVO) updated : Boolean = false - (FaceVO) view : View3D - (FaceVO) width : int - (FaceVO) PUBLIC METHODS - (FaceVO) clear():void - (FaceVO) resize(width:Number, height:Number, transparent:Boolean = true):void - (FaceVO) PROPERTY DETAIL public var backface:Boolean = false public var bitmap:BitmapData public var cleared:Boolean = true public var color:uint public var height:int public var invalidated:Boolean = true public var mapping:Matrix public var resized:Boolean public var source:Object3D public var updated:Boolean = false public var view:View3D public var width:int CONSTRUCTOR DETAIL public function FaceVO(source:Object3D = null, view:View3D = null) Parameters source:Object3D (default = null) view:View3D (default = null) METHOD DETAIL public function clear():void public function resize(width:Number, height:Number, transparent:Boolean = true):void Parameters width:Number height:Number transparent:Boolean (default = true) CODE EXAMPLES There are currently no examples for this class FindHit ======= Package : away3d.core.render Class : public class FindHit PUBLIC METHODS (FindHit) getMouseEvent(type:String):MouseEvent3D - Returns a 3d mouse event object populated with the properties from the hit point. (FindHit) CONSTRUCTOR DETAIL public function FindHit(view:View3D, primitives:Array, x:Number, y:Number) Parameters view:View3D - The view to be used. primitives:Array - The primitives that have been rendered in the last frame. x:Number - The x coordinate of the point to test. y:Number - The y coordinate of the point to test. METHOD DETAIL public function getMouseEvent(type:String):MouseEvent3D Returns a 3d mouse event object populated with the properties from the hit point. Parameters type:String Returns MouseEvent3D CODE EXAMPLES There are currently no examples for this class FogFilter ========= Package : away3d.core.filter Class : public class FogFilter Implements : IPrimitiveFilter Description : PUBLIC PROPERTIES material : IFogMaterial - Defines the material used by the fog layers. (FogFilter) 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. (FogFilter) PUBLIC METHODS (FogFilter) filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array - Applies the filter to the primitive array. (FogFilter) toString():String - Used to trace the values of a filter. (FogFilter) PROPERTY DETAIL 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. material:IFogMaterial[read-write] Defines the material used by the fog layers. Implementation public function get material():IFogMaterial public function set material(value:IFogMaterial):void CONSTRUCTOR DETAIL public function FogFilter(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters material:Material minZ:Number (default = 1000, min:0) maxZ:Number (default = 5000, min:0) subdivisions:Int (default = 20, min:1, max:50) materials:Array METHOD DETAIL public function filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array Applies the filter to the primitive array. Parameters primitives:Array - The primitives to be filtered. scene:Scene3D - The scene to which the primitives belongs. camera:Camera3D - The camera being used in the renderer for the primitives. clip:Clipping - The clipping object used in the renderer for the primitive's view. Returns Array 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 Frame ===== Package : away3d.core.base Class : public class Frame Implements : IFrame Description : PUBLIC PROPERTIES vertexpositions : Array - An array of vertex position objects. (Frame) PUBLIC METHODS (Frame) adjust(k:Number = 1):void - Adjusts the position of all vertex objects in the frame incrementally. (Frame) PROPERTY DETAIL public var vertexpositions:Array An array of vertex position objects. CONSTRUCTOR DETAIL public function Frame() METHOD DETAIL public function adjust(k:Number = 1):void Adjusts the position of all vertex objects in the frame incrementally. Parameters k:Number (default = 1) - The fraction by which to adjust the vertex values. CODE EXAMPLES There are currently no examples for this class GeodesicSphere ============== Package : away3d.primitives Class : public class GeodesicSphere Inheritance : AbstractPrimitive, 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) fractures : Number - Defines the fractures of the sphere. (GeodesicSphere) (^) 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) radius : Number - Defines the radius of the sphere. (GeodesicSphere) (^) 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 (GeodesicSphere) (^) 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. (GeodesicSphere) (^) 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 fractures:Number[read-write] Defines the fractures of the sphere. Defaults to 2. Implementation public function get fractures():Number public function set fractures(value:Number):void radius:Number[read-write] Defines the radius of the sphere. Defaults to 100. Implementation public function get radius():Number public function set radius(value:Number):void CONSTRUCTOR DETAIL public function GeodesicSphere(init:Object = null) Constructor for a geodesic sphere object where all the faces are of a constant size unlike a regular sphere object where faces decrease in size as they approach the poles of the sphere. The init object parameters are : 'radius' defines the radius of the sphere and 'fractures' which defines the level of subdivision of the surface of the sphere. Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. METHOD DETAIL public override 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 GridPlane ========= Package : away3d.primitives Class : public class GridPlane Inheritance : AbstractWirePrimitive, WireMesh, BaseMesh, Object3D 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) height : Number - Defines the height of the grid. (GridPlane) (^) 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) segmentsH : Number - Defines the number of vertical segments that make up the grid. (GridPlane) segmentsW : Number - Defines the number of horizontal segments that make up the grid. (GridPlane) (^) 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) width : Number - Defines the width of the grid. (GridPlane) (^) x : Number (Object3D) (^) y : Number (Object3D) yUp : Boolean - Defines whether the coordinates of the grid points use a yUp orientation (true) or a zUp orientation (false). (GridPlane) (^) z : Number (Object3D) PROTECTED PROPERTIES (GridPlane) (^) 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. (GridPlane) (^) 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 height:Number[read-write] Defines the height of the grid. Defaults to 100. Implementation public function get height():Number public function set height(value:Number):void segmentsH:Number[read-write] Defines the number of vertical segments that make up the grid. Defaults to 1. Implementation public function get segmentsH():Number public function set segmentsH(value:Number):void segmentsW:Number[read-write] Defines the number of horizontal segments that make up the grid. Defaults to 1. Implementation public function get segmentsW():Number public function set segmentsW(value:Number):void width:Number[read-write] Defines the width of the grid. Defaults to 100. Implementation public function get width():Number public function set width(value:Number):void yUp:Boolean[read-write] Defines whether the coordinates of the grid points use a yUp orientation (true) or a zUp orientation (false). Defaults to true. Implementation public function get yUp():Boolean public function set yUp(value:Boolean):void CONSTRUCTOR DETAIL public function GridPlane(init:Object = null) Constructor for a grid object. The init object parameters are : 'width'/'height' defines the size of the grid, 'segments' defines the number of segments for width and height unless overriden, 'segmentsW' defines number segments the grid is split into horizontally and 'segmentsH' how many segments grid is split into vertically. Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters width:Number (default = 100, min:0) height:Number (default = 100, min:0) segments:Int (default = 1, min:1) segmentsW:Int (default = segments, min:1) segmentsH:Int (default = segments, min:1) yUp:Boolean (default = true) METHOD DETAIL public override 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 HoverCamera3D ============= Package : away3d.cameras Class : public class HoverCamera3D Inheritance : Object3D Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) aperture : Number (Camera3D) (^) 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) distance : Number = 800 - Distance between the camera and the specified target. (HoverCamera3D) (^) dof : Boolean (Camera3D) (^) doflevels : Number = 16 (Camera3D) (^) 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) (^) focus : Number - A divisor value for the perspective depth of the view. (Camera3D) (^) inverseSceneTransform : Matrix3D - (Object3D) (^) maxblur : Number = 150 (Camera3D) maxtiltangle : Number = 90 (HoverCamera3D) (^) 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) mintiltangle : Number = 0 (HoverCamera3D) (^) 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) panangle : Number = 0 - Rotation of the camera in degrees around the y axis. (HoverCamera3D) (^) parent : ObjectContainer3D (TargetCamera3D) (^) 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) steps : Number = 8 (HoverCamera3D) (^) target : Object3D - The 3d object targeted by the camera. (TargetCamera3D) targetpanangle : Number = 0 (HoverCamera3D) targettiltangle : Number = 90 (HoverCamera3D) tiltangle : Number = 90 - Elevation angle of the camera in degrees. (HoverCamera3D) (^) transform : Matrix3D (Object3D) (^) useHandCursor : Boolean = false - Defines whether a hand cursor is displayed when the mouse rolls over the 3d object. (Object3D) (^) view : Matrix3D - Returns the transformation matrix used to resolve the scene to the view. (TargetCamera3D) (^) viewTransform : Matrix3D - (Object3D) (^) visible : Boolean = true - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) (^) y : Number (Object3D) yfactor : Number = 2 - Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. (HoverCamera3D) (^) z : Number (Object3D) (^) zoom : Number - Provides an overall scale value to the view (Camera3D) PROTECTED PROPERTIES (HoverCamera3D) (^) 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):* (Camera3D) (^) disableDof():void (Camera3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) enableDof():void (Camera3D) hover():Boolean (HoverCamera3D) (^) 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) (^) pan(angle:Number):void - Rotates the camera in its horizontal plane. (Camera3D) (^) pitch(angle:Number):void - Rotates the 3d object around it's local x-axis (Object3D) (^) primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (Object3D) (^) 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) (^) screen(object:Object3D, vertex:Vertex = null):ScreenVertex (Camera3D) (^) tick(time:int):void (Object3D) (^) tilt(angle:Number):void - Rotates the camera in its vertical plane. (Camera3D) (^) 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) update():Boolean - Updates the camera position. (HoverCamera3D) (^) 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 public var distance:Number = 800 Distance between the camera and the specified target. Defaults to 800. public var maxtiltangle:Number = 90 Maximum bounds for the tiltangle. Defaults to 90. See also tiltangle public var mintiltangle:Number = 0 Minimum bounds for the tiltangle. Defaults to 0. See also tiltangle public var panangle:Number = 0 Rotation of the camera in degrees around the y axis. Defaults to 0. public var steps:Number = 8 Fractional step taken each time the hover() method is called. Defaults to 8. Affects the speed at which the tiltangle and panangle resolve to their targets. See also tiltangle panangle public var targetpanangle:Number = 0 Target value for the panangle. Defaults to 0. See also panangle public var targettiltangle:Number = 90 Target value for the tiltangle. Defaults to 90. See also tiltangle public var tiltangle:Number = 90 Elevation angle of the camera in degrees. Defaults to 90. public var yfactor:Number = 2 Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. Defaults to 2. See also distance CONSTRUCTOR DETAIL public function HoverCamera3D(init:Object = null) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters yfactor:Number (default = yfactor) distance:Number (default = distance) panangle:Number (default = panangle) tiltangle:Number (default = tiltangle) targetpanangle:Number (default = targetpanangle) targettiltangle:Number (default = targettiltangle) mintiltangle:Number (default = mintiltangle) maxtiltangle:Number (default = maxtiltangle) steps:Number (default = steps) METHOD DETAIL public function hover():Boolean Updates the tiltangle and panangle values, then calls update(). Values are calculated using the defined targettiltangle, targetpanangle and steps variables. Returns Boolean - True if the camera position was updated, otherwise false. See also tiltangle panangle targettiltangle targetpanangle steps update() public function update():Boolean Updates the camera position. Position is calculated using the current values of tiltangle, panangle, distance and yfactor. Returns Boolean - True if the camera position was updated, otherwise false. See also tiltangle panangle distance yfactor CODE EXAMPLES HoverCamera3d Example //Replace the code below into the first frame of //the lesson Lesson_Basic_03_Meshes.fla // import core library import away3d.core.scene.*; // import file format loaders import away3d.loaders.*; //import math objects import away3d.core.math.*; // import away3d.cameras.*; // create a 3D-viewport var camera = new HoverCamera3D({zoom:3, focus:200, distance:1000}); // create a 3D-viewport camera.tiltangle = 40; camera.targettiltangle = 40; camera.mintiltangle = 20; camera.maxtiltangle = 50; camera.yfactor = 1; camera.steps = 7; var view:View3D = new View3D({camera:camera, x:300, y:200}); // add viewport to the stage addChild(view); // start mesh loading var loader:Object3DLoader = Obj.load("resources/turtle.obj", {material:"turtle_texture", name:"turtle", scaling:0.1, y:50, x:10, z: 10, loadersize:300}); // add the loader object to the scene view.scene.addChild(loader); // camera.update(); loader.rotationX = -90; // var rotCamera:Boolean = false; var lastMouseX:Number = mouseX; var lastMouseY:Number = mouseY; var firstClick:Boolean = true; // addEventListener(Event.ENTER_FRAME, onEnterFrame); function onEnterFrame(event:Event):void { // if (rotCamera) { if (firstClick == true) { firstClick = false; lastMouseX = view.mouseX; lastMouseY = view.mouseY; trace("frist click"); } // var dragX = (view.mouseX - lastMouseX); var dragY = (view.mouseY - lastMouseY); // lastMouseX = view.mouseX; lastMouseY = view.mouseY; // camera.targetpanangle += dragX; camera.targettiltangle += dragY camera.hover(); } else { // } // rerender viewport on each frame view.render(); } var hit:MovieClip = new MovieClip(); hit.graphics.beginFill(0xFF0000); hit.graphics.drawRect(0, 0, 500, 600); hit.graphics.endFill(); addChild(hit); hit.alpha = 0; hit.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler); function mouseDownHandler(evt:MouseEvent):void { rotCamera = true; } hit.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler); function mouseUpHandler(evt:MouseEvent):void { rotCamera = false; firstClick = true; } hit.addEventListener(MouseEvent.MOUSE_WHEEL, onMouseEvent); function onMouseEvent(event:MouseEvent):void { trace(camera.zoom); var dir = (event.delta > 0) ? .5 : -.5; camera.zoom = Math.max(2, Math.min(8, (camera.zoom+dir))); //camera.distanceTo(-40); } IAnimation ========== Package : away3d.core.base Interface : public interface IAnimation Implementors : Animation Description : Interface for objects that can animate the vertex values in a mesh PUBLIC METHODS update(mesh:BaseMesh):void - Updates the positions of vertex objects in the mesh to the current frame values (IAnimation) METHOD DETAIL 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 See also away3d.core.base.Frame CODE EXAMPLES There are currently no examples for this class IBlockerConsumer ================ Package : away3d.core.block Interface : public interface IBlockerConsumer Implementors : BlockerArray Description : PUBLIC METHODS blocker(block:Blocker):void - Adds blocker primitive to the consumer. (IBlockerConsumer) METHOD DETAIL public function blocker(block:Blocker):void Adds blocker primitive to the consumer. Parameters block:Blocker - The blocker primitive to add. CODE EXAMPLES There are currently no examples for this class IBlockerProvider ================ Package : away3d.core.block Interface : public interface IBlockerProvider Implementors : ConvexBlock Description : PUBLIC METHODS blockers(consumer:IBlockerConsumer):void (IBlockerProvider) METHOD DETAIL public function blockers(consumer:IBlockerConsumer):void Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object Parameters consumer:IBlockerConsumer - The consumer instance See also away3d.core.traverse.BlockerTraverser away3d.core.block.Blocker CODE EXAMPLES There are currently no examples for this class IClonable ========= Package : away3d.core.utils Interface : public interface IClonable Implementors : AmbientLight3D, DirectionalLight3D, Object3D, PointLight3D Description : Interface for object that can be cloned PUBLIC METHODS clone(object:* = null):* - (IClonable) METHOD DETAIL public function clone(object:* = null):* Parameters object:* (default = null) Returns * CODE EXAMPLES There are currently no examples for this class IFogMaterial ============ Package : away3d.materials Interface : ITriangleMaterial, IMaterial Implementors : ColorMaterial Description : Interface for fog filter materials PUBLIC PROPERTIES alpha : Number - Determines the alpha value of the material (IFogMaterial) (^) visible : Boolean - Indicates whether the material is visible (IMaterial) PUBLIC METHODS clone():IFogMaterial (IFogMaterial) renderFog(fog:DrawFog):void - Sends the material data coupled with data from the DrawFog primitive to the render session (IFogMaterial) (^) renderTriangle(tri:DrawTriangle):void (ITriangleMaterial) PROPERTY DETAIL alpha:Number[read-write] Determines the alpha value of the material Implementation public function get alpha():Number public function set alpha(value:Number):void METHOD DETAIL public function clone():IFogMaterial Duplicates the material's properties to another IFogMaterial object Returns IFogMaterial - The new object instance with duplicated properties applied public function renderFog(fog:DrawFog):void Sends the material data coupled with data from the DrawFog primitive to the render session Parameters fog:DrawFog CODE EXAMPLES There are currently no examples for this class IFrame ====== Package : away3d.core.base Interface : public interface IFrame Implementors : Frame Description : Interface for objects that store the vertex values for a single frame of animation PUBLIC METHODS adjust(k:Number = 1):void - Adjusts the position of all vertex objects in the frame incrementally. (IFrame) METHOD DETAIL public function adjust(k:Number = 1):void Adjusts the position of all vertex objects in the frame incrementally. Parameters k:Number (default = 1) - The fraction by which to adjust the vertex values. CODE EXAMPLES There are currently no examples for this class ILayerMaterial ============== Package : away3d.materials Interface : IMaterial Implementors : BitmapMaterial, BitmapMaterialContainer, CompositeMaterial Description : PUBLIC PROPERTIES (^) visible : Boolean - Indicates whether the material is visible (IMaterial) PUBLIC METHODS renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO - Renders a bitmapData surface object for the speficied face. (ILayerMaterial) renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void - Renders a material layer for the specified triangle. (ILayerMaterial) METHOD DETAIL 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 See also away3d.materials.BitmapMaterailContainer 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. CODE EXAMPLES There are currently no examples for this class ILightConsumer ============== Package : away3d.core.light Interface : public interface ILightConsumer Implementors : LightArray Description : Interface for containers capable of storing lighting info PUBLIC METHODS ambientLight(ambient:AmbientLight):void - Adds an ambient light primitive to the light consumer. (ILightConsumer) directionalLight(directional:DirectionalLight):void - Adds an directional light primitive to the light consumer. (ILightConsumer) pointLight(point:PointLight):void - Adds an point light primitive to the light consumer. (ILightConsumer) METHOD DETAIL public function ambientLight(ambient:AmbientLight):void Adds an ambient light primitive to the light consumer. Parameters ambient:AmbientLight - The light primitive to add. public function directionalLight(directional:DirectionalLight):void Adds an directional light primitive to the light consumer. Parameters directional:DirectionalLight - The light primitive to add. public function pointLight(point:PointLight):void Adds an point light primitive to the light consumer. Parameters point:PointLight - The light primitive to add. CODE EXAMPLES There are currently no examples for this class ILightProvider ============== Package : away3d.core.light Interface : public interface ILightProvider Implementors : AmbientLight3D, DirectionalLight3D, PointLight3D Description : Interface for objects that provide lighting to the scene PUBLIC METHODS light(consumer:ILightConsumer):void (ILightProvider) METHOD DETAIL 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. See also ../traverse/PrimitiveTraverser.html ../light/LightPrimitive.html ../light/ILightConsumer.html CODE EXAMPLES There are currently no examples for this class ILODObject ========== Package : away3d.containers Interface : public interface ILODObject Implementors : LODObject Description : Interface for objects that can toggle their visibily depending on view and distance to camera PUBLIC METHODS matchLOD(view:View3D):Boolean (ILODObject) METHOD DETAIL public function matchLOD(view:View3D):Boolean Used in ProjectionTraverser to determine whether the 3d object is visible. Parameters view:View3D - The view being used to calulate the perspective. Returns Boolean - Defines whether the LOD object is visible. See also away3d.core.traverse.ProjectionTraverser away3d.containers.LODObject.maxp away3d.containers.LODObject.minp CODE EXAMPLES There are currently no examples for this class IMaterial ========= Package : away3d.materials Interface : public interface IMaterial Subinterfaces : ILayerMaterial, ISegmentMaterial, ITriangleMaterial, IUVMaterial Description : Interface for all objects that can serve as a material PUBLIC PROPERTIES visible : Boolean - [read-only] Indicates whether the material is visible (IMaterial) PROPERTY DETAIL visible:Boolean[read-only] Indicates whether the material is visible Implementation public function get visible():Boolean CODE EXAMPLES There are currently no examples for this class IMeshElement ============ Package : away3d.core.base Interface : public interface IMeshElement Implementors : BaseMeshElement Description : d element of a mesh PUBLIC PROPERTIES maxX : Number - [read-only] Returns the maximum x value of the 3d element (IMeshElement) maxY : Number - [read-only] Returns the minimum y value of the 3d element (IMeshElement) maxZ : Number - [read-only] Returns the minimum z value of the 3d element (IMeshElement) minX : Number - [read-only] Returns the minimum x value of the 3d element (IMeshElement) minY : Number - [read-only] Returns the maximum y value of the 3d element (IMeshElement) minZ : Number - [read-only] Returns the maximum z value of the 3d element (IMeshElement) radius2 : Number - [read-only] Returns the squared bounding radius of the 3d element (IMeshElement) vertices : Array - [read-only] (IMeshElement) visible : Boolean - Defines whether the 3d element is visible in the scene. (IMeshElement) PUBLIC METHODS addOnVertexChange(listener:Function):void - Default method for adding a vertexchanged event listener (IMeshElement) addOnVertexValueChange(listener:Function):void - Default method for adding a vertexvaluechanged event listener (IMeshElement) addOnVisibleChange(listener:Function):void - Default method for adding a visiblechanged event listener (IMeshElement) removeOnVertexChange(listener:Function):void - Default method for removing a vertexchanged event listener (IMeshElement) removeOnVertexValueChange(listener:Function):void - Default method for removing a vertexvaluechanged event listener (IMeshElement) removeOnVisibleChange(listener:Function):void - Default method for removing a visiblechanged event listener (IMeshElement) 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] 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 CODE EXAMPLES There are currently no examples for this class Init ==== Package : away3d.core.utils Class : public class Init PUBLIC METHODS - (Init) getArray(name:String):Array - (Init) getBitmap(name:String):BitmapData - (Init) getBoolean(name:String, def:Boolean):Boolean - (Init) getColor(name:String, def:uint):uint - (Init) getCubeMaterials(name:String):CubeMaterialsData - (Init) getInit(name:String):Init - (Init) getInt(name:String, def:int, bounds:Object = null):int - (Init) getMaterial(name:String):ITriangleMaterial - (Init) getNumber(name:String, def:Number, bounds:Object = null):Number - (Init) getNumber3D(name:String):Number3D - (Init) getObject(name:String, type:Class = null):Object - (Init) getObject3D(name:String):Object3D - (Init) getObjectOrInit(name:String, type:Class = null):Object - (Init) getPosition(name:String):Number3D - (Init) getSegmentMaterial(name:String):ISegmentMaterial - (Init) getString(name:String, def:String):String - (Init) parse(init:Object):Init - [static] (Init) CONSTRUCTOR DETAIL public function Init(init:Object) Parameters init:Object METHOD DETAIL arcane function addForCheck():void arcane static function checkUnusedArguments():void public function getArray(name:String):Array Parameters name:String Returns Array public function getBitmap(name:String):BitmapData Parameters name:String Returns BitmapData public function getBoolean(name:String, def:Boolean):Boolean Parameters name:String def:Boolean Returns Boolean public function getColor(name:String, def:uint):uint Parameters name:String def:uint Returns uint public function getCubeMaterials(name:String):CubeMaterialsData Parameters name:String Returns CubeMaterialsData public function getInit(name:String):Init Parameters name:String Returns Init public function getInt(name:String, def:int, bounds:Object = null):int Parameters name:String def:int bounds:Object (default = null) Returns int public function getMaterial(name:String):ITriangleMaterial Parameters name:String Returns ITriangleMaterial public function getNumber(name:String, def:Number, bounds:Object = null):Number Parameters name:String def:Number bounds:Object (default = null) Returns Number public function getNumber3D(name:String):Number3D Parameters name:String Returns Number3D public function getObject(name:String, type:Class = null):Object Parameters name:String type:Class (default = null) Returns Object public function getObject3D(name:String):Object3D Parameters name:String Returns Object3D public function getObjectOrInit(name:String, type:Class = null):Object Parameters name:String type:Class (default = null) Returns Object public function getPosition(name:String):Number3D Parameters name:String Returns Number3D public function getSegmentMaterial(name:String):ISegmentMaterial Parameters name:String Returns ISegmentMaterial public function getString(name:String, def:String):String Parameters name:String def:String Returns String public static function parse(init:Object):Init Parameters init:Object Returns Init arcane function removeFromCheck():void CODE EXAMPLES There are currently no examples for this class IPhysicsScene ============= Package : away3d.containers Interface : public interface IPhysicsScene PUBLIC METHODS updateTime(time:int):void - (IPhysicsScene) METHOD DETAIL public function updateTime(time:int):void Parameters time:int CODE EXAMPLES There are currently no examples for this class IPrimitiveConsumer ================== Package : away3d.core.draw Interface : public interface IPrimitiveConsumer Implementors : DrawGroup, PrimitiveArray, PrimitiveQuadrantTree, PrimitiveVolumeBlock Description : Interface for containers capable of drawing primitives PUBLIC METHODS primitive(pri:DrawPrimitive):void - Adds a drawing primitive to the primitive consumer (IPrimitiveConsumer) METHOD DETAIL public function primitive(pri:DrawPrimitive):void Adds a drawing primitive to the primitive consumer Parameters pri:DrawPrimitive - The drawing primitive to add. CODE EXAMPLES There are currently no examples for this class IPrimitiveFilter ================ Package : away3d.core.filter Interface : public interface IPrimitiveFilter Implementors : FogFilter, ZDepthFilter, ZSortFilter Description : Interface for filters that work on primitive arrays PUBLIC METHODS filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array - Applies the filter to the primitive array. (IPrimitiveFilter) METHOD DETAIL public function filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array Applies the filter to the primitive array. Parameters primitives:Array - The primitives to be filtered. scene:Scene3D - The scene to which the primitives belongs. camera:Camera3D - The camera being used in the renderer for the primitives. clip:Clipping - The clipping object used in the renderer for the primitive's view. Returns Array CODE EXAMPLES There are currently no examples for this class IPrimitiveProvider ================== Package : away3d.core.draw Interface : public interface IPrimitiveProvider Implementors : AmbientLight3D, ConvexBlock, DebugObjectContainer3D, DirectionalLight3D, DirSprite2D, DofSprite2D, Mesh, MovieClipSprite, ObjectContainer3D, PointLight3D, Sprite2D, WireMesh Description : Interface for objects that provide drawing primitives to the rendering process PUBLIC METHODS primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void (IPrimitiveProvider) METHOD DETAIL public 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 CODE EXAMPLES There are currently no examples for this class IPrimitiveQuadrantFilter ======================== Package : away3d.core.filter Interface : public interface IPrimitiveQuadrantFilter Implementors : AnotherRivalFilter, QuadrantRiddleFilter Description : Interface for filters that work on primitive quadrant trees PUBLIC METHODS filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void - Applies the filter to the quadrant tree. (IPrimitiveQuadrantFilter) 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. CODE EXAMPLES There are currently no examples for this class IPrimitiveVolumeBlockFilter =========================== Package : away3d.core.filter Interface : public interface IPrimitiveVolumeBlockFilter PUBLIC METHODS filter(blocklist:PrimitiveVolumeBlock, scene:Scene3D, camera:Camera3D, clip:Clipping):void - Applies the filter to the volume block. (IPrimitiveVolumeBlockFilter) METHOD DETAIL public function filter(blocklist:PrimitiveVolumeBlock, scene:Scene3D, camera:Camera3D, clip:Clipping):void Applies the filter to the volume block. Parameters blocklist:PrimitiveVolumeBlock - The volume block tree to be filtered. scene:Scene3D - The scene to which the volume block tree belongs. camera:Camera3D - The camera being used in the renderer for the volume block tree clip:Clipping - The clipping object used in the renderer for the volume block tree's view. CODE EXAMPLES There are currently no examples for this class IRenderer ========= Package : away3d.core.render Interface : public interface IRenderer Implementors : BasicRenderer, QuadrantRenderer Description : Interface for renderers capable of rendering a scene to a view PUBLIC PROPERTIES session : AbstractRenderSession - Defines the render session object used by the renderer. (IRenderer) PUBLIC METHODS render(view:View3D):Array - Executes the render pipe that resolves the 3d scene into the view. (IRenderer) toString():String - Used to trace the values of a renderer. (IRenderer) 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 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 ISegmentMaterial ================ Package : away3d.materials Interface : IMaterial Implementors : WireframeMaterial Description : PUBLIC PROPERTIES (^) visible : Boolean - Indicates whether the material is visible (IMaterial) PUBLIC METHODS renderSegment(seg:DrawSegment):void (ISegmentMaterial) METHOD DETAIL public function renderSegment(seg:DrawSegment):void Sends data from the material coupled with data from the DrawSegment primitive to the render session. Parameters seg:DrawSegment CODE EXAMPLES There are currently no examples for this class ITriangleMaterial ================= Package : away3d.materials Interface : IMaterial Subinterfaces : IFogMaterial Implementors : AnimatedBitmapMaterial, BitmapFileMaterial, BitmapMaterial, BitmapMaterialContainer, CenterLightingMaterial, ColorMaterial, CompositeMaterial, EnviroColorMaterial, MovieMaterial, TransformBitmapMaterial, WireColorMaterial, WireframeMaterial Description : PUBLIC PROPERTIES (^) visible : Boolean - Indicates whether the material is visible (IMaterial) PUBLIC METHODS renderTriangle(tri:DrawTriangle):void (ITriangleMaterial) METHOD DETAIL public function renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the DrawTriangle primitive to the render session. Parameters tri:DrawTriangle CODE EXAMPLES There are currently no examples for this class IUpdatingMaterial ================= Package : away3d.materials Interface : public interface IUpdatingMaterial Implementors : BitmapMaterial, BitmapMaterialContainer, CenterLightingMaterial, CompositeMaterial Description : Interface for materials that require updating every render loop PUBLIC METHODS updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (IUpdatingMaterial) METHOD DETAIL 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 IUVMaterial =========== Package : away3d.materials Interface : IMaterial Implementors : AnimatedBitmapMaterial, BitmapFileMaterial, BitmapMaterial, MovieMaterial, TransformBitmapMaterial, WhiteShadingBitmapMaterial Description : Interface for materials that use uv texture coordinates PUBLIC PROPERTIES bitmap : BitmapData - [read-only] Returns the bitmapData object being used as the material texture. (IUVMaterial) height : Number - [read-only] Returns the height of the bitmapData being used as the material texture. (IUVMaterial) (^) visible : Boolean - Indicates whether the material is visible (IMaterial) width : Number - [read-only] Returns the width of the bitmapData being used as the material texture. (IUVMaterial) PUBLIC METHODS addOnResize(listener:Function):void - Default method for adding a materialresize event listener (IUVMaterial) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (IUVMaterial) removeOnResize(listener:Function):void - Default method for removing a materialresize event listener (IUVMaterial) PROPERTY DETAIL bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData height:Number[read-only] Returns the height of the bitmapData being used as the material texture. Implementation public function get height():Number width:Number[read-only] Returns the width of the bitmapData being used as the material texture. Implementation public function get width():Number METHOD DETAIL public function addOnResize(listener:Function):void Default method for adding a materialresize event listener Parameters listener:Function - The listener function public function getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate. Parameters u:Number - The u (horizontal) texture coordinate. v:Number - The v (verical) texture coordinate. Returns uint - The argb pixel value. public function removeOnResize(listener:Function):void Default method for removing a materialresize event listener Parameters listener:Function - The listener function CODE EXAMPLES There are currently no examples for this class Kmz === Package : away3d.loaders Class : public class Kmz PUBLIC PROPERTIES container : ObjectContainer3D - 3d container object used for storing the parsed kmz scene. (Kmz) containerData : ContainerData - Container data object used for storing the parsed kmz data structure. (Kmz) materialLibrary : MaterialLibrary - Reference container for all materials used in the kmz scene. (Kmz) PUBLIC METHODS (Kmz) load(url:String, init:Object = null):Object3DLoader - [static] Loads and parses a kmz file into a 3d container object. (Kmz) parse(data:*, init:Object = null, loader:Object3DLoader = null):ObjectContainer3D - [static] Creates a 3d container object from the raw binary data of a kmz file. (Kmz) PROPERTY DETAIL public var container:ObjectContainer3D 3d container object used for storing the parsed kmz scene. public var containerData:ContainerData Container data object used for storing the parsed kmz data structure. public var materialLibrary:MaterialLibrary Reference container for all materials used in the kmz scene. CONSTRUCTOR DETAIL public function Kmz(datastream:ByteArray, init:Object = null) Parameters datastream:ByteArray - The binary zip data of a loaded file. init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. See also away3d.loaders.Kmz.parse() away3d.loaders.Kmz.load() METHOD DETAIL public static function load(url:String, init:Object = null):Object3DLoader Loads and parses a kmz file into a 3d container 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):ObjectContainer3D Creates a 3d container object from the raw binary data of a kmz file. Parameters data:* - The birnay zip 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 ObjectContainer3D - A 3d container object representation of the kmz file. CODE EXAMPLES There are currently no examples for this class Lathe ===== Package : away3d.extrusions Class : public class Lathe 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) (^) 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 - (Lathe) (^) 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) (^) 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) CONSTRUCTOR DETAIL public function Lathe(aPoints:Array, init:Object = null) Class generates a Mesh from Number3D in a circular fashion Parameters aPoints:Array init:Object (default = null) CODE EXAMPLES There are currently no examples for this class LightArray ========== Package : away3d.core.light Class : public class LightArray Implements : ILightConsumer Description : PUBLIC PROPERTIES ambients : Array - The ambient light primitives stored in the consumer. (LightArray) directionals : Array - The directional light primitives stored in the consumer. (LightArray) numLights : int - The total number of light primitives stored in the consumer. (LightArray) points : Array - The point light primitives stored in the consumer. (LightArray) PUBLIC METHODS ambientLight(ambient:AmbientLight):void - Adds an ambient light primitive to the light consumer. (LightArray) clear():void - Clears all light primitives from the consumer. (LightArray) directionalLight(directional:DirectionalLight):void - Adds an directional light primitive to the light consumer. (LightArray) pointLight(point:PointLight):void - Adds an point light primitive to the light consumer. (LightArray) PROPERTY DETAIL public var ambients:Array The ambient light primitives stored in the consumer. public var directionals:Array The directional light primitives stored in the consumer. public var numLights:int The total number of light primitives stored in the consumer. public var points:Array The point light primitives stored in the consumer. METHOD DETAIL public function ambientLight(ambient:AmbientLight):void Adds an ambient light primitive to the light consumer. Parameters ambient:AmbientLight - The light primitive to add. public function clear():void Clears all light primitives from the consumer. public function directionalLight(directional:DirectionalLight):void Adds an directional light primitive to the light consumer. Parameters directional:DirectionalLight - The light primitive to add. public function pointLight(point:PointLight):void Adds an point light primitive to the light consumer. Parameters point:PointLight - The light primitive to add. CODE EXAMPLES There are currently no examples for this class LightPrimitive ============== Package : away3d.core.light Class : public class LightPrimitive Subclasses : AmbientLight, DirectionalLight, PointLight Description : 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) red : Number - Red component level. (LightPrimitive) specular : Number - Coefficient for the specular light intensity. (LightPrimitive) specularBitmap : BitmapData - Lightmap for specular intensity. (LightPrimitive) PROPERTY DETAIL public var ambient:Number Coefficient for the ambient light intensity. public var ambientBitmap:BitmapData Lightmap for ambient intensity. public var ambientDiffuseBitmap:BitmapData Combined lightmap for ambient and diffuse intensities. public var blue:Number Blue component level. public var diffuse:Number Coefficient for the diffuse light intensity. public var diffuseBitmap:BitmapData Lightmap for diffuse intensity. public var green:Number Green component level. public var red:Number Red component level. public var specular:Number Coefficient for the specular light intensity. public var specularBitmap:BitmapData Lightmap for specular intensity. CODE EXAMPLES There are currently no examples for this class Line2D ====== Package : away3d.core.draw Class : public class Line2D PUBLIC PROPERTIES a : Number - (Line2D) b : Number - (Line2D) c : Number - (Line2D) PUBLIC METHODS - (Line2D) cross(u:Line2D, v:Line2D):ScreenVertex - [static] (Line2D) distance(v:ScreenVertex):Number - (Line2D) from2points(v0:ScreenVertex, v1:ScreenVertex):Line2D - [static] (Line2D) side(x:Number, y:Number):Number - (Line2D) sideV(v:ScreenVertex):Number - (Line2D) toString():String - (Line2D) PROPERTY DETAIL public var a:Number public var b:Number public var c:Number CONSTRUCTOR DETAIL public function Line2D(a:Number, b:Number, c:Number) Parameters a:Number b:Number c:Number METHOD DETAIL public static function cross(u:Line2D, v:Line2D):ScreenVertex Parameters u:Line2D v:Line2D Returns ScreenVertex public function distance(v:ScreenVertex):Number Parameters v:ScreenVertex Returns Number public static function from2points(v0:ScreenVertex, v1:ScreenVertex):Line2D Parameters v0:ScreenVertex v1:ScreenVertex Returns Line2D public function side(x:Number, y:Number):Number Parameters x:Number y:Number Returns Number public function sideV(v:ScreenVertex):Number Parameters v:ScreenVertex Returns Number public function toString():String Returns String CODE EXAMPLES There are currently no examples for this class LineSegment =========== Package : away3d.primitives Class : public class LineSegment Inheritance : WireMesh, BaseMesh, Object3D 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) end : Vertex - Defines the ending vertex. (LineSegment) (^) 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 (Object3D) (^) 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) start : Vertex - Defines the starting vertex. (LineSegment) (^) 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 (LineSegment) (^) 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) (^) 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 end:Vertex[read-write] Defines the ending vertex of the segment Defines the ending vertex. Implementation public function get end():Vertex public function set end(value:Vertex):void start:Vertex[read-write] Defines the starting vertex of the segment. Defines the starting vertex. Implementation public function get start():Vertex public function set start(value:Vertex):void CONSTRUCTOR DETAIL public function LineSegment(init:Object = null) Constructor for a line segment object. The init object parameter 'edge' defines the length of the line segment to be created. Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. Init Parameters edge:Number (default = 100, min:0) CODE EXAMPLES There are currently no examples for this class LoaderEvent =========== Package : away3d.events Class : public class LoaderEvent Inheritance PUBLIC PROPERTIES : Object3DLoader loader : Object3DLoader Description : - A reference to the loader object that is relevant to the event. (LoaderEvent) PUBLIC METHODS (LoaderEvent) clone():Event - Creates a copy of the LoaderEvent object and sets the value of each property to match that of the original. (LoaderEvent) PUBLIC CONSTANTS LOAD_ERROR : String = "loaderror" - [static] Defines the value of the type property of a loaderror event object. (LoaderEvent) LOAD_SUCCESS : String = "loadsuccess" - [static] Defines the value of the type property of a loadsuccess event object. (LoaderEvent) PROPERTY DETAIL public var loader:Object3DLoader A reference to the loader object that is relevant to the event. CONSTRUCTOR DETAIL public function LoaderEvent(type:String, loader:Object3DLoader) Parameters type:String - The type of the event. Possible values are: LoaderEvent.LOAD_SUCCESS and LoaderEvent.LOAD_ERROR. loader:Object3DLoader - A reference to the loader object that is relevant to the event. METHOD DETAIL public override function clone():Event Creates a copy of the LoaderEvent object and sets the value of each property to match that of the original. Returns Event CONSTANT DETAIL public static const LOAD_ERROR:String = "loaderror" Defines the value of the type property of a loaderror event object. public static const LOAD_SUCCESS:String = "loadsuccess" Defines the value of the type property of a loadsuccess event object. CODE EXAMPLES There are currently no examples for this class LODObject ========= Package : away3d.containers Class : public class LODObject Inheritance : Object3D Implements : ILODObject 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 (ObjectContainer3D) (^) children : Array - Returns the children of the container as an array of 3d objects (ObjectContainer3D) (^) 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) maxp : Number - The maximum perspective value from which the 3d object can be viewed. (LODObject) (^) maxX : Number - Returns the maximum x value of the 3d object (ObjectContainer3D) (^) maxY : Number - Returns the maximum y value of the 3d object (ObjectContainer3D) (^) maxZ : Number - Returns the maximum z value of the 3d object (ObjectContainer3D) minp : Number - The minimum perspective value from which the 3d object can be viewed. (LODObject) (^) minX : Number - Returns the minimum x value of the 3d object (ObjectContainer3D) (^) minY : Number - Returns the minimum y value of the 3d object (ObjectContainer3D) (^) minZ : Number - Returns the minimum z value of the 3d object (ObjectContainer3D) (^) 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 (LODObject) (^) addChild(child:Object3D):void - Adds a 3d object to the scene as a child of the container (ObjectContainer3D) (^) addChildren(... childarray):void - Adds an array of 3d objects to the scene as children of the container (ObjectContainer3D) (^) 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):* (ObjectContainer3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) getChildByName(name:String):Object3D - Returns a 3d object specified by name from the child array of the container (ObjectContainer3D) (^) lookAt(target:Number3D, upAxis:Number3D = null):void (Object3D) matchLOD(view:View3D):Boolean (LODObject) (^) 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 3d object without moving the contents (ObjectContainer3D) (^) 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 (Object3D) (^) removeChild(child:Object3D):void - Removes a 3d object from the child array of the container (ObjectContainer3D) (^) removeChildByName(name:String):void - Removes a 3d object from the child array of the container (ObjectContainer3D) (^) 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. (ObjectContainer3D) (^) 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 (ObjectContainer3D) (^) 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 public var maxp:Number The maximum perspective value from which the 3d object can be viewed. public var minp:Number The minimum perspective value from which the 3d object can be viewed. CONSTRUCTOR DETAIL public function LODObject(init:Object = null, ... childarray) Parameters init:Object (default = null) - [optional] An initialisation object for specifying default instance properties. ... childarray - An array of children to be added on instatiation. Init Parameters maxp:Number (default = Infinity) minp:Number (default = 0) METHOD DETAIL public function matchLOD(view:View3D):Boolean Used in ProjectionTraverser to determine whether the 3d object is visible. Parameters view:View3D - The view being used to calulate the perspective. Returns Boolean - Defines whether the LOD object is visible. See also away3d.core.traverse.ProjectionTraverser maxp minp CODE EXAMPLES There are currently no examples for this class LogoCube ======== Package : away3d.primitives Class : public class LogoCube Inheritance : Cube, AbstractPrimitive, 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) (^) cubeMaterials : CubeMaterialsData - Defines the face materials of the cube. (Cube) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Mesh) (^) depth : Number - Defines the depth of the cube. (Cube) (^) elements : Array - Returns an array of the elements cont