Away3D API Reference: V2.3 ========================== away3d.animators IMeshAnimation : Interface for objects containing animation information for meshes. Animator : PathAnimator : SkinAnimation : TimeBase : away3d.animators.data 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. CurveSegment : Holds information about a segment of a curve. Path : Holds information about a single Path definition. away3d.animators.skin Bone : Channel : SkinController : SkinVertex : away3d.animators.utils AWTweener : PathUtils : Geometry handlers for classes using Path objects 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. SpringCam : A 1st and 3d person camera(depending on positionOffset!), hooked on a physical spring on an optional target. TargetCamera3D : Extended camera used to automatically look at a specified target object. away3d.cameras.lenses ILens : AbstractLens : Abstract lens for resolving perspective using the OrthogonalLens : PerspectiveLens : SphericalLens : ZoomFocusLens : away3d.containers ILODObject : Interface for objects that can toggle their visibily depending on view and distance to camera IPhysicsScene : 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 Animation : Holds information about the current state of a mesh animation. AnimationTransition : Holds information about the current state of animation to transition into another animation. Billboard : A graphics element used to represent objects that always face the camera Element : 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. Geometry : 3d object containing face and segment elements 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. VertexClassification : VertexPosition : Vertex position value object. 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. FrustumClipping : Frustum Clipping NearfieldClipping : Rectangle clipping combined with nearfield 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 DrawBillboard : Billboard primitive DrawBitmap : Unscaled bitmap drawing primitive DrawDisplayObject : Displayobject container drawing primitive. DrawFog : Fog drawing primitive DrawPrimitive : Abstract class for all drawing primitives DrawScaledBitmap : Scaled bitmap primitive DrawSegment : Line segment drawing primitive DrawTriangle : Triangle drawing primitive PrimitiveQuadrantTreeNode : Quadrant tree node PrimitiveVolumeBlock : Volume block containing 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.geom Frustum : Line2D : Line in 2D space Plane3D : Plane in 3D space 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 4x4 matrix Number2D : A point in 2D space. Number3D : A point in 3D space. Quaternion : A Quaternion object. away3d.core.project ConvexBlockProjector : DirSpriteProjector : DofSpriteProjector : MeshProjector : MovieClipSpriteProjector : ObjectContainerProjector : ProjectorType : SpriteProjector : 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 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 LightTraverser : 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. SessionTraverser : Traverser that gathers blocker primitives for occlusion culling. 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 : CameraVarsStore : 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 Billboards. DrawPrimitiveStore : FaceDictionaryVO : FaceMaterialVO : FaceVO : Init : Convinient object initialization support ValueObject : away3d.exporters AS3Exporter : Elevation2AS3 : Class Elevation2AS3 generates a string class of the elevation to pass to the SkinClass and ElevationReader in order to save space and processing time. ObjExporter : Class ObjExporter generates a string in the WaveFront obj format representing the object3D(s). away3d.extrusions CollisionMap : Elevation : Class Elevation returns a multidimentional array of Number3D's to pass to the SkinClass in order to generate an elevated mesh from ElevationModifier : Class ElevationModifier updates the vertexes of a flat Mesh such as a Plane, RegularPolygon with a bimap information ElevationReader : Lathe : Mirror : Class Mirror an Object3D geometry and its uv's NormalUVModifier : PathDuplicator : PathExtrude : 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 AbstractParser : Ase : File loader for the ASE file format. Collada : File loader for the Collada file format with animation. 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 AnimationData : Data class for the animation of a mesh. BoneData : Data class for a bone used in SkinAnimation. ChannelData : Data class for an animation channel ContainerData : Data class for 3d object containers. FaceData : Data class for a face object. GeometryData : Data class for the geometry data used in a mesh 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 generic 3d object away3d.loaders.utils AnimationLibrary : Store for all animations associated with an externally loaded file. ChannelLibrary : Store for all animation channels associated with an externally loaded file. GeometryLibrary : Store for all geometries associated with an externally loaded file. 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 IBillboardMaterial : Interface for materials that are capable of drawing billboards. 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. 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 VideoMaterial : 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.materials.utils NormalBumpMaker : Utility class, principally to transform bump map data into normal map data. NormalMapGenerator : SimpleShadow : This class generates a top projection shadow from vertex information of a given Object3D, Most suitable for still objects. away3d.primitives AbstractPrimitive : Abstract base class for shaded primitives AbstractWirePrimitive : Abstract base class for wire primitives BezierPatch : BezierPatch primitive creates a smooth mesh based on a 4x4 vertex patch using a cubic bezier curve. 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. Plane : Creates a 3d plane primitive. RegularPolygon : Creates a regular polygon. RoundedCube : Creates a 3d roundedcube primitive. 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. PatchData : PatchData definition for constructing BezierPatches. 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 SimpleView : SimpleView Slide : Represents a single slide of the demo AbstractLens ============ Package : away3d.cameras.lenses Class : public class AbstractLens Subclasses : OrthogonalLens, PerspectiveLens, SphericalLens, ZoomFocusLens Description : s position and properties PROTECTED PROPERTIES _camera : Camera3D - (AbstractLens) _cameraVarsStore : CameraVarsStore - (AbstractLens) classification : int - (AbstractLens) _clipBottom : Number - (AbstractLens) _clipHeight : Number - (AbstractLens) _clipLeft : Number - (AbstractLens) _clipping : Clipping - (AbstractLens) _clipRight : Number - (AbstractLens) _clipTop : Number - (AbstractLens) _clipWidth : Number - (AbstractLens) _drawPrimitiveStore : DrawPrimitiveStore - (AbstractLens) _far : Number - (AbstractLens) _focusOverZoom : Number - (AbstractLens) _frustum : Frustum - (AbstractLens) _len : Number - (AbstractLens) _near : Number - (AbstractLens) _persp : Number - (AbstractLens) _plane : Plane3D - (AbstractLens) _projected : ScreenVertex - (AbstractLens) _screenVertex : ScreenVertex - (AbstractLens) _scz : Number - (AbstractLens) _sw : Number - (AbstractLens) _sx : Number - (AbstractLens) _sy : Number - (AbstractLens) _sz : Number - (AbstractLens) _view : View3D - (AbstractLens) view : Matrix3D - (AbstractLens) viewTransform : Matrix3D - (AbstractLens) _vx : Number - (AbstractLens) _vy : Number - (AbstractLens) _vz : Number - (AbstractLens) _zoom2 : Number - (AbstractLens) PUBLIC METHODS setView(val:View3D):void - (AbstractLens) PROTECTED CONSTANTS toDEGREES : Number - (AbstractLens) toRADIANS : Number - (AbstractLens) PROPERTY DETAIL protected var _camera:Camera3D protected var _cameraVarsStore:CameraVarsStore protected var classification:int protected var _clipBottom:Number protected var _clipHeight:Number protected var _clipLeft:Number protected var _clipping:Clipping protected var _clipRight:Number protected var _clipTop:Number protected var _clipWidth:Number protected var _drawPrimitiveStore:DrawPrimitiveStore protected var _far:Number protected var _focusOverZoom:Number protected var _frustum:Frustum protected var _len:Number protected var _near:Number protected var _persp:Number protected var _plane:Plane3D protected var _projected:ScreenVertex protected var _screenVertex:ScreenVertex protected var _scz:Number protected var _sw:Number protected var _sx:Number protected var _sy:Number protected var _sz:Number protected var _view:View3D protected var view:Matrix3D protected var viewTransform:Matrix3D protected var _vx:Number protected var _vy:Number protected var _vz:Number protected var _zoom2:Number METHOD DETAIL public function setView(val:View3D):void Parameters val:View3D CONSTANT DETAIL protected const toDEGREES:Number protected const toRADIANS:Number CODE EXAMPLES There are currently no examples for this class AbstractParser ============== Package : away3d.loaders Class : public class AbstractParser Inheritance Subclasses : Ase, Collada, Kmz, Max3DS, Md2, Md2still, Obj Description : PUBLIC PROPERTIES container : Object3D - 3d container object used for storing the parsed 3ds object. (AbstractParser) parsedChunks : int - [read-only] Returns the total number of data chunks parsed (AbstractParser) totalChunks : int - [read-only] Returns the total number of data chunks available (AbstractParser) PUBLIC METHODS parseNext():void - Processes the next chunk in the parser (AbstractParser) PROPERTY DETAIL public var container:Object3D 3d container object used for storing the parsed 3ds object. parsedChunks:int[read-only] Returns the total number of data chunks parsed Implementation public function get parsedChunks():int totalChunks:int[read-only] Returns the total number of data chunks available Implementation public function get totalChunks():int METHOD DETAIL public function parseNext():void Processes the next chunk in the parser CODE EXAMPLES There are currently no examples for this class AbstractPrimitive ================= Package : away3d.primitives Class : public class AbstractPrimitive Inheritance : Mesh, Object3D Subclasses : Cone, Cube, Cylinder, GeodesicSphere, Plane, RegularPolygon, RoundedCube, Sphere, Torus Description : Abstract base class for shaded primitives PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) outline : ISegmentMaterial - Defines a segment material to be used for outlining the 3d object. (Mesh) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) (^) session : AbstractRenderSession - The render session used by the 3d object (Object3D) (^) smooth : Boolean - Determines whether the animation will smooth motion (interpolate) between frames. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (AbstractPrimitive) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) 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 (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) updateObject():void - (AbstractPrimitive) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) getDefaultMaterial():IMaterial - (Mesh) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) 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. public override function updateObject():void CODE EXAMPLES There are currently no examples for this class AbstractRenderSession ===================== Package : away3d.core.render Class : public class AbstractRenderSession Inheritance Subclasses : BitmapRenderSession, SpriteRenderSession Description : PUBLIC PROPERTIES alpha : Number = 1 - Placeholder for alpha property of containers (AbstractRenderSession) blendMode : String - Placeholder for blendMode property of containers (AbstractRenderSession) children : Dictionary - Dictionary of child displayobjects. (AbstractRenderSession) consumer : IPrimitiveConsumer - (AbstractRenderSession) filters : Array - Placeholder for filters property of containers (AbstractRenderSession) graphics : Graphics - Reference to the current graphics object being used for drawing. (AbstractRenderSession) newLayer : Sprite - Holds the last added layer sprite. (AbstractRenderSession) parent : AbstractRenderSession - (AbstractRenderSession) priconsumers : Dictionary - (AbstractRenderSession) primitives : Array - (AbstractRenderSession) renderer : IPrimitiveConsumer - (AbstractRenderSession) sessions : Array - Array of child sessions. (AbstractRenderSession) spriteLayers : Array - Dictionary of sprite layers for rendering composite materials. (AbstractRenderSession) updated : Boolean - (AbstractRenderSession) PUBLIC METHODS addChildSession(session:AbstractRenderSession):void - Adds a session as a child of the session object. (AbstractRenderSession) 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) addOnSessionUpdate(listener:Function):void - Default method for adding a sessionUpdated event listener (AbstractRenderSession) clear(view:View3D):void - Clears the render session. (AbstractRenderSession) clearChildSessions():void - (AbstractRenderSession) clearRenderers():void - (AbstractRenderSession) clone():AbstractRenderSession - Duplicates the render session's properties to another render session. (AbstractRenderSession) getConsumer(view:View3D):IPrimitiveConsumer - (AbstractRenderSession) getContainer(view:View3D):DisplayObject - Returns a display object representing the container for the specified view. (AbstractRenderSession) getTotalFaces(view:View3D):int - (AbstractRenderSession) removeChildSession(session:AbstractRenderSession):void - Removes a child session of the session object. (AbstractRenderSession) removeOnSessionUpdate(listener:Function):void - Default method for removing a sessionUpdated event listener (AbstractRenderSession) render(view:View3D):void - (AbstractRenderSession) renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void - Draws a billboard element with a fill bitmap into the graphics object. (AbstractRenderSession) renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void - Draws a billboard element with a fill color into the graphics object. (AbstractRenderSession) renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void - Draws a non-scaled bitmap into the graphics object. (AbstractRenderSession) renderFogColor(clip:Clipping, 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, layerGraphics:Graphics = null):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) onSessionUpdate(event:SessionEvent):void - (AbstractRenderSession) EVENTS (AbstractRenderSession) PROPERTY DETAIL public var alpha:Number = 1 Placeholder for alpha property of containers public var blendMode:String Placeholder for blendMode property of containers public var children:Dictionary Dictionary of child displayobjects. public var consumer:IPrimitiveConsumer 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 filters:Array Placeholder for filters property of containers public var graphics:Graphics Reference to the current graphics object being used for drawing. public var newLayer:Sprite Holds the last added layer sprite. public var parent:AbstractRenderSession public var priconsumers:Dictionary public var primitives:Array renderer:IPrimitiveConsumer[read-write] Implementation public function get renderer():IPrimitiveConsumer public function set renderer(value:IPrimitiveConsumer):void public var sessions:Array Array of child sessions. public var spriteLayers:Array Dictionary of sprite layers for rendering composite materials. See also away3d.materials.CompositeMaterial.renderTriangle() public var updated:Boolean METHOD DETAIL public function addChildSession(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 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 addOnSessionUpdate(listener:Function):void Default method for adding a sessionUpdated event listener Parameters listener:Function — The listener function public function clear(view:View3D):void Clears the render session. Parameters view:View3D public function clearChildSessions():void public function clearRenderers():void 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 getConsumer(view:View3D):IPrimitiveConsumer Parameters view:View3D Returns IPrimitiveConsumer 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 getTotalFaces(view:View3D):int Parameters view:View3D Returns int protected function onSessionUpdate(event:SessionEvent):void Parameters event:SessionEvent public function removeChildSession(session:AbstractRenderSession):void Removes a child session of the session object. Parameters session:AbstractRenderSession — The session object to be removed. public function removeOnSessionUpdate(listener:Function):void Default method for removing a sessionUpdated event listener Parameters listener:Function — The listener function public function render(view:View3D):void Parameters view:View3D public function renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void Draws a billboard element with a fill bitmap into the graphics object. Parameters bitmap:BitmapData primitive:DrawBillboard smooth:Boolean public function renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void Draws a billboard element with a fill color into the graphics object. Parameters color:int alpha:Number primitive:DrawBillboard 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(clip:Clipping, color:int, alpha:Number):void Draws a fog element into the graphics object. Parameters clip:Clipping 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, layerGraphics:Graphics = null):void Draws a triangle element with a fill color into the graphics object. Parameters color:int alpha:Number v0:ScreenVertex v1:ScreenVertex v2:ScreenVertex layerGraphics:Graphics (default = null) 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 EVENT DETAIL Event object type: away3d.events.SessionEvent Dispatched when the render contents of the session require updating. CODE EXAMPLES There are currently no examples for this class AbstractShader ============== Package : away3d.materials.shaders Class : public class AbstractShader Inheritance Implements : ILayerMaterial 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) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (AbstractShader) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (AbstractShader) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (AbstractShader) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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 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(tri:DrawTriangle):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 public function addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener Parameters listener:Function — The listener function public function getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO Parameters faceVO:FaceVO source:Object3D (default = null) view:View3D (default = null) Returns FaceMaterialVO 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 removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener Parameters listener:Function — The listener function public function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face. Parameters tri:DrawTriangle — The face object onto which the rendered sufrace is applied. containerRect:Rectangle — The rectangle object defining the bounds of the face in uv-space. parentFaceMaterialVO:FaceMaterialVO — The value object of the preceeding surface. Returns FaceMaterialVO 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(tri:DrawTriangle):void Renders the shader to the specified face. Parameters tri:DrawTriangle — 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 : Mesh, Object3D Subclasses : GridPlane, WireCircle, WireCone, WireCube, WireCylinder, WirePlane, WireSphere, WireTorus Description : Abstract base class for wire primitives PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) outline : ISegmentMaterial - Defines a segment material to be used for outlining the 3d object. (Mesh) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) (^) session : AbstractRenderSession - The render session used by the 3d object (Object3D) (^) smooth : Boolean - Determines whether the animation will smooth motion (interpolate) between frames. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (AbstractWirePrimitive) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) 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 (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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. (AbstractWirePrimitive) (^) clone(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) updateObject():void - (AbstractWirePrimitive) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS getDefaultMaterial():IMaterial - (AbstractWirePrimitive) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) 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. protected override function getDefaultMaterial():IMaterial Returns IMaterial public override function updateObject():void 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 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) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) (^) center : Vertex - (Object3D) color : int - Defines the color of the light object. (AmbientLight3D) debug : Boolean - Toggles debug mode: light object is visualised in the scene. (AmbientLight3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) debugPrimitive : Object3D - [read-only] (AmbientLight3D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) (^) visible : Boolean - 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the object without altering the apperance of child objects (Object3D) (^) applyRotations():void - Apply the local rotations to the object without altering the apperance of child objects (Object3D) clone(object:Object3D = null):Object3D (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) (^) movePivot(dx:Number, dy:Number, dz:Number):void - Moves the local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (Object3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (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 debug:Boolean[read-write] Toggles debug mode: light object is visualised in the scene. Implementation public function get debug():Boolean public function set debug(value:Boolean):void debugPrimitive:Object3D[read-only] Implementation public function get debugPrimitive():Object3D 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:Object3D = null):Object3D Duplicates the light object's properties to another AmbientLight3D object Parameters object:Object3D (default = null) — [optional] The new object instance into which all properties are copied Returns Object3D — 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 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) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (AbstractShader) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (AbstractShader) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (AbstractShader) (^) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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 clearFaces(source:Object3D, view:View3D):void - (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(tri:DrawTriangle):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 function clearFaces(source:Object3D, view:View3D):void Parameters source:Object3D view:View3D 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(tri:DrawTriangle):void Renders the shader to the specified face. Parameters tri:DrawTriangle — 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) (^) colorTransform : ColorTransform - Defines a colortransform for the texture bitmap. (BitmapMaterial) (^) debug : Boolean - 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 - returns 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 - 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) (^) showNormals : Boolean - Displays the normals per face in pink lines. (BitmapMaterial) (^) smooth : Boolean - 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) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (BitmapMaterial) clear():void - Manually clears all frames of the animation. (AnimatedBitmapMaterial) (^) clearFaces(source:Object3D = null, view:View3D = null):void - Clears facematerial value objects when bitmap requires updating (BitmapMaterial) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (BitmapMaterial) (^) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (TransformBitmapMaterial) (^) invalidateFaces(source:Object3D = null, view:View3D = null):void - Invalidates facematerial value objects when texturemapping requires updating (BitmapMaterial) play():void - Resumes playback of the animation (AnimatedBitmapMaterial) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (BitmapMaterial) (^) renderBillboard(bill:DrawBillboard):void (BitmapMaterial) (^) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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) (^) updateColorTransform():void (BitmapMaterial) (^) updateRenderBitmap():void (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[read-write] returns the frame index of the animation. Implementation public function get index():int 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 clear():void Manually clears all frames of the animation. a new series of bitmapdatas will be required using the setFrames handler. 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) geometry : Geometry - The geometry on which the animation is occurring. (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) mesh : Mesh - 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) transitionValue : Number - (Animation) PUBLIC METHODS (Animation) createTransition():void - Creates a new AnimationTransition object. (Animation) interpolate():void - Smooth interpolations between new AnimationSequence objects (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():void - Updates the positions of vertex objects in the geometry 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. public var geometry:Geometry The geometry on which the animation is occurring. 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 mesh:Mesh 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. transitionValue:Number[read-write] Implementation public function get transitionValue():Number public function set transitionValue(value:Number):void CONSTRUCTOR DETAIL public function Animation(geo:Geometry) Parameters geo:Geometry — The geometry object that the animation acts on. METHOD DETAIL public function createTransition():void Creates a new AnimationTransition object. public function interpolate():void Smooth interpolations between new AnimationSequence objects 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():void Updates the positions of vertex objects in the geometry to the current frame values 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 Orge 3d Animation based on V2.1 //------------------------------------------------------------------ import flash.display.*; import flash.events.*; import flash.geom.*; import away3d.loaders.*; import away3d.core.math.*; import away3d.core.render.*; import away3d.cameras.*; import away3d.core.utils.*; import away3d.core.base.*; import away3d.containers.*; import away3d.primitives.*; import away3d.cameras.*; import away3d.materials.*; import away3d.materials.shaders.*; // import away3d.core.base.AnimationSequence; // var view:View3D = new View3D({x:300, y:200}); addChild(view); var loaderMesh; var loader = Md2.load("ogre.md2",{material:"dragon_tex", name:"ogre", scaling:0.05, y:0, x:10, z:10, loadersize:300}); view.scene.addChild(loader); loader.addOnSuccess(onLoaderSuccess); var fps = 6 //run, stand. attack, salute_alt function onLoaderSuccess(event:Event):void { loaderMesh = (loader.handle as Mesh); loaderMesh.play(new AnimationSequence("fly", true, true, fps)); //loader.handle.play({prefix:"run", smooth:true, loop:true, fps:12}); //(loader.handle as Mesh).play({prefix:"run", smooth:true, loop:true, fps:12}); //loaderMesh.play({prefix:"run", smooth:true, loop:true, fps:12}); //loader.children[0].play({prefix:"run", smooth:true, loop:true, fps:12}); //(loader.result as Mesh).play({prefix:"run", loop:true, smooth:true, fps:12}); addEventListener(Event.ENTER_FRAME, onEnterFrame); } stop_bt.addEventListener(MouseEvent.CLICK, onStop); stepforward_bt.addEventListener(MouseEvent.CLICK, onStepForward); plyPause_bt.addEventListener(MouseEvent.CLICK, onPlyPause); run_bt.addEventListener(MouseEvent.CLICK, onRun); stand_bt.addEventListener(MouseEvent.CLICK, onStand); attack_bt.addEventListener(MouseEvent.CLICK, onAttack); crab_bt.addEventListener(MouseEvent.CLICK, onCrab); salute_bt.addEventListener(MouseEvent.CLICK, onSalute); // //loaderMesh.gotoAndPlay(4); // function onStop (event:Event) { //loaderMesh.play(new AnimationSequence("", true, true, fps)); loaderMesh.gotoAndStop(1); } function onPlyPause (event:Event) { //loaderMesh.play(new AnimationSequence("", true, true, fps)); loaderMesh.gotoAndPlay(loaderMesh.frame); } function onStepForward (event:Event) { //loaderMesh.play(new AnimationSequence("", true, true, fps)); var num = loaderMesh.frame num++; trace(num) loaderMesh.gotoAndStop(num); } function onRun (event:Event) { loaderMesh.play(new AnimationSequence("run", true, true, fps)); } function onStand (event:Event) { //loaderMesh.gotoAndStop(4); loaderMesh.play(new AnimationSequence("stand", true, true, fps)); } function onAttack (event:Event) { loaderMesh.play(new AnimationSequence("attack", true, true, fps)); } function onSalute (event:Event) { //loaderMesh.gotoAndStop(4); loaderMesh.play(new AnimationSequence("salute_alt", true, true, fps)); } function onCrab (event:Event) { loaderMesh.play(new AnimationSequence("cwalk", true, true, fps)); } function onEnterFrame(event:Event):void { view.scene.updateTime(); view.render(); } AnimationData ============= Package : away3d.loaders.data Class : public class AnimationData PUBLIC PROPERTIES animation : IMeshAnimation - Reference to the animation object of the resulting animation. (AnimationData) animationType : String = "skinAnimation" - String representing the animation type. (AnimationData) channels : Dictionary - Dictonary of names representing the animation channels used in the animation. (AnimationData) end : Number = 0 - Reference to the number of seconds the animation ends. (AnimationData) name : String - The name of the animation used as a unique reference. (AnimationData) start : Number = Infinity - Reference to the time the animation starts. (AnimationData) PUBLIC METHODS clone(object:Object3D):AnimationData - (AnimationData) PUBLIC CONSTANTS SKIN_ANIMATION : String = "skinAnimation" - [static] String representing a skin animation. (AnimationData) VERTEX_ANIMATION : String = "vertexAnimation" - [static] String representing a vertex animation. (AnimationData) PROPERTY DETAIL public var animation:IMeshAnimation Reference to the animation object of the resulting animation. public var animationType:String = "skinAnimation" String representing the animation type. public var channels:Dictionary Dictonary of names representing the animation channels used in the animation. public var end:Number = 0 Reference to the number of seconds the animation ends. public var name:String The name of the animation used as a unique reference. public var start:Number = Infinity Reference to the time the animation starts. METHOD DETAIL public function clone(object:Object3D):AnimationData Parameters object:Object3D Returns AnimationData CONSTANT DETAIL public static const SKIN_ANIMATION:String = "skinAnimation" String representing a skin animation. public static const VERTEX_ANIMATION:String = "vertexAnimation" String representing a vertex animation. 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) SEQUENCE_DONE : String = "sequenceDone" - [static] Defines the value of the type property of a sequenceDone event object. (AnimationEvent) SEQUENCE_UPDATE : String = "sequenceUpdate" - [static] Defines the value of the type property of a sequenceUpdate 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.SEQUENCE_UPDATE and AnimationEvent.SEQUENCE_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 SEQUENCE_DONE:String = "sequenceDone" Defines the value of the type property of a sequenceDone event object. public static const SEQUENCE_UPDATE:String = "sequenceUpdate" Defines the value of the type property of a sequenceUpdate event object. CODE EXAMPLES There are currently no examples for this class AnimationFrame ============== Package : away3d.animators.data 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.animators.data 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 AnimationLibrary ================ Package : away3d.loaders.utils Class : public dynamic class AnimationLibrary Inheritance PUBLIC METHODS : AnimationData Description : addAnimation(name:String):AnimationData - Adds an animation name reference to the library. (AnimationLibrary) getAnimation(name:String):AnimationData - Returns an animation data object for the given name reference in the library. (AnimationLibrary) METHOD DETAIL public function addAnimation(name:String):AnimationData Adds an animation name reference to the library. Parameters name:String Returns AnimationData public function getAnimation(name:String):AnimationData Returns an animation data object for the given name reference in the library. Parameters name:String Returns AnimationData CODE EXAMPLES There are currently no examples for this class AnimationSequence ================= Package : away3d.animators.data 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 = true, loop:Boolean = false, fps:Number = 3) Parameters prefix:String — The prefix string defining frames in the sequence. smooth:Boolean (default = true) — [optional] Determines if the animation should be smoothed (interpolated) between frames. Default = true; loop:Boolean (default = false) — [optional] Determines whether the animation sequence should loop. Default = false; fps:Number (default = 3) — [optional] Determines the speed of playback in keyframes of per second. Default = 3; CODE EXAMPLES There are currently no examples for this class AnimationTransition =================== Package : away3d.core.base Class : public class AnimationTransition PUBLIC PROPERTIES interpolate : Number - [read-only] (AnimationTransition) transitionValue : Number - (AnimationTransition) PUBLIC METHODS - (AnimationTransition) reset():void - (AnimationTransition) update():void - (AnimationTransition) PROPERTY DETAIL interpolate:Number[read-only] Implementation public function get interpolate():Number transitionValue:Number[read-write] Implementation public function get transitionValue():Number public function set transitionValue(value:Number):void CONSTRUCTOR DETAIL public function AnimationTransition(geo:Geometry) Parameters geo:Geometry METHOD DETAIL public function reset():void public function update():void CODE EXAMPLES There are currently no examples for this class Animator ======== Package : away3d.animators Class : public class Animator Inheritance : Mesh, Object3D Description : PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) framelist : Array - [read-only] (Animator) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) outline : ISegmentMaterial - Defines a segment material to be used for outlining the 3d object. (Mesh) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) (^) session : AbstractRenderSession - The render session used by the 3d object (Object3D) (^) smooth : Boolean - Determines whether the animation will smooth motion (interpolate) between frames. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES (Animator) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) addFace(face:Face):void - Adds a face object to the mesh object. (Mesh) addFrames(aFrames:Array):void - Add new frames to the object at runtime (Animator) (^) addOnCycle(listener:Function):void - Default method for adding a cycle event listener (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) scaleAnimation(scale:Number):void - Scales the vertex positions contained within all animation frames (Animator) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) getDefaultMaterial():IMaterial - (Mesh) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (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 — The Mesh to be used as reference aFrames:Array — [optional] An initialisation object for specifying default instance properties. init:Object (default = null) — [optional] If the geometry needs to be shown in a loop doloop:Boolean (default = false) METHOD DETAIL public function addFrames(aFrames:Array):void Add new frames to the object at runtime Parameters aFrames:Array public function generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void Parameters baseObject:Mesh aFrames:Array doloop:Boolean public function scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames Parameters scale:Number — The scaling value 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(tree:QuadrantRenderer, 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(tree:QuadrantRenderer, scene:Scene3D, camera:Camera3D, clip:Clipping):void Applies the filter to the quadrant tree. Parameters tree:QuadrantRenderer — 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 AS3Exporter =========== Package : away3d.exporters Class : public class AS3Exporter PUBLIC METHODS - Generates a string in the Actionscript3 format representing the object3D(s). (AS3Exporter) CONSTRUCTOR DETAIL public function AS3Exporter(object3d:Object3D, classname:String, packagename:String = "") Parameters object3d:Object3D — Object3D. The Object3D to be exported to the AS3 format. classname:String — Defines the class name used in the output string. packagename:String (default = "") — [optional] Defines the package name used in the output string. Defaults to no package. The generated class will require one parameter: a Scene3D object already instanciated, and optional an init object with property scaling. Default being 1. Example: var myClass:ClassName = new ClassName(this.view.scene, {scaling:.5}); To access the objects stored into the class: - ClassName.containers, a getter returns the ObjectContainers3D Array. - ClassName.meshes, a getter returns the Mesh Array. Example to access to change a material (ClassName.meshes[0] as Mesh).material = myNewMat; CODE EXAMPLES There are currently no examples for this class Ase === Package : away3d.loaders Class : public class Ase Inheritance : AbstractParser Description : PUBLIC PROPERTIES (^) container : Object3D - 3d container object used for storing the parsed 3ds object. (AbstractParser) (^) parsedChunks : int - Returns the total number of data chunks parsed (AbstractParser) (^) totalChunks : int - Returns the total number of data chunks available (AbstractParser) 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):Mesh - [static] Creates a 3d mesh object from the raw ascii data of the ase file. (Ase) (^) parseNext():void - Processes the next chunk in the parser (AbstractParser) CONSTRUCTOR DETAIL public function Ase(data:*, init:Object = null) Parameters data:* — 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):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. Returns Mesh — A 3d mesh object representation of the ase file. CODE EXAMPLES There are currently no examples for this class AWTweener ========= Package : away3d.animators.utils Class : public class AWTweener PUBLIC METHODS - AWTweener, a simplified tweening system to allow native tweens. (AWTweener) calculate(fps:Number = 30, startval:Number = 0, endval:Number = 1, duration:Number = 250, easeIn:Boolean = false, easeOut:Boolean = false):Array - [static] precalculates the numerical tween, returns steps as array (AWTweener) CONSTRUCTOR DETAIL public function AWTweener() METHOD DETAIL public static function calculate(fps:Number = 30, startval:Number = 0, endval:Number = 1, duration:Number = 250, easeIn:Boolean = false, easeOut:Boolean = false):Array precalculates the numerical tween, returns steps as array Parameters fps:Number (default = 30) — fps Number. Frame rate per second. Default = 30. startval:Number (default = 0) — startval Number. Start value. Default = 0. endval:Number (default = 1) — endval Number. End value. Default = 1. duration:Number (default = 250) — duration Number. Duration in millisec. Default = 250. easeIn:Boolean (default = false) — easeIn Boolean. If the values are tweened with an ease in. Default = false. easeOut:Boolean (default = false) — easeOut Boolean. If the values are tweened with an ease out. Default = false. Returns Array — Array Returns an array contatining the tweened values 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 based on V1.9.2 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 BasicRenderer ============= Package : away3d.core.render Class : public class BasicRenderer Implements : IPrimitiveConsumer, IRenderer Description : PUBLIC PROPERTIES filters : Array - Defines the array of filters to be used on the drawing primitives. (BasicRenderer) PUBLIC METHODS (BasicRenderer) clear(view:View3D):void - (BasicRenderer) clone():IPrimitiveConsumer - (BasicRenderer) list():Array - A list of primitives that have been clipped and blocked. (BasicRenderer) primitive(pri:DrawPrimitive):Boolean - Adds a drawing primitive to the primitive consumer (BasicRenderer) render(view:View3D):void - (BasicRenderer) toString():String - Used to trace the values of a renderer. (BasicRenderer) PROPERTY DETAIL filters:Array[read-write] Defines the array of filters to be used on the drawing primitives. Implementation public function get filters():Array public function set filters(value:Array):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 clear(view:View3D):void Parameters view:View3D public function clone():IPrimitiveConsumer Returns IPrimitiveConsumer public function list():Array A list of primitives that have been clipped and blocked. Returns Array — An array containing the primitives to be rendered. public function primitive(pri:DrawPrimitive):Boolean Adds a drawing primitive to the primitive consumer Parameters pri:DrawPrimitive — The drawing primitive to add. Returns Boolean — Whether the primitive was added. public function render(view:View3D):void Parameters view:View3D 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 BezierPatch =========== Package : away3d.primitives Class : public class BezierPatch Inheritance : Mesh, Object3D Description : PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) connectMirrors : Number - (BezierPatch) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) outline : ISegmentMaterial - Defines a segment material to be used for outlining the 3d object. (Mesh) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) patchData : PatchData - (BezierPatch) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) renderMode : Number - (BezierPatch) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) (^) session : AbstractRenderSession - The render session used by the 3d object (Object3D) (^) smooth : Boolean - Determines whether the animation will smooth motion (interpolate) between frames. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) xOffset : Number - (BezierPatch) (^) y : Number (Object3D) yOffset : Number - (BezierPatch) (^) z : Number (Object3D) zOffset : Number - (BezierPatch) PROTECTED PROPERTIES (BezierPatch) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) 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 (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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) buildPatch():void - Generate the patch mesh based on the patch data and render modes. (BezierPatch) (^) clone(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) refreshPatch():void - Refresh the patch with updated patch data information - this is far quicker than re-building the patch (BezierPatch) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) getDefaultMaterial():IMaterial - (Mesh) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) PUBLIC CONSTANTS B : int = 2048 - [static] (BezierPatch) BACK : Array - [static] (BezierPatch) BASEWIRE_ONLY : int = 2 - [static] (BezierPatch) BOTTOM : Array - [static] (BezierPatch) BOTTOMLEFT : int = 3 - [static] (BezierPatch) BOTTOMRIGHT : int = 4 - [static] (BezierPatch) BX : int - [static] (BezierPatch) BY : int - [static] (BezierPatch) BZ : int - [static] (BezierPatch) FRONT : Array - [static] (BezierPatch) L : int = 256 - [static] (BezierPatch) LEFT : Array - [static] (BezierPatch) LX : int - [static] (BezierPatch) LY : int - [static] (BezierPatch) LZ : int - [static] (BezierPatch) MIRRORWIRE_ONLY : int = 3 - [static] (BezierPatch) N : int = 1 - [static] (BezierPatch) NOTSET : int = 0 - [static] (BezierPatch) PATCH : int = 0 - [static] (BezierPatch) R : int = 512 - [static] (BezierPatch) RIGHT : Array - [static] (BezierPatch) RX : int - [static] (BezierPatch) RY : int - [static] (BezierPatch) RZ : int - [static] (BezierPatch) T : int = 1024 - [static] (BezierPatch) TOP : Array - [static] (BezierPatch) TOPLEFT : int = 1 - [static] (BezierPatch) TOPRIGHT : int = 2 - [static] (BezierPatch) TX : int - [static] (BezierPatch) TY : int - [static] (BezierPatch) TZ : int - [static] (BezierPatch) WIRE_ONLY : int = 1 - [static] (BezierPatch) X : int = 2 - [static] (BezierPatch) XY : int = 32 - [static] (BezierPatch) XYZ : int = 64 - [static] (BezierPatch) XZ : int = 4 - [static] (BezierPatch) Y : int = 16 - [static] (BezierPatch) YZ : int = 128 - [static] (BezierPatch) Z : int = 8 - [static] (BezierPatch) PROPERTY DETAIL public var connectMirrors:Number public var patchData:PatchData public var renderMode:Number public var xOffset:Number public var yOffset:Number public var zOffset:Number CONSTRUCTOR DETAIL public function BezierPatch(patchDataPrm:PatchData, init:Object = null) Parameters patchDataPrm:PatchData — Patch definition for this object. init:Object (default = null) — [optional] An initialisation object for specifying default instance properties. Init Parameters xoffset:Number (default = 0) yoffset:Number (default = 0) zoffset:Number (default = 0) renderMode:Int (default = 0, min:0, max:3 } ) METHOD DETAIL public function buildPatch():void Generate the patch mesh based on the patch data and render modes. public function refreshPatch():void Refresh the patch with updated patch data information - this is far quicker than re-building the patch CONSTANT DETAIL public static const B:int = 2048 public static const BACK:Array public static const BASEWIRE_ONLY:int = 2 public static const BOTTOM:Array public static const BOTTOMLEFT:int = 3 public static const BOTTOMRIGHT:int = 4 public static const BX:int public static const BY:int public static const BZ:int public static const FRONT:Array public static const L:int = 256 public static const LEFT:Array public static const LX:int public static const LY:int public static const LZ:int public static const MIRRORWIRE_ONLY:int = 3 public static const N:int = 1 public static const NOTSET:int = 0 public static const PATCH:int = 0 public static const R:int = 512 public static const RIGHT:Array public static const RX:int public static const RY:int public static const RZ:int public static const T:int = 1024 public static const TOP:Array public static const TOPLEFT:int = 1 public static const TOPRIGHT:int = 2 public static const TX:int public static const TY:int public static const TZ:int public static const WIRE_ONLY:int = 1 public static const X:int = 2 public static const XY:int = 32 public static const XYZ:int = 64 public static const XZ:int = 4 public static const Y:int = 16 public static const YZ:int = 128 public static const Z:int = 8 CODE EXAMPLES There are currently no examples for this class Billboard ========= Package : away3d.core.base Class : public class Billboard Inheritance : Element Description : PUBLIC PROPERTIES (^) extra : Object - An optional untyped object that can contain used-defined properties. (Element) height : Number - Defines the height of the billboard. (Billboard) material : IBillboardMaterial - Defines the material of the billboard. (Billboard) maxX : Number - [read-only] Returns the maximum x value of the segment (Billboard) maxY : Number - [read-only] Returns the maximum y value of the segment (Billboard) maxZ : Number - [read-only] Returns the maximum z value of the segment (Billboard) minX : Number - [read-only] Returns the minimum x value of the face (Billboard) minY : Number - [read-only] Returns the minimum y value of the face (Billboard) minZ : Number - [read-only] Returns the minimum y value of the face (Billboard) (^) parent : Geometry - Defines the parent 3d object of the segment. (Element) radius2 : Number - [read-only] Returns the squared bounding radius of the billboard. (Billboard) rotation : Number - Defines the rotation of the billboard. (Billboard) scaling : Number (Billboard) vertex : Vertex - Defines the vertex of the billboard. (Billboard) (^) vertexDirty : Boolean - (Element) vertices : Array - [read-only] Returns an array of vertex objects that are used by the segment. (Billboard) (^) visible : Boolean - Determines whether the 3d element is visible in the scene. (Element) width : Number - Defines the width of the billboard. (Billboard) x : Number (Billboard) y : Number (Billboard) z : Number (Billboard) PUBLIC METHODS (Billboard) addOnMaterialChange(listener:Function):void - Default method for adding a materialchanged event listener (Billboard) (^) addOnVertexChange(listener:Function):void - Default method for adding a vertexchanged event listener (Element) (^) addOnVertexValueChange(listener:Function):void - Default method for adding a vertexvaluechanged event listener (Element) (^) addOnVisibleChange(listener:Function):void - Default method for adding a visiblechanged event listener (Element) removeOnMaterialChange(listener:Function):void - Default method for removing a materialchanged event listener (Billboard) (^) removeOnVertexChange(listener:Function):void - Default method for removing a vertexchanged event listener (Element) (^) removeOnVertexValueChange(listener:Function):void - Default method for removing a vertexvaluechanged event listener (Element) (^) removeOnVisibleChange(listener:Function):void - Default method for removing a visiblechanged event listener (Element) EVENTS (Billboard) (^) (Element) (^) (Element) (^) (Element) PROPERTY DETAIL height:Number[read-write] Defines the height of the billboard. Implementation public function get height():Number public function set height(value:Number):void material:IBillboardMaterial[read-write] Defines the material of the billboard. Implementation public function get material():IBillboardMaterial public function set material(value:IBillboardMaterial):void maxX:Number[read-only] Returns the maximum x value of the segment 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 segment Implementation public function get maxY():Number See also maxZ property maxZ:Number[read-only] maxZ:Number[read-only] Returns the maximum z value of the segment Implementation public function get maxZ():Number See also minX property minX:Number[read-only] 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 y value of the face Implementation public function get minZ():Number See also radius2 property radius2:Number[read-only] radius2:Number[read-only] Returns the squared bounding radius of the billboard. Implementation public function get radius2():Number rotation:Number[read-write] Defines the rotation of the billboard. Implementation public function get rotation():Number public function set rotation(value:Number):void scaling:Number[read-write] Defines the scaling of the billboard when an IUVMaterial is used. Implementation public function get scaling():Number public function set scaling(value:Number):void vertex:Vertex[read-write] Defines the vertex of the billboard. Implementation public function get vertex():Vertex public function set vertex(value:Vertex):void vertices:Array[read-only] Returns an array of vertex objects that are used by the segment. Implementation public function get vertices():Array width:Number[read-write] Defines the width of the billboard. Implementation public function get width():Number public function set width(value:Number):void x:Number[read-write] Defines the x coordinate of the billboard relative to the local coordinates of the parent Mesh. Implementation public function get x():Number public function set x(value:Number):void y:Number[read-write] Defines the y coordinate of the billboard relative to the local coordinates of the parent Mesh. Implementation public function get y():Number public function set y(value:Number):void z:Number[read-write] Defines the z coordinate of the billboard relative to the local coordinates of the parent Mesh. Implementation public function get z():Number public function set z(value:Number):void CONSTRUCTOR DETAIL public function Billboard(vertex:Vertex, material:IBillboardMaterial = null, width:Number = 10, height:Number = 10) Parameters vertex:Vertex — The vertex object of the billboard material:IBillboardMaterial (default = null) — [optional] The material used by the billboard to render width:Number (default = 10) height:Number (default = 10) 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.BillboardEvent Dispatched when the material of the billboard changes. CODE EXAMPLES There are currently no examples for this class BillboardEvent ============== Package : away3d.events Class : public class BillboardEvent Inheritance PUBLIC PROPERTIES : Billboard billboard : Billboard Description : - A reference to the Billboard object that is relevant to the event. (BillboardEvent) PUBLIC METHODS (BillboardEvent) clone():Event - Creates a copy of the BillboardEvent object and sets the value of each property to match that of the original. (BillboardEvent) PUBLIC CONSTANTS MATERIAL_CHANGED : String = "materialChanged" - [static] Defines the value of the type property of a materialChanged event object. (BillboardEvent) PROPERTY DETAIL public var billboard:Billboard A reference to the Billboard object that is relevant to the event. CONSTRUCTOR DETAIL public function BillboardEvent(type:String, billboard:Billboard) Parameters type:String — The type of the event. Possible values are: BillboardEvent.MATERIAL_CHANGED. billboard:Billboard — A reference to the Billboard object that is relevant to the event. METHOD DETAIL public override function clone():Event Creates a copy of the BillboardEvent object and sets the value of each property to match that of the original. Returns Event CONSTANT DETAIL 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 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) (^) colorTransform : ColorTransform - Defines a colortransform for the texture bitmap. (BitmapMaterial) (^) debug : Boolean - 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 - 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) (^) showNormals : Boolean - Displays the normals per face in pink lines. (BitmapMaterial) (^) smooth : Boolean - 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) addOnLoadError(listener:Function):void - Default method for adding a loadError event listener (BitmapFileMaterial) addOnLoadProgress(listener:Function):void - Default method for adding a loadProgress event listener (BitmapFileMaterial) addOnLoadSuccess(listener:Function):void - Default method for adding a loadSuccess event listener (BitmapFileMaterial) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (BitmapMaterial) (^) clearFaces(source:Object3D = null, view:View3D = null):void - Clears facematerial value objects when bitmap requires updating (BitmapMaterial) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (BitmapMaterial) (^) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (TransformBitmapMaterial) (^) invalidateFaces(source:Object3D = null, view:View3D = null):void - Invalidates facematerial value objects when texturemapping requires updating (BitmapMaterial) removeOnLoadError(listener:Function):void - Default method for removing a loadError event listener (BitmapFileMaterial) removeOnLoadProgress(listener:Function):void - Default method for removing a loadProgress event listener (BitmapFileMaterial) removeOnLoadSuccess(listener:Function):void - Default method for removing a loadSuccess event listener (BitmapFileMaterial) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (BitmapMaterial) (^) renderBillboard(bill:DrawBillboard):void (BitmapMaterial) (^) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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) (^) updateColorTransform():void (BitmapMaterial) (^) updateRenderBitmap():void (BitmapMaterial) EVENTS (BitmapFileMaterial) (BitmapFileMaterial) (BitmapFileMaterial) 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. METHOD DETAIL public function addOnLoadError(listener:Function):void Default method for adding a loadError event listener Parameters listener:Function — The listener function public function addOnLoadProgress(listener:Function):void Default method for adding a loadProgress event listener Parameters listener:Function — The listener function public function addOnLoadSuccess(listener:Function):void Default method for adding a loadSuccess event listener Parameters listener:Function — The listener function public function removeOnLoadError(listener:Function):void Default method for removing a loadError event listener Parameters listener:Function — The listener function public function removeOnLoadProgress(listener:Function):void Default method for removing a loadProgress event listener Parameters listener:Function — The listener function public function removeOnLoadSuccess(listener:Function):void Default method for removing a loadSuccess event listener Parameters listener:Function — The listener function EVENT DETAIL Event object type: away3d.events.LoaderEvent Dispatched when the material fails to load a file. Event object type: away3d.events.LoaderEvent Dispatched every frame the material is loading. Event object type: away3d.events.LoaderEvent Dispatched when the material completes a file load successfully. CODE EXAMPLES There are currently no examples for this class BitmapMaterial ============== Package : away3d.materials Class : public class BitmapMaterial Inheritance Implements : IBillboardMaterial, ILayerMaterial, ITriangleMaterial, IUVMaterial Subclasses : BitmapMaterialContainer, TransformBitmapMaterial Description : Basic bitmap material 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) colorTransform : ColorTransform - Defines a colortransform for the texture bitmap. (BitmapMaterial) debug : Boolean - 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 - Determines if texture bitmap will tile in uv-space (BitmapMaterial) showNormals : Boolean - Displays the normals per face in pink lines. (BitmapMaterial) smooth : Boolean - 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) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (BitmapMaterial) clearFaces(source:Object3D = null, view:View3D = null):void - Clears facematerial value objects when bitmap requires updating (BitmapMaterial) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (BitmapMaterial) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (BitmapMaterial) invalidateFaces(source:Object3D = null, view:View3D = null):void - Invalidates facematerial value objects when texturemapping requires updating (BitmapMaterial) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (BitmapMaterial) renderBillboard(bill:DrawBillboard):void (BitmapMaterial) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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) updateColorTransform():void (BitmapMaterial) updateRenderBitmap():void (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-write] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData public function set bitmap(value:BitmapData):void 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 colorTransform:ColorTransform[read-write] Defines a colortransform for the texture bitmap. Implementation public function get colorTransform():ColorTransform public function set colorTransform(value:ColorTransform):void debug:Boolean[read-write] Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines. Implementation public function get debug():Boolean public function set debug(value:Boolean):void 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 repeat:Boolean[read-write] Determines if texture bitmap will tile in uv-space Implementation public function get repeat():Boolean public function set repeat(value:Boolean):void showNormals:Boolean[read-write] Displays the normals per face in pink lines. Implementation public function get showNormals():Boolean public function set showNormals(value:Boolean):void smooth:Boolean[read-write] Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen. Implementation public function get smooth():Boolean public function set smooth(value:Boolean):void 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 = false) debug:Boolean (default = false) repeat:Boolean (default = false) precision:Number (default = 0) blendMode:String (default = BlendMode.NORMAL) alpha:Number (default = _alpha, min:0, max:1) color:Color (default = _color) colorTransform:Object (default = ColorTransform) showNormals:Boolean (default = false) METHOD DETAIL public function addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener Parameters listener:Function — The listener function public function clearFaces(source:Object3D = null, view:View3D = null):void Clears facematerial value objects when bitmap requires updating Parameters source:Object3D (default = null) — [optional] The parent 3d object of the face. view:View3D (default = null) — [optional] The view rendering the draw triangle. public function getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO Parameters faceVO:FaceVO source:Object3D (default = null) view:View3D (default = null) Returns FaceMaterialVO 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 invalidateFaces(source:Object3D = null, view:View3D = null):void Invalidates facematerial value objects when texturemapping requires updating Parameters source:Object3D (default = null) — [optional] The parent 3d object of the face. view:View3D (default = null) — [optional] The view rendering the draw triangle. public function removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener Parameters listener:Function — The listener function public function renderBillboard(bill:DrawBillboard):void Sends data from the material coupled with data from the DrawBillboard primitive to the render session. Parameters bill:DrawBillboard public function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face. Parameters tri:DrawTriangle — The face object onto which the rendered sufrace is applied. containerRect:Rectangle — The rectangle object defining the bounds of the face in uv-space. parentFaceMaterialVO:FaceMaterialVO — The value object of the preceeding surface. Returns FaceMaterialVO 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 updateColorTransform():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() CODE EXAMPLES There are currently no examples for this class BitmapMaterialContainer ======================= Package : away3d.materials Class : public class BitmapMaterialContainer Inheritance : BitmapMaterial Implements : ILayerMaterial, ITriangleMaterial 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) (^) color : uint - Defines a colored tint for the texture bitmap. (BitmapMaterial) (^) colorTransform : ColorTransform - Defines a colortransform for the texture bitmap. (BitmapMaterial) (^) debug : Boolean - 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) (^) precision : Number - Corrects distortion caused by the affine transformation (non-perpective) of textures. (BitmapMaterial) (^) repeat : Boolean - Determines if texture bitmap will tile in uv-space (BitmapMaterial) (^) showNormals : Boolean - Displays the normals per face in pink lines. (BitmapMaterial) (^) smooth : Boolean - 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) addMaterial(material:ILayerMaterial):void - (BitmapMaterialContainer) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (BitmapMaterial) (^) clearFaces(source:Object3D = null, view:View3D = null):void - Clears facematerial value objects when bitmap requires updating (BitmapMaterial) clearMaterials():void - (BitmapMaterialContainer) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (BitmapMaterial) (^) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (BitmapMaterial) (^) invalidateFaces(source:Object3D = null, view:View3D = null):void - Invalidates facematerial value objects when texturemapping requires updating (BitmapMaterial) removeMaterial(material:ILayerMaterial):void - (BitmapMaterialContainer) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (BitmapMaterial) (^) renderBillboard(bill:DrawBillboard):void (BitmapMaterial) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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) 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) (^) updateColorTransform():void (BitmapMaterial) updateRenderBitmap():void (BitmapMaterialContainer) PROPERTY DETAIL protected 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) METHOD DETAIL public function addMaterial(material:ILayerMaterial):void Parameters material:ILayerMaterial public function clearMaterials():void 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 function removeMaterial(material:ILayerMaterial):void Parameters material:ILayerMaterial public override function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face. Parameters tri:DrawTriangle — The face object onto which the rendered sufrace is applied. containerRect:Rectangle — The rectangle object defining the bounds of the face in uv-space. parentFaceMaterialVO:FaceMaterialVO — The value object of the preceeding surface. Returns FaceMaterialVO 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 (^) alpha : Number = 1 - Placeholder for alpha property of containers (AbstractRenderSession) (^) blendMode : String - Placeholder for blendMode property of containers (AbstractRenderSession) (^) children : Dictionary - Dictionary of child displayobjects. (AbstractRenderSession) (^) consumer : IPrimitiveConsumer - (AbstractRenderSession) (^) filters : Array - Placeholder for filters property of containers (AbstractRenderSession) (^) graphics : Graphics - Reference to the current graphics object being used for drawing. (AbstractRenderSession) (^) newLayer : Sprite - Holds the last added layer sprite. (AbstractRenderSession) (^) parent : AbstractRenderSession - (AbstractRenderSession) (^) priconsumers : Dictionary - (AbstractRenderSession) (^) primitives : Array - (AbstractRenderSession) (^) renderer : IPrimitiveConsumer - (AbstractRenderSession) (^) sessions : Array - Array of child sessions. (AbstractRenderSession) (^) spriteLayers : Array - Dictionary of sprite layers for rendering composite materials. (AbstractRenderSession) (^) updated : Boolean - (AbstractRenderSession) PUBLIC METHODS (BitmapRenderSession) (^) addChildSession(session:AbstractRenderSession):void - Adds a session as a child of the session object. (AbstractRenderSession) 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) (^) addOnSessionUpdate(listener:Function):void - Default method for adding a sessionUpdated event listener (AbstractRenderSession) clear(view:View3D):void - Clears the render session. (BitmapRenderSession) (^) clearChildSessions():void - (AbstractRenderSession) (^) clearRenderers():void - (AbstractRenderSession) clone():AbstractRenderSession - Duplicates the render session's properties to another render session. (BitmapRenderSession) getBitmapContainer(view:View3D):Bitmap - (BitmapRenderSession) getBitmapData(view:View3D):BitmapData - Returns a bitmapData object containing the rendered view. (BitmapRenderSession) (^) getConsumer(view:View3D):IPrimitiveConsumer - (AbstractRenderSession) getContainer(view:View3D):DisplayObject - Returns a display object representing the container for the specified view. (BitmapRenderSession) (^) getTotalFaces(view:View3D):int - (AbstractRenderSession) (^) removeChildSession(session:AbstractRenderSession):void - Removes a child session of the session object. (AbstractRenderSession) (^) removeOnSessionUpdate(listener:Function):void - Default method for removing a sessionUpdated event listener (AbstractRenderSession) render(view:View3D):void - (BitmapRenderSession) (^) renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void - Draws a billboard element with a fill bitmap into the graphics object. (AbstractRenderSession) (^) renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void - Draws a billboard element with a fill color into the graphics object. (AbstractRenderSession) (^) renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void - Draws a non-scaled bitmap into the graphics object. (AbstractRenderSession) (^) renderFogColor(clip:Clipping, 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, layerGraphics:Graphics = null):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) (^) onSessionUpdate(event:SessionEvent):void - (AbstractRenderSession) EVENTS (^) (AbstractRenderSession) 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(view:View3D):void Clears the render session. Parameters view:View3D 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 function getBitmapContainer(view:View3D):Bitmap Parameters view:View3D Returns Bitmap 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. public override function render(view:View3D):void Parameters view:View3D 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) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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) (^) view : View3D - The view 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(pri: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(pri:Blocker):void Adds blocker primitive to the consumer. Parameters pri: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 Bone ==== Package : away3d.animators.skin Class : public class Bone Inheritance : ObjectContainer3D, Object3D Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) (^) center : Vertex - (Object3D) (^) children : Array - Returns the children of the container as an array of 3d objects (ObjectContainer3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) id : String - (Bone) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) joint : ObjectContainer3D - (Bone) jointRotationX : Number (Bone) jointRotationY : Number (Bone) jointRotationZ : Number (Bone) jointScaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Bone) jointScaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Bone) jointScaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Bone) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) (^) visible : Boolean - Defines whether the 3d object is visible in the scene (Object3D) (^) x : Number (Object3D) (^) y : Number (Object3D) (^) z : Number (Object3D) PROTECTED PROPERTIES - (Bone) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to child objects without altering the appearance of the object container (ObjectContainer3D) (^) applyRotations():void - Apply the local rotations to child objects without altering the appearance of the object container (ObjectContainer3D) clone(object:Object3D = null):Object3D (Bone) cloneAll(object:Object3D = null):Object3D - (Bone) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) getBoneByName(boneName:String):Bone - Returns a bone object specified by name from the child array of the container (ObjectContainer3D) (^) getChildByName(childName: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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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 (ObjectContainer3D) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (ObjectContainer3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) PROPERTY DETAIL public var id:String public var joint:ObjectContainer3D jointRotationX:Number[read-write] Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D. Implementation public function get jointRotationX():Number public function set jointRotationX(value:Number):void jointRotationY:Number[read-write] Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D. Implementation public function get jointRotationY():Number public function set jointRotationY(value:Number):void jointRotationZ:Number[read-write] Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D. Implementation public function get jointRotationZ():Number public function set jointRotationZ(value:Number):void jointScaleX:Number[read-write] Defines the scale of the 3d object along the x-axis, relative to local coordinates. Implementation public function get jointScaleX():Number public function set jointScaleX(value:Number):void jointScaleY:Number[read-write] Defines the scale of the 3d object along the y-axis, relative to local coordinates. Implementation public function get jointScaleY():Number public function set jointScaleY(value:Number):void jointScaleZ:Number[read-write] Defines the scale of the 3d object along the z-axis, relative to local coordinates. Implementation public function get jointScaleZ():Number public function set jointScaleZ(value:Number):void CONSTRUCTOR DETAIL public function Bone(init:Object = null, ... childarray) Parameters init:Object (default = null) ... childarray METHOD DETAIL public override function clone(object:Object3D = null):Object3D Duplicates the 3d object's properties to another Bone object Parameters object:Object3D (default = null) — [optional] The new object instance into which all properties are copied Returns Object3D — The new object instance with duplicated properties applied public override function cloneAll(object:Object3D = null):Object3D Parameters object:Object3D (default = null) Returns Object3D CODE EXAMPLES There are currently no examples for this class BoneData ======== Package : away3d.loaders.data Class : public class BoneData Inheritance : ContainerData, ObjectData Description : PUBLIC PROPERTIES (^) children : Array - An array containing the child 3d objects of the container. (ContainerData) (^) container : ObjectContainer3D - Reference to the 3d container object of the resulting container. (ContainerData) (^) id : String - Colada animation (ObjectData) jointTransform : Matrix3D - Transform information for the joint in a SkinAnimation (BoneData) (^) name : String - The name of the 3d object used as a unique reference. (ObjectData) (^) scale : Number - (ObjectData) (^) transform : Matrix3D - The 3d transformation matrix for the 3d object (ObjectData) PROPERTY DETAIL public var jointTransform:Matrix3D Transform information for the joint in a SkinAnimation 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 : SpringCam, TargetCamera3D Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) dof : Boolean (Camera3D) doflevels : Number = 16 (Camera3D) (^) eulers : Number3D (Object3D) (^) 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) fixedZoom : Boolean - (Camera3D) focus : Number - A divisor value for the perspective depth of the view. (Camera3D) fov : Number - Defines the field of view of the camera in a vertical direction. (Camera3D) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) invViewMatrix : Matrix3D - (Camera3D) lens : ILens - Defines a lens object used in vertex projection (Camera3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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 : View3D - (Camera3D) viewMatrix : Matrix3D - [read-only] Returns the transformation matrix used to resolve the scene to the view. (Camera3D) (^) visible : Boolean - 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) addOnCameraUpdate(listener:Function):void - Default method for adding a cameraUpdated event listener (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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the object without altering the apperance of child objects (Object3D) (^) applyRotations():void - Apply the local rotations to the object without altering the apperance of child objects (Object3D) clone(object:Object3D = null):Object3D (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) (^) movePivot(dx:Number, dy:Number, dz:Number):void - Moves the local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) removeOnCameraUpdate(listener:Function):void - Default method for removing a cameraUpdated event listener (Camera3D) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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():void - Updates the transformation matrix used to resolve the scene to the view. (Camera3D) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (Object3D) (^) updateTransform():void - (Object3D) EVENTS (Camera3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) PROTECTED CONSTANTS toDEGREES : Number = 57.29577951308232 - (Camera3D) toRADIANS : Number = 0.017453292519943295 - (Camera3D) 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 public var fixedZoom:Boolean 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 fov:Number[read-write] Defines the field of view of the camera in a vertical direction. Implementation public function get fov():Number public function set fov(value:Number):void public var invViewMatrix:Matrix3D lens:ILens[read-write] Defines a lens object used in vertex projection Implementation public function get lens():ILens public function set lens(value:ILens):void public var maxblur:Number = 150 Used in DofSprite2D. See also away3d.sprites.DofSprite2D view:View3D[read-write] Implementation public function get view():View3D public function set view(value:View3D):void viewMatrix:Matrix3D[read-only] Returns the transformation matrix used to resolve the scene to the view. Used in the ProjectionTraverser class Implementation public function get viewMatrix():Matrix3D See also away3d.core.traverse.ProjectionTraverser zoom:Number[read-write] Provides an overall scale value to the view Implementation public function get zoom():Number public function set zoom(value:Number):void CONSTRUCTOR DETAIL public function Camera3D(init:Object = null) Parameters init:Object (default = null) — [optional] An initialisation object for specifying default instance properties. Init Parameters fov:Number (default = _fov) focus:Number (default = 100) zoom:Number (default = _zoom) fixedZoom:Boolean (default = true) lens:Object (default = AbstractLens) aperture:Number (default = 22) maxblur:Number (default = 150) doflevels:Number (default = 16) dof:Boolean (default = false) lookat:Position METHOD DETAIL public function addOnCameraUpdate(listener:Function):void Default method for adding a cameraUpdated event listener Parameters listener:Function — The listener function public override function clone(object:Object3D = null):Object3D Duplicates the camera's properties to another Camera3D object. Parameters object:Object3D (default = null) — [optional] The new object instance into which all properties are copied. Returns Object3D — 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 removeOnCameraUpdate(listener:Function):void Default method for removing a cameraUpdated event listener Parameters listener:Function — The listener function 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. public function update():void Updates the transformation matrix used to resolve the scene to the view. Used in the BasicRender class See also away3d.core.render.BasicRender EVENT DETAIL Event object type: away3d.events.CameraEvent Dispatched when the focus or zoom properties of a camera update. See also focus zoom CONSTANT DETAIL protected const toDEGREES:Number = 57.29577951308232 protected const toRADIANS:Number = 0.017453292519943295 CODE EXAMPLES lookAt() an Object based on V1.9.2 camera.lookAt(myObjectA.position); // if mesh it top level object camera.lookAt(myObjectA.worldPosition); // if mesh is in a container CameraEvent =========== Package : away3d.events Class : public class CameraEvent Inheritance PUBLIC PROPERTIES : Camera3D camera : Camera3D Description : - A reference to the session object that is relevant to the event. (CameraEvent) PUBLIC METHODS (CameraEvent) clone():Event - Creates a copy of the FaceEvent object and sets the value of each property to match that of the original. (CameraEvent) PUBLIC CONSTANTS CAMERA_UPDATED : String = "cameraUpdated" - [static] Defines the value of the type property of a cameraUpdated event object. (CameraEvent) PROPERTY DETAIL public var camera:Camera3D A reference to the session object that is relevant to the event. CONSTRUCTOR DETAIL public function CameraEvent(type:String, camera:Camera3D) Parameters type:String — The type of the event. Possible values are: FaceEvent.UPDATED. camera:Camera3D — A reference to the camera 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 CAMERA_UPDATED:String = "cameraUpdated" Defines the value of the type property of a cameraUpdated event object. CODE EXAMPLES There are currently no examples for this class CameraVarsStore =============== Package : away3d.core.utils Class : public class CameraVarsStore PUBLIC PROPERTIES frustumDictionary : Dictionary - (CameraVarsStore) nodeClassificationDictionary : Dictionary - (CameraVarsStore) view : View3D - (CameraVarsStore) viewTransformDictionary : Dictionary - Dictionary of all objects transforms calulated from the camera view for the last render frame (CameraVarsStore) PUBLIC METHODS createFaceVO(face:Face, v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial, back:ITriangleMaterial, uv0:UV, uv1:UV, uv2:UV):FaceVO - (CameraVarsStore) createFrustum(node:Object3D):Frustum - (CameraVarsStore) createUV(u:Number, v:Number, session:AbstractRenderSession):UV - (CameraVarsStore) createVertex(x:Number, y:Number, z:Number):Vertex - (CameraVarsStore) createVertexClassification(vertex:Vertex):VertexClassification - (CameraVarsStore) createVertexClassificationDictionary(source:Object3D):Dictionary - (CameraVarsStore) createViewTransform(node:Object3D):Matrix3D - (CameraVarsStore) reset():void - (CameraVarsStore) PROPERTY DETAIL public var frustumDictionary:Dictionary public var nodeClassificationDictionary:Dictionary public var view:View3D public var viewTransformDictionary:Dictionary Dictionary of all objects transforms calulated from the camera view for the last render frame METHOD DETAIL public function createFaceVO(face:Face, v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial, back:ITriangleMaterial, uv0:UV, uv1:UV, uv2:UV):FaceVO Parameters face:Face v0:Vertex v1:Vertex v2:Vertex material:ITriangleMaterial back:ITriangleMaterial uv0:UV uv1:UV uv2:UV Returns FaceVO public function createFrustum(node:Object3D):Frustum Parameters node:Object3D Returns Frustum public function createUV(u:Number, v:Number, session:AbstractRenderSession):UV Parameters u:Number v:Number session:AbstractRenderSession Returns UV public function createVertex(x:Number, y:Number, z:Number):Vertex Parameters x:Number y:Number z:Number Returns Vertex public function createVertexClassification(vertex:Vertex):VertexClassification Parameters vertex:Vertex Returns VertexClassification public function createVertexClassificationDictionary(source:Object3D):Dictionary Parameters source:Object3D Returns Dictionary public function createViewTransform(node:Object3D):Matrix3D Parameters node:Object3D Returns Matrix3D public function reset():void CODE EXAMPLES There are currently no examples for this class 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:*):IMaterial - [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:*):IMaterial Parameters data:* Returns IMaterial 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 Subclasses : ShadingColorMaterial, WhiteShadingBitmapMaterial Description : PUBLIC PROPERTIES ambient_brightness : Number = 1 - Coefficient for ambient light level (CenterLightingMaterial) diffuse_brightness : Number = 1 - Coefficient for diffuse light level (CenterLightingMaterial) shininess : Number = 20 - Coefficient for shininess 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 addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (CenterLightingMaterial) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (CenterLightingMaterial) 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 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 shininess:Number = 20 Coefficient for shininess level public var specular_brightness:Number = 1 Coefficient for specular light level METHOD DETAIL public function addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener Parameters listener:Function — The listener function public function removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener Parameters listener:Function — The listener function 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 Channel ======= Package : away3d.animators.skin Class : public class Channel PUBLIC PROPERTIES inTangent : Array - (Channel) interpolations : Array - (Channel) name : String - (Channel) outTangent : Array - (Channel) param : Array - (Channel) target : Object3D - (Channel) times : Array - (Channel) type : Array - (Channel) PUBLIC METHODS - (Channel) clone(object:ObjectContainer3D):Channel - (Channel) update(time:Number, interpolate:Boolean = true):void - Updates the channel's target with the data point at the given time in seconds. (Channel) PROPERTY DETAIL public var inTangent:Array public var interpolations:Array public var name:String public var outTangent:Array public var param:Array public var target:Object3D public var times:Array public var type:Array CONSTRUCTOR DETAIL public function Channel(name:String) Parameters name:String METHOD DETAIL public function clone(object:ObjectContainer3D):Channel Parameters object:ObjectContainer3D Returns Channel public function update(time:Number, interpolate:Boolean = true):void Updates the channel's target with the data point at the given time in seconds. Parameters time:Number — Defines the time in seconds of the playhead of the animation. interpolate:Boolean (default = true) — [optional] Defines whether the animation interpolates between channel points Defaults to true. CODE EXAMPLES There are currently no examples for this class ChannelData =========== Package : away3d.loaders.data Class : public class ChannelData PUBLIC PROPERTIES channel : Channel - The channel object. (ChannelData) name : String - The name of the channel used as a unique reference. (ChannelData) type : String - (ChannelData) xml : XML - The xml object (ChannelData) PROPERTY DETAIL public var channel:Channel The channel object. public var name:String The name of the channel used as a unique reference. public var type:String public var xml:XML The xml object CODE EXAMPLES There are currently no examples for this class ChannelLibrary ============== Package : away3d.loaders.utils Class : public dynamic class ChannelLibrary Inheritance PUBLIC METHODS : ChannelData Description : addChannel(name:String, xml:XML):ChannelData - Adds an animation channel name reference to the library. (ChannelLibrary) getChannel(name:String):ChannelData - Returns an animation channel data object for the given name reference in the library. (ChannelLibrary) getChannelArray():Array - Returns an array of all animation channels. (ChannelLibrary) METHOD DETAIL public function addChannel(name:String, xml:XML):ChannelData Adds an animation channel name reference to the library. Parameters name:String xml:XML Returns ChannelData public function getChannel(name:String):ChannelData Returns an animation channel data object for the given name reference in the library. Parameters name:String Returns ChannelData public function getChannelArray():Array Returns an array of all animation channels. Returns Array CODE EXAMPLES There are currently no examples for this class Clipping ======== Package : away3d.core.clip Class : public class Clipping Inheritance Subclasses : FrustumClipping, NearfieldClipping, RectangleClipping Description : PUBLIC PROPERTIES maxX : Number - Maximum allowed x value for primitives (Clipping) maxY : Number - Maximum allowed y value for primitives (Clipping) maxZ : Number - Maximum allowed z value for primitives (Clipping) minX : Number - Minimum allowed x value for primitives (Clipping) minY : Number - Minimum allowed y value for primitives (Clipping) minZ : Number - Minimum allowed z value for primitives (Clipping) objectCulling : Boolean - (Clipping) view : View3D - (Clipping) PROTECTED PROPERTIES ini : Init - (Clipping) PUBLIC METHODS (Clipping) addOnClippingUpdate(listener:Function):void - Default method for adding a clippingUpdated event listener (Clipping) checkFace(faceVO:FaceVO, source:Object3D, clippedFaceVOs:Array):void - (Clipping) checkPrimitive(pri:DrawPrimitive):Boolean - Checks a drawing primitive for clipping. (Clipping) clone(object:Clipping = null):Clipping - (Clipping) rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean - Checks a bounding rectangle for clipping. (Clipping) removeOnClippingUpdate(listener:Function):void - Default method for removing a clippingUpdated event listener (Clipping) screen(container:Sprite, _loaderWidth:int, _loaderHeight:int):Clipping - Returns a clipping object initilised with the edges of the flash movie as the clipping bounds. (Clipping) toString():String - Used to trace the values of a rectangle clipping object. (Clipping) PROPERTY DETAIL protected var ini:Init maxX:Number[read-write] Maximum allowed x value for primitives Implementation public function get maxX():Number public function set maxX(value:Number):void maxY:Number[read-write] Maximum allowed y value for primitives Implementation public function get maxY():Number public function set maxY(value:Number):void maxZ:Number[read-write] Maximum allowed z value for primitives Implementation public function get maxZ():Number public function set maxZ(value:Number):void minX:Number[read-write] Minimum allowed x value for primitives Implementation public function get minX():Number public function set minX(value:Number):void minY:Number[read-write] Minimum allowed y value for primitives Implementation public function get minY():Number public function set minY(value:Number):void minZ:Number[read-write] Minimum allowed z value for primitives Implementation public function get minZ():Number public function set minZ(value:Number):void objectCulling:Boolean[read-write] Implementation public function get objectCulling():Boolean public function set objectCulling(value:Boolean):void view:View3D[read-write] Implementation public function get view():View3D public function set view(value:View3D):void CONSTRUCTOR DETAIL public function Clipping(init:Object = null) Parameters init:Object (default = null) — [optional] An initialisation object for specifying default instance properties. Init Parameters minX:Number (default = -Infinity) minY:Number (default = -Infinity) minZ:Number (default = -Infinity) maxX:Number (default = Infinity) maxY:Number (default = Infinity) maxZ:Number (default = Infinity) METHOD DETAIL public function addOnClippingUpdate(listener:Function):void Default method for adding a clippingUpdated event listener Parameters listener:Function — The listener function public function checkFace(faceVO:FaceVO, source:Object3D, clippedFaceVOs:Array):void Parameters faceVO:FaceVO source:Object3D clippedFaceVOs:Array public function checkPrimitive(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 clone(object:Clipping = null):Clipping Parameters object:Clipping (default = null) Returns Clipping 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 removeOnClippingUpdate(listener:Function):void Default method for removing a clippingUpdated event listener Parameters listener:Function — The listener function public function screen(container:Sprite, _loaderWidth:int, _loaderHeight:int):Clipping Returns a clipping object initilised with the edges of the flash movie as the clipping bounds. Parameters container:Sprite _loaderWidth:int _loaderHeight:int Returns Clipping public override function toString():String Used to trace the values of a rectangle clipping object. Returns String — A string representation of the rectangle clipping object. CODE EXAMPLES There are currently no examples for this class ClippingEvent ============= Package : away3d.events Class : public class ClippingEvent Inheritance PUBLIC PROPERTIES : Clipping clipping : Clipping Description : - A reference to the session object that is relevant to the event. (ClippingEvent) PUBLIC METHODS (ClippingEvent) clone():Event - Creates a copy of the FaceEvent object and sets the value of each property to match that of the original. (ClippingEvent) PUBLIC CONSTANTS CLIPPING_UPDATED : String = "clippingUpdated" - [static] Defines the value of the type property of a ClipingUpdated event object. (ClippingEvent) PROPERTY DETAIL public var clipping:Clipping A reference to the session object that is relevant to the event. CONSTRUCTOR DETAIL public function ClippingEvent(type:String, clipping:Clipping) Parameters type:String — The type of the event. Possible values are: FaceEvent.UPDATED. clipping:Clipping — A reference to the clipping 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 CLIPPING_UPDATED:String = "clippingUpdated" Defines the value of the type property of a ClipingUpdated event object. CODE EXAMPLES There are currently no examples for this class Collada ======= Package : away3d.loaders Class : public class Collada Inheritance : AbstractParser Description : PUBLIC PROPERTIES (^) container : Object3D - 3d container object used for storing the parsed 3ds object. (AbstractParser) containerData : ContainerData - Container data object used for storing the parsed collada data structure. (Collada) (^) parsedChunks : int - Returns the total number of data chunks parsed (AbstractParser) (^) totalChunks : int - Returns the total number of data chunks available (AbstractParser) PUBLIC METHODS (Collada) load(url:String, init:Object = null):Object3DLoader - [static] Loads and parses a collada file into a 3d container object. (Collada) parse(data:*, init:Object = null):ObjectContainer3D - [static] Creates a 3d container object from the raw xml data of a collada file. (Collada) parseNext():void - Processes the next chunk in the parser (Collada) PROPERTY DETAIL public var containerData:ContainerData Container data object used for storing the parsed collada data structure. CONSTRUCTOR DETAIL public function Collada(data:*, init:Object = null) Parameters data:* — 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) shading:Boolean (default = false) 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 parse(data:*, init: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. Returns ObjectContainer3D — A 3d loader object that can be used as a placeholder in a scene while the file is parsing. public override function parseNext():void Processes the next chunk in the parser CODE EXAMPLES There are currently no examples for this class CollisionMap ============ Package : away3d.extrusions Class : public class CollisionMap Inheritance PUBLIC PROPERTIES factorX : Number - (CollisionMap) factorY : Number - (CollisionMap) offsetX : Number - (CollisionMap) offsetY : Number - (CollisionMap) source : BitmapData - (CollisionMap) PUBLIC METHODS - Creates a new CollisionMap (CollisionMap) getColorAt(x:Number, y:Number):Number - If at the given coordinates a color is found that matches a defined color event, the color event will be triggered. (CollisionMap) read(x:Number, y:Number):void - If at the given coordinates a color is found that matches a defined color event, the color event will be triggered. (CollisionMap) setColorEvent(color:Number, eventid:String, listener:Function):void - Defines a color event for this class (CollisionMap) PROPERTY DETAIL factorX:Number[read-write] Implementation public function get factorX():Number public function set factorX(value:Number):void factorY:Number[read-write] Implementation public function get factorY():Number public function set factorY(value:Number):void offsetX:Number[read-write] Implementation public function get offsetX():Number public function set offsetX(value:Number):void offsetY:Number[read-write] Implementation public function get offsetY():Number public function set offsetY(value:Number):void source:BitmapData[read-write] Implementation public function get source():BitmapData public function set source(value:BitmapData):void CONSTRUCTOR DETAIL public function CollisionMap(sourcebmd:BitmapData, factorX:Number = 0, factorY:Number = 0) Parameters sourcebmd:BitmapData — sourcebmd The bitmapdata with color regions to act as trigger. factorX:Number (default = 0) — factorX [optional] A factor scale along the X axis factorY:Number (default = 0) — factorY [optional] A factor scale along the Y axis note that an offset equal to halfwidth/halfheight of the source is set per default. Because most terrains are placed centered at 0,0,0 METHOD DETAIL public function getColorAt(x:Number, y:Number):Number If at the given coordinates a color is found that matches a defined color event, the color event will be triggered. Parameters x:Number — x X coordinate on the source bmd y:Number — y Y coordinate on the source bmd Returns Number — A Number, the color value at coordinates x, y note that offsetX, offsetY, factorX, factorY are applied in this handler public function read(x:Number, y:Number):void If at the given coordinates a color is found that matches a defined color event, the color event will be triggered. Parameters x:Number — x X coordinate on the source bmd y:Number — y Y coordinate on the source bmd note that offsetX, offsetY, factorX, factorY are applied in this handler public function setColorEvent(color:Number, eventid:String, listener:Function):void Defines a color event for this class Parameters color:Number — color A color Number eventid:String — eventid A string to identify that event listener:Function — listener The function that must be triggered note that offsetX, offsetY, factorX, factorY are applied in this handler 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 Inheritance Implements : IBillboardMaterial, IFogMaterial, ITriangleMaterial Description : Material for solid color drawing PUBLIC PROPERTIES alpha : Number - (ColorMaterial) color : uint - (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) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (ColorMaterial) clone():IFogMaterial (ColorMaterial) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (ColorMaterial) renderBillboard(bill:DrawBillboard):void (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) updateMaterial(source:Object3D, view:View3D):void - Called once per render loop when material is visible. (ColorMaterial) PROPERTY DETAIL alpha:Number[read-write] Implementation public function get alpha():Number public function set alpha(value:Number):void color:uint[read-write] 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. 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 addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener Parameters listener:Function — The listener function 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 removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener Parameters listener:Function — The listener function public function renderBillboard(bill:DrawBillboard):void Sends data from the material coupled with data from the DrawBillboard primitive to the render session. Parameters bill:DrawBillboard 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 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 CompositeMaterial ================= Package : away3d.materials Class : public class CompositeMaterial Inheritance Implements : ILayerMaterial, ITriangleMaterial 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) 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) materials : Array - An array of bitmapmaterial objects to be overlayed sequentially. (CompositeMaterial) PUBLIC METHODS (CompositeMaterial) addMaterial(material:ILayerMaterial):void - (CompositeMaterial) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (CompositeMaterial) removeMaterial(material:ILayerMaterial):void - (CompositeMaterial) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (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. protected 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 addMaterial(material:ILayerMaterial):void Parameters material:ILayerMaterial public function addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener Parameters listener:Function — The listener function public function removeMaterial(material:ILayerMaterial):void Parameters material:ILayerMaterial public function removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener Parameters listener:Function — The listener function 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, Object3D Description : PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) height : Number - Defines the height of the cone. (Cone) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the 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 - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) radius : Number - Defines the radius of the cone base. (Cone) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) 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. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - 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) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) 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 (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) (^) updateObject():void - (AbstractPrimitive) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) 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 (^) getDefaultMaterial():IMaterial - (Mesh) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (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 based on V1.9.3 // 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 Subclasses : BoneData Description : PUBLIC PROPERTIES children : Array - An array containing the child 3d objects of the container. (ContainerData) container : ObjectContainer3D - Reference to the 3d container object of the resulting container. (ContainerData) (^) id : String - Colada animation (ObjectData) (^) name : String - The name of the 3d object used as a unique reference. (ObjectData) (^) scale : Number - (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. public var container:ObjectContainer3D Reference to the 3d container object of the resulting container. CODE EXAMPLES There are currently no examples for this class ConvexBlock =========== Package : away3d.blockers Class : public class ConvexBlock Inheritance : Object3D Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) (^) center : Vertex - (Object3D) debug : Boolean - Toggles debug mode: blocker is visualised in the scene. (ConvexBlock) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) (^) visible : Boolean - 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the object without altering the apperance of child objects (Object3D) (^) applyRotations():void - Apply the local rotations to the object without altering the apperance of child objects (Object3D) (^) clone(object:Object3D = null):Object3D (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) (^) movePivot(dx:Number, dy:Number, dz:Number):void - Moves the local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (Object3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (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) 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) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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) (^) view : View3D - The view 3d object of the drawing primitive. (DrawPrimitive) 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 ConvexBlockProjector ==================== Package : away3d.core.project Class : public class ConvexBlockProjector Implements : IBlockerProvider, IPrimitiveProvider Description : PUBLIC PROPERTIES view : View3D - (ConvexBlockProjector) PUBLIC METHODS blockers(source:Object3D, viewTransform:Matrix3D, consumer:IBlockerConsumer):void (ConvexBlockProjector) primitives(source:Object3D, viewTransform:Matrix3D, consumer:IPrimitiveConsumer):void - (ConvexBlockProjector) PROPERTY DETAIL view:View3D[read-write] Implementation public function get view():View3D public function set view(value:View3D):void METHOD DETAIL public function blockers(source:Object3D, viewTransform:Matrix3D, consumer:IBlockerConsumer):void Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object Parameters source:Object3D — The consumer instance viewTransform:Matrix3D consumer:IBlockerConsumer See also away3d.core.traverse.BlockerTraverser away3d.core.block.Blocker public function primitives(source:Object3D, viewTransform:Matrix3D, consumer:IPrimitiveConsumer):void Parameters source:Object3D viewTransform:Matrix3D consumer:IPrimitiveConsumer CODE EXAMPLES There are currently no examples for this class Cube ==== Package : away3d.primitives Class : public class Cube Inheritance : AbstractPrimitive, Mesh, Object3D Description : PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) 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. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) depth : Number - Defines the depth of the cube. (Cube) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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) flip : Boolean - Defines if the cube faces should be reversed, like a skybox. (Cube) (^) fps : int - Determines the frames per second at which the animation will run. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) height : Number - Defines the height of the cube. (Cube) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) map6 : Boolean - Defines if the cube should use a single (3 cols/2 rows) map spreaded over the whole cube. (Cube) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) outline : ISegmentMaterial - Defines a segment material to be used for outlining the 3d object. (Mesh) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) segmentsH : Number - Defines the number of vertical segments that make up the cube. (Cube) segmentsW : Number - Defines the number of horizontal segments that make up the cube. (Cube) (^) session : AbstractRenderSession - The render session used by the 3d object (Object3D) (^) smooth : Boolean - Determines whether the animation will smooth motion (interpolate) between frames. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - 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) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) 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 (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) (^) updateObject():void - (AbstractPrimitive) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) getDefaultMaterial():IMaterial - (Mesh) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (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 flip:Boolean[read-write] Defines if the cube faces should be reversed, like a skybox. Default is false. Implementation public function get flip():Boolean public function set flip(value:Boolean):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 map6:Boolean[read-write] Defines if the cube should use a single (3 cols/2 rows) map spreaded over the whole cube. topleft: left, topcenter:front, topright:right downleft:back, downcenter:top, downright: bottom Default is false. Implementation public function get map6():Boolean public function set map6(value:Boolean):void segmentsH:Number[read-write] Defines the number of vertical segments that make up the cube. Defaults 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 cube. Defaults 1. Implementation public function get segmentsW():Number public function set segmentsW(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. Properties of the init object: width, height, depth, segmentsH, segmentsW, flip, map6, material or faces (as CubeMaterialsData) Init Parameters width:Number (default = 100, min:0) height:Number (default = 100, min:0) depth:Number (default = 100, min:0) flip:Boolean (default = false) faces:CubeMaterials segmentsW:Int (default = 1, min:1) segmentsH:Int (default = 1, min:1) map6:Boolean (default = false) 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 based on V1.9.2 // 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) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) (^) center : Vertex - (Object3D) (^) 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) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) handle : Object3D - Returns a 3d object relating to the currently visible model. (Object3DLoader) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) 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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) parser : AbstractParser - (Object3DLoader) (^) parseTimeout : int - Defines a timeout period for file parsing (in milliseconds). (Object3DLoader) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) (^) visible : Boolean - 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged 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) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to child objects without altering the appearance of the object container (ObjectContainer3D) (^) applyRotations():void - Apply the local rotations to child objects without altering the appearance of the object container (ObjectContainer3D) (^) clone(object:Object3D = null):Object3D (ObjectContainer3D) (^) cloneAll(object:Object3D = null):Object3D (ObjectContainer3D) (^) distanceTo(obj:Object3D):Number - Calulates the absolute distance between the local 3d object position and the position of the given 3d object (Object3D) (^) getBoneByName(boneName:String):Bone - Returns a bone object specified by name from the child array of the container (ObjectContainer3D) (^) getChildByName(childName: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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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 (ObjectContainer3D) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS notifyError(event:Event):void - Listener function for an error event. (CubeLoader) notifyProgress(event:Event):void - Listener function for a progress event. (CubeLoader) (^) notifySuccess(event:Event):void - (Object3DLoader) (^) onGeometryComplete(event:Event):void - Automatically fired on a geometry complete event (Object3DLoader) (^) onGeometryError(event:IOErrorEvent):void - Automatically fired on an geometry error event. (Object3DLoader) (^) onGeometryProgress(event:ProgressEvent):void - Automatically fired on a geometry progress event (Object3DLoader) (^) onParserComplete(event:ParserEvent):void - Automatically fired on a parser complete event (Object3DLoader) (^) onParserError(event:ParserEvent):void - Automatically fired on an parser error event. (Object3DLoader) (^) onParserProgress(event:ParserEvent):void - Automatically fired on a parser progress event (Object3DLoader) (^) onTextureComplete(event:Event):void - Automatically fired on a texture complete event (Object3DLoader) (^) onTextureError(event:IOErrorEvent):void - Automatically fired on an texture error event. (Object3DLoader) (^) onTextureProgress(event:ProgressEvent):void - Automatically fired on a texture progress event (Object3DLoader) (^) updateDimensions():void - (ObjectContainer3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3DLoader) (^) (Object3DLoader) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (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...") parsingtitle:String (default = "Parsing Geometry...") METHOD DETAIL protected override function notifyError(event:Event):void Listener function for an error event. Parameters event:Event protected override function notifyProgress(event:Event):void Listener function for a progress event. Parameters event:Event 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 CurveSegment ============ Package : away3d.animators.data Class : public class CurveSegment PUBLIC PROPERTIES v0 : Number3D - coordinates first anchor. (CurveSegment) v1 : Number3D - coordinates end anchor. (CurveSegment) vc : Number3D - coordinates control vector for this curve. (CurveSegment) PUBLIC METHODS (CurveSegment) PROPERTY DETAIL public var v0:Number3D coordinates first anchor. public var v1:Number3D coordinates end anchor. public var vc:Number3D coordinates control vector for this curve. CONSTRUCTOR DETAIL public function CurveSegment(v0:Number3D, vc:Number3D, v1:Number3D) Parameters v0:Number3D — v0 A Number3D, the start anchor vector of the curve vc:Number3D — vc A Number3D, the control vector of the curve v1:Number3D — v1 A Number3D, the end anchor vector of the curve CODE EXAMPLES There are currently no examples for this class Cylinder ======== Package : away3d.primitives Class : public class Cylinder Inheritance : AbstractPrimitive, Mesh, Object3D Description : PUBLIC PROPERTIES (^) activePrefix : String - return the prefix of the animation actually started. (Mesh) (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) (^) back : ITriangleMaterial - Defines a triangle material to be used for the backface of all faces in the 3d object. (Mesh) (^) billboardMaterial : IBillboardMaterial - (Mesh) (^) billboards : Array - Returns an array of the billboards contained in the mesh 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 (Object3D) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) (^) elements : Array - Returns an array of all elements contained in the mesh object. (Mesh) (^) eulers : Number3D (Object3D) (^) extra : Object - An optional untyped object that can contain used-defined properties (Object3D) (^) faceMaterial : ITriangleMaterial - (Mesh) (^) 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. (Mesh) (^) frame : int - Indicates the current frame of animation (Mesh) (^) geometry : Geometry - Defines the geometry object used for the mesh. (Mesh) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) hasCycleEvent : Boolean - Indicates whether the animation has a cycle event listener (Mesh) (^) hasSequenceEvent : Boolean - Indicates whether the animation has a sequencedone event listener (Mesh) height : Number - Defines the height of the cylinder. (Cylinder) (^) indexes : Array - Placeholder for md2 frame indexes (Mesh) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) isRunning : Boolean - Indicates whether the animation is currently running. (Mesh) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) loop : Boolean - Determines whether the animation will loop. (Mesh) (^) material : IMaterial - Defines the material used to render the faces, segments or billboards in the geometry object. (Mesh) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the 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 - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) radius : Number - Defines the radius of the cylinder. (Cylinder) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (Object3D) (^) segmentMaterial : ISegmentMaterial - (Mesh) (^) segments : Array - Returns an array of the segments contained in the mesh object. (Mesh) 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. (Mesh) (^) transform : Matrix3D (Object3D) (^) transitionValue : Number - (Mesh) (^) type : String = "mesh" - String defining the type of class used to generate the mesh. (Mesh) (^) url : String - String defining the source of the mesh. (Mesh) (^) 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. (Mesh) (^) visible : Boolean - 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) (^) addBillboard(billboard:Billboard):void - Adds a billboard object to the mesh object. (Mesh) (^) 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 (Mesh) (^) 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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 sequenceDone event listener (Mesh) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) addSegment(segment:Segment):void - Adds a segment object to the mesh object. (Mesh) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the geometry without altering the appearance of the mesh (Mesh) (^) applyRotations():void - Apply the local rotations to the geometry without altering the appearance of the mesh (Mesh) (^) 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:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object (Mesh) (^) cloneAll(object:Object3D = null):Object3D - Duplicates the mesh properties to another 3d object, including geometry (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. (Mesh) (^) gotoAndStop(value:int):void - Brings the animation to the specifed frame and stops it there. (Mesh) (^) 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 local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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 (Mesh) (^) playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void - Plays a sequence of frames. (Mesh) (^) quarterFace(face:Face):void - Divides a face object into 4 equal sized face objects. (Mesh) (^) quarterFaces():void - Divides all faces objects of a Mesh into 4 equal sized face objects. (Mesh) (^) removeBillboard(billboard:Billboard):void - Removes a billboard object from the mesh object. (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 (Mesh) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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 sequenceDone event listener (Mesh) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged event listener (Object3D) (^) removeOnTransformChange(listener:Function):void - Default method for removing a transformchanged event listener (Object3D) (^) removeSegment(segment:Segment):void - Removes a segment object from the mesh object. (Mesh) (^) 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler angle (Object3D) (^) scale(scale:Number):void - Scales the contents of the 3d object. (Object3D) (^) setPlaySequences(playlist:Array, loopLast:Boolean = false):void - Passes an array of animationsequence objects to be added to the animation. (Mesh) (^) splitFace(face:Face, side:int = 0):void - Divides a face object into 2 face objects. (Mesh) (^) splitFaces(side:int = 0):void - Divides all faces objects of a Mesh into 2 face objects. (Mesh) (^) 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) (^) triFace(face:Face):void - Divides a face object into 3 face objects. (Mesh) (^) triFaces():void - Divides all faces objects of a Mesh into 3 face objects. (Mesh) (^) updateMaterials(source:Object3D, view:View3D):void - Updates the materials in the mesh object (Mesh) (^) updateObject():void - (AbstractPrimitive) (^) updateSession():void - (Object3D) (^) updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void - update vertex information. (Mesh) 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 (^) getDefaultMaterial():IMaterial - (Mesh) (^) updateDimensions():void - (Mesh) (^) updateTransform():void - (Object3D) EVENTS (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Mesh) (^) (Object3D) (^) (Object3D) (^) (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 based on V1.9.2 //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 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) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (AbstractShader) clearFaces(source:Object3D = null, view:View3D = null):void - Clears facematerial value objects when bitmap requires updating (DiffuseDot3Shader) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (AbstractShader) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (DiffuseDot3Shader) invalidateFaces(source:Object3D = null, view:View3D = null):void - Invalidates facematerial value objects when texturemapping requires updating (DiffuseDot3Shader) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (AbstractShader) (^) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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 (^) 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(tri:DrawTriangle):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 clearFaces(source:Object3D = null, view:View3D = null):void Clears facematerial value objects when bitmap requires updating Parameters source:Object3D (default = null) — [optional] The parent 3d object of the face. view:View3D (default = null) — [optional] 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 invalidateFaces(source:Object3D = null, view:View3D = null):void Invalidates facematerial value objects when texturemapping requires updating Parameters source:Object3D (default = null) — [optional] The parent 3d object of the face. view:View3D (default = null) — [optional] 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(tri:DrawTriangle):void Renders the shader to the specified face. Parameters tri:DrawTriangle — 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) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (AbstractShader) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (AbstractShader) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (AbstractShader) (^) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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 clearFaces(source:Object3D, view:View3D):void - (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(tri:DrawTriangle):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 function clearFaces(source:Object3D, view:View3D):void Parameters source:Object3D view:View3D 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(tri:DrawTriangle):void Renders the shader to the specified face. Parameters tri:DrawTriangle — 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():void - Updates the bitmapData object used as the lightmap for ambient light shading. (DirectionalLight) updateAmbientDiffuseBitmap():void - Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading. (DirectionalLight) updateDiffuseBitmap():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():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. light:DirectionalLight3D[read-write] A reference to the DirectionalLight3D object used by the light primitive. Implementation public function get light():DirectionalLight3D public function set light(value:DirectionalLight3D):void 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():void Updates the bitmapData object used as the lightmap for ambient light shading. public function updateAmbientDiffuseBitmap():void Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading. public function updateDiffuseBitmap():void Updates the bitmapData object used as the lightmap for diffuse light shading. public function updateDirection(e:Object3DEvent):void Updates the direction vector of the directional light. Parameters e:Object3DEvent public function updateSpecularBitmap():void Updates the bitmapData object used as the lightmap for specular light shading. CODE EXAMPLES There are currently no examples for this class DirectionalLight3D ================== Package : away3d.lights Class : public class DirectionalLight3D Inheritance : Object3D Implements : IClonable, ILightProvider 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) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) brightness : Number - Defines a coefficient for the overall light intensity. (DirectionalLight3D) (^) center : Vertex - (Object3D) color : int - Defines the color of the light object. (DirectionalLight3D) debug : Boolean - Toggles debug mode: light object is visualised in the scene. (DirectionalLight3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) debugPrimitive : Object3D - [read-only] (DirectionalLight3D) diffuse : Number - Defines a coefficient for the diffuse light intensity. (DirectionalLight3D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) (^) visible : Boolean - 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the object without altering the apperance of child objects (Object3D) (^) applyRotations():void - Apply the local rotations to the object without altering the apperance of child objects (Object3D) clone(object:Object3D = null):Object3D (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) (^) movePivot(dx:Number, dy:Number, dz:Number):void - Moves the local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (Object3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (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 debug:Boolean[read-write] Toggles debug mode: light object is visualised in the scene. Implementation public function get debug():Boolean public function set debug(value:Boolean):void debugPrimitive:Object3D[read-only] Implementation public function get debugPrimitive():Object3D 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:Object3D = null):Object3D Duplicates the light object's properties to another DirectionalLight3D object Parameters object:Object3D (default = null) — [optional] The new object instance into which all properties are copied Returns Object3D — 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 CODE EXAMPLES There are currently no examples for this class DirSprite2D =========== Package : away3d.sprites Class : public class DirSprite2D Inheritance : Object3D Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (Object3D) bitmaps : Dictionary - [read-only] (DirSprite2D) (^) 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) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) deltaZ : Number - An optional offset value added to the z depth used to sort the sprite (DirSprite2D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) rotation : Number - Defines the overall 2d rotation of the sprite object (DirSprite2D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) scaling : Number - Defines the overall scaling of the sprite object (DirSprite2D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) vertices : Array - [read-only] (DirSprite2D) (^) visible : Boolean - 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the object without altering the apperance of child objects (Object3D) (^) applyRotations():void - Apply the local rotations to the object without altering the apperance of child objects (Object3D) (^) clone(object:Object3D = null):Object3D (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) (^) movePivot(dx:Number, dy:Number, dz:Number):void - Moves the local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (Object3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (Object3D) PROPERTY DETAIL bitmaps:Dictionary[read-only] Implementation public function get bitmaps():Dictionary 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 vertices:Array[read-only] Implementation public function get vertices():Array 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. CODE EXAMPLES Testing DirSprite2D based on V2.1 /** Testing DirSprite2D Sprite used: from the game [http://en.wikipedia.org/wiki/Myth_(computer_game)] @author p48l0.84nd1n[at]gmail.com **/ package dob { import away3d.cameras.Camera3D; import away3d.containers.ObjectContainer3D; import away3d.containers.Scene3D; import away3d.containers.View3D; import away3d.materials.BitmapMaterial; import away3d.materials.IMaterial; import away3d.materials.WireframeMaterial; import away3d.primitives.Plane; import flash.display.BitmapData; import flash.events.Event; import flash.text.TextField; import flash.display.Bitmap; import flash.display.Sprite; import away3d.extrusions.Elevation; import away3d.extrusions.SkinExtrude; import away3d.core.render.Renderer; import away3d.sprites.DirSprite2D; import flash.display.StageScaleMode; import flash.display.StageQuality; public class Main extends Sprite { //Engine variables private var scene:Scene3D; private var viewport:View3D; private var camara:Camera3D; //--LIBRARY ASSETS [Embed(source = "../../assets/elevate3.jpg")] private var road_class:Class; [Embed(source = "../../assets/elevate3_bump.jpg")] private var road_bump_class:Class; private var container:ObjectContainer3D; public function Main() { trace('Iniciando'); iniciar(); addEventListener(Event.ENTER_FRAME, render, false, 0, true); stage.quality = StageQuality.LOW; stage.scaleMode = StageScaleMode.NO_SCALE; } private function iniciar():void { scene = new Scene3D(); camara = new Camera3D( { zoom:10, focus:100, x:-600, y:300, z: -700 } ); viewport = new View3D( { scene:scene, camera:camara, renderer:Renderer.BASIC } ); viewport.x = 250; viewport.y = 250; addChild(viewport); ////////////////////////////// var plano:Plane = new Plane(); plano.segmentsH = 10; plano.segmentsW = 10; plano.width = 500; plano.height = 500; plano.material = new BitmapMaterial((new road_class() as Bitmap).bitmapData); plano.yUp = true; container = new ObjectContainer3D(); scene.addChild(container); poneSoldados(); var tf:TextField = new TextField(); tf.textColor = 0xFF0000; tf.autoSize = 'left'; tf.htmlText = " <a href='http://away3d.com/' target='_blank'><u>Away3D</u></a> test - by <a href='http://flashybot.blogspot.com/' target='_blank'><u>Pablo Bandin</u></a> - getting closer - june 2008"; addChild(tf); container.addChild(plano); camara.lookAt(plano.position); } private function poneSoldados():void { [Embed(source = '../../assets/knight/knight0001.png')] var frontPNG:Class; [Embed(source = '../../assets/knight/knight0003.png')] var leftPNG:Class; [Embed(source = '../../assets/knight/knight0002.png')] var frontleftPNG:Class; [Embed(source = '../../assets/knight/knight0004.png')] var leftbackPNG:Class; [Embed(source = '../../assets/knight/knight0005.png')] var backPNG:Class; [Embed(source = '../../assets/knight/knight0006.png')] var backrightPNG:Class; [Embed(source = '../../assets/knight/knight0007.png')] var rightPNG:Class; [Embed(source = '../../assets/knight/knight0008.png')] var rightFrontPNG:Class; var tmp:DirSprite2D; var total:int = 10; var angulo:Number = 360 / total; var anguloRAD:Number = (Math.PI*2) / total for (var i:int = 0; i < total; i++ ) { tmp = new DirSprite2D(); tmp.add( 1,0,0,(new frontPNG() as Bitmap).bitmapData); tmp.add( 0.7, 0, 0.7, (new frontleftPNG() as Bitmap).bitmapData); tmp.add( 0,0,1,(new leftPNG() as Bitmap).bitmapData); tmp.add( -0.7,0,0.7,(new leftbackPNG() as Bitmap).bitmapData); tmp.add( -1,0,0,(new backPNG() as Bitmap).bitmapData); tmp.add( -0.7,0,-0.7,(new backrightPNG() as Bitmap).bitmapData); tmp.add( 0,0,-1,(new rightPNG() as Bitmap).bitmapData); tmp.add( 0.7,0,-0.7,(new rightFrontPNG() as Bitmap).bitmapData); //tmp.rotationY = -180 + (i * angulo) ; tmp.x = Math.cos(i * angulo) * 100; tmp.z = Math.sin(i * angulo) * 100; tmp.y = 35; tmp.scaling = 0.5; container.addChild(tmp); } } private function render(e:Event):void { viewport.render(); container.rotationY += 1; } } } DirSpriteProjector ================== Package : away3d.core.project Class : public class DirSpriteProjector Implements : IPrimitiveProvider Description : PUBLIC PROPERTIES view : View3D - (DirSpriteProjector) PUBLIC METHODS primitives(source:Object3D, viewTransform:Matrix3D, consumer:IPrimitiveConsumer):void - (DirSpriteProjector) PROPERTY DETAIL view:View3D[read-write] Implementation public function get view():View3D public function set view(value:View3D):void METHOD DETAIL public function primitives(source:Object3D, viewTransform:Matrix3D, consumer:IPrimitiveConsumer):void Parameters source:Object3D viewTransform:Matrix3D consumer:IPrimitiveConsumer 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 Description : PUBLIC PROPERTIES (^) alpha : Number - An optional alpha value that can be applied to the 3d object. (Object3D) (^) animationLibrary : AnimationLibrary - Reference container for all animations used in the container. (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) (^) center : Vertex - (Object3D) (^) debugbb : Boolean - Indicates whether a debug bounding box should be rendered around the 3d object. (Object3D) (^) debugBoundingBox : WireCube - (Object3D) (^) debugBoundingSphere : WireSphere - (Object3D) (^) debugbs : Boolean - Indicates whether a debug bounding sphere should be rendered around the 3d object. (Object3D) deltaZ : Number - An optional offset value added to the z depth used to sort the sprite (DofSprite2D) (^) eulers : Number3D (Object3D) (^) 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) (^) geometryLibrary : GeometryLibrary - Reference container for all geometries used in the container. (Object3D) (^) inverseSceneTransform : Matrix3D - Returns the inverse of sceneTransform. (Object3D) (^) lightarray : ILightConsumer - returns the array of lights contained inside the container. (Object3D) (^) materialLibrary : MaterialLibrary - Reference container for all materials used in the container. (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) (^) objectDepth : Number - Boundary depth of the 3d object return The depth of the mesh (Object3D) (^) objectHeight : Number - Boundary height of the 3d object return The height of the mesh (Object3D) (^) objectWidth : Number - Boundary width of the 3d object return The width of the object (Object3D) (^) ownCanvas : Boolean - Defines whether the contents of the 3d object are rendered using it's own render session (Object3D) (^) ownLights : Boolean - Defines whether the children of the container are rendered using it's own lights. (Object3D) (^) ownSession : AbstractRenderSession - Defines a unique render session for the 3d object. (Object3D) (^) parent : ObjectContainer3D - Defines the parent of the 3d object. (Object3D) (^) pivotPoint : Number3D - Defines the local point around which the object rotates. (Object3D) (^) pivotZero : Boolean - (Object3D) (^) position : Number3D (Object3D) (^) projectorType : String - (Object3D) (^) pushback : Boolean - Elements use their furthest point from the camera when z-sorting (Object3D) (^) pushfront : Boolean - Elements use their nearest point to the camera when z-sorting (Object3D) (^) renderer : IPrimitiveConsumer - An optional renderer object that can be used to render the contents of the object. (Object3D) rotation : Number - Defines the overall 2d rotation of the sprite object (DofSprite2D) (^) rotationX : Number (Object3D) (^) rotationY : Number (Object3D) (^) rotationZ : Number (Object3D) (^) scaleX : Number - Defines the scale of the 3d object along the x-axis, relative to local coordinates. (Object3D) (^) scaleY : Number - Defines the scale of the 3d object along the y-axis, relative to local coordinates. (Object3D) (^) scaleZ : Number - Defines the scale of the 3d object along the z-axis, relative to local coordinates. (Object3D) scaling : Number - Defines the overall scaling of the sprite object (DofSprite2D) (^) scene : Scene3D - Returns the parent scene of the 3d object (Object3D) (^) scenePivotPoint : Number3D - (Object3D) (^) scenePosition : Number3D (Object3D) (^) sceneTransform : Matrix3D (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) (^) visible : Boolean - 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) (^) addOnParentUpdate(listener:Function):void - Default method for adding a parentupdated event listener (Object3D) (^) addOnRollOut(listener:Function):void - Default method for adding a rollOut3D event listener (Object3D) (^) addOnRollOver(listener:Function):void - Default method for adding a rollOver3D 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) (^) addOnSessionChange(listener:Function):void - Default method for adding a sessionchanged event listener (Object3D) (^) addOnTransformChange(listener:Function):void - Default method for adding a transformchanged event listener (Object3D) (^) applyPosition(dx:Number, dy:Number, dz:Number):void - Apply the given position to the object without altering the apperance of child objects (Object3D) (^) applyRotations():void - Apply the local rotations to the object without altering the apperance of child objects (Object3D) (^) clone(object:Object3D = null):Object3D (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) (^) movePivot(dx:Number, dy:Number, dz:Number):void - Moves the local point around which the object rotates. (Object3D) (^) moveRight(distance:Number):void - Moves the 3d object forwards along it's local x axis (Object3D) (^) moveTo(dx:Number, dy:Number, dz:Number):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) (^) 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) (^) removeOnParentUpdate(listener:Function):void - Default method for removing a parentupdated event listener (Object3D) (^) removeOnRollOut(listener:Function):void - Default method for removing a rollOut3D event listener (Object3D) (^) removeOnRollOver(listener:Function):void - Default method for removing a rollOver3D 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) (^) removeOnSessionChange(listener:Function):void - Default method for removing a sessionchanged 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) (^) rotateTo(ax:Number, ay:Number, az:Number):void - Rotates the 3d object directly to a euler 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) (^) updateObject():void - (Object3D) (^) updateSession():void - (Object3D) (^) yaw(angle:Number):void - Rotates the 3d object around it's local y-axis (Object3D) PROTECTED METHODS (^) updateDimensions():void - (Object3D) (^) updateTransform():void - (Object3D) EVENTS (^) (Object3D) (^) (Object3D) (^) (Object3D) (^) (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) CODE EXAMPLES There are currently no examples for this class DofSpriteProjector ================== Package : away3d.core.project Class : public class DofSpriteProjector Implements : IPrimitiveProvider Description : PUBLIC PROPERTIES view : View3D - (DofSpriteProjector) PUBLIC METHODS primitives(source:Object3D, viewTransform:Matrix3D, consumer:IPrimitiveConsumer):void - (DofSpriteProjector) PROPERTY DETAIL view:View3D[read-write] Implementation public function get view():View3D public function set view(value:View3D):void METHOD DETAIL public function primitives(source:Object3D, viewTransform:Matrix3D, consumer:IPrimitiveConsumer):void Parameters source:Object3D viewTransform:Matrix3D consumer:IPrimitiveConsumer 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) 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) (^) addMaterial(material:ILayerMaterial):void - (CompositeMaterial) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (CompositeMaterial) (^) removeMaterial(material:ILayerMaterial):void - (CompositeMaterial) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (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 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) (^) color : uint - Defines a colored tint for the texture bitmap. (BitmapMaterial) (^) colorTransform : ColorTransform - Defines a colortransform for the texture bitmap. (BitmapMaterial) (^) debug : Boolean - 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) 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 - Determines if texture bitmap will tile in uv-space (BitmapMaterial) shininess : Number - The exponential dropoff value used for specular highlights. (Dot3BitmapMaterialCache) (^) showNormals : Boolean - Displays the normals per face in pink lines. (BitmapMaterial) (^) smooth : Boolean - 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) (^) addMaterial(material:ILayerMaterial):void - (BitmapMaterialContainer) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (BitmapMaterial) (^) clearFaces(source:Object3D = null, view:View3D = null):void - Clears facematerial value objects when bitmap requires updating (BitmapMaterial) (^) clearMaterials():void - (BitmapMaterialContainer) (^) getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO - (BitmapMaterial) (^) getPixel32(u:Number, v:Number):uint - Returns the argb value of the bitmapData pixel at the given u v coordinate. (BitmapMaterial) (^) invalidateFaces(source:Object3D = null, view:View3D = null):void - Invalidates facematerial value objects when texturemapping requires updating (BitmapMaterial) (^) removeMaterial(material:ILayerMaterial):void - (BitmapMaterialContainer) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (BitmapMaterial) (^) renderBillboard(bill:DrawBillboard):void (BitmapMaterial) (^) renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO - 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) (^) 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) (^) updateColorTransform():void (BitmapMaterial) (^) updateRenderBitmap():void (BitmapMaterialContainer) 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) moviematerial : MovieMaterial - [read-only] Returns the MovieMaterial object being used as the material texture. (Dot3MovieMaterial) 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) (^) addMaterial(material:ILayerMaterial):void - (CompositeMaterial) (^) addOnMaterialUpdate(listener:Function):void - Default method for adding a materialupdated event listener (CompositeMaterial) (^) removeMaterial(material:ILayerMaterial):void - (CompositeMaterial) (^) removeOnMaterialUpdate(listener:Function):void - Default method for removing a materialupdated event listener (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 bitmap:BitmapData[read-only] Returns the bitmapData object being used as the material texture. Implementation public function get bitmap():BitmapData moviematerial:MovieMaterial[read-only] Returns the MovieMaterial object being used as the material texture. Implementation public function get moviematerial():MovieMaterial 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. CODE EXAMPLES There are currently no examples for this class DrawBillboard ============= Package : away3d.core.draw Class : public class DrawBillboard Inheritance : DrawPrimitive Description : Billboard primitive PUBLIC PROPERTIES (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (DrawPrimitive) height : Number - The height of the billboard if a non-uv material is used. (DrawBillboard) mapping : Matrix - (DrawBillboard) material : IBillboardMaterial - The material object used as the billboard primitive's texture. (DrawBillboard) (^) 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) (^) 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. (DrawBillboard) scale : Number - A scaling value used to scale the billboard primitive relative to the dimensions of a uv material. (DrawBillboard) screenvertex : ScreenVertex - The screenvertex used to position the billboard primitive in the view. (DrawBillboard) (^) 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) (^) view : View3D - The view 3d object of the drawing primitive. (DrawPrimitive) width : Number - The width of the billboard if a non-uv material is used. (DrawBillboard) PUBLIC METHODS calc():void - Calculates the min, max and screen properties required for rendering the drawing primitive. (DrawBillboard) clear():void - Deletes the data currently held by the drawing primitive. (DrawBillboard) contains(x:Number, y:Number):Boolean - Determines whether the given point lies inside the drawing primitive (DrawBillboard) (^) 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. (DrawBillboard) (^) toString():String - Used to trace the values of a drawing primitive. (DrawPrimitive) PROPERTY DETAIL public var height:Number The height of the billboard if a non-uv material is used. public var mapping:Matrix public var material:IBillboardMaterial The material object used as the billboard primitive's 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 billboard primitive relative to the dimensions of a uv material. public var screenvertex:ScreenVertex The screenvertex used to position the billboard primitive in the view. public var width:Number The width of the billboard if a non-uv material is used. 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 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) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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) (^) view : View3D - The view 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) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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 session used by the drawing primitive. (DrawDisplayObject) (^) source : Object3D - The parent 3d object of the drawing primitive. (DrawPrimitive) (^) view : View3D - The view 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 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 clip : Clipping - The clipping object used to render the drawing primitive. (DrawFog) (^) create : Function - Placeholder function for creating new drawing primitives from a cache of objects. (DrawPrimitive) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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) (^) view : View3D - The view 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 clip:Clipping The clipping object used to render the drawing primitive. 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 DrawPrimitive ============= Package : away3d.core.draw Class : public class DrawPrimitive Subclasses : Blocker, DrawBillboard, DrawBitmap, DrawDisplayObject, DrawFog, 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) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) 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) view : View3D - The view 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 generated:Boolean Indicator of whether primitive is the produce of a generator algorithm 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 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. public var view:View3D The view 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 DrawPrimitiveStore ================== Package : away3d.core.utils Class : public class DrawPrimitiveStore PUBLIC PROPERTIES blockerDictionary : Dictionary - (DrawPrimitiveStore) view : View3D - (DrawPrimitiveStore) PUBLIC METHODS createConvexBlocker(source:Object3D, vertices:Array):ConvexBlocker - (DrawPrimitiveStore) createDrawBillboard(source:Object3D, material:IBillboardMaterial, screenvertex:ScreenVertex, width:Number, height:Number, scale:Number, rotation:Number, generated:Boolean = false):DrawBillboard - (DrawPrimitiveStore) createDrawDisplayObject(source:Object3D, screenvertex:ScreenVertex, session:AbstractRenderSession, displayobject:DisplayObject, generated:Boolean = false):DrawDisplayObject - (DrawPrimitiveStore) createDrawScaledBitmap(source:Object3D, screenvertex:ScreenVertex, smooth:Boolean, bitmap:BitmapData, scale:Number, rotation:Number, generated:Boolean = false):DrawScaledBitmap - (DrawPrimitiveStore) createDrawSegment(source:Object3D, material:ISegmentMaterial, v0:ScreenVertex, v1:ScreenVertex, generated:Boolean = false):DrawSegment - (DrawPrimitiveStore) createDrawTriangle(source:Object3D, faceVO:FaceVO, material:ITriangleMaterial, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, uv0:UV, uv1:UV, uv2:UV, generated:Boolean = false):DrawTriangle - (DrawPrimitiveStore) createScreenVertex(vertex:Vertex):ScreenVertex - (DrawPrimitiveStore) createVertexDictionary(source:Object3D):Dictionary - (DrawPrimitiveStore) reset():void - (DrawPrimitiveStore) PROPERTY DETAIL public var blockerDictionary:Dictionary public var view:View3D METHOD DETAIL public function createConvexBlocker(source:Object3D, vertices:Array):ConvexBlocker Parameters source:Object3D vertices:Array Returns ConvexBlocker public function createDrawBillboard(source:Object3D, material:IBillboardMaterial, screenvertex:ScreenVertex, width:Number, height:Number, scale:Number, rotation:Number, generated:Boolean = false):DrawBillboard Parameters source:Object3D material:IBillboardMaterial screenvertex:ScreenVertex width:Number height:Number scale:Number rotation:Number generated:Boolean (default = false) Returns DrawBillboard public function createDrawDisplayObject(source:Object3D, screenvertex:ScreenVertex, session:AbstractRenderSession, displayobject:DisplayObject, generated:Boolean = false):DrawDisplayObject Parameters source:Object3D screenvertex:ScreenVertex session:AbstractRenderSession displayobject:DisplayObject generated:Boolean (default = false) Returns DrawDisplayObject public function createDrawScaledBitmap(source:Object3D, screenvertex:ScreenVertex, smooth:Boolean, bitmap:BitmapData, scale:Number, rotation:Number, generated:Boolean = false):DrawScaledBitmap Parameters source:Object3D screenvertex:ScreenVertex smooth:Boolean bitmap:BitmapData scale:Number rotation:Number generated:Boolean (default = false) Returns DrawScaledBitmap public function createDrawSegment(source:Object3D, material:ISegmentMaterial, v0:ScreenVertex, v1:ScreenVertex, generated:Boolean = false):DrawSegment Parameters source:Object3D material:ISegmentMaterial v0:ScreenVertex v1:ScreenVertex generated:Boolean (default = false) Returns DrawSegment public function createDrawTriangle(source:Object3D, faceVO:FaceVO, material:ITriangleMaterial, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, uv0:UV, uv1:UV, uv2:UV, generated:Boolean = false):DrawTriangle Parameters source:Object3D faceVO:FaceVO material:ITriangleMaterial v0:ScreenVertex v1:ScreenVertex v2:ScreenVertex uv0:UV uv1:UV uv2:UV generated:Boolean (default = false) Returns DrawTriangle public function createScreenVertex(vertex:Vertex):ScreenVertex Parameters vertex:Vertex Returns ScreenVertex public function createVertexDictionary(source:Object3D):Dictionary Parameters source:Object3D Returns Dictionary public function reset():void 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) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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) (^) view : View3D - The view 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) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (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) (^) 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) (^) view : View3D - The view 3d object of the drawing primitive. (DrawPrimitive) 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) faceVO : FaceVO - A reference to the face object used by the triangle primitive. (DrawTriangle) (^) generated : Boolean - Indicator of whether primitive is the produce of a generator algorithm (DrawPrimitive) material : ITriangleMaterial - The material object used as the triangle primitive's 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) (^) 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) 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) (^) view : View3D - The view 3d object of the drawing primitive. (DrawPrimitive) 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 faceVO:FaceVO A reference to the face object used by the triangle primitive. public var material:ITriangleMaterial The material object used as the triangle primitive's 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 Element ======= Package : away3d.core.base Class : public class Element Inheritance Subclasses : Billboard, Face, Segment Description : PUBLIC PROPERTIES extra : Object - An optional untyped object that can contain used-defined properties. (Element) maxX : Number - [read-only] Returns the maximum x value of the 3d element (Element) maxY : Number - [read-only] Returns the maximum y value of the 3d element (Element) maxZ : Number - [read-only] Returns the maximum z value of the 3d element (Element) minX : Number - [read-only] Returns the minimum x value of the 3d element (Element) minY : Number - [read-only] Returns the minimum y value of the 3d element (Element) minZ : Number - [read-only] Returns the minimum z value of the 3d element (Element) parent : Geometry - Defines the parent 3d object of the segment. (Element) radius2 : Number - [read-only] Returns the squared bounding radius of the 3d element (Element) vertexDirty : Boolean - (Element) vertices : Array - [read-only] Returns an array of vertex objects that make up the 3d element. (Element) visible : Boolean - Determines whether the 3d element is visible in the scene. (Element) PUBLIC METHODS addOnVertexChange(listener:Function):void - Default method for adding a vertexchanged event listener (Element) addOnVertexValueChange(listener:Function):void - Default method for adding a vertexvaluechanged event listener (Element) addOnVisibleChange(listener:Function):void - Default method for adding a visiblechanged event listener (Element) removeOnVertexChange(listener:Function):void - Default method for removing a vertexchanged event listener (Element) removeOnVertexValueChange(listener:Function):void - Default method for removing a vertexvaluechanged event listener (Element) removeOnVisibleChange(listener:Function):void - Default method for removing a visiblechanged event listener (Element) EVENTS (Element) (Element) (Element) PROPERTY DETAIL public var extra:Object An optional untyped object that can contain used-defined properties. 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 maximum y value of the 3d element Implementation public function get maxY():Number maxZ:Number[read-only] Returns the maximum 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 minimum y value of the 3d element Implementation public function get minY():Number minZ:Number[read-only] Returns the minimum z value of the 3d element Implementation public function get minZ():Number public var parent:Geometry Defines the parent 3d object of the segment. radius2:Number[read-only] Returns the squared bounding radius of the 3d element Implementation public function get radius2():Number public var vertexDirty:Boolean 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] Determines 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.ElementEvent Dispatched when the vertex of a 3d element changes. Event object type: away3d.events.ElementEvent Dispatched when the vertex value of a 3d element changes. Event object type: away3d.events.ElementEvent Dispatched when the visiblity of a 3d element changes. CODE EXAMPLES There are currently no examples for this class ElementEvent ============ Package : away3d.events Class : public class ElementEvent Inheritance PUBLIC PROPERTIES : Element element : Element Description : - A reference to the element object that is relevant to the event. (ElementEvent) PUBLIC METHODS (ElementEvent) clone():Event - Creates a copy of the ElementEvent object and sets the value of each property to match that of the original. (ElementEvent) PUBLIC CONSTANTS VERTEX_CHANGED : String = "vertexChanged" - [static] Defines the value of the type property of a vertexChanged event object. (ElementEvent) VERTEXVALUE_CHANGED : String = "vertexvalueChanged" - [static] Defines the value of the type property of a vertexvalueChanged event object. (ElementEvent) VISIBLE_CHANGED : String = "visibleChanged" - [static] Defines the value of the type property of a visibleChanged event object. (ElementEvent) PROPERTY DETAIL public var element:Element A reference to the element object that is relevant to the event. CONSTRUCTOR DETAIL public function ElementEvent(type:String, element:Element) Parameters type:String — The type of the event. Possible values are: ElementEvent.VERTEX_CHANGED, ElementEvent.VERTEXVALUE_CHANGED and ElementEvent.VISIBLE_CHANGED. element:Element — A reference to the element object that is relevant to the event. METHOD DETAIL public override function clone():Event Creates a copy of the ElementEvent object and sets the value of each property to match that of the original. Returns Event CONSTANT DETAIL public static const VERTEX_CHANGED:String = "vertexChanged" Defines the value of the type property of a vertexChanged event object. public static const VERTEXVALUE_CHANGED:String = "vertexvalueChanged" Defines the value of the type property of a vertexvalueChanged event object. public static const VISIBLE_CHANGED:String = "visibleChanged" Defines the value of the type property of a visibleChanged event object. CODE EXAMPLES There are currently no examples for this class Elevation ========= Package : away3d.extrusions Class : public class Elevation PUBLIC PROPERTIES maxElevation : Number - (Elevation) minElevation : Number - (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 - Generate the Array representing the mesh (Elevation) PROPERTY DETAIL maxElevation:Number[read-write] Implementation public function get maxElevation():Number public function set maxElevation(value:Number):void minElevation:Number[read-write] Implementation public function get minElevation():Number public function set minElevation(value:Number):void 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 Generate the Array representing the mesh Parameters sourceBmd:BitmapData — Bitmapdata. The bitmapData to read from. channel:String (default = "r") — [optional] String. The channel information to read. supported "a", alpha, "r", red, "g", green, "b", blue and "av" (averages and luminance). Default is red channel "r". subdivisionX:int (default = 10) — [optional] int. The subdivision to read the pixels along the x axis. Default is 10. subdivisionY:int (default = 10) — [optional] int. The subdivision to read the pixels along the y axis. Default is 10. scalingX:Number (default = 1) — [optional] Number. The scale multiplier along the x axis. Default is 1. scalingY:Number (default = 1) — [optional] Number. The scale multiplier along the y axis. Default is 1. elevate:Number (default = .5) — [optional] Number. The scale multiplier along the z axis. Default is .5. Returns Array CODE EXAMPLES There are currently no examples for this class Elevation2AS3 ============= Package : away3d.exporters Class : public class Elevation2AS3 PUBLIC PROPERTIES maxElevation : Number - (Elevation2AS3) minElevation : Number - (Elevation2AS3) PUBLIC METHODS - Creates a generate an as3 file of the elevation array. (Elevation2AS3) export(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void - Generate the string representing the mesh and optionally color information for the reader. (Elevation2AS3) PROPERTY DETAIL maxElevation:Number[read-write] Implementation public function get maxElevation():Number public function set maxElevation(value:Number):void minElevation:Number[read-write] Implementation public function get minElevation():Number public function set minElevation(value:Number):void CONSTRUCTOR DETAIL public function Elevation2AS3(classname:String, packagename:String = "", exportmap:Boolean = false) Parameters classname:String — String, the name of the class that will be exported. packagename:String (default = "") — [optional] String. the name of the package that will be exported. exportmap:Boolean (default = false) — [optional] Boolean. Defines if the class should generate an array to pass to the ElevationReader. METHOD DETAIL public function export(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void Generate the string representing the mesh and optionally color information for the reader. Parameters sourceBmd:BitmapData — Bitmapdata. The bitmapData to read from. channel:String (default = "r") — [optional] String. The channel information to read. supported "a", alpha, "r", red, "g", green, "b", blue and "av" (averages and luminance). Default is red channel "r". subdivisionX:int (default = 10) — [optional] int. The subdivision to read the pixels along the x axis. Default is 10. subdivisionY:int (default = 10) — [optional] int. The subdivision to read the pixels along the y axis. Default is 10. factorX:Number (default = 1) — [optional] Number. The scale multiplier along the x axis. Default is 1. factorY:Number (default = 1) — [optional] Number. The scale multiplier along the y axis. Default is 1. elevate:Number (default = .5) — [optional] Number. The scale multiplier along the z axis. Default is .5. CODE EXAMPLES Elevation2AS3 based on V2.1 import away3d.exporters.Elevation2AS3; [ code]; private function generateAS3Terrain():void { var elevationoutput:Elevation2AS3 = new Elevation2AS3("Mountain", "terrains", true); //--> false exports only the mesh of the elevation //--> true exports mesh and readermap data of the elevation var factor:Number = 17; var elevatelevel:Number = 6; var pixelprecision:Number = 100; elevationoutput.export(generateFromLib("elevationsource"), "r", pixelprecision, pixelprecision, factor, factor, elevatelevel); } XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX How to use in your project the as3 output XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX Terrain mesh only: import terrains.Mountain; --> our export generated by the code above [...code...] private function terrainOnly():void { var elevationoutput: Mountain = new Mountain(); var matsource:IMaterial = new BitmapMaterial(bitmapdata_colorsource , {smooth:false, debug:false}); terrain = new SkinExtrude(elevationoutput.data, {material:matsource, recenter:true, coverall:true}); terrain.rotationX = 90; this.scene.addChild(terrain); } Terrain mesh and map: //--> note: this example uses the AS3 generated source as material for the mesh. In your code, change accordingly with your color sources. import terrains.Mountain; [...code...] private function terrainWithMap():void { var elevationoutput: Mountain = new Mountain(); var elevationreader: ElevationReader = new ElevationReader(); elevationoutput.map = elevationreader; var matsource:IMaterial = new BitmapMaterial(elevationreader.source); terrain = new SkinExtrude(elevationoutput.data, {material:matsource, recenter:true, coverall:true}); terrain.rotationX = 90; this.scene.addChild(terrain); } ---> more info read the doc on both Elevation and ElevationReader class ElevationModifier ================= Package : away3d.extrusions Class : public class ElevationModifier PUBLIC METHODS - (ElevationModifier) update(sourceBmd:BitmapData, mesh:Object3D, channel:String = "r", elevate:Number = .5, axis:String = "z"):void - Updates the vertexes of a Mesh on the z axis according to color information stored into a BitmapData (ElevationModifier) CONSTRUCTOR DETAIL public function ElevationModifier() METHOD DETAIL public function update(sourceBmd:BitmapData, mesh:Object3D, channel:String = "r", elevate:Number = .5, axis:String = "z"):void Updates the vertexes of a Mesh on the z axis according to color information stored into a BitmapData Parameters sourceBmd:BitmapData — Bitmapdata. The bitmapData to read from. mesh:Object3D — Object3D. The mesh Object3D to be updated. channel:String (default = "r") — [optional] String. The channel information to read. supported "a", alpha, "r", red, "g", green, "b", blue and "av" (averages and luminance). Default is red channel "r". elevate:Number (default = .5) — [optional] Number. The scale multiplier along the z axis. Default is .5. axis:String (default = "z") — [optional] String. The axis to influence. Default is "z". CODE EXAMPLES There are currently no examples for this class ElevationReader =============== Package : away3d.extrusions Class : public class ElevationReader PUBLIC PROPERTIES maxElevation : Number - (ElevationReader) minElevation : Number - (ElevationReader) source : BitmapData - [read-only] returns the generated bitmapdata, a smooth representation of the geometry. (ElevationReader) PUBLIC METHODS - Class generates a traced representation of the elevation geometry, allowing surface tracking to place or move objects on the elevation geometry. (ElevationReader) applyHeightGradient(src:BitmapData, color:uint = 0x80000000, reverse:Boolean = true, blendmode:String = "normal"):void - Apply the generated height source to a bitmapdata. (ElevationReader) getLevel(x:Number, y:Number, offset:Number = 0):Number - returns the generated bitmapdata, a smooth representation of the geometry. (ElevationReader) setSource(sourceBmd:BitmapData, channel:String = "r", factorX:Number = 1, factorY:Number = 1, factorZ:Number = .5):void - Optional method to be allow the use of a custom (externally) prerendered map. (ElevationReader) traceLevels(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void - generates the smooth representation of the geometry. (ElevationReader) PROPERTY DETAIL maxElevation:Number[read-write] Implementation public function get maxElevation():Number public function set maxElevation(value:Number):void minElevation:Number[read-write] Implementation public function get minElevation():Number public function set minElevation(value:Number):void source:BitmapData[read-only] returns the generated bitmapdata, a smooth representation of the geometry. Implementation public function get source():BitmapData CONSTRUCTOR DETAIL public function ElevationReader(smoothness:int = 0) Parameters smoothness:int (default = 0) METHOD DETAIL public function applyHeightGradient(src:BitmapData, color:uint = 0x80000000, reverse:Boolean = true, blendmode:String = "normal"):void Apply the generated height source to a bitmapdata. The height information is merged to the source creating a smoother look. Parameters src:BitmapData — The bitmapdata that will be merged. color:uint (default = 0x80000000) — [optional] The color that will be applied. Note that 32 bits color will allow alpha. 0x88FF0000 defines a red with .5 alpha while 0xFF0000 defines a red with no alpha. Default is .5 alpha black. reverse:Boolean (default = true) — [optional] Defines if the color is set using the heightmap from 0-255 or 255-0. Default = true, if a black is used, the darkest are will be at the base of the elevation. blendmode:String (default = "normal") — [optional] Blendmode to be applyed in the merge. Possible string values are: lighten, multiply, overlay, screen, substract, add, darken, difference, erase, hardlight, invert and layer.Default = "normal"; public function getLevel(x:Number, y:Number, offset:Number = 0):Number returns the generated bitmapdata, a smooth representation of the geometry. Parameters x:Number — The x coordinate on the generated bitmapdata. y:Number — The y coordinate on the generated bitmapdata. offset:Number (default = 0) — [optional] the offset that will be added to the elevation value at the x and y coordinates plus the offset. Default = 0. Returns Number — A Number, the elevation value at the x and y coordinates plus the offset. public function setSource(sourceBmd:BitmapData, channel:String = "r", factorX:Number = 1, factorY:Number = 1, factorZ:Number = .5):void Optional method to be allow the use of a custom (externally) prerendered map. Parameters sourceBmd:BitmapData — Bitmapdata. The bitmapData to read from. channel:String (default = "r") — [optional] String. The channel information to read. Supported "a", alpha, "r", red, "g", green, "b", blue and "av" (averages and luminance). Default is red channel "r". factorX:Number (default = 1) — [optional] Number. The scale multiplier along the x axis. Default is 1. factorY:Number (default = 1) — [optional] Number. The scale multiplier along the y axis. Default is 1. factorZ:Number (default = .5) — [optional] Number. The scale multiplier along the z axis (the elevation factor). Default is .5. public function traceLevels(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void generates the smooth representation of the geometry. uses same parameters as the Elevation class. Parameters sourceBmd:BitmapData — Bitmapdata. The bitmapData to read from. channel:String (default = "r") — [optional] String. The channel information to read. supported "a", alpha, "r", red, "g", green, "b", blue and "av" (averages and luminance). Default is red channel "r". subdivisionX:int (default = 10) — [optional] int. The subdivision to read the pixels along the x axis. Default is 10. subdivisionY:int (default = 10) — [optional] int. The subdivision to read the pixels along the y axis. Default is 10. factorX:Number (default = 1) — [optional] Number. The scale multiplier along the x axis. Default is 1. factorY:Number (default = 1) — [optional] Number. The scale multiplier along the y axis. Default is 1. elevate:Number (default = .5) — [optional] Number. The scale multiplier along the z axis. Default is .5. See also away3d.extrusions.Elevation CODE EXAMPLES There are currently no examples for this class EnviroBitmapMaterial ==================== Package : away3d.materials Class : public class EnviroBitmapMaterial Inheritance : CompositeMaterial Description : PUBLIC P