Away3D API Reference: V2.1

  Package Description
  away3d.animation  
  Animator  
  away3d.blockers  
  ConvexBlock Convex hull blocking all drawing primitives underneath.
  away3d.cameras  
  Camera3D Basic camera used to resolve a view.
  HoverCamera3D Extended camera used to hover round a specified target object.
  TargetCamera3D Extended camera used to automatically look at a specified target object.
  away3d.containers  
  ILODObject Interface for objects that can toggle their visibily depending on view and distance to camera
  IPhysicsScene  
  DebugObjectContainer3D Extension of
  LODObject 3d object container that is drawn only if its scaling to perspective falls within a given range.
  ObjectContainer3D 3d object container node for other 3d objects in a scene
  Scene3D The root container of all 3d objects in a single scene
  View3D Sprite container used for storing camera, scene, session, renderer and clip references, and resolving mouse events
  away3d.core.base  
  IAnimation Interface for objects that can animate the vertex values in a mesh
  IFrame Interface for objects that store the vertex values for a single frame of animation
  IMeshElement Interface for objects that define a 3d element of a mesh
  Animation Holds information about the current state of a mesh animation.
  AnimationFrame Holds information about a single animation frame.
  AnimationGroup Holds information about a list of animation sequences.
  AnimationSequence Holds information about a sequence of animation frames.
  BaseMesh Abstract 3d object containing unspecified elements.
  BaseMeshElement Basic 3d element object Not intended for direct use - use
  Face A triangle element used in the mesh object
  Frame Holds vertexposition information about a single animation frame.
  Mesh 3d object containing face and segment elements
  Morpher Keyframe animation morpher
  Object3D Base class for all 3d objects.
  Segment A line element used in the wiremesh and mesh object
  UV Texture coordinates value object.
  Vertex A vertex coordinate value object.
  VertexPosition Vertex position value object.
  WireMesh 3d object containing segment elements
  away3d.core.block  
  IBlockerConsumer Interface for containers capable of storing blockers.
  IBlockerProvider Interface for objects that provide blocker instances for occlusion culling in the renderer.
  Blocker Abstract primitive that can block other primitives from drawing
  BlockerArray Array for storing blocker objects
  ConvexBlocker Convex hull primitive that blocks all primitives behind and contained completely inside.
  away3d.core.clip  
  Clipping Base clipping class for no clipping.
  RectangleClipping Rectangle clipping
  away3d.core.draw  
  IPrimitiveConsumer Interface for containers capable of drawing primitives
  IPrimitiveProvider Interface for objects that provide drawing primitives to the rendering process
  DrawBitmap Unscaled bitmap drawing primitive
  DrawDisplayObject Displayobject container drawing primitive.
  DrawFog Fog drawing primitive
  DrawGroup Group drawing primitive.
  DrawPrimitive Abstract class for all drawing primitives
  DrawScaledBitmap Scaled bitmap primitive
  DrawSegment Line segment drawing primitive
  DrawTriangle Triangle drawing primitive
  Line2D Line in 2D space
  Plane3D Plane in 3D space
  PrimitiveArray Array for storing drawing primitives.
  PrimitiveQuadrantTree Quadrant tree for storing drawing primitives
  PrimitiveQuadrantTreeNode Quadrant tree node
  PrimitiveVolumeBlock Volume block tree for storing drawing primitives
  PrimitiveVolumeBlockNode Volume block tree node
  ScreenVertex representation of a 3d vertex resolved to the view.
  away3d.core.filter  
  IPrimitiveFilter Interface for filters that work on primitive arrays
  IPrimitiveQuadrantFilter Interface for filters that work on primitive quadrant trees
  IPrimitiveVolumeBlockFilter Interface for filters that work on primitive volume blocks
  AnotherRivalFilter Corrects triangle z-sorting
  FogFilter Adds fog layers to a view and provides automatic farfield filtering for primitives outside the furthest fog layers.
  QuadrantRiddleFilter Splits all intersecting triangles and line segments.
  ZDepthFilter Defines a maximum z value for rendering primitives
  ZSortFilter Sorts drawing primitives by z coordinate.
  away3d.core.light  
  ILightConsumer Interface for containers capable of storing lighting info
  ILightProvider Interface for objects that provide lighting to the scene
  AmbientLight Ambient light primitive
  DirectionalLight Directional light primitive.
  LightArray Array for storing light primitives.
  LightPrimitive Abstract light primitve.
  PointLight Point light primitive
  away3d.core.math  
  Matrix3D A 3D transformation 4x3 matrix
  Number3D A point in 3D space.
  Quaternion A Quaternion object.
  away3d.core.render  
  IRenderer Interface for renderers capable of rendering a scene to a view
  AbstractRenderSession Abstract Drawing session object containing the method used for drawing the view to screen.
  BasicRenderer Default renderer for a view.
  BitmapRenderSession Drawing session object that renders all drawing primitives into a
  FindHit Finds the object that is rendered under a certain view coordinate.
  Projection Data object for camera transform, focus and zoom properties.
  QuadrantRenderer Renderer that uses quadrant tree for storing and operating drawing primitives.
  Renderer A static class for an easy access to the most useful renderers.
  SpriteRenderSession Drawing session object that renders all drawing primitives into a
  away3d.core.stats  
  Stats  
  away3d.core.traverse  
  BlockerTraverser Traverser that gathers blocker primitives for occlusion culling.
  PrimitiveTraverser Traverser that gathers drawing primitives to render the scene.
  ProjectionTraverser Traverser that resolves the transform tree in a scene, ready for rendering.
  TickTraverser Traverser that fires a time-based method for all objects in scene
  Traverser Abstract class for all traverser that perform actions on the whole scene.
  away3d.core.utils  
  IClonable Interface for object that can be cloned
  CacheStore  
  Cast Helper class for casting assets to usable objects
  CastError  
  Color Static helper class for color manipulations
  Debug Class for emmiting debuging messages, warnings and errors
  DofCache Provides static pre-blurred bitmap images for depth of field-effect when used together with billboarded sprites, such as particles.
  FaceDictionaryVO  
  FaceVO  
  Init Convinient object initialization support
  ValueObject  
  away3d.events  
  AnimationEvent Passed as a parameter when an animation event occurs
  FaceEvent Passed as a parameter when a face event occurs
  LoaderEvent Passed as a parameter when a 3d object loader event occurs
  MaterialEvent Passed as a parameter when a material event occurs
  MeshElementEvent Passed as a parameter when a meshelement event occurs
  MouseEvent3D Passed as a parameter when a 3d mouse event occurs
  Object3DEvent Passed as a parameter when a 3d object event occurs
  SegmentEvent Passed as a parameter when a segment event occurs
  away3d.extrusions  
  CollisionMap  
  Elevation  
  ElevationReader  
  Lathe  
  SegmentsExtrude  
  SkinExtrude  
  away3d.lights  
  AmbientLight3D Lightsource that colors all shaded materials evenly from any angle
  DirectionalLight3D Lightsource that colors all shaded materials proportional to the dot product of the offset vector with the normal vector.
  PointLight3D Lightsource that colors all shaded materials proportional to the dot product of the distance vector with the normal vector.
  away3d.loaders  
  Ase File loader for the ASE file format.
  Collada File loader for the Collada file format.
  CubeLoader Default loader class used as a placeholder for loading 3d content
  Kmz File loader for the KMZ 4 file format (exported from Google Sketchup).
  Max3DS File loader for the 3DS file format.
  Md2 File loader for the Md2 file format.
  Md2still File loader for the Md2 file format (non-animated version).
  Obj File loader for the OBJ file format.
  Object3DLoader Abstract loader class used as a placeholder for loading 3d content
  away3d.loaders.data  
  ContainerData Data class for 3d object containers.
  FaceData Data class for a face object.
  MaterialData Data class for the material data of a face.
  MeshData Data class for the mesh data of a 3d object
  MeshMaterialData Data class for teh material of a 3d object
  ObjectData Data class for a gneric 3d object
  away3d.loaders.utils  
  MaterialLibrary Store for all materials associated with an externally loaded file.
  TextureLoader Used to store the name and loader reference of an external texture image.
  TextureLoadQueue Creates a queue of textures that load sequentially
  away3d.materials  
  IFogMaterial Interface for fog filter materials
  ILayerMaterial Interface for materials that can be layered using
  IMaterial Interface for all objects that can serve as a material
  ISegmentMaterial Interface for materials that are capable of drawing line segments.
  ITriangleMaterial Interface for materials that are capable of rendering triangle faces.
  IUpdatingMaterial Interface for materials that require updating every render loop
  IUVMaterial Interface for materials that use uv texture coordinates
  AnimatedBitmapMaterial Bitmap material that allows fast rendering of animations by caching bitmapdata objects for each frame.
  BitmapFileMaterial Bitmap material that loads it's texture from an external bitmapasset file.
  BitmapMaterial Basic bitmap material
  BitmapMaterialContainer Container for caching multiple bitmapmaterial objects.
  CenterLightingMaterial Abstract class for materials that calculate lighting for the face's center Not intended for direct use - use
  ColorMaterial Material for solid color drawing
  CompositeMaterial Container for layering multiple material objects.
  Dot3BitmapMaterial Bitmap material with DOT3 shading.
  Dot3BitmapMaterialCache Bitmap material with cached DOT3 shading.
  Dot3MovieMaterial Animated movie material with DOT3 shading.
  EnviroBitmapMaterial Bitmap material with environment shading.
  EnviroBitmapMaterialCache Bitmap material with cached environment shading.
  EnviroColorMaterial Color material with environment shading.
  MovieMaterial Animated movie material.
  PhongBitmapMaterial Bitmap material with phong shading.
  PhongBitmapMaterialCache Bitmap material with cached phong shading.
  PhongColorMaterial Color material with phong shading.
  PhongColorMaterialCache Color material with cached phong shading.
  PhongMovieMaterial Animated movie material with phong shading.
  ShadingColorMaterial Color material with flat shading.
  TransformBitmapMaterial Basic bitmap texture material
  WhiteShadingBitmapMaterial Bitmap material with flat white lighting
  WireColorMaterial Wire material for solid color drawing with optional face border outlining
  WireframeMaterial Wire material for face border outlining only
  away3d.materials.shaders  
  AbstractShader Base class for shaders.
  AmbientShader Shader class for ambient lighting
  DiffuseDot3Shader Diffuse Dot3 shader class for directional lighting.
  DiffusePhongShader Diffuse shader class for directional lighting.
  EnviroShader Shader class for environment lighting.
  SpecularPhongShader Specular shader class for directional lighting.
  away3d.primitives  
  AbstractPrimitive Creates a 3d cone primitive.
  AbstractWirePrimitive Creates a 3d cone primitive.
  Cone Creates a 3d cone primitive.
  Cube Creates a 3d cube primitive.
  Cylinder Creates a 3d cylinder primitive.
  GeodesicSphere Creates a 3d geodesic sphere primitive.
  GridPlane Creates a 3d grid primitive.
  LineSegment Creates a 3d line segment.
  LogoCube Creates a 3d cube primitive with the Away3d logo.
  Plane Creates a 3d plane primitive.
  RegularPolygon Creates a regular polygon.
  SeaTurtle Creates a sea turtle model (exported using asAS3Class).
  Skybox QTVR-style 360 panorama renderer that is initialized with six images.
  Skybox6 QTVR-style 360 panorama renderer that is initialized with one solid image.
  Sphere Creates a 3d sphere primitive.
  Torus Creates a 3d torus primitive.
  Triangle Creates a 3d triangle.
  Trident Creates an axis trident.
  WireCircle Creates a 3d wire polygon.
  WireCone Creates a 3d wire cone primitive.
  WireCube Creates a 3d wire cube primitive.
  WireCylinder Creates a 3d wire cylinder primitive.
  WirePlane Creates a 3d wire plane primitive.
  WireSphere Creates a 3d wire sphere primitive.
  WireTorus Creates a 3d wire torus primitive.
  away3d.primitives.data  
  CubeMaterialsData Data structure for individual materials on the sides of a cube.
  away3d.sprites  
  DirSprite2D Spherical billboard (always facing the camera) sprite object that uses an array of bitmapData objects defined with viewing direction vectors.
  DofSprite2D Spherical billboard (always facing the camera) sprite object that uses a cached array of bitmapData objects as it's texture.
  MovieClipSprite Spherical billboard (always facing the camera) sprite object that uses a movieclip as it's texture.
  Sprite2D Spherical billboard (always facing the camera) sprite object that uses a bitmapData object as it's texture.
  away3d.test  
  BaseDemo Base class for Away3D demos
  Button Simple rounded rectangle button
  Panel Simple rounded rectangle panel
  Slide Represents a single slide of the demo

AbstractPrimitive

Package away3d.primitives
Class public class AbstractPrimitive
Inheritance AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses Cone, Cube, Cylinder, GeodesicSphere, Plane, RegularPolygon, Sphere, Torus
Creates a 3d cone primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
    sceneTransform : Matrix3D
[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
AbstractPrimitive
(init:Object = null)
Creates a new AbstractPrimitive object.
 AbstractPrimitive
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 AbstractPrimitive
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
sceneTransform property
sceneTransform:Matrix3D  [read-only]

Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.

Implementation
    public function get sceneTransform():Matrix3D
Constructor detail
AbstractPrimitive () constructor
public function AbstractPrimitive(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties
Method detail
buildPrimitive () method
public function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.AbstractPrimitive'

Code examples
There are currently no examples for this class

AbstractRenderSession

Package away3d.core.render
Class public class AbstractRenderSession
Subclasses BitmapRenderSession, SpriteRenderSession
Abstract Drawing session object containing the method used for drawing the view to screen. Not intended for direct use - use SpriteRenderSession or BitmapRenderSession.
Public Properties
  Property Defined by
    children : Dictionary
Dictionary of child displayobjects.
 AbstractRenderSession
    graphics : Graphics
Reference to the current graphics object being used for drawing.
 AbstractRenderSession
    lightarray : LightArray
Defines the light provider object for the render sesion.
 AbstractRenderSession
    newLayer : Sprite
Holds the last added layer sprite.
 AbstractRenderSession
    sessions : Dictionary
Dictionary of child sessions.
 AbstractRenderSession
    spriteLayers : Array
Dictionary of sprite layers for rendering composite materials.
 AbstractRenderSession
    view : View3D
Defines the view object used for the render session.
 AbstractRenderSession
Public Methods
  Method Defined by
   
addDisplayObject(child:DisplayObject):void
Adds a display object to the render session display list.
 AbstractRenderSession
   
addLayerObject(child:Sprite):void
Adds a layer sprite to the render session display list.
 AbstractRenderSession
   
clear():void
Clears the render session.
 AbstractRenderSession
   
clone():AbstractRenderSession
Duplicates the render session's properties to another render session.
 AbstractRenderSession
   
flush():void
Flushes any cached drawing operations to screen.
 AbstractRenderSession
   
getContainer(view:View3D):DisplayObject
Returns a display object representing the container for the specified view.
 AbstractRenderSession
   
registerChildSession(session:AbstractRenderSession):void
Adds a session as a child of the session object.
 AbstractRenderSession
   
renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void
Draws a non-scaled bitmap into the graphics object.
 AbstractRenderSession
   
renderFogColor(color:int, alpha:Number):void
Draws a fog element into the graphics object.
 AbstractRenderSession
   
renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void
Draws a segment element into the graphics object.
 AbstractRenderSession
   
renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void
Draws a bitmap with a precalculated matrix into the graphics object.
 AbstractRenderSession
   
renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void
Draws a triangle element with a bitmap texture into the graphics object.
 AbstractRenderSession
   
renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a triangle element with a fill color into the graphics object.
 AbstractRenderSession
   
renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element into the graphics object.
 AbstractRenderSession
   
renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element with a fill color into the graphics object.
 AbstractRenderSession
Protected Methods
  Method Defined by
   
createLayer():void
Creates a new render layer for rendering composite materials.
 AbstractRenderSession
Property detail
children property
public var children:Dictionary

Dictionary of child displayobjects.

doActive property  
arcane var doActive:Array

Array for storing added displayobjects to the canvas

doStore property  
arcane var doStore:Array

Array for storing old displayobjects to the canvas

graphics property  
public var graphics:Graphics

Reference to the current graphics object being used for drawing.

lightarray property  
lightarray:LightArray  [read-write]

Defines the light provider object for the render sesion.

Implementation
    public function get lightarray():LightArray
    public function set lightarray(value:LightArray):void
newLayer property  
public var newLayer:Sprite

Holds the last added layer sprite.

sessions property  
public var sessions:Dictionary

Dictionary of child sessions.

spriteLayers property  
public var spriteLayers:Array

Dictionary of sprite layers for rendering composite materials.

See also

away3d.materials.CompositeMaterial.renderTriangle()
view property  
view:View3D  [read-write]

Defines the view object used for the render session.

Implementation
    public function get view():View3D
    public function set view(value:View3D):void
Method detail
addDisplayObject () method
public function addDisplayObject(child:DisplayObject):void

Adds a display object to the render session display list.

Parameters
child:DisplayObject - The display object to add.
addLayerObject () method  
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.
clear () method  
public function clear():void

Clears the render session.

clone () method  
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
createLayer () method  
protected function createLayer():void

Creates a new render layer for rendering composite materials.

See also

away3d.materials.CompositeMaterial.renderTriangle()
flush () method  
public function flush():void

Flushes any cached drawing operations to screen.

getContainer () method  
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.
registerChildSession () method  
public function registerChildSession(session:AbstractRenderSession):void

Adds a session as a child of the session object.

Parameters
session:AbstractRenderSession - The session object to be added as a child.
renderBitmap () method  
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)
renderFogColor () method  
public function renderFogColor(color:int, alpha:Number):void

Draws a fog element into the graphics object.

Parameters
color:int
 
alpha:Number
renderLine () method  
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
renderScaledBitmap () method  
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)
renderTriangleBitmap () method  
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)
renderTriangleColor () method  
public function renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void

Draws a triangle element with a fill color into the graphics object.

Parameters
color:int
 
alpha:Number
 
v0:ScreenVertex
 
v1:ScreenVertex
 
v2:ScreenVertex
renderTriangleLine () method  
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
renderTriangleLineFill () method  
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
Wiki link
Click to go to the wiki page for 'away3d.core.render.AbstractRenderSession'

Code examples
There are currently no examples for this class

AbstractShader

Package away3d.materials.shaders
Class public class AbstractShader
Inheritance AbstractShader -> flash.events.EventDispatcher
Implements ILayerMaterial, IUpdatingMaterial
Subclasses AmbientShader, DiffuseDot3Shader, DiffusePhongShader, EnviroShader, SpecularPhongShader
Base class for shaders. Not intended for direct use - use one of the shading materials in the materials package.
Public Properties
  Property Defined by
    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
  Property Defined by
    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
  Method Defined by
   
AbstractShader
(init:Object = null)
Creates a new AbstractShader object.
 AbstractShader
   
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 AbstractShader
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 AbstractShader
Protected Methods
  Method Defined by
   
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 AbstractShader
   
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
   
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
   
renderShader(face:Face):void
Renders the shader to the specified face.
 AbstractShader
Property detail
blendMode property
public var blendMode:String

Defines a blendMode value for the shader bitmap.

debug property  
public var debug:Boolean

Determines if faces with the shader applied are drawn with outlines

ini property  
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.

smooth property  
public var smooth:Boolean

Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen

visible property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
Constructor detail
AbstractShader () constructor
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
clearFaceDictionary () method
protected function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters
source:Object3D - The parent 3d object of the face.
 
view:View3D - The view rendering the draw triangle.

See also

away3d.core.utils.FaceVO
getLightingShape () method  
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.
getShape () method  
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
renderFace () method  
public function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters
face:Face - The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle - The rectangle object defining the bounds of the face in uv-space.
 
parentFaceVO:FaceVO - The value object of the preceeding surface.
Returns
FaceVO
renderLayer () method  
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.
renderShader () method  
protected function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters
face:Face - The face object being rendered.
updateMaterial () method  
public function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.AbstractShader'

Code examples
There are currently no examples for this class

AbstractWirePrimitive

Package away3d.primitives
Class public class AbstractWirePrimitive
Inheritance AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses GridPlane, WireCircle, WireCone, WireCube, WireCylinder, WirePlane, WireSphere, WireTorus
Creates a 3d cone primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
    sceneTransform : Matrix3D
[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
AbstractWirePrimitive
(init:Object = null)
Creates a new AbstractPrimitive object.
 AbstractWirePrimitive
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 AbstractWirePrimitive
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
sceneTransform property
sceneTransform:Matrix3D  [read-only]

Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.

Implementation
    public function get sceneTransform():Matrix3D
Constructor detail
AbstractWirePrimitive () constructor
public function AbstractWirePrimitive(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties
Method detail
buildPrimitive () method
public function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.AbstractWirePrimitive'

Code examples
There are currently no examples for this class

AmbientLight

Package away3d.core.light
Class public class AmbientLight
Inheritance AmbientLight -> LightPrimitive
Ambient light primitive
Public Properties
  Property Defined by
  (^) 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
A reference to the AmbientLight3D object used by the light primitive.
 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
  Method Defined by
   
updateAmbientBitmap(ambient:Number):void
Updates the bitmapData object used as the lightmap for ambient light shading.
 AmbientLight
Property detail
light property
public var light:AmbientLight3D

A reference to the AmbientLight3D object used by the light primitive.

Method detail
updateAmbientBitmap () method
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.
Wiki link
Click to go to the wiki page for 'away3d.core.light.AmbientLight'

Code examples
There are currently no examples for this class

AmbientLight3D

Package away3d.lights
Class public class AmbientLight3D
Inheritance AmbientLight3D -> Object3D -> flash.events.EventDispatcher
Implements IClonable, ILightProvider, IPrimitiveProvider
Lightsource that colors all shaded materials evenly from any angle
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    ambient : Number
Defines a coefficient for the ambient light intensity.
 AmbientLight3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    color : int
Defines the color of the light object.
 AmbientLight3D
    debug : Boolean
Toggles debug mode: light object is visualised in the scene.
 AmbientLight3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
AmbientLight3D
(init:Object = null)
Creates a new AmbientLight3D object.
 AmbientLight3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
clone(object:* = null):*
Duplicates the light object's properties to another AmbientLight3D object
 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
Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object
 AmbientLight3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 AmbientLight3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
ambient property
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 property  
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 property  
public var debug:Boolean

Toggles debug mode: light object is visualised in the scene.

Constructor detail
AmbientLight3D () constructor
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
clone () method
public override function clone(object:* = null):*

Duplicates the light object's properties to another AmbientLight3D object

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied
Returns
* - The new object instance with duplicated properties applied
light () method  
public function light(consumer:ILightConsumer):void

Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object

Parameters
consumer:ILightConsumer - The consumer instance.
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object
Wiki link
Click to go to the wiki page for 'away3d.lights.AmbientLight3D'

Code examples
There are currently no examples for this class

AmbientShader

Package away3d.materials.shaders
Class public class AmbientShader
Inheritance AmbientShader -> AbstractShader -> flash.events.EventDispatcher
Shader class for ambient lighting

See also

away3d.lights.AmbientLight3D
Public Properties
  Property Defined by
  (^) 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
  Method Defined by
   
AmbientShader
(init:Object = null)
Creates a new AmbientShader object.
 AmbientShader
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 AmbientShader
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 AmbientShader
Protected Methods
  Method Defined by
   
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 AmbientShader
  (^)
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
  (^)
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
   
renderShader(face:Face):void
Renders the shader to the specified face.
 AmbientShader
Property detail
color property
public var color:uint

Defines a 24 bit color value used by the shader

Constructor detail
AmbientShader () constructor
public function AmbientShader(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
clearFaceDictionary () method
protected override function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters
source:Object3D - The parent 3d object of the face.
 
view:View3D - The view rendering the draw triangle.
renderLayer () method  
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.
renderShader () method  
protected override function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters
face:Face - The face object being rendered.
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.AmbientShader'

Code examples
There are currently no examples for this class

AnimatedBitmapMaterial

Package away3d.materials
Class public class AnimatedBitmapMaterial
Inheritance AnimatedBitmapMaterial -> TransformBitmapMaterial -> BitmapMaterial -> flash.events.EventDispatcher
Implements ITriangleMaterial, IUVMaterial
Bitmap material that allows fast rendering of animations by caching bitmapdata objects for each frame. Not suitable for use with long animations, where the initialisation time will be lengthy and the memory footprint large. If interactive movieclip properties are required, please refer to MovieMaterial.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
    autoplay : Boolean
Indicates whether the animation will start playing on initialisation.
 AnimatedBitmapMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) globalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
 TransformBitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
    index : int
[write-only] Manually sets the frame index of the animation.
 AnimatedBitmapMaterial
    loop : Boolean
Indicates whether the animation will loop.
 AnimatedBitmapMaterial
  (^) offsetX : Number
Offsets the x coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) offsetY : Number
Offsets the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) projectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
 TransformBitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
  (^) rotation : Number
Rotates the texture in uv-space
 TransformBitmapMaterial
  (^) scaleX : Number
Scales the x coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) scaleY : Number
Scales the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
  (^) throughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
 TransformBitmapMaterial
  (^) transform : Matrix
Transforms the texture in uv-space
 TransformBitmapMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
  (^) width : Number
Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Method Defined by
   
AnimatedBitmapMaterial
(movie:MovieClip, init:Object = null)
Creates a new AnimatedBitmapMaterial object.
 AnimatedBitmapMaterial
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 TransformBitmapMaterial
   
play():void
Resumes playback of the animation
 AnimatedBitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 TransformBitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 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
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 TransformBitmapMaterial
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterial
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
autoplay property
public var autoplay:Boolean

Indicates whether the animation will start playing on initialisation. If false, only the first frame is displayed.

index property  
index:int  [write-only]

Manually sets the frame index of the animation.

Implementation
    public function set index(value:int):void
loop property  
public var loop:Boolean

Indicates whether the animation will loop.

Constructor detail
AnimatedBitmapMaterial () constructor
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
play () method
public function play():void

Resumes playback of the animation

setFrames () method  
public function setFrames(sources:Array):void

Resets the cached bitmapData objects making up the animation with a pre-defined array.

Parameters
sources:Array
setMovie () method  
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.
stop () method  
public function stop():void

Halts playback of the animation

Wiki link
Click to go to the wiki page for 'away3d.materials.AnimatedBitmapMaterial'

Code examples
There are currently no examples for this class

Animation

Package away3d.core.base
Class public class Animation
Inheritance Animation -> flash.events.EventDispatcher
Implements IAnimation
Holds information about the current state of a mesh animation.
Public Properties
  Property Defined by
    cycleEvent : Boolean = false
Determines whether the animation will fire cycle events.
 Animation
    delay : Number = 0
Determines the delay time between animation cycles if loop is set to true.
 Animation
    fps : Number = 24
The frames per second at which the animation will run.
 Animation
    frame : Number = 0
The current frame of the animation.
 Animation
    isRunning : Boolean
[read-only] Indicates whether the animation is currently running.
 Animation
    latest : uint
[read-only] Returns the number of the latest frame displayed.
 Animation
    loop : Boolean = false
Determines whether the animation will loop.
 Animation
    object : BaseMesh
The Mesh on which the animation is occurring.
 Animation
    sequence : Array
Holds an array of animation frames.
 Animation
    sequenceEvent : Boolean = false
Determines whether the animation will fire sequence events.
 Animation
    smooth : Boolean = false
Determines whether the animation will smooth motion (interpolate) between frames.
 Animation
Public Methods
  Method Defined by
   
Animation
(obj:BaseMesh)
Creates a new Animation object.
 Animation
   
start():void
Jumps to the beginning of the animation and start playing
 Animation
   
stop():void
Stops the animation at it's current position.
 Animation
   
update(mesh:BaseMesh):void
Updates the positions of vertex objects in the mesh to the current frame values
 Animation
Events
  Event Summary Defined by
   
cycle
 Dispatched when all frame sequences are complete Animation
   
sequenceupdate
 Dispatched when the current frame sequence is complete Animation
Property detail
cycleEvent property
public var cycleEvent:Boolean = false

Determines whether the animation will fire cycle events.

See also

away3d.events.AnimationEvent
delay property  
public var delay:Number = 0

Determines the delay time between animation cycles if loop is set to true.

See also

loop
fps property  
public var fps:Number = 24

The frames per second at which the animation will run.

frame property  
public var frame:Number = 0

The current frame of the animation.

isRunning property  
isRunning:Boolean  [read-only]

Indicates whether the animation is currently running.

Implementation
    public function get isRunning():Boolean
latest property  
latest:uint  [read-only]

Returns the number of the latest frame displayed.

Implementation
    public function get latest():uint
loop property  
public var loop:Boolean = false

Determines whether the animation will loop.

object property  
public var object:BaseMesh

The Mesh on which the animation is occurring.

sequence property  
public var sequence:Array

Holds an array of animation frames.

See also

away3d.core.base.AnimationFrame
sequenceEvent property  
public var sequenceEvent:Boolean = false

Determines whether the animation will fire sequence events.

See also

away3d.events.AnimationEvent
smooth property  
public var smooth:Boolean = false

Determines whether the animation will smooth motion (interpolate) between frames.

Constructor detail
Animation () constructor
public function Animation(obj:BaseMesh)
Parameters
obj:BaseMesh - The mesh object that the animation acts on.
Method detail
start () method
public function start():void

Jumps to the beginning of the animation and start playing

stop () method  
public function stop():void

Stops the animation at it's current position.

update () method  
public function update(mesh:BaseMesh):void

Updates the positions of vertex objects in the mesh to the current frame values

Parameters
mesh:BaseMesh - The mesh on which the animation object acts
Event detail
cycle event 
Event object type: away3d.events.AnimationEvent

Dispatched when all frame sequences are complete

sequenceupdate event   
Event object type: away3d.events.AnimationEvent

Dispatched when the current frame sequence is complete

Wiki link
Click to go to the wiki page for 'away3d.core.base.Animation'

Code examples
There are currently no examples for this class

AnimationEvent

Package away3d.events
Class public class AnimationEvent
Inheritance AnimationEvent -> flash.events.Event
Passed as a parameter when an animation event occurs
Public Properties
  Property Defined by
    animation : Animation
A reference to the animation object that is relevant to the event.
 AnimationEvent
Public Methods
  Method Defined by
   
AnimationEvent
(type:String, animation:Animation)
Creates a new AnimationEvent object.
 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
  Constant Defined by
    CYCLE : String = "cycle"
[static] Defines the value of the type property of a cycle event object.
 AnimationEvent
    SQUENCE_DONE : String = "squencedone"
[static] Defines the value of the type property of a sequence done event object.
 AnimationEvent
    SQUENCE_UPDATE : String = "squenceupdate"
[static] Defines the value of the type property of a sequence update event object.
 AnimationEvent
Property detail
animation property
public var animation:Animation

A reference to the animation object that is relevant to the event.

Constructor detail
AnimationEvent () constructor
public function AnimationEvent(type:String, animation:Animation)
Parameters
type:String - The type of the event. Possible values are: AnimationEvent.CYCLE, AnimationEvent.SQUENCE_UPDATE and AnimationEvent.SQUENCE_DONE.
 
animation:Animation - A reference to the animation object that is relevant to the event.
Method detail
clone () method
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
CYCLE constant
public static const CYCLE:String = "cycle"

Defines the value of the type property of a cycle event object.

SQUENCE_DONE constant  
public static const SQUENCE_DONE:String = "squencedone"

Defines the value of the type property of a sequence done event object.

SQUENCE_UPDATE constant  
public static const SQUENCE_UPDATE:String = "squenceupdate"

Defines the value of the type property of a sequence update event object.

Wiki link
Click to go to the wiki page for 'away3d.events.AnimationEvent'

Code examples
There are currently no examples for this class

AnimationFrame

Package away3d.core.base
Class public class AnimationFrame
Holds information about a single animation frame.
Public Properties
  Property Defined by
    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
  Method Defined by
   
AnimationFrame
(frame:Number, sort:String = null)
Creates a new AnimationFrame object.
 AnimationFrame
Property detail
frame property
public var frame:Number

Frame number.

sort property  
public var sort:String

An optional sort string used to order the animation frames.

time property  
public var time:uint

Time from the start of the animation.

Constructor detail
AnimationFrame () constructor
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.
Wiki link
Click to go to the wiki page for 'away3d.core.base.AnimationFrame'

Code examples
There are currently no examples for this class

AnimationGroup

Package away3d.core.base
Class public class AnimationGroup
Holds information about a list of animation sequences.
Public Properties
  Property Defined by
    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
  Method Defined by
   
AnimationGroup
(playlist:Array = null, loopLast:Boolean = false)
Creates a new AnimationSequence object.
 AnimationGroup
Property detail
fps property
public var fps:uint

Determines the speed of playback in frames per second.

loop property  
public var loop:Boolean

Determines whether the animation sequence should loop.

loopLast property  
public var loopLast:Boolean

Determines if the last animation sequence should be looped.

playlist property  
public var playlist:Array

An array of animation sequence objects.

Constructor detail
AnimationGroup () constructor
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.
Wiki link
Click to go to the wiki page for 'away3d.core.base.AnimationGroup'

Code examples
There are currently no examples for this class

AnimationSequence

Package away3d.core.base
Class public class AnimationSequence
Holds information about a sequence of animation frames.
Public Properties
  Property Defined by
    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
  Method Defined by
   
AnimationSequence
(prefix:String, smooth:Boolean = false, loop:Boolean = false, fps:Number = 24)
Creates a new AnimationSequence object.
 AnimationSequence
Property detail
fps property
public var fps:Number

Determines the speed of playback in frames per second.

loop property  
public var loop:Boolean

Determines whether the animation sequence should loop.

prefix property  
public var prefix:String

The prefix string defining frames in the sequence.

smooth property  
public var smooth:Boolean

Determines if the animation should be smoothed (interpolated) between frames.

Constructor detail
AnimationSequence () constructor
public function AnimationSequence(prefix:String, smooth:Boolean = false, loop:Boolean = false, fps:Number = 24)
Parameters
prefix:String - The prefix string defining frames in the sequence.
 
smooth:Boolean (default = false) - Determines if the animation should be smoothed (interpolated) between frames.
 
loop:Boolean (default = false) - Determines whether the animation sequence should loop.
 
fps:Number (default = 24) - Determines the speed of playback in frames per second.
Wiki link
Click to go to the wiki page for 'away3d.core.base.AnimationSequence'

Code examples
There are currently no examples for this class

Animator

Package away3d.animation
Class public class Animator
Inheritance Animator -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
    framelist : Array
[read-only]
 Animator
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Animator
(baseObject:Mesh, aFrames:Array, init:Object = null, doloop:Boolean = false)
 Animator
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
   
addFrames(aFrames:Array):void
 Animator
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
   
generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void
 Animator
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
framelist property
framelist:Array  [read-only]
Implementation
    public function get framelist():Array
Constructor detail
Animator () constructor
public function Animator(baseObject:Mesh, aFrames:Array, init:Object = null, doloop:Boolean = false)
Parameters
baseObject:Mesh
 
aFrames:Array
 
init:Object (default = null)
 
doloop:Boolean (default = false)
Method detail
addFrames () method
public function addFrames(aFrames:Array):void
Parameters
aFrames:Array
generate () method  
public function generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void
Parameters
baseObject:Mesh
 
aFrames:Array
 
doloop:Boolean
Wiki link
Click to go to the wiki page for 'away3d.animation.Animator'

Code examples
There are currently no examples for this class

AnotherRivalFilter

Package away3d.core.filter
Class public class AnotherRivalFilter
Implements IPrimitiveQuadrantFilter
Corrects triangle z-sorting
Public Methods
  Method Defined by
   
AnotherRivalFilter
(maxdelay:int = 60000)
Creates a new AnotherRivalFilter object.
 AnotherRivalFilter
   
filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void
Applies the filter to the quadrant tree.
 AnotherRivalFilter
   
toString():String
Used to trace the values of a filter.
 AnotherRivalFilter
Constructor detail
AnotherRivalFilter () constructor
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
filter () method
public function filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void

Applies the filter to the quadrant tree.

Parameters
pritree:PrimitiveQuadrantTree - The quadrant tree to be filtered.
 
scene:Scene3D - The scene to which the quadrant tree belongs.
 
camera:Camera3D - The camera being used in the renderer for the quadrant tree
 
clip:Clipping - The clipping object used in the renderer for the quadrant tree's view.
toString () method  
public function toString():String

Used to trace the values of a filter.

Returns
String - A string representation of the filter object.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.AnotherRivalFilter'

Code examples
There are currently no examples for this class

Ase

Package away3d.loaders
Class public class Ase
File loader for the ASE file format.
Public Methods
  Method Defined by
   
Ase
(data:String, init:Object = null)
Creates a new Ase object.
 Ase
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses an ase file into a 3d mesh object.
 Ase
   
parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh
[static] Creates a 3d mesh object from the raw ascii data of the ase file.
 Ase
Constructor detail
Ase () constructor
public function Ase(data:String, init:Object = null)
Parameters
data:String - The ascii data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  scaling:Number (default = 1)

See also

away3d.loaders.Ase.parse()
away3d.loaders.Ase.load()
Method detail
load () method
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.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh

Creates a 3d mesh object from the raw ascii data of the ase file.

Parameters
data:* - The ascii data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object3DLoader (default = null) - [optional] Not intended for direct use.
Returns
Mesh - A 3d mesh object representation of the ase file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Ase'

Code examples
There are currently no examples for this class

BaseDemo

Package away3d.test
Class public class BaseDemo
Inheritance BaseDemo -> flash.display.Sprite
Base class for Away3D demos
Protected Properties
  Property Defined by
    camera : HoverCamera3D
BaseDemo
    centergroup : Sprite
BaseDemo
    infogroup : Sprite
BaseDemo
    lefttopgroup : Sprite
BaseDemo
    startlabel : TextField
BaseDemo
    statsgroup : Sprite
BaseDemo
    titlegroup : Sprite
BaseDemo
    view : View3D
BaseDemo
Public Methods
  Method Defined by
   
BaseDemo
(title:String, infogroupheight:Number = 410)
 BaseDemo
Protected Methods
  Method Defined by
   
addSlide(title:String, text:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession):void
 BaseDemo
Property detail
camera property
protected var camera:HoverCamera3D
centergroup property  
protected var centergroup:Sprite
infogroup property  
protected var infogroup:Sprite
lefttopgroup property  
protected var lefttopgroup:Sprite
startlabel property  
protected var startlabel:TextField
statsgroup property  
protected var statsgroup:Sprite
titlegroup property  
protected var titlegroup:Sprite
view property  
protected var view:View3D
Constructor detail
BaseDemo () constructor
public function BaseDemo(title:String, infogroupheight:Number = 410)
Parameters
title:String
 
infogroupheight:Number (default = 410)
Method detail
addSlide () method
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
Wiki link
Click to go to the wiki page for 'away3d.test.BaseDemo'

Code examples

Away3D HelloAway3D.as

package
{
import flash.display.*;
import flash.events.*;
import flash.utils.*;

import away3d.objects.*;
import away3d.core.material.*;
import away3d.core.proto.*;

[SWF(backgroundColor="#222266", frameRate="60", width="600", height="400")]
public class HelloAway3D extends Sprite
{
public var view:View3D;
public var sphere:Sphere;

public function HelloAway3D()
{
view = new View3D();
view.x = 300;
view.y = 200;
addChild(view);

sphere = new Sphere(new WireColorMaterial(0xFF7700, 0xCC4400), {radius:250, segmentsW:12, segmentsH:9, y:50});

view.scene.addChild(sphere);
view.camera.lookAt(sphere);

addEventListener(Event.ENTER_FRAME, onEnterFrame);
}

private function onEnterFrame(event:Event):void
{
view.render();
sphere.rotationY = getTimer() / 100;
}

}

}

From HelloAway3D.as


BaseMesh

Package away3d.core.base
Class public class BaseMesh
Inheritance BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses Mesh, WireMesh
Abstract 3d object containing unspecified elements. Not intended for direct use - use Mesh or WireMesh.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
    boundingRadius : Number
[read-only] Returns the bounding radius of the 3d object
 BaseMesh
    elements : Array
[read-only] Returns an array of the elements contained in the mesh object
 BaseMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
    fps : int
[write-only] Determines the frames per second at which the animation will run.
 BaseMesh
    frame : int
Indicates the current frame of animation
 BaseMesh
    framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
    frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
    hasCycleEvent : Boolean
[read-only] Indicates whether the animation has a cycle event listener
 BaseMesh
    hasSequenceEvent : Boolean
[read-only] Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
    isRunning : Boolean
[read-only] Indicates whether the animation is currently running.
 BaseMesh
    loop : Boolean
[write-only] Determines whether the animation will loop.
 BaseMesh
    maxX : Number
[read-only] Returns the maximum x value of the 3d object
 BaseMesh
    maxY : Number
[read-only] Returns the maximum y value of the 3d object
 BaseMesh
    maxZ : Number
[read-only] Returns the maximum z value of the 3d object
 BaseMesh
    minX : Number
[read-only] Returns the minimum x value of the 3d object
 BaseMesh
    minY : Number
[read-only] Returns the minimum y value of the 3d object
 BaseMesh
    minZ : Number
[read-only] Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
    pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
    pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    smooth : Boolean
[write-only] Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    type : String
String defining the type of class used to generate the mesh.
 BaseMesh
    url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
    vertices : Array
[read-only] Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
BaseMesh
(init:Object = null)
Creates a new BaseMesh object.
 BaseMesh
   
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
   
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
   
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
   
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 BaseMesh
   
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
   
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
   
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
   
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
   
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
   
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
   
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
   
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
   
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
   
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
   
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
   
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
   
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
   
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
boundingRadius property
boundingRadius:Number  [read-only]

Returns the bounding radius of the 3d object

Implementation
    public function get boundingRadius():Number
elements property  
elements:Array  [read-only]

Returns an array of the elements contained in the mesh object

Implementation
    public function get elements():Array

Throws
- Not implemented
fps property  
fps:int  [write-only]

Determines the frames per second at which the animation will run.

Implementation
    public function set fps(value:int):void
frame property  
frame:int  [read-write]

Indicates the current frame of animation

Implementation
    public function get frame():int
    public function set frame(value:int):void
framenames property  
public var framenames:Dictionary

A dictionary containing all frame names of the mesh

frames property  
public var frames:Dictionary

A dictionary containing all frames of the mesh

hasCycleEvent property  
hasCycleEvent:Boolean  [read-only]

Indicates whether the animation has a cycle event listener

Implementation
    public function get hasCycleEvent():Boolean
hasSequenceEvent property  
hasSequenceEvent:Boolean  [read-only]

Indicates whether the animation has a sequencedone event listener

Implementation
    public function get hasSequenceEvent():Boolean
isRunning property  
isRunning:Boolean  [read-only]

Indicates whether the animation is currently running.

Implementation
    public function get isRunning():Boolean
loop property  
loop:Boolean  [write-only]

Determines whether the animation will loop.

Implementation
    public function set loop(value:Boolean):void
maxX property  
maxX:Number  [read-only]

Returns the maximum x value of the 3d object

Implementation
    public function get maxX():Number
maxY property  
maxY:Number  [read-only]

Returns the maximum y value of the 3d object

Implementation
    public function get maxY():Number
maxZ property  
maxZ:Number  [read-only]

Returns the maximum z value of the 3d object

Implementation
    public function get maxZ():Number
minX property  
minX:Number  [read-only]

Returns the minimum x value of the 3d object

Implementation
    public function get minX():Number
minY property  
minY:Number  [read-only]

Returns the minimum y value of the 3d object

Implementation
    public function get minY():Number
minZ property  
minZ:Number  [read-only]

Returns the minimum z value of the 3d object

Implementation
    public function get minZ():Number
pushback property  
public var pushback:Boolean

Elements use their furthest point from the camera when z-sorting

pushfront property  
public var pushfront:Boolean

Elements use their nearest point to the camera when z-sorting

smooth property  
smooth:Boolean  [write-only]

Determines whether the animation will smooth motion (interpolate) between frames.

Implementation
    public function set smooth(value:Boolean):void
type property  
public var type:String

String defining the type of class used to generate the mesh. Used to display information in the stats panel

See also

away3d.core.stats.Stats
url property  
public var url:String

String defining the source of the mesh. If the mesh has been created internally, the string is used to display the package name of the creating object. Used to display information in the stats panel

See also

away3d.core.stats.Stats
vertices property  
vertices:Array  [read-only]

Returns an array of the vertices contained in the mesh object

Implementation
    public function get vertices():Array
Constructor detail
BaseMesh () constructor
public function BaseMesh(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties
Init Parameters
  pushback:Boolean (default = false)
  pushfront:Boolean (default = false)
Method detail
addElement () method
protected function addElement(element:IMeshElement):void

Adds an element to the mesh object.

Parameters
element:IMeshElement - The element to be added to the mesh.
addOnCycle () method  
public function addOnCycle(listener:Function):void

Default method for adding a cycle event listener

Parameters
listener:Function - The listener function
addOnSequenceDone () method  
public function addOnSequenceDone(listener:Function):void

Default method for adding a squencedone event listener

Parameters
listener:Function - The listener function
gotoAndPlay () method  
public function gotoAndPlay(value:int):void

Starts playing the animation at the specified frame.

Parameters
value:int - A number representing the frame number.
gotoAndStop () method  
public function gotoAndStop(value:int):void

Brings the animation to the specifed frame and stops it there.

Parameters
value:int - A number representing the frame number.
play () method  
public function play(sequence:AnimationSequence):void

Plays a sequence of frames

Parameters
sequence:AnimationSequence - The animationsequence to play
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawPrimitive
removeElement () method  
protected function removeElement(element:IMeshElement):void

Removes an element to the mesh object.

Parameters
element:IMeshElement - The element to be removed from the mesh.
removeOnCycle () method  
public function removeOnCycle(listener:Function):void

Default method for removing a cycle event listener

Parameters
listener:Function - The listener function
removeOnSequenceDone () method  
public function removeOnSequenceDone(listener:Function):void

Default method for removing a squencedone event listener

Parameters
listener:Function - The listener function
scale () method  
public override function scale(scale:Number):void

Scales the contents of the mesh.

Parameters
scale:Number - The scaling value
scaleAnimation () method  
public function scaleAnimation(scale:Number):void

Scales the vertex positions contained within all animation frames

Parameters
scale:Number - The scaling value
scaleX () method  
public function scaleX(scaleX:Number):void

Scales the contents of the mesh along the x-axis.

Parameters
scaleX:Number - The scaling value
scaleXYZ () method  
protected function scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void

Scales the contents of the mesh using 3 axis values.

Parameters
scaleX:Number - The scaling value along the x-axis
 
scaleY:Number - The scaling value along the y-axis
 
scaleZ:Number - The scaling value along the z-axis
scaleY () method  
public function scaleY(scaleY:Number):void

Scales the contents of the mesh along the y-axis.

Parameters
scaleY:Number - The scaling value
scaleZ () method  
public function scaleZ(scaleZ:Number):void

Scales the contents of the mesh along the z-axis.

Parameters
scaleZ:Number - The scaling value
setPlaySequences () method  
public function setPlaySequences(playlist:Array, loopLast:Boolean = false):void

Passes an array of animationsequence objects to be added to the animation.

Parameters
playlist:Array - An array of animationsequence objects.
 
loopLast:Boolean (default = false) - [optional] Determines whether the last sequence will loop. Defaults to false.
tick () method  
public override function tick(time:int):void

Called by the TickTraverser. updates the animation object

Parameters
time:int - The absolute time at the start of the render cycle

See also

away3d.core.traverse.TickTraverser
away3d.core.basr.Animation.update()
Event detail
cycle event 
Event object type: away3d.events.AnimationEvent

Dispatched when the animation object completes a single sequence cycle.

sequencedone event   
Event object type: away3d.events.AnimationEvent

Dispatched when the animation object completes all frame sequences.

Wiki link
Click to go to the wiki page for 'away3d.core.base.BaseMesh'

Code examples
There are currently no examples for this class

BaseMeshElement

Package away3d.core.base
Class public class BaseMeshElement
Inheritance BaseMeshElement -> flash.events.EventDispatcher
Implements IMeshElement
Subclasses Face, Segment
Basic 3d element object Not intended for direct use - use Segment or Face.
Public Properties
  Property Defined by
    maxX : Number
[read-only] Returns the maximum x value of the 3d element
 BaseMeshElement
    maxY : Number
[read-only] Returns the minimum y value of the 3d element
 BaseMeshElement
    maxZ : Number
[read-only] Returns the minimum z value of the 3d element
 BaseMeshElement
    minX : Number
[read-only] Returns the minimum x value of the 3d element
 BaseMeshElement
    minY : Number
[read-only] Returns the maximum y value of the 3d element
 BaseMeshElement
    minZ : Number
[read-only] Returns the maximum z value of the 3d element
 BaseMeshElement
    radius2 : Number
[read-only] Returns the squared bounding radius of the 3d element
 BaseMeshElement
    vertices : Array
[read-only] Returns an array of vertex objects that make up the 3d element.
 BaseMeshElement
    visible : Boolean
Defines whether the 3d element is visible in the scene.
 BaseMeshElement
Public Methods
  Method Defined by
   
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
 BaseMeshElement
   
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
 BaseMeshElement
   
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
 BaseMeshElement
   
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
 BaseMeshElement
   
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
 BaseMeshElement
   
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
 BaseMeshElement
Events
  Event Summary Defined by
   
vertexchanged
 Dispatched when the vertex of a 3d element changes. BaseMeshElement
   
vertexvaluechanged
 Dispatched when the vertex value of a 3d element changes. BaseMeshElement
   
visiblechanged
 Dispatched when the visiblity of a 3d element changes. BaseMeshElement
Property detail
maxX property
maxX:Number  [read-only]

Returns the maximum x value of the 3d element

Implementation
    public function get maxX():Number
maxY property  
maxY:Number  [read-only]

Returns the minimum y value of the 3d element

Implementation
    public function get maxY():Number
maxZ property  
maxZ:Number  [read-only]

Returns the minimum z value of the 3d element

Implementation
    public function get maxZ():Number
minX property  
minX:Number  [read-only]

Returns the minimum x value of the 3d element

Implementation
    public function get minX():Number
minY property  
minY:Number  [read-only]

Returns the maximum y value of the 3d element

Implementation
    public function get minY():Number
minZ property  
minZ:Number  [read-only]

Returns the maximum z value of the 3d element

Implementation
    public function get minZ():Number
radius2 property  
radius2:Number  [read-only]

Returns the squared bounding radius of the 3d element

Implementation
    public function get radius2():Number
vertices property  
vertices:Array  [read-only]

Returns an array of vertex objects that make up the 3d element.

Implementation
    public function get vertices():Array
visible property  
visible:Boolean  [read-write]

Defines whether the 3d element is visible in the scene.

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method detail
addOnVertexChange () method
public function addOnVertexChange(listener:Function):void

Default method for adding a vertexchanged event listener

Parameters
listener:Function - The listener function
addOnVertexValueChange () method  
public function addOnVertexValueChange(listener:Function):void

Default method for adding a vertexvaluechanged event listener

Parameters
listener:Function - The listener function
addOnVisibleChange () method  
public function addOnVisibleChange(listener:Function):void

Default method for adding a visiblechanged event listener

Parameters
listener:Function - The listener function
removeOnVertexChange () method  
public function removeOnVertexChange(listener:Function):void

Default method for removing a vertexchanged event listener

Parameters
listener:Function - The listener function
removeOnVertexValueChange () method  
public function removeOnVertexValueChange(listener:Function):void

Default method for removing a vertexvaluechanged event listener

Parameters
listener:Function - The listener function
removeOnVisibleChange () method  
public function removeOnVisibleChange(listener:Function):void

Default method for removing a visiblechanged event listener

Parameters
listener:Function - The listener function
Event detail
vertexchanged event 
Event object type: away3d.events.MeshElementEvent

Dispatched when the vertex of a 3d element changes.

vertexvaluechanged event   
Event object type: away3d.events.MeshElementEvent

Dispatched when the vertex value of a 3d element changes.

visiblechanged event   
Event object type: away3d.events.MeshElementEvent

Dispatched when the visiblity of a 3d element changes.

Wiki link
Click to go to the wiki page for 'away3d.core.base.BaseMeshElement'

Code examples
There are currently no examples for this class

BasicRenderer

Package away3d.core.render
Class public class BasicRenderer
Implements IRenderer
Default renderer for a view. Contains the main render loop for rendering a scene to a view, which resolves the projection, culls any drawing primitives that are occluded or outside the viewport, and then z-sorts and renders them to screen.
Public Properties
  Property Defined by
    session : AbstractRenderSession
Defines the render session object used by the renderer.
 BasicRenderer
Public Methods
  Method Defined by
   
BasicRenderer
(... filters)
Creates a new BasicRenderer object.
 BasicRenderer
   
render(view:View3D):Array
Executes the render pipe that resolves the 3d scene into the view.
 BasicRenderer
   
toString():String
Used to trace the values of a renderer.
 BasicRenderer
Property detail
session property
session:AbstractRenderSession  [read-write]

Defines the render session object used by the renderer.

Implementation
    public function get session():AbstractRenderSession
    public function set session(value:AbstractRenderSession):void
Constructor detail
BasicRenderer () constructor
public function BasicRenderer(... filters)
Parameters
... filters - [optional] An array of filters to use on projected drawing primitives before rendering them to screen.
Method detail
render () method
public function render(view:View3D):Array

Executes the render pipe that resolves the 3d scene into the view.

Parameters
view:View3D
Returns
Array
toString () method  
public function toString():String

Used to trace the values of a renderer.

Returns
String - A string representation of the renderer object.
Wiki link
Click to go to the wiki page for 'away3d.core.render.BasicRenderer'

Code examples
There are currently no examples for this class

BitmapFileMaterial

Package away3d.materials
Class public class BitmapFileMaterial
Inheritance BitmapFileMaterial -> TransformBitmapMaterial -> BitmapMaterial -> flash.events.EventDispatcher
Implements ITriangleMaterial, IUVMaterial
Bitmap material that loads it's texture from an external bitmapasset file.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) globalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
 TransformBitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
  (^) offsetX : Number
Offsets the x coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) offsetY : Number
Offsets the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) projectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
 TransformBitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
  (^) rotation : Number
Rotates the texture in uv-space
 TransformBitmapMaterial
  (^) scaleX : Number
Scales the x coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) scaleY : Number
Scales the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
  (^) throughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
 TransformBitmapMaterial
  (^) transform : Matrix
Transforms the texture in uv-space
 TransformBitmapMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
  (^) width : Number
Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Method Defined by
   
BitmapFileMaterial
(url:String = "", init:Object = null)
Creates a new BitmapFileMaterial object.
 BitmapFileMaterial
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 TransformBitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 TransformBitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 TransformBitmapMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 TransformBitmapMaterial
Protected Methods
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 TransformBitmapMaterial
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterial
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Constructor detail
BitmapFileMaterial () constructor
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.
Wiki link
Click to go to the wiki page for 'away3d.materials.BitmapFileMaterial'

Code examples
There are currently no examples for this class

BitmapMaterial

Package away3d.materials
Class public class BitmapMaterial
Inheritance BitmapMaterial -> flash.events.EventDispatcher
Implements ILayerMaterial, ITriangleMaterial, IUpdatingMaterial, IUVMaterial
Subclasses BitmapMaterialContainer, TransformBitmapMaterial
Basic bitmap material
Public Properties
  Property Defined by
    alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 BitmapMaterial
    blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
    color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
    debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
    height : Number
[read-only] Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
    precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
    repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
    smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 BitmapMaterial
    width : Number
[read-only] Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Property Defined by
    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
  Method Defined by
   
BitmapMaterial
(bitmap:BitmapData, init:Object = null)
Creates a new BitmapMaterial object.
 BitmapMaterial
   
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
   
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 BitmapMaterial
   
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
   
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 BitmapMaterial
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 BitmapMaterial
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 BitmapMaterial
Protected Methods
  Method Defined by
   
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 BitmapMaterial
   
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
   
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterial
Events
  Event Summary Defined by
   
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
alpha property
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 property  
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
blendMode property  
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 property  
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
debug property  
public var debug:Boolean = false

Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.

height property  
height:Number  [read-only]

Returns the height of the bitmapData being used as the material texture.

Implementation
    public function get height():Number
ini property  
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 property  
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 property  
public var repeat:Boolean = false

Determines if texture bitmap will tile in uv-space

smooth property  
public var smooth:Boolean = false

Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.

visible property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
width property  
width:Number  [read-only]

Returns the width of the bitmapData being used as the material texture.

Implementation
    public function get width():Number
Constructor detail
BitmapMaterial () constructor
public function BitmapMaterial(bitmap:BitmapData, init:Object = null)
Parameters
bitmap:BitmapData - The bitmapData object to be used as the material's texture.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  smooth:Boolean (default = smooth)
  debug:Boolean (default = debug)
  repeat:Boolean (default = repeat)
  precision:Number (default = 0)
  blendMode:String (default = BlendMode.NORMAL)
  alpha:Number (default = _alpha, min:0, max:1)
  color:Color (default = _color)
Method detail
addOnResize () method
public function addOnResize(listener:Function):void

Default method for adding a materialresize event listener

Parameters
listener:Function - The listener function
getMapping () method  
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.
getPixel32 () method  
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.
removeOnResize () method  
public function removeOnResize(listener:Function):void

Default method for removing a materialresize event listener

Parameters
listener:Function - The listener function
renderFace () method  
public function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters
face:Face - The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle - The rectangle object defining the bounds of the face in uv-space.
 
parentFaceVO:FaceVO - The value object of the preceeding surface.
Returns
FaceVO
renderLayer () method  
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.
renderTriangle () method  
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
setColorTransform () method  
protected function setColorTransform():void

Updates the colortransform object applied to the texture from the color and alpha properties.

See also

color
alpha
updateMaterial () method  
public function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
updateRenderBitmap () method  
protected function updateRenderBitmap():void

Updates the texture bitmapData with the colortransform determined from the color and alpha properties.

See also

color
alpha
setColorTransform()
Event detail
materialresize event 
Event object type: away3d.events.MaterialEvent

Dispatched when the bitmapData used for the material texture is resized.

Wiki link
Click to go to the wiki page for 'away3d.materials.BitmapMaterial'

Code examples
There are currently no examples for this class

BitmapMaterialContainer

Package away3d.materials
Class public class BitmapMaterialContainer
Inheritance BitmapMaterialContainer -> BitmapMaterial -> flash.events.EventDispatcher
Implements ILayerMaterial, ITriangleMaterial, IUpdatingMaterial
Subclasses Dot3BitmapMaterialCache, EnviroBitmapMaterialCache, PhongBitmapMaterialCache, PhongColorMaterialCache
Container for caching multiple bitmapmaterial objects. Renders each material by caching a bitmapData surface object for each face. For continually updating materials, use CompositeMaterial.

See also

away3d.materials.CompositeMaterial
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
    cache : Boolean
Defines whether each created bitmapData surface is to be cached, or updated every frame.
 BitmapMaterialContainer
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
    materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 BitmapMaterialContainer
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
    transparent : Boolean
Defines whether the caching bitmapData objects are transparent
 BitmapMaterialContainer
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
  (^) width : Number
Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Method Defined by
   
BitmapMaterialContainer
(width:int, height:int, init:Object = null)
Creates a new BitmapMaterialContainer object.
 BitmapMaterialContainer
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 BitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
   
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 BitmapMaterialContainer
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 BitmapMaterial
   
update():void
Clear and updates the currrent bitmapData surface on all faces.
 BitmapMaterialContainer
   
updateMaterial(source:Object3D, view:View3D):void
Creates a new BitmapMaterialContainer object.
 BitmapMaterialContainer
Protected Methods
  Method Defined by
   
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 BitmapMaterialContainer
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
   
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterialContainer
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
cache property
cache:Boolean  [read-write]

Defines whether each created bitmapData surface is to be cached, or updated every frame. Updating all bitmapData surface objects is costly, so needs to be used sparingly.

Implementation
    public function get cache():Boolean
    public function set cache(value:Boolean):void
materials property  
public var materials:Array

An array of bitmapmaterial objects to be overlayed sequentially.

transparent property  
public var transparent:Boolean

Defines whether the caching bitmapData objects are transparent

Constructor detail
BitmapMaterialContainer () constructor
public function BitmapMaterialContainer(width:int, height:int, init:Object = null)
Parameters
width:int - The containing width of the texture, applied to all child materials.
 
height:int - The containing height of the texture, applied to all child materials.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  materials:Array
  transparent:Boolean (default = true)
  cache:Boolean (default = true)
Method detail
getMapping () method
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.
renderFace () method  
public override function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters
face:Face - The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle - The rectangle object defining the bounds of the face in uv-space.
 
parentFaceVO:FaceVO - The value object of the preceeding surface.
Returns
FaceVO
update () method  
public function update():void

Clear and updates the currrent bitmapData surface on all faces.

updateMaterial () method  
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.
updateRenderBitmap () method  
protected override function updateRenderBitmap():void

Updates the texture bitmapData with the colortransform determined from the color and alpha properties.

Wiki link
Click to go to the wiki page for 'away3d.materials.BitmapMaterialContainer'

Code examples
There are currently no examples for this class

BitmapRenderSession

Package away3d.core.render
Class public class BitmapRenderSession
Inheritance BitmapRenderSession -> AbstractRenderSession
Drawing session object that renders all drawing primitives into a Bitmap container.
Public Properties
  Property Defined by
  (^) children : Dictionary
Dictionary of child displayobjects.
 AbstractRenderSession
  (^) graphics : Graphics
Reference to the current graphics object being used for drawing.
 AbstractRenderSession
  (^) lightarray : LightArray
Defines the light provider object for the render sesion.
 AbstractRenderSession
  (^) newLayer : Sprite
Holds the last added layer sprite.
 AbstractRenderSession
  (^) sessions : Dictionary
Dictionary of child sessions.
 AbstractRenderSession
  (^) spriteLayers : Array
Dictionary of sprite layers for rendering composite materials.
 AbstractRenderSession
    view : View3D
Defines the view object used for the render session.
 BitmapRenderSession
Public Methods
  Method Defined by
   
BitmapRenderSession
(scale:Number = 2)
Creates a new BitmapRenderSession object.
 BitmapRenderSession
   
addDisplayObject(child:DisplayObject):void
Adds a display object to the render session display list.
 BitmapRenderSession
   
addLayerObject(child:Sprite):void
Adds a layer sprite to the render session display list.
 BitmapRenderSession
   
clear():void
Clears the render session.
 BitmapRenderSession
   
clone():AbstractRenderSession
Duplicates the render session's properties to another render session.
 BitmapRenderSession
   
flush():void
Flushes any cached drawing operations to screen.
 BitmapRenderSession
   
getBitmapData(view:View3D):BitmapData
Returns a bitmapData object containing the rendered view.
 BitmapRenderSession
   
getContainer(view:View3D):DisplayObject
Returns a display object representing the container for the specified view.
 BitmapRenderSession
  (^)
registerChildSession(session:AbstractRenderSession):void
Adds a session as a child of the session object.
 AbstractRenderSession
  (^)
renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void
Draws a non-scaled bitmap into the graphics object.
 AbstractRenderSession
  (^)
renderFogColor(color:int, alpha:Number):void
Draws a fog element into the graphics object.
 AbstractRenderSession
  (^)
renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void
Draws a segment element into the graphics object.
 AbstractRenderSession
  (^)
renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void
Draws a bitmap with a precalculated matrix into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void
Draws a triangle element with a bitmap texture into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a triangle element with a fill color into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element with a fill color into the graphics object.
 AbstractRenderSession
Protected Methods
  Method Defined by
   
createLayer():void
Creates a new render layer for rendering composite materials.
 BitmapRenderSession
Property detail
view property
view:View3D  [read-write]

Defines the view object used for the render session.

Implementation
    public function get view():View3D
    public function set view(value:View3D):void
Constructor detail
BitmapRenderSession () constructor
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
addDisplayObject () method
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.
addLayerObject () method  
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.
clear () method  
public override function clear():void

Clears the render session.

clone () method  
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
createLayer () method  
protected override function createLayer():void

Creates a new render layer for rendering composite materials.

flush () method  
public override function flush():void

Flushes any cached drawing operations to screen.

getBitmapData () method  
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.
getContainer () method  
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.
Wiki link
Click to go to the wiki page for 'away3d.core.render.BitmapRenderSession'

Code examples
There are currently no examples for this class

Blocker

Package away3d.core.block
Class public class Blocker
Inheritance Blocker -> DrawPrimitive
Subclasses ConvexBlocker
Abstract primitive that can block other primitives from drawing
Public Properties
  Property Defined by
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
   
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
block () method
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
Wiki link
Click to go to the wiki page for 'away3d.core.block.Blocker'

Code examples
There are currently no examples for this class

BlockerArray

Package away3d.core.block
Class public class BlockerArray
Implements IBlockerConsumer
Array for storing blocker objects
Public Properties
  Property Defined by
    clip : Clipping
Determines the viewport clipping to be used on blocker primitives.
 BlockerArray
Public Methods
  Method Defined by
   
blocker(block:Blocker):void
Adds blocker primitive to the consumer.
 BlockerArray
   
list():Array
Returns a sorted list of blocker primitives for use in BasicRender
 BlockerArray
Property detail
clip property
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
blocker () method
public function blocker(block:Blocker):void

Adds blocker primitive to the consumer.

Parameters
block:Blocker - The blocker primitive to add.
list () method  
public function list():Array

Returns a sorted list of blocker primitives for use in BasicRender

Returns
Array

See also

away3d.core.render.BasicRender
Wiki link
Click to go to the wiki page for 'away3d.core.block.BlockerArray'

Code examples
There are currently no examples for this class

BlockerTraverser

Package away3d.core.traverse
Class public class BlockerTraverser
Inheritance BlockerTraverser -> Traverser
Traverser that gathers blocker primitives for occlusion culling.
Public Properties
  Property Defined by
    consumer : IBlockerConsumer
Defines the blocker consumer being used.
 BlockerTraverser
    view : View3D
Defines the view being used.
 BlockerTraverser
Public Methods
  Method Defined by
   
BlockerTraverser
()
Creates a new BlockerTraverser object.
 BlockerTraverser
   
apply(node:Object3D):void
Executed when the traverser is applied to the node.
 BlockerTraverser
  (^)
enter(node:Object3D):void
Executed when the traverser enters the node.
 Traverser
  (^)
leave(node:Object3D):void
Executed when the traverser leaves the node.
 Traverser
   
match(node:Object3D):Boolean
Determines if the specified node is required to be traversed.
 BlockerTraverser
Property detail
consumer property
public var consumer:IBlockerConsumer

Defines the blocker consumer being used.

view property  
public var view:View3D

Defines the view being used.

Constructor detail
BlockerTraverser () constructor
public function BlockerTraverser()
Method detail
apply () method
public override function apply(node:Object3D):void

Executed when the traverser is applied to the node.

Parameters
node:Object3D
match () method  
public override function match(node:Object3D):Boolean

Determines if the specified node is required to be traversed.

Parameters
node:Object3D - The 3d object to be tested.
Returns
Boolean - The result of the test.
Wiki link
Click to go to the wiki page for 'away3d.core.traverse.BlockerTraverser'

Code examples
There are currently no examples for this class

Button

Package away3d.test
Class public class Button
Inheritance Button -> flash.display.SimpleButton
Simple rounded rectangle button
Public Properties
  Property Defined by
    selected : Boolean = false
Button
Public Methods
  Method Defined by
   
Button
(text:String, pwidth:int = 80, pheight:int = 20)
 Button
Property detail
selected property
public var selected:Boolean = false
Constructor detail
Button () constructor
public function Button(text:String, pwidth:int = 80, pheight:int = 20)
Parameters
text:String
 
pwidth:int (default = 80)
 
pheight:int (default = 20)
Wiki link
Click to go to the wiki page for 'away3d.test.Button'

Code examples
There are currently no examples for this class

CacheStore

Package away3d.core.utils
Class public class CacheStore
Public Properties
  Property Defined by
    whiteShadingCache : Dictionary
[static]
 CacheStore
Property detail
whiteShadingCache property
public static var whiteShadingCache:Dictionary
Wiki link
Click to go to the wiki page for 'away3d.core.utils.CacheStore'

Code examples
There are currently no examples for this class

Camera3D

Package away3d.cameras
Class public class Camera3D
Inheritance Camera3D -> Object3D -> flash.events.EventDispatcher
Subclasses TargetCamera3D
Basic camera used to resolve a view.

See also

away3d.containers.View3D
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    aperture : Number
Used in DofSprite2D.
 Camera3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    dof : Boolean
Used in DofSprite2D.
 Camera3D
    doflevels : Number = 16
Used in DofSprite2D.
 Camera3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
    focus : Number
A divisor value for the perspective depth of the view.
 Camera3D
  (^) inverseSceneTransform : Matrix3D
Object3D
    maxblur : Number = 150
Used in DofSprite2D.
 Camera3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
    view : Matrix3D
[read-only] Returns the transformation matrix used to resolve the scene to the view.
 Camera3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    zoom : Number
Provides an overall scale value to the view
 Camera3D
Protected Properties
  Method Defined by
   
Camera3D
(init:Object = null)
Creates a new Camera3D object.
 Camera3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
clone(object:* = null):*
Duplicates the camera's properties to another Camera3D object.
 Camera3D
   
disableDof():void
Used in DofSprite2D
 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
Used in DofSprite2D.
 Camera3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
   
pan(angle:Number):void
Rotates the camera in its horizontal plane.
 Camera3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
   
screen(object:Object3D, vertex:Vertex = null):ScreenVertex
Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.
 Camera3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
   
tilt(angle:Number):void
Rotates the camera in its vertical plane.
 Camera3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
aperture property
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 property  
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
doflevels property  
public var doflevels:Number = 16

Used in DofSprite2D.

See also

away3d.sprites.DofSprite2D
focus property  
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
maxblur property  
public var maxblur:Number = 150

Used in DofSprite2D.

See also

away3d.sprites.DofSprite2D
view property  
view:Matrix3D  [read-only]

Returns the transformation matrix used to resolve the scene to the view. Used in the ProjectionTraverser class

Implementation
    public function get view():Matrix3D

See also

away3d.core.traverse.ProjectionTraverser
zoom property  
public var zoom:Number

Provides an overall scale value to the view

Constructor detail
Camera3D () constructor
public function Camera3D(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  zoom:Number (default = 10)
  focus:Number (default = 100)
  aperture:Number (default = 22)
  maxblur:Number (default = 150)
  doflevels:Number (default = 16)
  dof:Boolean (default = false)
  lookat:Position
Method detail
clone () method
public override function clone(object:* = null):*

Duplicates the camera's properties to another Camera3D object.

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied.
Returns
* - The new object instance with duplicated properties applied.
disableDof () method  
public function disableDof():void

Used in DofSprite2D

See also

away3d.sprites.DofSprite2D
enableDof () method  
public function enableDof():void

Used in DofSprite2D.

See also

away3d.sprites.DofSprite2D
pan () method  
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.
screen () method  
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
tilt () method  
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.
Wiki link
Click to go to the wiki page for 'away3d.cameras.Camera3D'

Code examples

lookAt() an Object

camera.lookAt(myObjectA.position); // if mesh it top level object
camera.lookAt(myObjectA.worldPosition); // if mesh is in a container

Cast

Package away3d.core.utils
Class public class Cast
Helper class for casting assets to usable objects
Public Methods
  Method Defined by
   
bitmap(data:*):BitmapData
[static]
 Cast
   
bytearray(data:*):ByteArray
[static]
 Cast
   
color(data:*):uint
[static]
 Cast
   
material(data:*):ITriangleMaterial
[static]
 Cast
   
string(data:*):String
[static]
 Cast
   
tryclass(name:String):Object
[static]
 Cast
   
trycolor(data:*):uint
[static]
 Cast
   
wirematerial(data:*):ISegmentMaterial
[static]
 Cast
   
xml(data:*):XML
[static]
 Cast
Method detail
bitmap () method
public static function bitmap(data:*):BitmapData
Parameters
data:*
Returns
BitmapData
bytearray () method  
public static function bytearray(data:*):ByteArray
Parameters
data:*
Returns
ByteArray
color () method  
public static function color(data:*):uint
Parameters
data:*
Returns
uint
material () method  
public static function material(data:*):ITriangleMaterial
Parameters
data:*
Returns
ITriangleMaterial
string () method  
public static function string(data:*):String
Parameters
data:*
Returns
String
tryclass () method  
public static function tryclass(name:String):Object
Parameters
name:String
Returns
Object
trycolor () method  
public static function trycolor(data:*):uint
Parameters
data:*
Returns
uint
wirematerial () method  
public static function wirematerial(data:*):ISegmentMaterial
Parameters
data:*
Returns
ISegmentMaterial
xml () method  
public static function xml(data:*):XML
Parameters
data:*
Returns
XML
Wiki link
Click to go to the wiki page for 'away3d.core.utils.Cast'

Code examples
There are currently no examples for this class

CastError

Package away3d.core.utils
Class public class CastError
Inheritance CastError -> Error
Public Methods
  Method Defined by
   
CastError
(message:String)
 CastError
Constructor detail
CastError () constructor
public function CastError(message:String)
Parameters
message:String
Wiki link
Click to go to the wiki page for 'away3d.core.utils.CastError'

Code examples
There are currently no examples for this class

CenterLightingMaterial

Package away3d.materials
Class public class CenterLightingMaterial
Inheritance CenterLightingMaterial -> flash.events.EventDispatcher
Implements ITriangleMaterial, IUpdatingMaterial
Subclasses ShadingColorMaterial, WhiteShadingBitmapMaterial
Abstract class for materials that calculate lighting for the face's center Not intended for direct use - use ShadingColorMaterial or WhiteShadingBitmapMaterial.
Public Properties
  Property Defined by
    ak : Number = 20
Coefficient for shininess level
 CenterLightingMaterial
    ambient_brightness : Number = 1
Coefficient for ambient light level
 CenterLightingMaterial
    diffuse_brightness : Number = 1
Coefficient for diffuse light level
 CenterLightingMaterial
    specular_brightness : Number = 1
Coefficient for specular light level
 CenterLightingMaterial
Protected Properties
  Property Defined by
    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
  Method Defined by
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CenterLightingMaterial
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CenterLightingMaterial
Property detail
ak property
public var ak:Number = 20

Coefficient for shininess level

ambient_brightness property  
public var ambient_brightness:Number = 1

Coefficient for ambient light level

diffuse_brightness property  
public var diffuse_brightness:Number = 1

Coefficient for diffuse light level

ini property  
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.

specular_brightness property  
public var specular_brightness:Number = 1

Coefficient for specular light level

Method detail
renderTriangle () method
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
updateMaterial () method  
public function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.CenterLightingMaterial'

Code examples
There are currently no examples for this class

Clipping

Package away3d.core.clip
Class public class Clipping
Subclasses RectangleClipping
Base clipping class for no clipping.
Public Properties
  Property Defined by
    maxX : Number = 1000000
Maximum allowed x value for primitives
 Clipping
    maxY : Number = 1000000
Maximum allowed y value for primitives
 Clipping
    minX : Number = -1000000
Minimum allowed x value for primitives
 Clipping
    minY : Number = -1000000
Minimum allowed y value for primitives
 Clipping
Public Methods
  Method Defined by
   
asRectangleClipping():RectangleClipping
Returns a rectangle clipping object representing the bounding box of the clipping object.
 Clipping
   
check(pri:DrawPrimitive):Boolean
Checks a drawing primitive for clipping.
 Clipping
   
rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean
Checks a bounding rectangle for clipping.
 Clipping
   
screen(container:Sprite):Clipping
Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds.
 Clipping
Property detail
maxX property
public var maxX:Number = 1000000

Maximum allowed x value for primitives

maxY property  
public var maxY:Number = 1000000

Maximum allowed y value for primitives

minX property  
public var minX:Number = -1000000

Minimum allowed x value for primitives

minY property  
public var minY:Number = -1000000

Minimum allowed y value for primitives

Method detail
asRectangleClipping () method
public function asRectangleClipping():RectangleClipping

Returns a rectangle clipping object representing the bounding box of the clipping object.

Returns
RectangleClipping
check () method  
public function check(pri:DrawPrimitive):Boolean

Checks a drawing primitive for clipping.

Parameters
pri:DrawPrimitive - The drawing primitive being checked.
Returns
Boolean - The clipping result - false for clipped, true for non-clipped.
rect () method  
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.
screen () method  
public function screen(container:Sprite):Clipping

Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds.

Parameters
container:Sprite
Returns
Clipping
Wiki link
Click to go to the wiki page for 'away3d.core.clip.Clipping'

Code examples
There are currently no examples for this class

Collada

Package away3d.loaders
Class public class Collada
File loader for the Collada file format.
Public Properties
  Property Defined by
    container : ObjectContainer3D
3d container object used for storing the parsed collada scene.
 Collada
    containerData : ContainerData
Container data object used for storing the parsed collada data structure.
 Collada
    materialLibrary : MaterialLibrary
Reference container for all materials used in the collada scene.
 Collada
Public Methods
  Method Defined by
   
Collada
(xml:XML, init:Object = null)
Creates a new Collada object.
 Collada
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses a collada file into a 3d container object.
 Collada
   
loadTextures(data:*, init:Object = null):Object3DLoader
[static] Loads and parses the textures for a collada file into a 3d container object.
 Collada
   
parse(data:*, init:Object = null, loader:Object = null):ObjectContainer3D
[static] Creates a 3d container object from the raw xml data of a collada file.
 Collada
Property detail
container property
public var container:ObjectContainer3D

3d container object used for storing the parsed collada scene.

containerData property  
public var containerData:ContainerData

Container data object used for storing the parsed collada data structure.

materialLibrary property  
public var materialLibrary:MaterialLibrary

Reference container for all materials used in the collada scene.

Constructor detail
Collada () constructor
public function Collada(xml:XML, init:Object = null)
Parameters
xml:XML - The xml data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  texturePath:String (default = "")
  autoLoadTextures:Boolean (default = true)
  scaling:Number (default = 1)
  material:Material
  centerMeshes:Boolean (default = false)
  materials:Object

See also

away3d.loaders.Collada.parse()
away3d.loaders.Collada.load()
Method detail
load () method
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.
loadTextures () method  
public static function loadTextures(data:*, init:Object = null):Object3DLoader

Loads and parses the textures for a collada file into a 3d container object.

Parameters
data:* - The xml data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Returns
Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the textures are loading.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object = null):ObjectContainer3D

Creates a 3d container object from the raw xml data of a collada file.

Parameters
data:* - The xml data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object (default = null) - [optional] Not intended for direct use.
Returns
ObjectContainer3D - A 3d container object representation of the collada file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Collada'

Code examples
There are currently no examples for this class

CollisionMap

Package away3d.extrusions
Class public class CollisionMap
Inheritance CollisionMap -> flash.events.EventDispatcher
Public Properties
  Property Defined by
    offsetx : Number
[write-only]
 CollisionMap
    offsety : Number
[write-only]
 CollisionMap
Public Methods
  Method Defined by
   
CollisionMap
(source:BitmapData, view:Object, factorX:Number = 0, factorY:Number = 0)
 CollisionMap
   
getColorAt(x:Number, y:Number):Number
 CollisionMap
   
read(x:Number, y:Number):void
 CollisionMap
   
setColorEvent(color:Number, eventID:String, listener:Function):void
 CollisionMap
Property detail
offsetx property
offsetx:Number  [write-only]
Implementation
    public function set offsetx(value:Number):void
offsety property  
offsety:Number  [write-only]
Implementation
    public function set offsety(value:Number):void
Constructor detail
CollisionMap () constructor
public function CollisionMap(source:BitmapData, view:Object, factorX:Number = 0, factorY:Number = 0)
Parameters
source:BitmapData
 
view:Object
 
factorX:Number (default = 0)
 
factorY:Number (default = 0)
Method detail
getColorAt () method
public function getColorAt(x:Number, y:Number):Number
Parameters
x:Number
 
y:Number
Returns
Number
read () method  
public function read(x:Number, y:Number):void
Parameters
x:Number
 
y:Number
setColorEvent () method  
public function setColorEvent(color:Number, eventID:String, listener:Function):void
Parameters
color:Number
 
eventID:String
 
listener:Function
Wiki link
Click to go to the wiki page for 'away3d.extrusions.CollisionMap'

Code examples
There are currently no examples for this class

Color

Package away3d.core.utils
Class public class Color
Static helper class for color manipulations
Public Methods
  Method Defined by
   
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
  Constant Defined by
    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
add () method
public static function add(colora:int, colorb:int):int
Parameters
colora:int
 
colorb:int
Returns
int
fromFloats () method  
public static function fromFloats(red:Number, green:Number, blue:Number):int
Parameters
red:Number
 
green:Number
 
blue:Number
Returns
int
fromHSV () method  
public static function fromHSV(hue:Number, saturation:Number, value:Number):int
Parameters
hue:Number
 
saturation:Number
 
value:Number
Returns
int
fromInts () method  
public static function fromInts(red:int, green:int, blue:int):int
Parameters
red:int
 
green:int
 
blue:int
Returns
int
fromIntsCheck () method  
public static function fromIntsCheck(red:int, green:int, blue:int):int
Parameters
red:int
 
green:int
 
blue:int
Returns
int
inverseAdd () method  
public static function inverseAdd(colora:int, colorb:int):int
Parameters
colora:int
 
colorb:int
Returns
int
multiply () method  
public static function multiply(color:int, k:Number):int
Parameters
color:int
 
k:Number
Returns
int
Constant detail
black constant
public static const black:int = 0x000000
blue constant  
public static const blue:int = 0x0000FF
cyan constant  
public static const cyan:int = 0x00FFFF
green constant  
public static const green:int = 0x00FF00
purple constant  
public static const purple:int = 0xFF00FF
red constant  
public static const red:int = 0xFF0000
white constant  
public static const white:int = 0xFFFFFF
yellow constant  
public static const yellow:int = 0xFFFF00
Wiki link
Click to go to the wiki page for 'away3d.core.utils.Color'

Code examples
There are currently no examples for this class

ColorMaterial

Package away3d.materials
Class public class ColorMaterial
Implements IFogMaterial, ITriangleMaterial
Material for solid color drawing
Public Properties
  Property Defined by
    alpha : Number
Determines the alpha value of the material
 ColorMaterial
    color : uint
24 bit color value representing the material color
 ColorMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 ColorMaterial
Protected Properties
  Property Defined by
    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
  Method Defined by
   
ColorMaterial
(color:* = null, init:Object = null)
Creates a new ColorMaterial object.
 ColorMaterial
   
clone():IFogMaterial
Duplicates the material's properties to another IFogMaterial object
 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
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 ColorMaterial
Property detail
alpha property
alpha:Number  [read-write]

Determines the alpha value of the material

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
color property  
public var color:uint

24 bit color value representing the material color

ini property  
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 property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
Constructor detail
ColorMaterial () constructor
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
clone () method
public function clone():IFogMaterial

Duplicates the material's properties to another IFogMaterial object

Returns
IFogMaterial - The new object instance with duplicated properties applied
renderFog () method  
public function renderFog(fog:DrawFog):void

Sends the material data coupled with data from the DrawFog primitive to the render session

Parameters
fog:DrawFog
renderTriangle () method  
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
Wiki link
Click to go to the wiki page for 'away3d.materials.ColorMaterial'

Code examples
There are currently no examples for this class

CompositeMaterial

Package away3d.materials
Class public class CompositeMaterial
Implements ILayerMaterial, ITriangleMaterial, IUpdatingMaterial
Subclasses Dot3BitmapMaterial, Dot3MovieMaterial, EnviroBitmapMaterial, PhongBitmapMaterial, PhongColorMaterial, PhongMovieMaterial
Container for layering multiple material objects. Renders each material by drawing one triangle per meterial layer. For static bitmap materials, use BitmapMaterialContainer.

See also

away3d.materials.BitmapMaterialContainer
Public Properties
  Property Defined by
    alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
    blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
    color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
    materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Property Defined by
    ini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
 CompositeMaterial
Public Methods
  Method Defined by
   
CompositeMaterial
(init:Object = null)
Creates a new CompositeMaterial object.
 CompositeMaterial
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
   
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 CompositeMaterial
Property detail
alpha property
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
blendMode property  
public var blendMode:String

Defines a blendMode value for the layer container.

color property  
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
ini property  
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.

materials property  
public var materials:Array

An array of bitmapmaterial objects to be overlayed sequentially.

visible property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
Constructor detail
CompositeMaterial () constructor
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
renderLayer () method
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.
renderTriangle () method  
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
setColorTransform () method  
protected function setColorTransform():void

Updates the colortransform object applied to the texture from the color and alpha properties.

See also

color
alpha
updateMaterial () method  
public function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.CompositeMaterial'

Code examples
There are currently no examples for this class

Cone

Package away3d.primitives
Class public class Cone
Inheritance Cone -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d cone primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the cone.
 Cone
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
    openEnded : Boolean
Defines whether the end of the cone is left open (true) or closed (false).
 Cone
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the cone base.
 Cone
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
    segmentsH : Number
Defines the number of vertical segments that make up the cone.
 Cone
    segmentsW : Number
Defines the number of horizontal segments that make up the cone.
 Cone
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the cone points use a yUp orientation (true) or a zUp orientation (false).
 Cone
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Cone
(init:Object = null)
Creates a new Cone object.
 Cone
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Cone
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 Cone
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
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 property  
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 property  
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 property  
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 property  
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 property  
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
Cone () constructor
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
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
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
Wiki link
Click to go to the wiki page for 'away3d.primitives.Cone'

Code examples

Cone Creation

                       // Cone
var cone1:Cone = new Cone({name:"Cone1", x:-250, segmentsH:5, segmentsW:20, height:250, material:new WireframeMaterial(0xff000000)});
var cone2:Cone = new Cone({name:"Cone2", x:0, radius:50, material:new ShadingColorMaterial({color:0xaa0000})});
var cone3:Cone = new Cone({name:"Cone3", x:250, segmentsH:10, segmentsW:20, material:new PreciseBitmapMaterial(textureImage)});
var coneContainer:ObjectContainer3D = new ObjectContainer3D({name:"Cone", visible:true}, cone1, cone2, cone3);
view.scene.addChild(coneContainer);

Source Files : http://www.geepers.oxyuk.net/software/objectexamples.html

Simple object creation tutorial


ContainerData

Package away3d.loaders.data
Class public class ContainerData
Inheritance ContainerData -> ObjectData
Data class for 3d object containers.
Public Properties
  Property Defined by
    children : Array
An array containing the child 3d objects of the container.
 ContainerData
  (^) name : String
The name of the 3d object used as a unique reference.
 ObjectData
  (^) transform : Matrix3D
The 3d transformation matrix for the 3d object
 ObjectData
Property detail
children property
public var children:Array

An array containing the child 3d objects of the container.

Wiki link
Click to go to the wiki page for 'away3d.loaders.data.ContainerData'

Code examples
There are currently no examples for this class

ConvexBlock

Package away3d.blockers
Class public class ConvexBlock
Inheritance ConvexBlock -> Object3D -> flash.events.EventDispatcher
Implements IBlockerProvider, IPrimitiveProvider
Convex hull blocking all drawing primitives underneath.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    debug : Boolean
Toggles debug mode: blocker is visualised in the scene.
 ConvexBlock
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
    vertices : Array
Verticies to use for calculating the convex hull.
 ConvexBlock
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
ConvexBlock
(vertices:Array, init:Object = null)
Creates a new ConvexBlock object.
 ConvexBlock
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
blockers(consumer:IBlockerConsumer):void
Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object
 ConvexBlock
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 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
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 ConvexBlock
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
debug property
public var debug:Boolean

Toggles debug mode: blocker is visualised in the scene.

vertices property  
public var vertices:Array

Verticies to use for calculating the convex hull.

Constructor detail
ConvexBlock () constructor
public function ConvexBlock(vertices:Array, init:Object = null)
Parameters
vertices:Array - An Array of vertices to use for calculating the convex hull.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  debug:Boolean (default = false)
Method detail
blockers () method
public function blockers(consumer:IBlockerConsumer):void

Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object

Parameters
consumer:IBlockerConsumer - The consumer instance

See also

away3d.core.traverse.BlockerTraverser
away3d.core.block.Blocker
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawPrimitive
Wiki link
Click to go to the wiki page for 'away3d.blockers.ConvexBlock'

Code examples
There are currently no examples for this class

ConvexBlocker

Package away3d.core.block
Class public class ConvexBlocker
Inheritance ConvexBlocker -> Blocker -> DrawPrimitive
Convex hull primitive that blocks all primitives behind and contained completely inside.
Public Properties
  Property Defined by
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
    vertices : Array
Defines the vertices used to calulate the convex hull.
 ConvexBlocker
Public Methods
  Method Defined by
   
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
vertices property
public var vertices:Array

Defines the vertices used to calulate the convex hull.

Method detail
block () method
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
calc () method  
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

contains () method  
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.
render () method  
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.block.ConvexBlocker'

Code examples
There are currently no examples for this class

Cube

Package away3d.primitives
Class public class Cube
Inheritance Cube -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses LogoCube
Creates a 3d cube primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
    cubeMaterials : CubeMaterialsData
Defines the face materials of the cube.
 Cube
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
    depth : Number
Defines the depth of the cube.
 Cube
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the cube.
 Cube
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
    width : Number
Defines the width of the cube.
 Cube
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Cube
(init:Object = null)
Creates a new Cube object.
 Cube
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Cube
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
cubeMaterials property
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 property  
depth:Number  [read-write]

Defines the depth of the cube. Defaults to 100.

Implementation
    public function get depth():Number
    public function set depth(value:Number):void
height property  
height:Number  [read-write]

Defines the height of the cube. Defaults to 100.

Implementation
    public function get height():Number
    public function set height(value:Number):void
width property  
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
Cube () constructor
public function Cube(init:Object = null)

Constructor for a cube object. The init object parameters are : 'size' defines all the dimensions of the cube unless overridden, 'width'/'height'/'depth' explicit dimensions for the cube and 'faces' which itself is an init object.

The 'faces' object takes the following parameters as materials : 'left', 'right', 'bottom', 'top', 'front' and 'back'.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  width:Number (default = 100, min:0)
  height:Number (default = 100, min:0)
  depth:Number (default = 100, min:0)
  faces:CubeMaterials
  cubeMaterials:CubeMaterials
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.Cube'

Code examples

*Lesson_Basic_02_Primitives.fla

// import core library
import away3d.core.scene.*;
// import geometry primitives
import away3d.objects.*;

// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
addChild(view);

// create primitives
var plane:Object3D = new Plane({material:"yellow#", name:"plane", y:-100, width:1000, height:1000, pushback:true});
var sphere:Object3D = new Sphere({material:"red#", name:"sphere", x: 300, y:160, z: 300, radius:150, segmentsW:12, segmentsH:9});
var cube:Object3D = new Cube({material:"blue#", name:"cube", x: 300, y:160, z: -80, width:200, height:200, depth:200});
var torus:Object3D = new Torus({material:"limegreen#", name:"torus", x:-250, y:160, z:-250, radius:150, tube:60, segmentsR:8, segmentsT:6});

// add primitives to the scene
view.scene.addChildren(sphere, cube, plane, torus);

// set camera in space
view.camera.moveTo(torus.position);
view.camera.lookAt(cube.position);
view.camera.moveBackward(1500);
view.camera.moveUp(1500);
view.camera.lookAt(plane.position);

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rerender viewport on each frame
view.render();
}

From Lesson_Basic_02_Primitives.fla


CubeLoader

Package away3d.loaders
Class public class CubeLoader
Inheritance CubeLoader -> Object3DLoader -> ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
Default loader class used as a placeholder for loading 3d content
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 ObjectContainer3D
  (^) children : Array
Returns the children of the container as an array of 3d objects
 ObjectContainer3D
  (^) containerData : ContainerData
Returns the the data container being used by the loaded file.
 Object3DLoader
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) handle : Object3D
Returns a 3d object relating to the currently visible model.
 Object3DLoader
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) materialLibrary : MaterialLibrary
Returns the material library being used by the loaded file.
 Object3DLoader
  (^) maxX : Number
Returns the maximum x value of the 3d object
 ObjectContainer3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 ObjectContainer3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 ObjectContainer3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 ObjectContainer3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 ObjectContainer3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 ObjectContainer3D
  (^) mode : String
Returns the current loading mode of the 3d object loader.
 Object3DLoader
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) parse : Function
Function placeholder for the parse method from the correct file loader class.
 Object3DLoader
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) texturePath : String
Returns the filepath to the directory where any required texture files are located.
 Object3DLoader
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) url : String
Returns the url string of the file being loaded.
 Object3DLoader
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
CubeLoader
(init:Object = null)
Creates a new CubeLoader object.
 CubeLoader
  (^)
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
  (^)
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnError(listener:Function):void
Default method for adding a loaderror event listener
 Object3DLoader
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSuccess(listener:Function):void
Default method for adding a loadsuccess event listener
 Object3DLoader
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnError(listener:Function):void
Default method for removing a loaderror event listener
 Object3DLoader
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSuccess(listener:Function):void
Default method for removing a loadsuccess event listener
 Object3DLoader
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 ObjectContainer3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
onComplete(event:Event):void
Automatically fired on a complete event
 Object3DLoader
   
onError(event:IOErrorEvent):void
Listener function for an error event.
 CubeLoader
   
onProgress(event:ProgressEvent):void
Listener function for a progress event.
 CubeLoader
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
loaderror
 Dispatched when the 3d object loader fails to load a file. Object3DLoader
  (^)
loadsuccess
 Dispatched when the 3d object loader completes a file load successfully. Object3DLoader
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Public Constants
Constructor detail
CubeLoader () constructor
public function CubeLoader(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  loadersize:Number (default = 200)
  geometrytitle:String (default = "Loading Geometry...")
  texturetitle:String (default = "Loading Texture...")
Method detail
onError () method
protected override function onError(event:IOErrorEvent):void

Listener function for an error event.

Parameters
event:IOErrorEvent
onProgress () method  
protected override function onProgress(event:ProgressEvent):void

Listener function for a progress event.

Parameters
event:ProgressEvent
Wiki link
Click to go to the wiki page for 'away3d.loaders.CubeLoader'

Code examples
There are currently no examples for this class

CubeMaterialsData

Package away3d.primitives.data
Class public class CubeMaterialsData
Inheritance CubeMaterialsData -> flash.events.EventDispatcher
Data structure for individual materials on the sides of a cube.

See also

away3d.primitives.Cube
away3d.primitives.Skybox
Public Properties
  Property Defined by
    back : ITriangleMaterial
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
  Property Defined by
    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
  Method Defined by
   
CubeMaterialsData
(init:Object = null)
Creates a new CubeMaterialsData object.
 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
  Event Summary Defined by
   
materialchanged
 Dispatched when the cube materials object has one of it's materials updated. CubeMaterialsData
Property detail
back property
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 property  
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 property  
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
ini property  
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 property  
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 property  
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 property  
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
CubeMaterialsData () constructor
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
addOnMaterialChange () method
public function addOnMaterialChange(listener:Function):void

Default method for adding a materialchanged event listener

Parameters
listener:Function - The listener function
removeOnMaterialChange () method  
public function removeOnMaterialChange(listener:Function):void

Default method for removing a materialchanged event listener

Parameters
listener:Function - The listener function
Event detail
materialchanged event 
Event object type: away3d.events.MaterialEvent

Dispatched when the cube materials object has one of it's materials updated.

Wiki link
Click to go to the wiki page for 'away3d.primitives.data.CubeMaterialsData'

Code examples
There are currently no examples for this class

Cylinder

Package away3d.primitives
Class public class Cylinder
Inheritance Cylinder -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d cylinder primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the cylinder.
 Cylinder
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
    openEnded : Boolean
Defines whether the ends of the cylinder are left open (true) or closed (false).
 Cylinder
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the cylinder.
 Cylinder
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
    segmentsH : Number
Defines the number of vertical segments that make up the cylinder.
 Cylinder
    segmentsW : Number
Defines the number of horizontal segments that make up the cylinder.
 Cylinder
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the cylinder points use a yUp orientation (true) or a zUp orientation (false).
 Cylinder
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Cylinder
(init:Object = null)
Creates a new Cylinder object.
 Cylinder
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Cylinder
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 Cylinder
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
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 property  
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 property  
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 property  
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 property  
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 property  
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
Cylinder () constructor
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
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
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
Wiki link
Click to go to the wiki page for 'away3d.primitives.Cylinder'

Code examples

Creating Elliptical cylinder

//add this in Cylinder class constructor

var radiusW:Number = init.getNumber("radiusW", radius, {min:0});
var radiusH:Number = init.getNumber("radiusH", radius, {min:0});

//replace the radius property with radiusW and radiusH in the buildCylinder method parameters

for (i = 0; i < segmentsW; i++)
{
var verangle:Number = 2 * i / segmentsW * Math.PI;
var x:Number = radiusH * Math.sin(verangle);
var y:Number = radiusW * Math.cos(verangle);
grid[j][i] = new Vertex(y, z, x);
}

Debug

Package away3d.core.utils
Class public class Debug
Class for emmiting debuging messages, warnings and errors
Public Properties
  Property Defined by
    active : Boolean = false
[static]
 Debug
    warningsAsErrors : Boolean = false
[static]
 Debug
Public Methods
  Method Defined by
   
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
active property
public static var active:Boolean = false
warningsAsErrors property  
public static var warningsAsErrors:Boolean = false
Method detail
clear () method
public static function clear():void
delimiter () method  
public static function delimiter():void
error () method  
public static function error(message:Object):void
Parameters
message:Object
trace () method  
public static function trace(message:Object):void
Parameters
message:Object
warning () method  
public static function warning(message:Object):void
Parameters
message:Object
Wiki link
Click to go to the wiki page for 'away3d.core.utils.Debug'

Code examples
There are currently no examples for this class

DebugObjectContainer3D

Package away3d.containers
Class public class DebugObjectContainer3D
Inheritance DebugObjectContainer3D -> ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Extension of ObjectContainer3D used in debugging. Gives the option for displaying a bounding box and bounding sphere of the contained object tree.

See also

away3d.containers.ObjectContainer3D
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 ObjectContainer3D
  (^) children : Array
Returns the children of the container as an array of 3d objects
 ObjectContainer3D
    debugbb : Boolean = false
defines whether a bounding box for the child 3d objects is displayed
 DebugObjectContainer3D
    debugbs : Boolean = false
defines whether a bounding sphere for the child 3d objects is displayed
 DebugObjectContainer3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 ObjectContainer3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 ObjectContainer3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 ObjectContainer3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 ObjectContainer3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 ObjectContainer3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 ObjectContainer3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
DebugObjectContainer3D
(init:Object = null, ... childarray)
Creates a new DebugObjectContainer3D object
 DebugObjectContainer3D
  (^)
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
  (^)
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 DebugObjectContainer3D
  (^)
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 ObjectContainer3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
debugbb property
public var debugbb:Boolean = false

defines whether a bounding box for the child 3d objects is displayed

debugbs property  
public var debugbs:Boolean = false

defines whether a bounding sphere for the child 3d objects is displayed

Constructor detail
DebugObjectContainer3D () constructor
public function DebugObjectContainer3D(init:Object = null, ... childarray)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties
 
... childarray - An array of children to be added on instatiation
Method detail
primitives () method
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawPrimitive
Wiki link
Click to go to the wiki page for 'away3d.containers.DebugObjectContainer3D'

Code examples
There are currently no examples for this class

DiffuseDot3Shader

Package away3d.materials.shaders
Class public class DiffuseDot3Shader
Inheritance DiffuseDot3Shader -> AbstractShader -> flash.events.EventDispatcher
Implements IUVMaterial
Diffuse Dot3 shader class for directional lighting.

See also

away3d.lights.DirectionalLight3D
Public Properties
  Property Defined by
    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
  Method Defined by
   
DiffuseDot3Shader
(bitmap:BitmapData, init:Object = null)
Creates a new DiffuseDot3Shader object.
 DiffuseDot3Shader
   
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 DiffuseDot3Shader
   
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 DiffuseDot3Shader
   
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 DiffuseDot3Shader
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 DiffuseDot3Shader
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 DiffuseDot3Shader
Protected Methods
  Method Defined by
   
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 DiffuseDot3Shader
  (^)
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
  (^)
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
   
renderShader(face:Face):void
Renders the shader to the specified face.
 DiffuseDot3Shader
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the shader DOT3 map.

Implementation
    public function get bitmap():BitmapData
height property  
height:Number  [read-only]

Returns the height of the bitmapData being used as the shader DOT3 map.

Implementation
    public function get height():Number
tangentSpace property  
public var tangentSpace:Boolean

Determines if the DOT3 mapping is rendered in tangent space (true) or object space (false).

width property  
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
DiffuseDot3Shader () constructor
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
addOnResize () method
public function addOnResize(listener:Function):void

Default method for adding a materialresize event listener

Parameters
listener:Function - The listener function
clearFaceDictionary () method  
protected override function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters
source:Object3D - The parent 3d object of the face.
 
view:View3D - The view rendering the draw triangle.
getPixel32 () method  
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.
removeOnResize () method  
public function removeOnResize(listener:Function):void

Default method for removing a materialresize event listener

Parameters
listener:Function - The listener function
renderLayer () method  
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.
renderShader () method  
protected override function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters
face:Face - The face object being rendered.
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.DiffuseDot3Shader'

Code examples
There are currently no examples for this class

DiffusePhongShader

Package away3d.materials.shaders
Class public class DiffusePhongShader
Inheritance DiffusePhongShader -> AbstractShader -> flash.events.EventDispatcher
Diffuse shader class for directional lighting.

See also

away3d.lights.DirectionalLight3D
Public Properties
  Property Defined by
  (^) 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
  Method Defined by
   
DiffusePhongShader
(init:Object = null)
Creates a new DiffusePhongShader object.
 DiffusePhongShader
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 DiffusePhongShader
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 DiffusePhongShader
Protected Methods
  Method Defined by
   
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 DiffusePhongShader
  (^)
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
  (^)
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
   
renderShader(face:Face):void
Renders the shader to the specified face.
 DiffusePhongShader
Constructor detail
DiffusePhongShader () constructor
public function DiffusePhongShader(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
clearFaceDictionary () method
protected override function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters
source:Object3D - The parent 3d object of the face.
 
view:View3D - The view rendering the draw triangle.
renderLayer () method  
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.
renderShader () method  
protected override function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters
face:Face - The face object being rendered.
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.DiffusePhongShader'

Code examples
There are currently no examples for this class

DirectionalLight

Package away3d.core.light
Class public class DirectionalLight
Inheritance DirectionalLight -> LightPrimitive
Directional light primitive.
Public Properties
  Property Defined by
  (^) 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
A reference to the DirectionalLight3D object used by the light primitive.
 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
  Method Defined by
   
clearTransform():void
Clears the transform and matrix dictionaries used in the shading materials.
 DirectionalLight
   
setColorMatrixTransform(source:Object3D):void
Updates the color transform matrix.
 DirectionalLight
   
setDiffuseTransform(source:Object3D):void
Updates the transform matrix for the diffuse lightmap.
 DirectionalLight
   
setNormalMatrixTransform(source:Object3D):void
Updates the normal transform matrix.
 DirectionalLight
   
setSpecularTransform(source:Object3D, view:View3D):void
Updates the transform matrix for the specular lightmap.
 DirectionalLight
   
updateAmbientBitmap(ambient:Number):void
Updates the bitmapData object used as the lightmap for ambient light shading.
 DirectionalLight
   
updateAmbientDiffuseBitmap(ambient:Number, diffuse:Number):void
Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading.
 DirectionalLight
   
updateDiffuseBitmap(diffuse:Number):void
Updates the bitmapData object used as the lightmap for diffuse light shading.
 DirectionalLight
   
updateDirection(e:Object3DEvent):void
Updates the direction vector of the directional light.
 DirectionalLight
   
updateSpecularBitmap(specular:Number):void
Updates the bitmapData object used as the lightmap for specular light shading.
 DirectionalLight
Property detail
ambientDiffuseColorTransform property
public var ambientDiffuseColorTransform:ColorTransform

Color transform used in cached shading materials for combined ambient and diffuse color intensities.

colorMatrixTransform property  
public var colorMatrixTransform:Dictionary

Colormatrix transform used in DOT3 materials for resolving color in the normal map.

diffuseColorTransform property  
public var diffuseColorTransform:ColorTransform

Color transform used in cached shading materials for ambient intensities.

diffuseTransform property  
public var diffuseTransform:Dictionary

Transform dictionary for the diffuse lightmap used by shading materials.

light property  
public var light:DirectionalLight3D

A reference to the DirectionalLight3D object used by the light primitive.

normalMatrixTransform property  
public var normalMatrixTransform:Dictionary

Colormatrix transform used in DOT3 materials for resolving normal values in the normal map.

specularTransform property  
public var specularTransform:Dictionary

Transform dictionary for the specular lightmap used by shading materials.

Method detail
clearTransform () method
public function clearTransform():void

Clears the transform and matrix dictionaries used in the shading materials.

setColorMatrixTransform () method  
public function setColorMatrixTransform(source:Object3D):void

Updates the color transform matrix.

Parameters
source:Object3D

See also

colorMatrixTransform
setDiffuseTransform () method  
public function setDiffuseTransform(source:Object3D):void

Updates the transform matrix for the diffuse lightmap.

Parameters
source:Object3D

See also

diffuseTransform
setNormalMatrixTransform () method  
public function setNormalMatrixTransform(source:Object3D):void

Updates the normal transform matrix.

Parameters
source:Object3D

See also

normalMatrixTransform
setSpecularTransform () method  
public function setSpecularTransform(source:Object3D, view:View3D):void

Updates the transform matrix for the specular lightmap.

Parameters
source:Object3D
 
view:View3D

See also

specularTransform
updateAmbientBitmap () method  
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.
updateAmbientDiffuseBitmap () method  
public function updateAmbientDiffuseBitmap(ambient:Number, diffuse:Number):void

Updates the bitmapData object used as the lightmap for the combined ambient and diffue light shading.

Parameters
ambient:Number - The coefficient for ambient light intensity.
 
diffuse:Number - The coefficient for diffuse light intensity.
updateDiffuseBitmap () method  
public function updateDiffuseBitmap(diffuse:Number):void

Updates the bitmapData object used as the lightmap for diffuse light shading.

Parameters
diffuse:Number - The coefficient for diffuse light intensity.
updateDirection () method  
public function updateDirection(e:Object3DEvent):void

Updates the direction vector of the directional light.

Parameters
e:Object3DEvent
updateSpecularBitmap () method  
public function updateSpecularBitmap(specular:Number):void

Updates the bitmapData object used as the lightmap for specular light shading.

Parameters
specular:Number - The coefficient for specular light intensity.
Wiki link
Click to go to the wiki page for 'away3d.core.light.DirectionalLight'

Code examples
There are currently no examples for this class

DirectionalLight3D

Package away3d.lights
Class public class DirectionalLight3D
Inheritance DirectionalLight3D -> Object3D -> flash.events.EventDispatcher
Implements IClonable, ILightProvider, IPrimitiveProvider
Lightsource that colors all shaded materials proportional to the dot product of the offset vector with the normal vector. The scalar value of distance does not affect the resulting light intensity, it is calulated as if the source is an infinite distance away with an infinite brightness.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    ambient : Number
Defines a coefficient for the ambient light intensity.
 DirectionalLight3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    brightness : Number
Defines a coefficient for the overall light intensity.
 DirectionalLight3D
    color : int
Defines the color of the light object.
 DirectionalLight3D
    debug : Boolean
Toggles debug mode: light object is visualised in the scene.
 DirectionalLight3D
    diffuse : Number
Defines a coefficient for the diffuse light intensity.
 DirectionalLight3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    specular : Number
Defines a coefficient for the specular light intensity.
 DirectionalLight3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
DirectionalLight3D
(init:Object = null)
Creates a new DirectionalLight3D object.
 DirectionalLight3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
clone(object:* = null):*
Duplicates the light object's properties to another DirectionalLight3D object
 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
Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object
 DirectionalLight3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 DirectionalLight3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
ambient property
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 property  
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 property  
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 property  
public var debug:Boolean

Toggles debug mode: light object is visualised in the scene.

diffuse property  
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 property  
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
DirectionalLight3D () constructor
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
clone () method
public override function clone(object:* = null):*

Duplicates the light object's properties to another DirectionalLight3D object

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied
Returns
* - The new object instance with duplicated properties applied
light () method  
public function light(consumer:ILightConsumer):void

Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object

Parameters
consumer:ILightConsumer - The consumer instance.
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object
Wiki link
Click to go to the wiki page for 'away3d.lights.DirectionalLight3D'

Code examples
There are currently no examples for this class

DirSprite2D

Package away3d.sprites
Class public class DirSprite2D
Inheritance DirSprite2D -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Spherical billboard (always facing the camera) sprite object that uses an array of bitmapData objects defined with viewing direction vectors. Draws 2d directional image dependent on viewing angle inline with z-sorted triangles in a scene.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    deltaZ : Number
An optional offset value added to the z depth used to sort the sprite
 DirSprite2D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
    rotation : Number
Defines the overall 2d rotation of the sprite object
 DirSprite2D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    scaling : Number
Defines the overall scaling of the sprite object
 DirSprite2D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    smooth : Boolean
Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen
 DirSprite2D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
DirSprite2D
(init:Object = null)
Creates a new DirSprite2D object.
 DirSprite2D
   
add(x:Number, y:Number, z:Number, bitmap:BitmapData):void
Adds a new bitmap definition to the array of directional textures.
 DirSprite2D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 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
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 DirSprite2D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
deltaZ property
public var deltaZ:Number

An optional offset value added to the z depth used to sort the sprite

rotation property  
public var rotation:Number

Defines the overall 2d rotation of the sprite object

scaling property  
public var scaling:Number

Defines the overall scaling of the sprite object

smooth property  
public var smooth:Boolean

Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen

Constructor detail
DirSprite2D () constructor
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
add () method
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.
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawScaledBitmap
Wiki link
Click to go to the wiki page for 'away3d.sprites.DirSprite2D'

Code examples
There are currently no examples for this class

DofCache

Package away3d.core.utils
Class public class DofCache
Provides static pre-blurred bitmap images for depth of field-effect when used together with billboarded sprites, such as particles.
Public Properties
  Property Defined by
    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
  Method Defined by
   
DofCache
(levels:Number, texture:BitmapData)
 DofCache
   
getBitmap(depth:Number):BitmapData
 DofCache
   
getDofCache(bitmap:BitmapData):DofCache
[static]
 DofCache
   
resetDof(enabled:Boolean):void
[static]
 DofCache
Property detail
aperture property
public static var aperture:Number = 22
doflevels property  
public static var doflevels:Number = 16
focus property  
public static var focus:Number
maxblur property  
public static var maxblur:Number = 150
usedof property  
public static var usedof:Boolean = false
Constructor detail
DofCache () constructor
public function DofCache(levels:Number, texture:BitmapData)
Parameters
levels:Number
 
texture:BitmapData
Method detail
getBitmap () method
public function getBitmap(depth:Number):BitmapData
Parameters
depth:Number
Returns
BitmapData
getDofCache () method  
public static function getDofCache(bitmap:BitmapData):DofCache
Parameters
bitmap:BitmapData
Returns
DofCache
resetDof () method  
public static function resetDof(enabled:Boolean):void
Parameters
enabled:Boolean
Wiki link
Click to go to the wiki page for 'away3d.core.utils.DofCache'

Code examples
There are currently no examples for this class

DofSprite2D

Package away3d.sprites
Class public class DofSprite2D
Inheritance DofSprite2D -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Spherical billboard (always facing the camera) sprite object that uses a cached array of bitmapData objects as it's texture. A depth of field blur image over a number of different perspecives is drawn and cached for later retrieval and display.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    bitmap : BitmapData
Defines the bitmapData object to use for the sprite texture.
 DofSprite2D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    deltaZ : Number
An optional offset value added to the z depth used to sort the sprite
 DofSprite2D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
    rotation : Number
Defines the overall 2d rotation of the sprite object
 DofSprite2D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    scaling : Number
Defines the overall scaling of the sprite object
 DofSprite2D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    smooth : Boolean
Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen
 DofSprite2D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
DofSprite2D
(bitmap:BitmapData, init:Object = null)
Creates a new DofSprite2D object.
 DofSprite2D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 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
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 DofSprite2D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
bitmap property
public var bitmap:BitmapData

Defines the bitmapData object to use for the sprite texture.

deltaZ property  
public var deltaZ:Number

An optional offset value added to the z depth used to sort the sprite

rotation property  
public var rotation:Number

Defines the overall 2d rotation of the sprite object

scaling property  
public var scaling:Number

Defines the overall scaling of the sprite object

smooth property  
public var smooth:Boolean

Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen

Constructor detail
DofSprite2D () constructor
public function DofSprite2D(bitmap:BitmapData, init:Object = null)
Parameters
bitmap:BitmapData - The bitmapData object to be used as the sprite's texture.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  scaling:Number (default = 1, min:0)
  rotation:Number (default = 0)
  smooth:Boolean (default = false)
  deltaZ:Number (default = 0)
Method detail
primitives () method
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawScaledBitmap
Wiki link
Click to go to the wiki page for 'away3d.sprites.DofSprite2D'

Code examples
There are currently no examples for this class

Dot3BitmapMaterial

Package away3d.materials
Class public class Dot3BitmapMaterial
Inheritance Dot3BitmapMaterial -> CompositeMaterial
Bitmap material with DOT3 shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 Dot3BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
  (^) color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    normalMap : BitmapData
[read-only] Returns the bitmapData object being used as the material normal map.
 Dot3BitmapMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 Dot3BitmapMaterial
    specular : Number
Coefficient for specular light level.
 Dot3BitmapMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Method Defined by
   
Dot3BitmapMaterial
(bitmap:BitmapData, normalMap:BitmapData, init:Object = null)
Creates a new Dot3BitmapMaterial object.
 Dot3BitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 CompositeMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
normalMap property  
normalMap:BitmapData  [read-only]

Returns the bitmapData object being used as the material normal map.

Implementation
    public function get normalMap():BitmapData
shininess property  
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
Dot3BitmapMaterial () constructor
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)
Wiki link
Click to go to the wiki page for 'away3d.materials.Dot3BitmapMaterial'

Code examples
There are currently no examples for this class

Dot3BitmapMaterialCache

Package away3d.materials
Class public class Dot3BitmapMaterialCache
Inheritance Dot3BitmapMaterialCache -> BitmapMaterialContainer -> BitmapMaterial -> flash.events.EventDispatcher
Bitmap material with cached DOT3 shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 Dot3BitmapMaterialCache
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) cache : Boolean
Defines whether each created bitmapData surface is to be cached, or updated every frame.
 BitmapMaterialContainer
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 BitmapMaterialContainer
    normalMap : BitmapData
[read-only] Returns the bitmapData object being used as the material normal map.
 Dot3BitmapMaterialCache
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 Dot3BitmapMaterialCache
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
    specular : Number
Coefficient for specular light level.
 Dot3BitmapMaterialCache
  (^) transparent : Boolean
Defines whether the caching bitmapData objects are transparent
 BitmapMaterialContainer
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
  (^) width : Number
Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Method Defined by
   
Dot3BitmapMaterialCache
(bitmap:BitmapData, normalMap:BitmapData, init:Object = null)
Creates a new Dot3BitmapMaterialCache object.
 Dot3BitmapMaterialCache
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 BitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 BitmapMaterialContainer
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 BitmapMaterial
  (^)
update():void
Clear and updates the currrent bitmapData surface on all faces.
 BitmapMaterialContainer
  (^)
updateMaterial(source:Object3D, view:View3D):void
Creates a new BitmapMaterialContainer object.
 BitmapMaterialContainer
Protected Methods
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 BitmapMaterialContainer
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterialContainer
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
normalMap property  
normalMap:BitmapData  [read-only]

Returns the bitmapData object being used as the material normal map.

Implementation
    public function get normalMap():BitmapData
shininess property  
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
Dot3BitmapMaterialCache () constructor
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)
Wiki link
Click to go to the wiki page for 'away3d.materials.Dot3BitmapMaterialCache'

Code examples
There are currently no examples for this class

Dot3MovieMaterial

Package away3d.materials
Class public class Dot3MovieMaterial
Inheritance Dot3MovieMaterial -> CompositeMaterial
Animated movie material with DOT3 shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 Dot3MovieMaterial
  (^) blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
  (^) color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    normalMap : BitmapData
[read-only] Returns the bitmapData object being used as the material normal map.
 Dot3MovieMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 Dot3MovieMaterial
    specular : Number
Coefficient for specular light level.
 Dot3MovieMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Method Defined by
   
Dot3MovieMaterial
(movie:Sprite, normalMap:BitmapData, init:Object = null)
Creates a new Dot3MovieMaterial object.
 Dot3MovieMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 CompositeMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
normalMap property  
normalMap:BitmapData  [read-only]

Returns the bitmapData object being used as the material normal map.

Implementation
    public function get normalMap():BitmapData
shininess property  
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
Dot3MovieMaterial () constructor
public function Dot3MovieMaterial(movie:Sprite, normalMap:BitmapData, init:Object = null)
Parameters
movie:Sprite - The movieclip to be used as the material's texture.
 
normalMap:BitmapData - The bitmapData object to be used as the material's DOT3 map.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  shininess:Number (default = 20)
  specular:Number (default = 0.7)
Wiki link
Click to go to the wiki page for 'away3d.materials.Dot3MovieMaterial'

Code examples
There are currently no examples for this class

DrawBitmap

Package away3d.core.draw
Class public class DrawBitmap
Inheritance DrawBitmap -> DrawPrimitive
Unscaled bitmap drawing primitive
Public Properties
  Property Defined by
    bitmap : BitmapData
The bitmapData object used as the bitmap primitive texture.
 DrawBitmap
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
    screenvertex : ScreenVertex
DrawBitmap
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
   
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
bitmap property
public var bitmap:BitmapData

The bitmapData object used as the bitmap primitive texture.

screenvertex property  
public var screenvertex:ScreenVertex
Method detail
calc () method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear () method  
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
render () method  
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawBitmap'

Code examples
There are currently no examples for this class

DrawDisplayObject

Package away3d.core.draw
Class public class DrawDisplayObject
Inheritance DrawDisplayObject -> DrawPrimitive
Displayobject container drawing primitive.
Public Properties
  Property Defined by
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
    displayobject : DisplayObject
A reference to the displayobject used by the drawing primitive.
 DrawDisplayObject
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
    screenvertex : ScreenVertex
The screenvertex used to position the drawing primitive in the view.
 DrawDisplayObject
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
    session : AbstractRenderSession
A reference to the render session used by the drawing primitive.
 DrawDisplayObject
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
   
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
displayobject property
public var displayobject:DisplayObject

A reference to the displayobject used by the drawing primitive.

screenvertex property  
public var screenvertex:ScreenVertex

The screenvertex used to position the drawing primitive in the view.

session property  
public var session:AbstractRenderSession

A reference to the render session used by the drawing primitive.

Method detail
calc () method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear () method  
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
render () method  
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawDisplayObject'

Code examples
There are currently no examples for this class

DrawFog

Package away3d.core.draw
Class public class DrawFog
Inheritance DrawFog -> DrawPrimitive
Fog drawing primitive
Public Properties
  Property Defined by
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
    material : IFogMaterial
The material used to render the drawing primitive.
 DrawFog
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
  (^)
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
material property
public var material:IFogMaterial

The material used to render the drawing primitive.

Method detail
render () method
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawFog'

Code examples
There are currently no examples for this class

DrawGroup

Package away3d.core.draw
Class public class DrawGroup
Inheritance DrawGroup -> DrawPrimitive
Implements IPrimitiveConsumer
Group drawing primitive.
Public Properties
  Property Defined by
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
    primitives : Array
The primitives contained in the group.
 DrawGroup
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
  (^)
calc():void
Calculates the min, max and screen properties required for rendering the drawing primitive.
 DrawPrimitive
   
clear():void
Deletes the data currently held by the drawing primitive.
 DrawGroup
   
contains(x:Number, y:Number):Boolean
Determines whether the given point lies inside the drawing primitive
 DrawGroup
  (^)
getZ(x:Number, y:Number):Number
Calulates the screen z value of a precise point on the drawing primitive.
 DrawPrimitive
   
primitive(pri:DrawPrimitive):void
Adds a drawing primitive to the primitive group
 DrawGroup
  (^)
quarter(focus:Number):Array
Cuts the drawing primitive into 4 equally sized drawing primitives.
 DrawPrimitive
   
render():void
Draws the primitive to the view.
 DrawGroup
  (^)
toString():String
Used to trace the values of a drawing primitive.
 DrawPrimitive
Property detail
primitives property
public var primitives:Array

The primitives contained in the group.

Method detail
clear () method
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
primitive () method  
public function primitive(pri:DrawPrimitive):void

Adds a drawing primitive to the primitive group

Parameters
pri:DrawPrimitive - The drawing primitive to add.
render () method  
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawGroup'

Code examples
There are currently no examples for this class

DrawPrimitive

Package away3d.core.draw
Class public class DrawPrimitive
Subclasses Blocker, DrawBitmap, DrawDisplayObject, DrawFog, DrawGroup, DrawScaledBitmap, DrawSegment, DrawTriangle
Abstract class for all drawing primitives
Public Properties
  Property Defined by
    create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
    maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
    maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
    maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
    minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
    minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
    minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
    projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
    quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
    screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
    source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
   
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
create property
public var create:Function

Placeholder function for creating new drawing primitives from a cache of objects. Saves recreating objects and GC problems.

maxX property  
public var maxX:Number

Indicates the maximum x value of the drawing primitive.

maxY property  
public var maxY:Number

Indicates the maximum y value of the drawing primitive.

maxZ property  
public var maxZ:Number

Indicates the maximum z value of the drawing primitive.

minX property  
public var minX:Number

Indicates the minimum x value of the drawing primitive.

minY property  
public var minY:Number

Indicates the minimum y value of the drawing primitive.

minZ property  
public var minZ:Number

Indicates the minimum z value of the drawing primitive.

projection property  
public var projection:Projection

Reference to the last projection object used for the primitive

quadrant property  
public var quadrant:PrimitiveQuadrantTreeNode

Reference to the last quadrant used by the drawing primitive. Used in PrimitiveQuadrantTree

See also

away3d.core.render.PrimitiveQuadrantTree
screenZ property  
public var screenZ:Number

Indicates the screen z value of the drawing primitive (used for z-sorting).

source property  
public var source:Object3D

The parent 3d object of the drawing primitive.

Method detail
calc () method
public function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear () method  
public function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
getZ () method  
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).
quarter () method  
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
render () method  
public function render():void

Draws the primitive to the view.

toString () method  
public function toString():String

Used to trace the values of a drawing primitive.

Returns
String - A string representation of the drawing primitive.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawPrimitive'

Code examples
There are currently no examples for this class

DrawScaledBitmap

Package away3d.core.draw
Class public class DrawScaledBitmap
Inheritance DrawScaledBitmap -> DrawPrimitive
Scaled bitmap primitive
Public Properties
  Property Defined by
    bitmap : BitmapData
The bitmapData object used as the scaled bitmap primitive texture.
 DrawScaledBitmap
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
    rotation : Number
A rotation value used to rotate the scaled bitmap primitive.
 DrawScaledBitmap
    scale : Number
A scaling value used to scale the scaled bitmap primitive.
 DrawScaledBitmap
    screenvertex : ScreenVertex
The screenvertex used to position the scaled bitmap primitive in the view.
 DrawScaledBitmap
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
    smooth : Boolean
Determines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 DrawScaledBitmap
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
Public Methods
  Method Defined by
   
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
bitmap property
public var bitmap:BitmapData

The bitmapData object used as the scaled bitmap primitive texture.

rotation property  
public var rotation:Number

A rotation value used to rotate the scaled bitmap primitive.

scale property  
public var scale:Number

A scaling value used to scale the scaled bitmap primitive.

screenvertex property  
public var screenvertex:ScreenVertex

The screenvertex used to position the scaled bitmap primitive in the view.

smooth property  
public var smooth:Boolean

Determines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen.

Method detail
calc () method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear () method  
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
render () method  
public override function render():void

Draws the primitive to the view.

Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawScaledBitmap'

Code examples
There are currently no examples for this class

DrawSegment

Package away3d.core.draw
Class public class DrawSegment
Inheritance DrawSegment -> DrawPrimitive
Line segment drawing primitive
Public Properties
  Property Defined by
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
    length : Number
The screen length of the segment primitive.
 DrawSegment
    material : ISegmentMaterial
The material of the segment primitive.
 DrawSegment
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
    v0 : ScreenVertex
The v0 screenvertex of the segment primitive.
 DrawSegment
    v1 : ScreenVertex
The v1 screenvertex of the segment primitive.
 DrawSegment
Public Methods
  Method Defined by
   
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
length property
public var length:Number

The screen length of the segment primitive.

material property  
public var material:ISegmentMaterial

The material of the segment primitive.

v0 property  
public var v0:ScreenVertex

The v0 screenvertex of the segment primitive.

v1 property  
public var v1:ScreenVertex

The v1 screenvertex of the segment primitive.

Method detail
calc () method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear () method  
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
getZ () method  
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).
quarter () method  
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
render () method  
public override function render():void

Draws the primitive to the view.

toString () method  
public override function toString():String

Used to trace the values of a drawing primitive.

Returns
String - A string representation of the drawing primitive.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawSegment'

Code examples
There are currently no examples for this class

DrawTriangle

Package away3d.core.draw
Class public class DrawTriangle
Inheritance DrawTriangle -> DrawPrimitive
Triangle drawing primitive
Public Properties
  Property Defined by
    area : Number
The calulated area of the triangle primitive.
 DrawTriangle
    backface : Boolean = false
Indicates whether the face of the triangle primitive is facing away from the camera.
 DrawTriangle
  (^) create : Function
Placeholder function for creating new drawing primitives from a cache of objects.
 DrawPrimitive
    face : Face
A reference to the face object used by the triangle primitive.
 DrawTriangle
    invtexturemapping : Matrix
The inverse texturemapping matrix of the triangle primitive texture.
 DrawTriangle
    material : ITriangleMaterial
The bitmapData object used as the triangle primitive texture.
 DrawTriangle
  (^) maxX : Number
Indicates the maximum x value of the drawing primitive.
 DrawPrimitive
  (^) maxY : Number
Indicates the maximum y value of the drawing primitive.
 DrawPrimitive
  (^) maxZ : Number
Indicates the maximum z value of the drawing primitive.
 DrawPrimitive
  (^) minX : Number
Indicates the minimum x value of the drawing primitive.
 DrawPrimitive
  (^) minY : Number
Indicates the minimum y value of the drawing primitive.
 DrawPrimitive
  (^) minZ : Number
Indicates the minimum z value of the drawing primitive.
 DrawPrimitive
  (^) projection : Projection
Reference to the last projection object used for the primitive
 DrawPrimitive
  (^) quadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
 DrawPrimitive
  (^) screenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
 DrawPrimitive
  (^) source : Object3D
The parent 3d object of the drawing primitive.
 DrawPrimitive
    texturemapping : Matrix
The texturemapping matrix of the triangle primitive texture.
 DrawTriangle
    uv0 : UV
The uv0 uv coordinate of the triangle primitive.
 DrawTriangle
    uv1 : UV
The uv1 uv coordinate of the triangle primitive.
 DrawTriangle
    uv2 : UV
The uv2 uv coordinate of the triangle primitive.
 DrawTriangle
    v0 : ScreenVertex
The v0 screenvertex of the triangle primitive.
 DrawTriangle
    v1 : ScreenVertex
The v1 screenvertex of the triangle primitive.
 DrawTriangle
    v2 : ScreenVertex
The v2 screenvertex of the triangle primitive.
 DrawTriangle
Public Methods
  Method Defined by
   
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
area property
public var area:Number

The calulated area of the triangle primitive.

backface property  
public var backface:Boolean = false

Indicates whether the face of the triangle primitive is facing away from the camera.

face property  
public var face:Face

A reference to the face object used by the triangle primitive.

invtexturemapping property  
public var invtexturemapping:Matrix

The inverse texturemapping matrix of the triangle primitive texture.

material property  
public var material:ITriangleMaterial

The bitmapData object used as the triangle primitive texture.

texturemapping property  
public var texturemapping:Matrix

The texturemapping matrix of the triangle primitive texture.

uv0 property  
public var uv0:UV

The uv0 uv coordinate of the triangle primitive.

uv1 property  
public var uv1:UV

The uv1 uv coordinate of the triangle primitive.

uv2 property  
public var uv2:UV

The uv2 uv coordinate of the triangle primitive.

v0 property  
public var v0:ScreenVertex

The v0 screenvertex of the triangle primitive.

v1 property  
public var v1:ScreenVertex

The v1 screenvertex of the triangle primitive.

v2 property  
public var v2:ScreenVertex

The v2 screenvertex of the triangle primitive.

Method detail
calc () method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear () method  
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains () method  
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.
distanceToCenter () method  
public final function distanceToCenter(x:Number, y:Number):Number
Parameters
x:Number
 
y:Number
Returns
Number
getUV () method  
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.
getZ () method  
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).
quarter () method  
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
render () method  
public override function render():void

Draws the primitive to the view.

toString () method  
public override function toString():String

Used to trace the values of a drawing primitive.

Returns
String - A string representation of the drawing primitive.
transformUV () method  
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
Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawTriangle'

Code examples
There are currently no examples for this class

Elevation

Package away3d.extrusions
Class public class Elevation
Public Methods
  Method Defined by
   
Elevation
()
 Elevation
   
generate(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, scalingX:Number = 1, scalingY:Number = 1, elevate:Number = .5):Array
 Elevation
Constructor detail
Elevation () constructor
public function Elevation()

Class returns a multidimentional array based on pixel information that can be passed to the SkinExtrude class.

Method detail
generate () method
public function generate(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, scalingX:Number = 1, scalingY:Number = 1, elevate:Number = .5):Array
Parameters
sourceBmd:BitmapData
 
channel:String (default = "r")
 
subdivisionX:int (default = 10)
 
subdivisionY:int (default = 10)
 
scalingX:Number (default = 1)
 
scalingY:Number (default = 1)
 
elevate:Number (default = .5)
Returns
Array
Wiki link
Click to go to the wiki page for 'away3d.extrusions.Elevation'

Code examples
There are currently no examples for this class

ElevationReader

Package away3d.extrusions
Class public class ElevationReader
Public Properties
  Property Defined by
    source : BitmapData
[read-only]
 ElevationReader
Public Methods
  Method Defined by
   
ElevationReader
(smoothness:int = 0)
 ElevationReader
   
getLevel(x:Number, y:Number, offset:Number = 0):Number
 ElevationReader
   
traceLevels(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void
 ElevationReader
Property detail
source property
source:BitmapData  [read-only]
Implementation
    public function get source():BitmapData
Constructor detail
ElevationReader () constructor
public function ElevationReader(smoothness:int = 0)
Parameters
smoothness:int (default = 0)
Method detail
getLevel () method
public function getLevel(x:Number, y:Number, offset:Number = 0):Number
Parameters
x:Number
 
y:Number
 
offset:Number (default = 0)
Returns
Number
traceLevels () method  
public function traceLevels(sourceBmd:BitmapData, channel:String = "r", subdivisionX:int = 10, subdivisionY:int = 10, factorX:Number = 1, factorY:Number = 1, elevate:Number = .5):void
Parameters
sourceBmd:BitmapData
 
channel:String (default = "r")
 
subdivisionX:int (default = 10)
 
subdivisionY:int (default = 10)
 
factorX:Number (default = 1)
 
factorY:Number (default = 1)
 
elevate:Number (default = .5)
Wiki link
Click to go to the wiki page for 'away3d.extrusions.ElevationReader'

Code examples
There are currently no examples for this class

EnviroBitmapMaterial

Package away3d.materials
Class public class EnviroBitmapMaterial
Inheritance EnviroBitmapMaterial -> CompositeMaterial
Bitmap material with environment shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 EnviroBitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
  (^) color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
    enviroMap : BitmapData
[read-only] Returns the bitmapData object being used as the material environment map.
 EnviroBitmapMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    mode : String
Setting for possible mapping methods.
 EnviroBitmapMaterial
    reflectiveness : Number
Coefficient for the reflectiveness of the material.
 EnviroBitmapMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Method Defined by
   
EnviroBitmapMaterial
(bitmap:BitmapData, enviroMap:BitmapData, init:Object = null)
Creates a new EnviroBitmapMaterial object.
 EnviroBitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 CompositeMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
enviroMap property  
enviroMap:BitmapData  [read-only]

Returns the bitmapData object being used as the material environment map.

Implementation
    public function get enviroMap():BitmapData
mode property  
mode:String  [read-write]

Setting for possible mapping methods.

Implementation
    public function get mode():String
    public function set mode(value:String):void
reflectiveness property  
reflectiveness:Number  [read-write]

Coefficient for the reflectiveness of the material.

Implementation
    public function get reflectiveness():Number
    public function set reflectiveness(value:Number):void
Constructor detail
EnviroBitmapMaterial () constructor
public function EnviroBitmapMaterial(bitmap:BitmapData, enviroMap:BitmapData, init:Object = null)
Parameters
bitmap:BitmapData - The bitmapData object to be used as the material's texture.
 
enviroMap:BitmapData - The bitmapData object to be used as the material's normal map.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  mode:String (default = "linear")
  reflectiveness:Number (default = 0.5, min:0, max:1)
Wiki link
Click to go to the wiki page for 'away3d.materials.EnviroBitmapMaterial'

Code examples
There are currently no examples for this class

EnviroBitmapMaterialCache

Package away3d.materials
Class public class EnviroBitmapMaterialCache
Inheritance EnviroBitmapMaterialCache -> BitmapMaterialContainer -> BitmapMaterial -> flash.events.EventDispatcher
Bitmap material with cached environment shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 EnviroBitmapMaterialCache
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) cache : Boolean
Defines whether each created bitmapData surface is to be cached, or updated every frame.
 BitmapMaterialContainer
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
    enviroMap : BitmapData
[read-only] Returns the bitmapData object being used as the material environment map.
 EnviroBitmapMaterialCache
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 BitmapMaterialContainer
    mode : String
Setting for possible mapping methods.
 EnviroBitmapMaterialCache
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
    reflectiveness : Number
Coefficient for the reflectiveness of the material.
 EnviroBitmapMaterialCache
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
  (^) transparent : Boolean
Defines whether the caching bitmapData objects are transparent
 BitmapMaterialContainer
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
  (^) width : Number
Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Method Defined by
   
EnviroBitmapMaterialCache
(bitmap:BitmapData, enviroMap:BitmapData, init:Object = null)
Creates a new EnviroBitmapMaterialCache object.
 EnviroBitmapMaterialCache
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 BitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 BitmapMaterialContainer
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 BitmapMaterial
  (^)
update():void
Clear and updates the currrent bitmapData surface on all faces.
 BitmapMaterialContainer
  (^)
updateMaterial(source:Object3D, view:View3D):void
Creates a new BitmapMaterialContainer object.
 BitmapMaterialContainer
Protected Methods
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 BitmapMaterialContainer
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterialContainer
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
enviroMap property  
enviroMap:BitmapData  [read-only]

Returns the bitmapData object being used as the material environment map.

Implementation
    public function get enviroMap():BitmapData
mode property  
mode:String  [read-write]

Setting for possible mapping methods.

Implementation
    public function get mode():String
    public function set mode(value:String):void
reflectiveness property  
reflectiveness:Number  [read-write]

Coefficient for the reflectiveness of the material.

Implementation
    public function get reflectiveness():Number
    public function set reflectiveness(value:Number):void
Constructor detail
EnviroBitmapMaterialCache () constructor
public function EnviroBitmapMaterialCache(bitmap:BitmapData, enviroMap:BitmapData, init:Object = null)
Parameters
bitmap:BitmapData - The bitmapData object to be used as the material's texture.
 
enviroMap:BitmapData - The bitmapData object to be used as the material's environment map.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  mode:String (default = "linear")
  reflectiveness:Number (default = 0.5, min:0, max:1)
Wiki link
Click to go to the wiki page for 'away3d.materials.EnviroBitmapMaterialCache'

Code examples
There are currently no examples for this class

EnviroColorMaterial

Package away3d.materials
Class public class EnviroColorMaterial
Inheritance EnviroColorMaterial -> EnviroShader -> AbstractShader -> flash.events.EventDispatcher
Implements ITriangleMaterial
Color material with environment shading.
Public Properties
  Property Defined by
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the shader environment map.
 EnviroShader
  (^) blendMode : String
Defines a blendMode value for the shader bitmap.
 AbstractShader
    color : uint
Defines the color of the material.
 EnviroColorMaterial
  (^) debug : Boolean
Determines if faces with the shader applied are drawn with outlines
 AbstractShader
  (^) height : Number
Returns the width of the bitmapData being used as the shader environment map.
 EnviroShader
  (^) mode : String
Setting for possible mapping methods.
 EnviroShader
    reflectiveness : Number
[write-only] Coefficient for the reflectiveness of the environment map.
 EnviroColorMaterial
  (^) smooth : Boolean
Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen
 AbstractShader
  (^) visible : Boolean
Indicates whether the material is visible
 AbstractShader
  (^) width : Number
Returns the height of the bitmapData being used as the shader environment map.
 EnviroShader
Protected Properties
  Method Defined by
   
EnviroColorMaterial
(color:*, enviroMap:BitmapData, init:Object = null)
Creates a new EnviroColorMaterial object.
 EnviroColorMaterial
  (^)
getMapping(source:Mesh, face:Face):Matrix
 EnviroShader
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 EnviroShader
   
renderTriangle(tri:DrawTriangle):void
Sends the material data coupled with data from the DrawTriangle primitive to the render session.
 EnviroColorMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 EnviroShader
Protected Methods
  Method Defined by
  (^)
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 EnviroShader
  (^)
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
  (^)
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
  (^)
renderShader(face:Face):void
Renders the shader to the specified face.
 EnviroShader
Property detail
color property
color:uint  [read-write]

Defines the color of the material.

Implementation
    public function get color():uint
    public function set color(value:uint):void
reflectiveness property  
reflectiveness:Number  [write-only]

Coefficient for the reflectiveness of the environment map.

Implementation
    public function set reflectiveness(value:Number):void
Constructor detail
EnviroColorMaterial () constructor
public function EnviroColorMaterial(color:*, enviroMap:BitmapData, init:Object = null)
Parameters
color:* - A string, hex value or colorname representing the color of the material.
 
enviroMap:BitmapData - The bitmapData object to be used as the material's environment map.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
renderTriangle () method
public function renderTriangle(tri:DrawTriangle):void

Sends the material data coupled with data from the DrawTriangle primitive to the render session.

Parameters
tri:DrawTriangle
Wiki link
Click to go to the wiki page for 'away3d.materials.EnviroColorMaterial'

Code examples
There are currently no examples for this class

EnviroShader

Package away3d.materials.shaders
Class public class EnviroShader
Inheritance EnviroShader -> AbstractShader -> flash.events.EventDispatcher
Subclasses EnviroColorMaterial
Shader class for environment lighting.
Public Properties
  Property Defined by
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the shader environment map.
 EnviroShader
  (^) blendMode : String
Defines a blendMode value for the shader bitmap.
 AbstractShader
  (^) debug : Boolean
Determines if faces with the shader applied are drawn with outlines
 AbstractShader
    height : Number
[read-only] Returns the width of the bitmapData being used as the shader environment map.
 EnviroShader
    mode : String
Setting for possible mapping methods.
 EnviroShader
    reflectiveness : Number
Coefficient for the reflectiveness of the environment map.
 EnviroShader
  (^) smooth : Boolean
Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen
 AbstractShader
  (^) visible : Boolean
Indicates whether the material is visible
 AbstractShader
    width : Number
[read-only] Returns the height of the bitmapData being used as the shader environment map.
 EnviroShader
Protected Properties
  Method Defined by
   
EnviroShader
(bitmap:BitmapData, init:Object = null)
Creates a new EnviroShader object.
 EnviroShader
   
getMapping(source:Mesh, face:Face):Matrix
 EnviroShader
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 EnviroShader
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 EnviroShader
Protected Methods
  Method Defined by
   
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 EnviroShader
  (^)
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
  (^)
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
   
renderShader(face:Face):void
Renders the shader to the specified face.
 EnviroShader
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the shader environment map.

Implementation
    public function get bitmap():BitmapData
height property  
height:Number  [read-only]

Returns the width of the bitmapData being used as the shader environment map.

Implementation
    public function get height():Number
mode property  
public var mode:String

Setting for possible mapping methods.

reflectiveness property  
reflectiveness:Number  [read-write]

Coefficient for the reflectiveness of the environment map.

Implementation
    public function get reflectiveness():Number
    public function set reflectiveness(value:Number):void
width property  
width:Number  [read-only]

Returns the height of the bitmapData being used as the shader environment map.

Implementation
    public function get width():Number
Constructor detail
EnviroShader () constructor
public function EnviroShader(bitmap:BitmapData, init:Object = null)
Parameters
bitmap:BitmapData - The bitmapData object to be used as the material's environment map.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
clearFaceDictionary () method
protected override function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters
source:Object3D - The parent 3d object of the face.
 
view:View3D - The view rendering the draw triangle.
getMapping () method  
public function getMapping(source:Mesh, face:Face):Matrix
Parameters
source:Mesh
 
face:Face
Returns
Matrix
renderLayer () method  
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.
renderShader () method  
protected override function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters
face:Face - The face object being rendered.
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.EnviroShader'

Code examples
There are currently no examples for this class

Face

Package away3d.core.base
Class public class Face
Inheritance Face -> BaseMeshElement -> flash.events.EventDispatcher
A triangle element used in the mesh object

See also

away3d.core.base.Mesh
Public Properties
  Property Defined by
    area : Number
[read-only] Returns the calculated 2 dimensional area of the face.
 Face
    back : ITriangleMaterial
Defines the optional back material of the face.
 Face
    extra : Object
An optional untyped object that can contain used-defined properties.
 Face
    material : ITriangleMaterial
Defines the material of the face.
 Face
    maxU : Number
[read-only] Returns the maximum u value of the face
 Face
    maxV : Number
[read-only] Returns the maximum v value of the face
 Face
    maxX : Number
[read-only] Returns the maximum x value of the face
 Face
    maxY : Number
[read-only] Returns the maximum y value of the face
 Face
    maxZ : Number
[read-only] Returns the maximum zx value of the face
 Face
    minU : Number
[read-only] Returns the minimum u value of the face
 Face
    minV : Number
[read-only] Returns the minimum v value of the face
 Face
    minX : Number
[read-only] Returns the minimum x value of the face
 Face
    minY : Number
[read-only] Returns the minimum y value of the face
 Face
    minZ : Number
[read-only] Returns the minimum z value of the face
 Face
    normal : Number3D
[read-only] Returns the normal vector of the face.
 Face
    parent : Mesh
Defines the parent 3d object of the face.
 Face
    radius2 : Number
[read-only] Returns the squared bounding radius of the face.
 Face
    uv0 : UV
Defines the uv0 coordinate of the face.
 Face
    uv1 : UV
Defines the uv1 coordinate of the face.
 Face
    uv2 : UV
Defines the uv2 coordinate of the face.
 Face
    uvs : Array
[read-only] Returns an array of uv objects that are used by the face.
 Face
    v0 : Vertex
Defines the v0 vertex of the face.
 Face
    v1 : Vertex
Defines the v1 vertex of the face.
 Face
    v2 : Vertex
Defines the v2 vertex of the face.
 Face
    vertices : Array
[read-only] Returns an array of vertex objects that are used by the face.
 Face
  (^) visible : Boolean
Defines whether the 3d element is visible in the scene.
 BaseMeshElement
Public Methods
  Method Defined by
   
Face
(v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial = null, uv0:UV = null, uv1:UV = null, uv2:UV = null)
Creates a new Face object.
 Face
   
addOnMappingChange(listener:Function):void
Default method for adding a mappingchanged event listener
 Face
   
addOnMaterialChange(listener:Function):void
Default method for adding a materialchanged event listener
 Face
  (^)
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
 BaseMeshElement
  (^)
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
 BaseMeshElement
  (^)
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
 BaseMeshElement
   
invert():void
Inverts the geometry of the face object by swapping the v1, v2 and uv1, uv2 points.
 Face
   
removeOnMappingChange(listener:Function):void
Default method for removing a mappingchanged event listener
 Face
   
removeOnMaterialChange(listener:Function):void
Default method for removing a materialchanged event listener
 Face
  (^)
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
 BaseMeshElement
  (^)
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
 BaseMeshElement
  (^)
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
 BaseMeshElement
Events
  Event Summary Defined by
   
mappingchanged
 Dispatched when the uv mapping of the face changes. Face
   
materialchanged
 Dispatched when the material of the face changes. Face
  (^)
vertexchanged
 Dispatched when the vertex of a 3d element changes. BaseMeshElement
  (^)
vertexvaluechanged
 Dispatched when the vertex value of a 3d element changes. BaseMeshElement
  (^)
visiblechanged
 Dispatched when the visiblity of a 3d element changes. BaseMeshElement
Property detail
area property
area:Number  [read-only]

Returns the calculated 2 dimensional area of the face.

Implementation
    public function get area():Number
back property  
back:ITriangleMaterial  [read-write]

Defines the optional back material of the face. Displays when the face is pointing away from the camera.

Implementation
    public function get back():ITriangleMaterial
    public function set back(value:ITriangleMaterial):void
extra property  
public var extra:Object

An optional untyped object that can contain used-defined properties.

material property  
material:ITriangleMaterial  [read-write]

Defines the material of the face.

Implementation
    public function get material():ITriangleMaterial
    public function set material(value:ITriangleMaterial):void
maxU property  
maxU:Number  [read-only]

Returns the maximum u value of the face

Implementation
    public function get maxU():Number

See also

away3d.core.base.UV.u
maxV property  
maxV:Number  [read-only]

Returns the maximum v value of the face

Implementation
    public function get maxV():Number

See also

away3d.core.base.UV.v
maxX property  
maxX:Number  [read-only]

Returns the maximum x value of the face

Implementation
    public function get maxX():Number

See also

maxY property  
maxY:Number  [read-only]

Returns the maximum y value of the face

Implementation
    public function get maxY():Number

See also

maxZ property  
maxZ:Number  [read-only]

Returns the maximum zx value of the face

Implementation
    public function get maxZ():Number

See also

minU property  
minU:Number  [read-only]

Returns the minimum u value of the face

Implementation
    public function get minU():Number

See also

away3d.core.base.UV.u
minV property  
minV:Number  [read-only]

Returns the minimum v value of the face

Implementation
    public function get minV():Number

See also

away3d.core.base.UV.v
minX property  
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]

Returns the minimum y value of the face

Implementation
    public function get minY():Number

See also

minZ property  
minZ:Number  [read-only]

Returns the minimum z value of the face

Implementation
    public function get minZ():Number

See also

normal property  
normal:Number3D  [read-only]

Returns the normal vector of the face.

Implementation
    public function get normal():Number3D
parent property  
public var parent:Mesh

Defines the parent 3d object of the face.

radius2 property  
radius2:Number  [read-only]

Returns the squared bounding radius of the face.

Implementation
    public function get radius2():Number
uv0 property  
uv0:UV  [read-write]

Defines the uv0 coordinate of the face.

Implementation
    public function get uv0():UV
    public function set uv0(value:UV):void
uv1 property  
uv1:UV  [read-write]

Defines the uv1 coordinate of the face.

Implementation
    public function get uv1():UV
    public function set uv1(value:UV):void
uv2 property  
uv2:UV  [read-write]

Defines the uv2 coordinate of the face.

Implementation
    public function get uv2():UV
    public function set uv2(value:UV):void
uvs property  
uvs:Array  [read-only]

Returns an array of uv objects that are used by the face.

Implementation
    public function get uvs():Array
v0 property  
v0:Vertex  [read-write]

Defines the v0 vertex of the face.

Implementation
    public function get v0():Vertex
    public function set v0(value:Vertex):void
v1 property  
v1:Vertex  [read-write]

Defines the v1 vertex of the face.

Implementation
    public function get v1():Vertex
    public function set v1(value:Vertex):void
v2 property  
v2:Vertex  [read-write]

Defines the v2 vertex of the face.

Implementation
    public function get v2():Vertex
    public function set v2(value:Vertex):void
vertices property  
vertices:Array  [read-only]

Returns an array of vertex objects that are used by the face.

Implementation
    public function get vertices():Array
Constructor detail
Face () constructor
public function Face(v0:Vertex, v1:Vertex, v2:Vertex, material:ITriangleMaterial = null, uv0:UV = null, uv1:UV = null, uv2:UV = null)
Parameters
v0:Vertex - The first vertex object of the triangle
 
v1:Vertex - The second vertex object of the triangle
 
v2:Vertex - The third vertex object of the triangle
 
material:ITriangleMaterial (default = null) - The material used by the triangle to render
 
uv0:UV (default = null) - [optional] The first uv object of the triangle
 
uv1:UV (default = null) - [optional] The second uv object of the triangle
 
uv2:UV (default = null) - [optional] The third uv object of the triangle

See also

away3d.core.base.Vertex
away3d.materials.ITriangleMaterial
away3d.core.base.UV
Method detail
addOnMappingChange () method
public function addOnMappingChange(listener:Function):void

Default method for adding a mappingchanged event listener

Parameters
listener:Function - The listener function
addOnMaterialChange () method  
public function addOnMaterialChange(listener:Function):void

Default method for adding a materialchanged event listener

Parameters
listener:Function - The listener function
invert () method  
public function invert():void

Inverts the geometry of the face object by swapping the v1, v2 and uv1, uv2 points.

removeOnMappingChange () method  
public function removeOnMappingChange(listener:Function):void

Default method for removing a mappingchanged event listener

Parameters
listener:Function - The listener function
removeOnMaterialChange () method  
public function removeOnMaterialChange(listener:Function):void

Default method for removing a materialchanged event listener

Parameters
listener:Function - The listener function
Event detail
mappingchanged event 
Event object type: away3d.events.FaceEvent

Dispatched when the uv mapping of the face changes.

materialchanged event   
Event object type: away3d.events.FaceEvent

Dispatched when the material of the face changes.

Wiki link
Click to go to the wiki page for 'away3d.core.base.Face'

Code examples
There are currently no examples for this class

FaceData

Package away3d.loaders.data
Class public class FaceData
Data class for a face object.
Public Properties
  Property Defined by
    materialData : MaterialData
Holds teh material data for the face.
 FaceData
    uv0 : int
Index of uv coordinate 0.
 FaceData
    uv1 : int
Index of uv coordinate 1.
 FaceData
    uv2 : int
Index of uv coordinate 2.
 FaceData
    v0 : int
Index of vertex 0.
 FaceData
    v1 : int
Index of vertex 1.
 FaceData
    v2 : int
Index of vertex 2.
 FaceData
    visible : Boolean
Determines whether the face is visible.
 FaceData
Property detail
materialData property
public var materialData:MaterialData

Holds teh material data for the face.

uv0 property  
public var uv0:int

Index of uv coordinate 0.

uv1 property  
public var uv1:int

Index of uv coordinate 1.

uv2 property  
public var uv2:int

Index of uv coordinate 2.

v0 property  
public var v0:int

Index of vertex 0.

v1 property  
public var v1:int

Index of vertex 1.

v2 property  
public var v2:int

Index of vertex 2.

visible property  
public var visible:Boolean

Determines whether the face is visible.

Wiki link
Click to go to the wiki page for 'away3d.loaders.data.FaceData'

Code examples
There are currently no examples for this class

FaceDictionaryVO

Package away3d.core.utils
Class public class FaceDictionaryVO
Public Properties
  Property Defined by
    bitmap : BitmapData
FaceDictionaryVO
    dirty : Boolean
FaceDictionaryVO
Public Methods
  Method Defined by
   
FaceDictionaryVO
(width:Number = 0, height:Number = 0)
 FaceDictionaryVO
   
clear():void
 FaceDictionaryVO
   
reset(width:Number, height:Number):void
 FaceDictionaryVO
Property detail
bitmap property
public var bitmap:BitmapData
dirty property  
public var dirty:Boolean
Constructor detail
FaceDictionaryVO () constructor
public function FaceDictionaryVO(width:Number = 0, height:Number = 0)
Parameters
width:Number (default = 0)
 
height:Number (default = 0)
Method detail
clear () method
public function clear():void
reset () method  
public function reset(width:Number, height:Number):void
Parameters
width:Number
 
height:Number
Wiki link
Click to go to the wiki page for 'away3d.core.utils.FaceDictionaryVO'

Code examples
There are currently no examples for this class

FaceEvent

Package away3d.events
Class public class FaceEvent
Inheritance FaceEvent -> flash.events.Event
Passed as a parameter when a face event occurs
Public Properties
  Property Defined by
    face : Face
A reference to the face object that is relevant to the event.
 FaceEvent
Public Methods
  Method Defined by
   
FaceEvent
(type:String, face:Face)
Creates a new FaceEvent object.
 FaceEvent
   
clone():Event
Creates a copy of the FaceEvent object and sets the value of each property to match that of the original.
 FaceEvent
Public Constants
  Constant Defined by
    MAPPING_CHANGED : String = "mappingchanged"
[static] Defines the value of the type property of a mappingchanged event object.
 FaceEvent
    MATERIAL_CHANGED : String = "materialchanged"
[static] Defines the value of the type property of a materialchanged event object.
 FaceEvent
Property detail
face property
public var face:Face

A reference to the face object that is relevant to the event.

Constructor detail
FaceEvent () constructor
public function FaceEvent(type:String, face:Face)
Parameters
type:String - The type of the event. Possible values are: FaceEvent.MAPPING_CHANGED and FaceEvent.MATERIAL_CHANGED.
 
face:Face - A reference to the face object that is relevant to the event.
Method detail
clone () method
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
MAPPING_CHANGED constant
public static const MAPPING_CHANGED:String = "mappingchanged"

Defines the value of the type property of a mappingchanged event object.

MATERIAL_CHANGED constant  
public static const MATERIAL_CHANGED:String = "materialchanged"

Defines the value of the type property of a materialchanged event object.

Wiki link
Click to go to the wiki page for 'away3d.events.FaceEvent'

Code examples
There are currently no examples for this class

FaceVO

Package away3d.core.utils
Class public class FaceVO
Public Properties
  Property Defined by
    backface : Boolean = false
FaceVO
    bitmap : BitmapData
FaceVO
    cleared : Boolean = true
FaceVO
    color : uint
FaceVO
    height : int
FaceVO
    invalidated : Boolean = true
FaceVO
    mapping : Matrix
FaceVO
    resized : Boolean
FaceVO
    source : Object3D
FaceVO
    updated : Boolean = false
FaceVO
    view : View3D
FaceVO
    width : int
FaceVO
Public Methods
  Method Defined by
   
FaceVO
(source:Object3D = null, view:View3D = null)
 FaceVO
   
clear():void
 FaceVO
   
resize(width:Number, height:Number, transparent:Boolean = true):void
 FaceVO
Property detail
backface property
public var backface:Boolean = false
bitmap property  
public var bitmap:BitmapData
cleared property  
public var cleared:Boolean = true
color property  
public var color:uint
height property  
public var height:int
invalidated property  
public var invalidated:Boolean = true
mapping property  
public var mapping:Matrix
resized property  
public var resized:Boolean
source property  
public var source:Object3D
updated property  
public var updated:Boolean = false
view property  
public var view:View3D
width property  
public var width:int
Constructor detail
FaceVO () constructor
public function FaceVO(source:Object3D = null, view:View3D = null)
Parameters
source:Object3D (default = null)
 
view:View3D (default = null)
Method detail
clear () method
public function clear():void
resize () method  
public function resize(width:Number, height:Number, transparent:Boolean = true):void
Parameters
width:Number
 
height:Number
 
transparent:Boolean (default = true)
Wiki link
Click to go to the wiki page for 'away3d.core.utils.FaceVO'

Code examples
There are currently no examples for this class

FindHit

Package away3d.core.render
Class public class FindHit
Finds the object that is rendered under a certain view coordinate. Used for mouse click events.
Public Methods
  Method Defined by
   
FindHit
(view:View3D, primitives:Array, x:Number, y:Number)
Creates a new FindHit object.
 FindHit
   
getMouseEvent(type:String):MouseEvent3D
Returns a 3d mouse event object populated with the properties from the hit point.
 FindHit
Constructor detail
FindHit () constructor
public function FindHit(view:View3D, primitives:Array, x:Number, y:Number)
Parameters
view:View3D - The view to be used.
 
primitives:Array - The primitives that have been rendered in the last frame.
 
x:Number - The x coordinate of the point to test.
 
y:Number - The y coordinate of the point to test.
Method detail
getMouseEvent () method
public function getMouseEvent(type:String):MouseEvent3D

Returns a 3d mouse event object populated with the properties from the hit point.

Parameters
type:String
Returns
MouseEvent3D
Wiki link
Click to go to the wiki page for 'away3d.core.render.FindHit'

Code examples
There are currently no examples for this class

FogFilter

Package away3d.core.filter
Class public class FogFilter
Implements IPrimitiveFilter
Adds fog layers to a view and provides automatic farfield filtering for primitives outside the furthest fog layers.
Public Properties
  Property Defined by
    material : IFogMaterial
Defines the material used by the fog layers.
 FogFilter
Protected Properties
  Property Defined by
    ini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
 FogFilter
Public Methods
  Method Defined by
   
FogFilter
(init:Object = null)
Creates a new FogFilter object.
 FogFilter
   
filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array
Applies the filter to the primitive array.
 FogFilter
   
toString():String
Used to trace the values of a filter.
 FogFilter
Property detail
ini property
protected var ini:Init

Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.

material property  
material:IFogMaterial  [read-write]

Defines the material used by the fog layers.

Implementation
    public function get material():IFogMaterial
    public function set material(value:IFogMaterial):void
Constructor detail
FogFilter () constructor
public function FogFilter(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  material:Material
  minZ:Number (default = 1000, min:0)
  maxZ:Number (default = 5000, min:0)
  subdivisions:Int (default = 20, min:1, max:50)
  materials:Array
Method detail
filter () method
public function filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array

Applies the filter to the primitive array.

Parameters
primitives:Array - The primitives to be filtered.
 
scene:Scene3D - The scene to which the primitives belongs.
 
camera:Camera3D - The camera being used in the renderer for the primitives.
 
clip:Clipping - The clipping object used in the renderer for the primitive's view.
Returns
Array
toString () method  
public function toString():String

Used to trace the values of a filter.

Returns
String - A string representation of the filter object.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.FogFilter'

Code examples
There are currently no examples for this class

Frame

Package away3d.core.base
Class public class Frame
Implements IFrame
Holds vertexposition information about a single animation frame.
Public Properties
  Property Defined by
    vertexpositions : Array
An array of vertex position objects.
 Frame
Public Methods
  Method Defined by
   
Frame
()
Creates a new Frame object.
 Frame
   
adjust(k:Number = 1):void
Adjusts the position of all vertex objects in the frame incrementally.
 Frame
Property detail
vertexpositions property
public var vertexpositions:Array

An array of vertex position objects.

Constructor detail
Frame () constructor
public function Frame()
Method detail
adjust () method
public function adjust(k:Number = 1):void

Adjusts the position of all vertex objects in the frame incrementally.

Parameters
k:Number (default = 1) - The fraction by which to adjust the vertex values.
Wiki link
Click to go to the wiki page for 'away3d.core.base.Frame'

Code examples
There are currently no examples for this class

GeodesicSphere

Package away3d.primitives
Class public class GeodesicSphere
Inheritance GeodesicSphere -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d geodesic sphere primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
    fractures : Number
Defines the fractures of the sphere.
 GeodesicSphere
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the sphere.
 GeodesicSphere
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
GeodesicSphere
(init:Object = null)
Creates a new GeodesicSphere object.
 GeodesicSphere
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 GeodesicSphere
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
fractures property
fractures:Number  [read-write]

Defines the fractures of the sphere. Defaults to 2.

Implementation
    public function get fractures():Number
    public function set fractures(value:Number):void
radius property  
radius:Number  [read-write]

Defines the radius of the sphere. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
Constructor detail
GeodesicSphere () constructor
public function GeodesicSphere(init:Object = null)

Constructor for a geodesic sphere object where all the faces are of a constant size unlike a regular sphere object where faces decrease in size as they approach the poles of the sphere.

The init object parameters are : 'radius' defines the radius of the sphere and 'fractures' which defines the level of subdivision of the surface of the sphere.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.GeodesicSphere'

Code examples
There are currently no examples for this class

GridPlane

Package away3d.primitives
Class public class GridPlane
Inheritance GridPlane -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d grid primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the grid.
 GridPlane
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
    segmentsH : Number
Defines the number of vertical segments that make up the grid.
 GridPlane
    segmentsW : Number
Defines the number of horizontal segments that make up the grid.
 GridPlane
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
    width : Number
Defines the width of the grid.
 GridPlane
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the grid points use a yUp orientation (true) or a zUp orientation (false).
 GridPlane
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
GridPlane
(init:Object = null)
Creates a new GridPlane object.
 GridPlane
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 GridPlane
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
height:Number  [read-write]

Defines the height of the grid. Defaults to 100.

Implementation
    public function get height():Number
    public function set height(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the grid. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the grid. Defaults to 1.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
width property  
width:Number  [read-write]

Defines the width of the grid. Defaults to 100.

Implementation
    public function get width():Number
    public function set width(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the grid points use a yUp orientation (true) or a zUp orientation (false). Defaults to true.

Implementation
    public function get yUp():Boolean
    public function set yUp(value:Boolean):void
Constructor detail
GridPlane () constructor
public function GridPlane(init:Object = null)

Constructor for a grid object. The init object parameters are : 'width'/'height' defines the size of the grid, 'segments' defines the number of segments for width and height unless overriden, 'segmentsW' defines number segments the grid is split into horizontally and 'segmentsH' how many segments grid is split into vertically.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  width:Number (default = 100, min:0)
  height:Number (default = 100, min:0)
  segments:Int (default = 1, min:1)
  segmentsW:Int (default = segments, min:1)
  segmentsH:Int (default = segments, min:1)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.GridPlane'

Code examples
There are currently no examples for this class

HoverCamera3D

Package away3d.cameras
Class public class HoverCamera3D
Inheritance HoverCamera3D -> TargetCamera3D -> Camera3D -> Object3D -> flash.events.EventDispatcher
Extended camera used to hover round a specified target object.

See also

away3d.containers.View3D
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) aperture : Number
Used in DofSprite2D.
 Camera3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    distance : Number = 800
Distance between the camera and the specified target.
 HoverCamera3D
  (^) dof : Boolean
Used in DofSprite2D.
 Camera3D
  (^) doflevels : Number = 16
Used in DofSprite2D.
 Camera3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) focus : Number
A divisor value for the perspective depth of the view.
 Camera3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxblur : Number = 150
Used in DofSprite2D.
 Camera3D
    maxtiltangle : Number = 90
Maximum bounds for the tiltangle.
 HoverCamera3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
    mintiltangle : Number = 0
Minimum bounds for the tiltangle.
 HoverCamera3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
    panangle : Number = 0
Rotation of the camera in degrees around the y axis.
 HoverCamera3D
  (^) parent : ObjectContainer3D
Cannot parent a TargetCamera3D object.
 TargetCamera3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    steps : Number = 8
Fractional step taken each time the hover() method is called.
 HoverCamera3D
  (^) target : Object3D
The 3d object targeted by the camera.
 TargetCamera3D
    targetpanangle : Number = 0
Target value for the panangle.
 HoverCamera3D
    targettiltangle : Number = 90
Target value for the tiltangle.
 HoverCamera3D
    tiltangle : Number = 90
Elevation angle of the camera in degrees.
 HoverCamera3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) view : Matrix3D
Returns the transformation matrix used to resolve the scene to the view.
 TargetCamera3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yfactor : Number = 2
Fractional difference in distance between the horizontal camera orientation and vertical camera orientation.
 HoverCamera3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) zoom : Number
Provides an overall scale value to the view
 Camera3D
Protected Properties
  Method Defined by
   
HoverCamera3D
(init:Object = null)
Creates a new HoverCamera3D object.
 HoverCamera3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the camera's properties to another Camera3D object.
 Camera3D
  (^)
disableDof():void
Used in DofSprite2D
 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
Used in DofSprite2D.
 Camera3D
   
hover():Boolean
Updates the tiltangle and panangle values, then calls update().
 HoverCamera3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pan(angle:Number):void
Rotates the camera in its horizontal plane.
 Camera3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
screen(object:Object3D, vertex:Vertex = null):ScreenVertex
Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.
 Camera3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
tilt(angle:Number):void
Rotates the camera in its vertical plane.
 Camera3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
update():Boolean
Updates the camera position.
 HoverCamera3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
distance property
public var distance:Number = 800

Distance between the camera and the specified target. Defaults to 800.

maxtiltangle property  
public var maxtiltangle:Number = 90

Maximum bounds for the tiltangle. Defaults to 90.

See also

tiltangle
mintiltangle property  
public var mintiltangle:Number = 0

Minimum bounds for the tiltangle. Defaults to 0.

See also

tiltangle
panangle property  
public var panangle:Number = 0

Rotation of the camera in degrees around the y axis. Defaults to 0.

steps property  
public var steps:Number = 8

Fractional step taken each time the hover() method is called. Defaults to 8. Affects the speed at which the tiltangle and panangle resolve to their targets.

See also

tiltangle
panangle
targetpanangle property  
public var targetpanangle:Number = 0

Target value for the panangle. Defaults to 0.

See also

panangle
targettiltangle property  
public var targettiltangle:Number = 90

Target value for the tiltangle. Defaults to 90.

See also

tiltangle
tiltangle property  
public var tiltangle:Number = 90

Elevation angle of the camera in degrees. Defaults to 90.

yfactor property  
public var yfactor:Number = 2

Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. Defaults to 2.

See also

distance
Constructor detail
HoverCamera3D () constructor
public function HoverCamera3D(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  yfactor:Number (default = yfactor)
  distance:Number (default = distance)
  panangle:Number (default = panangle)
  tiltangle:Number (default = tiltangle)
  targetpanangle:Number (default = targetpanangle)
  targettiltangle:Number (default = targettiltangle)
  mintiltangle:Number (default = mintiltangle)
  maxtiltangle:Number (default = maxtiltangle)
  steps:Number (default = steps)
Method detail
hover () method
public function hover():Boolean

Updates the tiltangle and panangle values, then calls update(). Values are calculated using the defined targettiltangle, targetpanangle and steps variables.

Returns
Boolean - True if the camera position was updated, otherwise false.

See also

tiltangle
panangle
targettiltangle
targetpanangle
steps
update()
update () method  
public function update():Boolean

Updates the camera position. Position is calculated using the current values of tiltangle, panangle, distance and yfactor.

Returns
Boolean - True if the camera position was updated, otherwise false.

See also

tiltangle
panangle
distance
yfactor
Wiki link
Click to go to the wiki page for 'away3d.cameras.HoverCamera3D'

Code examples

HoverCamera3d Example

//Replace the code below into the first frame of
//the lesson Lesson_Basic_03_Meshes.fla


// import core library
import away3d.core.scene.*;
// import file format loaders
import away3d.loaders.*;
//import math objects
import away3d.core.math.*;
//
import away3d.cameras.*;

// create a 3D-viewport

var camera = new HoverCamera3D({zoom:3, focus:200, distance:1000});
// create a 3D-viewport
camera.tiltangle = 40;
camera.targettiltangle = 40;
camera.mintiltangle =  20;
camera.maxtiltangle = 50;
camera.yfactor = 1;
camera.steps = 7;

var view:View3D = new View3D({camera:camera, x:300, y:200});
// add viewport to the stage
addChild(view);

// start mesh loading
var loader:Object3DLoader = Obj.load("resources/turtle.obj",
{material:"turtle_texture", name:"turtle", scaling:0.1, y:50, x:10, z:
10, loadersize:300});
// add the loader object to the scene
view.scene.addChild(loader);
//
camera.update();
loader.rotationX = -90;
//
var rotCamera:Boolean = false;
var lastMouseX:Number = mouseX;
var lastMouseY:Number = mouseY;
var firstClick:Boolean = true;
//
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
//
if (rotCamera) {
if (firstClick == true) {
firstClick = false;
lastMouseX = view.mouseX;
lastMouseY = view.mouseY;
trace("frist click");
}
//
var dragX = (view.mouseX - lastMouseX);
var dragY = (view.mouseY - lastMouseY);
//
lastMouseX = view.mouseX;
lastMouseY = view.mouseY;
//
camera.targetpanangle += dragX;
camera.targettiltangle += dragY
camera.hover();
} else {
//
}
// rerender viewport on each frame
view.render();
}
var hit:MovieClip = new MovieClip();
hit.graphics.beginFill(0xFF0000);
hit.graphics.drawRect(0, 0, 500, 600);
hit.graphics.endFill();
addChild(hit);
hit.alpha = 0;
hit.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
function mouseDownHandler(evt:MouseEvent):void {
rotCamera = true;
}
hit.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
function mouseUpHandler(evt:MouseEvent):void {
rotCamera = false;
firstClick = true;
}
hit.addEventListener(MouseEvent.MOUSE_WHEEL, onMouseEvent);
function onMouseEvent(event:MouseEvent):void {
trace(camera.zoom);
var dir = (event.delta > 0) ? .5 : -.5;
camera.zoom = Math.max(2, Math.min(8, (camera.zoom+dir)));
//camera.distanceTo(-40);
}

IAnimation

Package away3d.core.base
Interface public interface IAnimation
Implementors Animation
Interface for objects that can animate the vertex values in a mesh
Public Methods
  Method Defined by
   
update(mesh:BaseMesh):void
Updates the positions of vertex objects in the mesh to the current frame values
 IAnimation
Method detail
update () method
public function update(mesh:BaseMesh):void

Updates the positions of vertex objects in the mesh to the current frame values

Parameters
mesh:BaseMesh - The mesh on which the animation object acts

See also

away3d.core.base.Frame
Wiki link
Click to go to the wiki page for 'away3d.core.base.IAnimation'

Code examples
There are currently no examples for this class

IBlockerConsumer

Package away3d.core.block
Interface public interface IBlockerConsumer
Implementors BlockerArray
Interface for containers capable of storing blockers.
Public Methods
  Method Defined by
   
blocker(block:Blocker):void
Adds blocker primitive to the consumer.
 IBlockerConsumer
Method detail
blocker () method
public function blocker(block:Blocker):void

Adds blocker primitive to the consumer.

Parameters
block:Blocker - The blocker primitive to add.
Wiki link
Click to go to the wiki page for 'away3d.core.block.IBlockerConsumer'

Code examples
There are currently no examples for this class

IBlockerProvider

Package away3d.core.block
Interface public interface IBlockerProvider
Implementors ConvexBlock
Interface for objects that provide blocker instances for occlusion culling in the renderer.
Public Methods
  Method Defined by
   
blockers(consumer:IBlockerConsumer):void
Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object
 IBlockerProvider
Method detail
blockers () method
public function blockers(consumer:IBlockerConsumer):void

Called from the BlockerTraverser when passing Blocker objects to the blocker consumer object

Parameters
consumer:IBlockerConsumer - The consumer instance

See also

away3d.core.traverse.BlockerTraverser
away3d.core.block.Blocker
Wiki link
Click to go to the wiki page for 'away3d.core.block.IBlockerProvider'

Code examples
There are currently no examples for this class

IClonable

Package away3d.core.utils
Interface public interface IClonable
Implementors AmbientLight3D, DirectionalLight3D, Object3D, PointLight3D
Interface for object that can be cloned
Public Methods
  Method Defined by
   
clone(object:* = null):*
 IClonable
Method detail
clone () method
public function clone(object:* = null):*
Parameters
object:* (default = null)
Returns
*
Wiki link
Click to go to the wiki page for 'away3d.core.utils.IClonable'

Code examples
There are currently no examples for this class

IFogMaterial

Package away3d.materials
Interface public interface IFogMaterial extends ITriangleMaterial, IMaterial
Implementors ColorMaterial
Interface for fog filter materials
Public Properties
  Property Defined by
    alpha : Number
Determines the alpha value of the material
 IFogMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 IMaterial
Public Methods
  Method Defined by
   
clone():IFogMaterial
Duplicates the material's properties to another IFogMaterial object
 IFogMaterial
   
renderFog(fog:DrawFog):void
Sends the material data coupled with data from the DrawFog primitive to the render session
 IFogMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 ITriangleMaterial
Property detail
alpha property
alpha:Number  [read-write]

Determines the alpha value of the material

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
Method detail
clone () method
public function clone():IFogMaterial

Duplicates the material's properties to another IFogMaterial object

Returns
IFogMaterial - The new object instance with duplicated properties applied
renderFog () method  
public function renderFog(fog:DrawFog):void

Sends the material data coupled with data from the DrawFog primitive to the render session

Parameters
fog:DrawFog
Wiki link
Click to go to the wiki page for 'away3d.materials.IFogMaterial'

Code examples
There are currently no examples for this class

IFrame

Package away3d.core.base
Interface public interface IFrame
Implementors Frame
Interface for objects that store the vertex values for a single frame of animation
Public Methods
  Method Defined by
   
adjust(k:Number = 1):void
Adjusts the position of all vertex objects in the frame incrementally.
 IFrame
Method detail
adjust () method
public function adjust(k:Number = 1):void

Adjusts the position of all vertex objects in the frame incrementally.

Parameters
k:Number (default = 1) - The fraction by which to adjust the vertex values.
Wiki link
Click to go to the wiki page for 'away3d.core.base.IFrame'

Code examples
There are currently no examples for this class

ILayerMaterial

Package away3d.materials
Interface public interface ILayerMaterial extends IMaterial
Implementors AbstractShader, BitmapMaterial, BitmapMaterialContainer, CompositeMaterial
Interface for materials that can be layered using CompositeMaterial or BitmapMaterialContainer.

See also

away3d.materials.CompositeMaterial
away3d.materials.BitmapMaterialContainer
Public Properties
  Property Defined by
  (^) visible : Boolean
Indicates whether the material is visible
 IMaterial
Public Methods
  Method Defined by
   
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 ILayerMaterial
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 ILayerMaterial
Method detail
renderFace () method
public function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters
face:Face - The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle - The rectangle object defining the bounds of the face in uv-space.
 
parentFaceVO:FaceVO - The value object of the preceeding surface.
Returns
FaceVO

See also

away3d.materials.BitmapMaterailContainer
renderLayer () method  
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.
Wiki link
Click to go to the wiki page for 'away3d.materials.ILayerMaterial'

Code examples
There are currently no examples for this class

ILightConsumer

Package away3d.core.light
Interface public interface ILightConsumer
Implementors LightArray
Interface for containers capable of storing lighting info
Public Methods
  Method Defined by
   
ambientLight(ambient:AmbientLight):void
Adds an ambient light primitive to the light consumer.
 ILightConsumer
   
directionalLight(directional:DirectionalLight):void
Adds an directional light primitive to the light consumer.
 ILightConsumer
   
pointLight(point:PointLight):void
Adds an point light primitive to the light consumer.
 ILightConsumer
Method detail
ambientLight () method
public function ambientLight(ambient:AmbientLight):void

Adds an ambient light primitive to the light consumer.

Parameters
ambient:AmbientLight - The light primitive to add.
directionalLight () method  
public function directionalLight(directional:DirectionalLight):void

Adds an directional light primitive to the light consumer.

Parameters
directional:DirectionalLight - The light primitive to add.
pointLight () method  
public function pointLight(point:PointLight):void

Adds an point light primitive to the light consumer.

Parameters
point:PointLight - The light primitive to add.
Wiki link
Click to go to the wiki page for 'away3d.core.light.ILightConsumer'

Code examples
There are currently no examples for this class

ILightProvider

Package away3d.core.light
Interface public interface ILightProvider
Implementors AmbientLight3D, DirectionalLight3D, PointLight3D
Interface for objects that provide lighting to the scene
Public Methods
  Method Defined by
   
light(consumer:ILightConsumer):void
Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object
 ILightProvider
Method detail
light () method
public function light(consumer:ILightConsumer):void

Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object

Parameters
consumer:ILightConsumer - The consumer instance.

See also

../traverse/PrimitiveTraverser.html
../light/LightPrimitive.html
../light/ILightConsumer.html
Wiki link
Click to go to the wiki page for 'away3d.core.light.ILightProvider'

Code examples
There are currently no examples for this class

ILODObject

Package away3d.containers
Interface public interface ILODObject
Implementors LODObject
Interface for objects that can toggle their visibily depending on view and distance to camera
Public Methods
  Method Defined by
   
matchLOD(view:View3D):Boolean
Used in ProjectionTraverser to determine whether the 3d object is visible.
 ILODObject
Method detail
matchLOD () method
public function matchLOD(view:View3D):Boolean

Used in ProjectionTraverser to determine whether the 3d object is visible.

Parameters
view:View3D - The view being used to calulate the perspective.
Returns
Boolean - Defines whether the LOD object is visible.

See also

away3d.core.traverse.ProjectionTraverser
away3d.containers.LODObject.maxp
away3d.containers.LODObject.minp
Wiki link
Click to go to the wiki page for 'away3d.containers.ILODObject'

Code examples
There are currently no examples for this class

IMaterial

Package away3d.materials
Interface public interface IMaterial
Subinterfaces ILayerMaterial, ISegmentMaterial, ITriangleMaterial, IUVMaterial
Interface for all objects that can serve as a material
Public Properties
  Property Defined by
    visible : Boolean
[read-only] Indicates whether the material is visible
 IMaterial
Property detail
visible property
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
Wiki link
Click to go to the wiki page for 'away3d.materials.IMaterial'

Code examples
There are currently no examples for this class

IMeshElement

Package away3d.core.base
Interface public interface IMeshElement
Implementors BaseMeshElement
Interface for objects that define a 3d element of a mesh
Public Properties
  Property Defined by
    maxX : Number
[read-only] Returns the maximum x value of the 3d element
 IMeshElement
    maxY : Number
[read-only] Returns the minimum y value of the 3d element
 IMeshElement
    maxZ : Number
[read-only] Returns the minimum z value of the 3d element
 IMeshElement
    minX : Number
[read-only] Returns the minimum x value of the 3d element
 IMeshElement
    minY : Number
[read-only] Returns the maximum y value of the 3d element
 IMeshElement
    minZ : Number
[read-only] Returns the maximum z value of the 3d element
 IMeshElement
    radius2 : Number
[read-only] Returns the squared bounding radius of the 3d element
 IMeshElement
    vertices : Array
[read-only]
 IMeshElement
    visible : Boolean
Defines whether the 3d element is visible in the scene.
 IMeshElement
Public Methods
  Method Defined by
   
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
 IMeshElement
   
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
 IMeshElement
   
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
 IMeshElement
   
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
 IMeshElement
   
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
 IMeshElement
   
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
 IMeshElement
Property detail
maxX property
maxX:Number  [read-only]

Returns the maximum x value of the 3d element

Implementation
    public function get maxX():Number
maxY property  
maxY:Number  [read-only]

Returns the minimum y value of the 3d element

Implementation
    public function get maxY():Number
maxZ property  
maxZ:Number  [read-only]

Returns the minimum z value of the 3d element

Implementation
    public function get maxZ():Number
minX property  
minX:Number  [read-only]

Returns the minimum x value of the 3d element

Implementation
    public function get minX():Number
minY property  
minY:Number  [read-only]

Returns the maximum y value of the 3d element

Implementation
    public function get minY():Number
minZ property  
minZ:Number  [read-only]

Returns the maximum z value of the 3d element

Implementation
    public function get minZ():Number
radius2 property  
radius2:Number  [read-only]

Returns the squared bounding radius of the 3d element

Implementation
    public function get radius2():Number
vertices property  
vertices:Array  [read-only]
Implementation
    public function get vertices():Array
visible property  
visible:Boolean  [read-write]

Defines whether the 3d element is visible in the scene.

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method detail
addOnVertexChange () method
public function addOnVertexChange(listener:Function):void

Default method for adding a vertexchanged event listener

Parameters
listener:Function - The listener function
addOnVertexValueChange () method  
public function addOnVertexValueChange(listener:Function):void

Default method for adding a vertexvaluechanged event listener

Parameters
listener:Function - The listener function
addOnVisibleChange () method  
public function addOnVisibleChange(listener:Function):void

Default method for adding a visiblechanged event listener

Parameters
listener:Function - The listener function
removeOnVertexChange () method  
public function removeOnVertexChange(listener:Function):void

Default method for removing a vertexchanged event listener

Parameters
listener:Function - The listener function
removeOnVertexValueChange () method  
public function removeOnVertexValueChange(listener:Function):void

Default method for removing a vertexvaluechanged event listener

Parameters
listener:Function - The listener function
removeOnVisibleChange () method  
public function removeOnVisibleChange(listener:Function):void

Default method for removing a visiblechanged event listener

Parameters
listener:Function - The listener function
Wiki link
Click to go to the wiki page for 'away3d.core.base.IMeshElement'

Code examples
There are currently no examples for this class

Init

Package away3d.core.utils
Class public class Init
Convinient object initialization support
Public Methods
  Method Defined by
   
Init
(init:Object)
 Init
   
getArray(name:String):Array
 Init
   
getBitmap(name:String):BitmapData
 Init
   
getBoolean(name:String, def:Boolean):Boolean
 Init
   
getColor(name:String, def:uint):uint
 Init
   
getCubeMaterials(name:String):CubeMaterialsData
 Init
   
getInit(name:String):Init
 Init
   
getInt(name:String, def:int, bounds:Object = null):int
 Init
   
getMaterial(name:String):ITriangleMaterial
 Init
   
getNumber(name:String, def:Number, bounds:Object = null):Number
 Init
   
getNumber3D(name:String):Number3D
 Init
   
getObject(name:String, type:Class = null):Object
 Init
   
getObject3D(name:String):Object3D
 Init
   
getObjectOrInit(name:String, type:Class = null):Object
 Init
   
getPosition(name:String):Number3D
 Init
   
getSegmentMaterial(name:String):ISegmentMaterial
 Init
   
getString(name:String, def:String):String
 Init
   
parse(init:Object):Init
[static]
 Init
Constructor detail
Init () constructor
public function Init(init:Object)
Parameters
init:Object
Method detail
addForCheck () method
arcane function addForCheck():void
checkUnusedArguments () method  
arcane static function checkUnusedArguments():void
getArray () method  
public function getArray(name:String):Array
Parameters
name:String
Returns
Array
getBitmap () method  
public function getBitmap(name:String):BitmapData
Parameters
name:String
Returns
BitmapData
getBoolean () method  
public function getBoolean(name:String, def:Boolean):Boolean
Parameters
name:String
 
def:Boolean
Returns
Boolean
getColor () method  
public function getColor(name:String, def:uint):uint
Parameters
name:String
 
def:uint
Returns
uint
getCubeMaterials () method  
public function getCubeMaterials(name:String):CubeMaterialsData
Parameters
name:String
Returns
CubeMaterialsData
getInit () method  
public function getInit(name:String):Init
Parameters
name:String
Returns
Init
getInt () method  
public function getInt(name:String, def:int, bounds:Object = null):int
Parameters
name:String
 
def:int
 
bounds:Object (default = null)
Returns
int
getMaterial () method  
public function getMaterial(name:String):ITriangleMaterial
Parameters
name:String
Returns
ITriangleMaterial
getNumber () method  
public function getNumber(name:String, def:Number, bounds:Object = null):Number
Parameters
name:String
 
def:Number
 
bounds:Object (default = null)
Returns
Number
getNumber3D () method  
public function getNumber3D(name:String):Number3D
Parameters
name:String
Returns
Number3D
getObject () method  
public function getObject(name:String, type:Class = null):Object
Parameters
name:String
 
type:Class (default = null)
Returns
Object
getObject3D () method  
public function getObject3D(name:String):Object3D
Parameters
name:String
Returns
Object3D
getObjectOrInit () method  
public function getObjectOrInit(name:String, type:Class = null):Object
Parameters
name:String
 
type:Class (default = null)
Returns
Object
getPosition () method  
public function getPosition(name:String):Number3D
Parameters
name:String
Returns
Number3D
getSegmentMaterial () method  
public function getSegmentMaterial(name:String):ISegmentMaterial
Parameters
name:String
Returns
ISegmentMaterial
getString () method  
public function getString(name:String, def:String):String
Parameters
name:String
 
def:String
Returns
String
parse () method  
public static function parse(init:Object):Init
Parameters
init:Object
Returns
Init
removeFromCheck () method  
arcane function removeFromCheck():void
Wiki link
Click to go to the wiki page for 'away3d.core.utils.Init'

Code examples
There are currently no examples for this class

IPhysicsScene

Package away3d.containers
Interface public interface IPhysicsScene
Public Methods
  Method Defined by
   
updateTime(time:int):void
 IPhysicsScene
Method detail
updateTime () method
public function updateTime(time:int):void
Parameters
time:int
Wiki link
Click to go to the wiki page for 'away3d.containers.IPhysicsScene'

Code examples
There are currently no examples for this class

IPrimitiveConsumer

Package away3d.core.draw
Interface public interface IPrimitiveConsumer
Implementors DrawGroup, PrimitiveArray, PrimitiveQuadrantTree, PrimitiveVolumeBlock
Interface for containers capable of drawing primitives
Public Methods
  Method Defined by
   
primitive(pri:DrawPrimitive):void
Adds a drawing primitive to the primitive consumer
 IPrimitiveConsumer
Method detail
primitive () method
public function primitive(pri:DrawPrimitive):void

Adds a drawing primitive to the primitive consumer

Parameters
pri:DrawPrimitive - The drawing primitive to add.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.IPrimitiveConsumer'

Code examples
There are currently no examples for this class

IPrimitiveFilter

Package away3d.core.filter
Interface public interface IPrimitiveFilter
Implementors FogFilter, ZDepthFilter, ZSortFilter
Interface for filters that work on primitive arrays
Public Methods
  Method Defined by
   
filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array
Applies the filter to the primitive array.
 IPrimitiveFilter
Method detail
filter () method
public function filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array

Applies the filter to the primitive array.

Parameters
primitives:Array - The primitives to be filtered.
 
scene:Scene3D - The scene to which the primitives belongs.
 
camera:Camera3D - The camera being used in the renderer for the primitives.
 
clip:Clipping - The clipping object used in the renderer for the primitive's view.
Returns
Array
Wiki link
Click to go to the wiki page for 'away3d.core.filter.IPrimitiveFilter'

Code examples
There are currently no examples for this class

IPrimitiveProvider

Package away3d.core.draw
Interface public interface IPrimitiveProvider
Implementors AmbientLight3D, ConvexBlock, DebugObjectContainer3D, DirectionalLight3D, DirSprite2D, DofSprite2D, Mesh, MovieClipSprite, ObjectContainer3D, PointLight3D, Sprite2D, WireMesh
Interface for objects that provide drawing primitives to the rendering process
Public Methods
  Method Defined by
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 IPrimitiveProvider
Method detail
primitives () method
public function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawPrimitive
Wiki link
Click to go to the wiki page for 'away3d.core.draw.IPrimitiveProvider'

Code examples
There are currently no examples for this class

IPrimitiveQuadrantFilter

Package away3d.core.filter
Interface public interface IPrimitiveQuadrantFilter
Implementors AnotherRivalFilter, QuadrantRiddleFilter
Interface for filters that work on primitive quadrant trees
Public Methods
  Method Defined by
   
filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void
Applies the filter to the quadrant tree.
 IPrimitiveQuadrantFilter
Method detail
filter () method
public function filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void

Applies the filter to the quadrant tree.

Parameters
pritree:PrimitiveQuadrantTree - The quadrant tree to be filtered.
 
scene:Scene3D - The scene to which the quadrant tree belongs.
 
camera:Camera3D - The camera being used in the renderer for the quadrant tree
 
clip:Clipping - The clipping object used in the renderer for the quadrant tree's view.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.IPrimitiveQuadrantFilter'

Code examples
There are currently no examples for this class

IPrimitiveVolumeBlockFilter

Package away3d.core.filter
Interface public interface IPrimitiveVolumeBlockFilter
Interface for filters that work on primitive volume blocks
Public Methods
  Method Defined by
   
filter(blocklist:PrimitiveVolumeBlock, scene:Scene3D, camera:Camera3D, clip:Clipping):void
Applies the filter to the volume block.
 IPrimitiveVolumeBlockFilter
Method detail
filter () method
public function filter(blocklist:PrimitiveVolumeBlock, scene:Scene3D, camera:Camera3D, clip:Clipping):void

Applies the filter to the volume block.

Parameters
blocklist:PrimitiveVolumeBlock - The volume block tree to be filtered.
 
scene:Scene3D - The scene to which the volume block tree belongs.
 
camera:Camera3D - The camera being used in the renderer for the volume block tree
 
clip:Clipping - The clipping object used in the renderer for the volume block tree's view.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.IPrimitiveVolumeBlockFilter'

Code examples
There are currently no examples for this class

IRenderer

Package away3d.core.render
Interface public interface IRenderer
Implementors BasicRenderer, QuadrantRenderer
Interface for renderers capable of rendering a scene to a view
Public Properties
  Property Defined by
    session : AbstractRenderSession
Defines the render session object used by the renderer.
 IRenderer
Public Methods
  Method Defined by
   
render(view:View3D):Array
Executes the render pipe that resolves the 3d scene into the view.
 IRenderer
   
toString():String
Used to trace the values of a renderer.
 IRenderer
Property detail
session property
session:AbstractRenderSession  [read-write]

Defines the render session object used by the renderer.

Implementation
    public function get session():AbstractRenderSession
    public function set session(value:AbstractRenderSession):void
Method detail
render () method
public function render(view:View3D):Array

Executes the render pipe that resolves the 3d scene into the view.

Parameters
view:View3D
Returns
Array
toString () method  
public function toString():String

Used to trace the values of a renderer.

Returns
String - A string representation of the renderer object.
Wiki link
Click to go to the wiki page for 'away3d.core.render.IRenderer'

Code examples
There are currently no examples for this class

ISegmentMaterial

Package away3d.materials
Interface public interface ISegmentMaterial extends IMaterial
Implementors WireframeMaterial
Interface for materials that are capable of drawing line segments.
Public Properties
  Property Defined by
  (^) visible : Boolean
Indicates whether the material is visible
 IMaterial
Public Methods
  Method Defined by
   
renderSegment(seg:DrawSegment):void
Sends data from the material coupled with data from the DrawSegment primitive to the render session.
 ISegmentMaterial
Method detail
renderSegment () method
public function renderSegment(seg:DrawSegment):void

Sends data from the material coupled with data from the DrawSegment primitive to the render session.

Parameters
seg:DrawSegment
Wiki link
Click to go to the wiki page for 'away3d.materials.ISegmentMaterial'

Code examples
There are currently no examples for this class

ITriangleMaterial

Package away3d.materials
Interface public interface ITriangleMaterial extends IMaterial
Subinterfaces IFogMaterial
Implementors AnimatedBitmapMaterial, BitmapFileMaterial, BitmapMaterial, BitmapMaterialContainer, CenterLightingMaterial, ColorMaterial, CompositeMaterial, EnviroColorMaterial, MovieMaterial, TransformBitmapMaterial, WireColorMaterial, WireframeMaterial
Interface for materials that are capable of rendering triangle faces.
Public Properties
  Property Defined by
  (^) visible : Boolean
Indicates whether the material is visible
 IMaterial
Public Methods
  Method Defined by
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 ITriangleMaterial
Method detail
renderTriangle () method
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
Wiki link
Click to go to the wiki page for 'away3d.materials.ITriangleMaterial'

Code examples
There are currently no examples for this class

IUpdatingMaterial

Package away3d.materials
Interface public interface IUpdatingMaterial
Implementors AbstractShader, BitmapMaterial, BitmapMaterialContainer, CenterLightingMaterial, CompositeMaterial
Interface for materials that require updating every render loop
Public Methods
  Method Defined by
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 IUpdatingMaterial
Method detail
updateMaterial () method
public function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.IUpdatingMaterial'

Code examples
There are currently no examples for this class

IUVMaterial

Package away3d.materials
Interface public interface IUVMaterial extends IMaterial
Implementors AnimatedBitmapMaterial, BitmapFileMaterial, BitmapMaterial, DiffuseDot3Shader, MovieMaterial, TransformBitmapMaterial, WhiteShadingBitmapMaterial
Interface for materials that use uv texture coordinates
Public Properties
  Property Defined by
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 IUVMaterial
    height : Number
[read-only] Returns the height of the bitmapData being used as the material texture.
 IUVMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 IMaterial
    width : Number
[read-only] Returns the width of the bitmapData being used as the material texture.
 IUVMaterial
Public Methods
  Method Defined by
   
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 IUVMaterial
   
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 IUVMaterial
   
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 IUVMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
height property  
height:Number  [read-only]

Returns the height of the bitmapData being used as the material texture.

Implementation
    public function get height():Number
width property  
width:Number  [read-only]

Returns the width of the bitmapData being used as the material texture.

Implementation
    public function get width():Number
Method detail
addOnResize () method
public function addOnResize(listener:Function):void

Default method for adding a materialresize event listener

Parameters
listener:Function - The listener function
getPixel32 () method  
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.
removeOnResize () method  
public function removeOnResize(listener:Function):void

Default method for removing a materialresize event listener

Parameters
listener:Function - The listener function
Wiki link
Click to go to the wiki page for 'away3d.materials.IUVMaterial'

Code examples
There are currently no examples for this class

Kmz

Package away3d.loaders
Class public class Kmz
File loader for the KMZ 4 file format (exported from Google Sketchup).
Public Properties
  Property Defined by
    container : ObjectContainer3D
3d container object used for storing the parsed kmz scene.
 Kmz
    containerData : ContainerData
Container data object used for storing the parsed kmz data structure.
 Kmz
    materialLibrary : MaterialLibrary
Reference container for all materials used in the kmz scene.
 Kmz
Public Methods
  Method Defined by
   
Kmz
(datastream:ByteArray, init:Object = null)
Creates a new Kmz object.
 Kmz
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses a kmz file into a 3d container object.
 Kmz
   
parse(data:*, init:Object = null, loader:Object3DLoader = null):ObjectContainer3D
[static] Creates a 3d container object from the raw binary data of a kmz file.
 Kmz
Property detail
container property
public var container:ObjectContainer3D

3d container object used for storing the parsed kmz scene.

containerData property  
public var containerData:ContainerData

Container data object used for storing the parsed kmz data structure.

materialLibrary property  
public var materialLibrary:MaterialLibrary

Reference container for all materials used in the kmz scene.

Constructor detail
Kmz () constructor
public function Kmz(datastream:ByteArray, init:Object = null)
Parameters
datastream:ByteArray - The binary zip data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

See also

away3d.loaders.Kmz.parse()
away3d.loaders.Kmz.load()
Method detail
load () method
public static function load(url:String, init:Object = null):Object3DLoader

Loads and parses a kmz file into a 3d container object.

Parameters
url:String - The url location of the file to load.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Returns
Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the file is loading.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):ObjectContainer3D

Creates a 3d container object from the raw binary data of a kmz file.

Parameters
data:* - The birnay zip data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object3DLoader (default = null) - [optional] Not intended for direct use.
Returns
ObjectContainer3D - A 3d container object representation of the kmz file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Kmz'

Code examples
There are currently no examples for this class

Lathe

Package away3d.extrusions
Class public class Lathe
Inheritance Lathe -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Lathe
(aPoints:Array, init:Object = null)
 Lathe
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
Lathe () constructor
public function Lathe(aPoints:Array, init:Object = null)

Class generates a Mesh from Number3D in a circular fashion

Parameters
aPoints:Array
 
init:Object (default = null)
Wiki link
Click to go to the wiki page for 'away3d.extrusions.Lathe'

Code examples
There are currently no examples for this class

LightArray

Package away3d.core.light
Class public class LightArray
Implements ILightConsumer
Array for storing light primitives.
Public Properties
  Property Defined by
    ambients : Array
The ambient light primitives stored in the consumer.
 LightArray
    directionals : Array
The directional light primitives stored in the consumer.
 LightArray
    numLights : int
The total number of light primitives stored in the consumer.
 LightArray
    points : Array
The point light primitives stored in the consumer.
 LightArray
Public Methods
  Method Defined by
   
ambientLight(ambient:AmbientLight):void
Adds an ambient light primitive to the light consumer.
 LightArray
   
clear():void
Clears all light primitives from the consumer.
 LightArray
   
directionalLight(directional:DirectionalLight):void
Adds an directional light primitive to the light consumer.
 LightArray
   
pointLight(point:PointLight):void
Adds an point light primitive to the light consumer.
 LightArray
Property detail
ambients property
public var ambients:Array

The ambient light primitives stored in the consumer.

directionals property  
public var directionals:Array

The directional light primitives stored in the consumer.

numLights property  
public var numLights:int

The total number of light primitives stored in the consumer.

points property  
public var points:Array

The point light primitives stored in the consumer.

Method detail
ambientLight () method
public function ambientLight(ambient:AmbientLight):void

Adds an ambient light primitive to the light consumer.

Parameters
ambient:AmbientLight - The light primitive to add.
clear () method  
public function clear():void

Clears all light primitives from the consumer.

directionalLight () method  
public function directionalLight(directional:DirectionalLight):void

Adds an directional light primitive to the light consumer.

Parameters
directional:DirectionalLight - The light primitive to add.
pointLight () method  
public function pointLight(point:PointLight):void

Adds an point light primitive to the light consumer.

Parameters
point:PointLight - The light primitive to add.
Wiki link
Click to go to the wiki page for 'away3d.core.light.LightArray'

Code examples
There are currently no examples for this class

LightPrimitive

Package away3d.core.light
Class public class LightPrimitive
Subclasses AmbientLight, DirectionalLight, PointLight
Abstract light primitve.
Public Properties
  Property Defined by
    ambient : Number
Coefficient for the ambient light intensity.
 LightPrimitive
    ambientBitmap : BitmapData
Lightmap for ambient intensity.
 LightPrimitive
    ambientDiffuseBitmap : BitmapData
Combined lightmap for ambient and diffuse intensities.
 LightPrimitive
    blue : Number
Blue component level.
 LightPrimitive
    diffuse : Number
Coefficient for the diffuse light intensity.
 LightPrimitive
    diffuseBitmap : BitmapData
Lightmap for diffuse intensity.
 LightPrimitive
    green : Number
Green component level.
 LightPrimitive
    red : Number
Red component level.
 LightPrimitive
    specular : Number
Coefficient for the specular light intensity.
 LightPrimitive
    specularBitmap : BitmapData
Lightmap for specular intensity.
 LightPrimitive
Property detail
ambient property
public var ambient:Number

Coefficient for the ambient light intensity.

ambientBitmap property  
public var ambientBitmap:BitmapData

Lightmap for ambient intensity.

ambientDiffuseBitmap property  
public var ambientDiffuseBitmap:BitmapData

Combined lightmap for ambient and diffuse intensities.

blue property  
public var blue:Number

Blue component level.

diffuse property  
public var diffuse:Number

Coefficient for the diffuse light intensity.

diffuseBitmap property  
public var diffuseBitmap:BitmapData

Lightmap for diffuse intensity.

green property  
public var green:Number

Green component level.

red property  
public var red:Number

Red component level.

specular property  
public var specular:Number

Coefficient for the specular light intensity.

specularBitmap property  
public var specularBitmap:BitmapData

Lightmap for specular intensity.

Wiki link
Click to go to the wiki page for 'away3d.core.light.LightPrimitive'

Code examples
There are currently no examples for this class

Line2D

Package away3d.core.draw
Class public class Line2D
Line in 2D space
Public Properties
  Property Defined by
    a : Number
Line2D
    b : Number
Line2D
    c : Number
Line2D
Public Methods
  Method Defined by
   
Line2D
(a:Number, b:Number, c:Number)
 Line2D
   
cross(u:Line2D, v:Line2D):ScreenVertex
[static]
 Line2D
   
distance(v:ScreenVertex):Number
 Line2D
   
from2points(v0:ScreenVertex, v1:ScreenVertex):Line2D
[static]
 Line2D
   
side(x:Number, y:Number):Number
 Line2D
   
sideV(v:ScreenVertex):Number
 Line2D
   
toString():String
 Line2D
Property detail
a property
public var a:Number
b property  
public var b:Number
c property  
public var c:Number
Constructor detail
Line2D () constructor
public function Line2D(a:Number, b:Number, c:Number)
Parameters
a:Number
 
b:Number
 
c:Number
Method detail
cross () method
public static function cross(u:Line2D, v:Line2D):ScreenVertex
Parameters
u:Line2D
 
v:Line2D
Returns
ScreenVertex
distance () method  
public function distance(v:ScreenVertex):Number
Parameters
v:ScreenVertex
Returns
Number
from2points () method  
public static function from2points(v0:ScreenVertex, v1:ScreenVertex):Line2D
Parameters
v0:ScreenVertex
 
v1:ScreenVertex
Returns
Line2D
side () method  
public function side(x:Number, y:Number):Number
Parameters
x:Number
 
y:Number
Returns
Number
sideV () method  
public function sideV(v:ScreenVertex):Number
Parameters
v:ScreenVertex
Returns
Number
toString () method  
public function toString():String
Returns
String
Wiki link
Click to go to the wiki page for 'away3d.core.draw.Line2D'

Code examples
There are currently no examples for this class

LineSegment

Package away3d.primitives
Class public class LineSegment
Inheritance LineSegment -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d line segment.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
    end : Vertex
Defines the ending vertex.
 LineSegment
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
    start : Vertex
Defines the starting vertex.
 LineSegment
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
LineSegment
(init:Object = null)
Creates a new LineSegment object.
 LineSegment
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
end property
end:Vertex  [read-write]

Defines the ending vertex of the segment

Defines the ending vertex.

Implementation
    public function get end():Vertex
    public function set end(value:Vertex):void
start property  
start:Vertex  [read-write]

Defines the starting vertex of the segment.

Defines the starting vertex.

Implementation
    public function get start():Vertex
    public function set start(value:Vertex):void
Constructor detail
LineSegment () constructor
public function LineSegment(init:Object = null)

Constructor for a line segment object. The init object parameter 'edge' defines the length of the line segment to be created.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  edge:Number (default = 100, min:0)
Wiki link
Click to go to the wiki page for 'away3d.primitives.LineSegment'

Code examples
There are currently no examples for this class

LoaderEvent

Package away3d.events
Class public class LoaderEvent
Inheritance LoaderEvent -> flash.events.Event
Passed as a parameter when a 3d object loader event occurs
Public Properties
  Property Defined by
    loader : Object3DLoader
A reference to the loader object that is relevant to the event.
 LoaderEvent
Public Methods
  Method Defined by
   
LoaderEvent
(type:String, loader:Object3DLoader)
Creates a new LoaderEvent object.
 LoaderEvent
   
clone():Event
Creates a copy of the LoaderEvent object and sets the value of each property to match that of the original.
 LoaderEvent
Public Constants
  Constant Defined by
    LOAD_ERROR : String = "loaderror"
[static] Defines the value of the type property of a loaderror event object.
 LoaderEvent
    LOAD_SUCCESS : String = "loadsuccess"
[static] Defines the value of the type property of a loadsuccess event object.
 LoaderEvent
Property detail
loader property
public var loader:Object3DLoader

A reference to the loader object that is relevant to the event.

Constructor detail
LoaderEvent () constructor
public function LoaderEvent(type:String, loader:Object3DLoader)
Parameters
type:String - The type of the event. Possible values are: LoaderEvent.LOAD_SUCCESS and LoaderEvent.LOAD_ERROR.
 
loader:Object3DLoader - A reference to the loader object that is relevant to the event.
Method detail
clone () method
public override function clone():Event

Creates a copy of the LoaderEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant detail
LOAD_ERROR constant
public static const LOAD_ERROR:String = "loaderror"

Defines the value of the type property of a loaderror event object.

LOAD_SUCCESS constant  
public static const LOAD_SUCCESS:String = "loadsuccess"

Defines the value of the type property of a loadsuccess event object.

Wiki link
Click to go to the wiki page for 'away3d.events.LoaderEvent'

Code examples
There are currently no examples for this class

LODObject

Package away3d.containers
Class public class LODObject
Inheritance LODObject -> ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
Implements ILODObject
3d object container that is drawn only if its scaling to perspective falls within a given range.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 ObjectContainer3D
  (^) children : Array
Returns the children of the container as an array of 3d objects
 ObjectContainer3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
    maxp : Number
The maximum perspective value from which the 3d object can be viewed.
 LODObject
  (^) maxX : Number
Returns the maximum x value of the 3d object
 ObjectContainer3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 ObjectContainer3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 ObjectContainer3D
    minp : Number
The minimum perspective value from which the 3d object can be viewed.
 LODObject
  (^) minX : Number
Returns the minimum x value of the 3d object
 ObjectContainer3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 ObjectContainer3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 ObjectContainer3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
LODObject
(init:Object = null, ... childarray)
Creates a new LODObject object.
 LODObject
  (^)
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
  (^)
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
   
matchLOD(view:View3D):Boolean
Used in ProjectionTraverser to determine whether the 3d object is visible.
 LODObject
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 ObjectContainer3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
maxp property
public var maxp:Number

The maximum perspective value from which the 3d object can be viewed.

minp property  
public var minp:Number

The minimum perspective value from which the 3d object can be viewed.

Constructor detail
LODObject () constructor
public function LODObject(init:Object = null, ... childarray)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
... childarray - An array of children to be added on instatiation.
Init Parameters
  maxp:Number (default = Infinity)
  minp:Number (default = 0)
Method detail
matchLOD () method
public function matchLOD(view:View3D):Boolean

Used in ProjectionTraverser to determine whether the 3d object is visible.

Parameters
view:View3D - The view being used to calulate the perspective.
Returns
Boolean - Defines whether the LOD object is visible.

See also

away3d.core.traverse.ProjectionTraverser
maxp
minp
Wiki link
Click to go to the wiki page for 'away3d.containers.LODObject'

Code examples
There are currently no examples for this class

LogoCube

Package away3d.primitives
Class public class LogoCube
Inheritance LogoCube -> Cube -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d cube primitive with the Away3d logo.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) cubeMaterials : CubeMaterialsData
Defines the face materials of the cube.
 Cube
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) depth : Number
Defines the depth of the cube.
 Cube
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) height : Number
Defines the height of the cube.
 Cube
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) width : Number
Defines the width of the cube.
 Cube
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
LogoCube
(init:Object = null)
Creates a new LogoCube object.
 LogoCube
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Cube
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
LogoCube () constructor
public function LogoCube(init:Object = null)

Constructor for a logo cube object. This creates cube with a logo representation on each face.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Wiki link
Click to go to the wiki page for 'away3d.primitives.LogoCube'

Code examples
There are currently no examples for this class

MaterialData

Package away3d.loaders.data
Class public class MaterialData
Data class for the material data of a face.

See also

away3d.loaders.data.FaceData
Public Properties
  Property Defined by
    ambientColor : int
Optional ambient color of the material.
 MaterialData
    diffuseColor : int
Optional diffuse color of the material.
 MaterialData
    faces : Array
Array of indexes representing the faces that use the material.
 MaterialData
    material : ITriangleMaterial
Reference to the material object of the resulting material.
 MaterialData
    materialType : String = "wireframeMaterial"
String representing the material type.
 MaterialData
    name : String
The name of the material used as a unique reference.
 MaterialData
    specularColor : int
Optional specular color of the material.
 MaterialData
    textureBitmap : BitmapData
Reference to the bitmapData object of the texture image.
 MaterialData
    textureFileName : String
Reference to the filename of the texture image.
 MaterialData
Public Constants
  Constant Defined by
    SHADING_MATERIAL : String = "shadingMaterial"
[static] String representing a shaded material.
 MaterialData
    TEXTURE_MATERIAL : String = "textureMaterial"
[static] String representing a texture material.
 MaterialData
    WIREFRAME_MATERIAL : String = "wireframeMaterial"
[static] String representing a wireframe material.
 MaterialData
Property detail
ambientColor property
public var ambientColor:int

Optional ambient color of the material.

diffuseColor property  
public var diffuseColor:int

Optional diffuse color of the material.

faces property  
public var faces:Array

Array of indexes representing the faces that use the material.

material property  
public var material:ITriangleMaterial

Reference to the material object of the resulting material.

materialType property  
public var materialType:String = "wireframeMaterial"

String representing the material type.

name property  
public var name:String

The name of the material used as a unique reference.

specularColor property  
public var specularColor:int

Optional specular color of the material.

textureBitmap property  
public var textureBitmap:BitmapData

Reference to the bitmapData object of the texture image.

textureFileName property  
public var textureFileName:String

Reference to the filename of the texture image.

Constant detail
SHADING_MATERIAL constant
public static const SHADING_MATERIAL:String = "shadingMaterial"

String representing a shaded material.

TEXTURE_MATERIAL constant  
public static const TEXTURE_MATERIAL:String = "textureMaterial"

String representing a texture material.

WIREFRAME_MATERIAL constant  
public static const WIREFRAME_MATERIAL:String = "wireframeMaterial"

String representing a wireframe material.

Wiki link
Click to go to the wiki page for 'away3d.loaders.data.MaterialData'

Code examples
There are currently no examples for this class

MaterialEvent

Package away3d.events
Class public class MaterialEvent
Inheritance MaterialEvent -> flash.events.Event
Passed as a parameter when a material event occurs
Public Properties
  Property Defined by
    extra : Object
A reference to a user defined extra object that is relevant to the event.
 MaterialEvent
    material : IMaterial
A reference to the material object that is relevant to the event.
 MaterialEvent
Public Methods
  Method Defined by
   
MaterialEvent
(type:String, material:IMaterial)
Creates a new MaterialEvent object.
 MaterialEvent
   
clone():Event
Creates a copy of the MaterialEvent object and sets the value of each property to match that of the original.
 MaterialEvent
Public Constants
  Constant Defined by
    CHANGED : String = "materialchanged"
[static] Defines the value of the type property of a materialchanged event object.
 MaterialEvent
    RESIZED : String = "materialresize"
[static] Defines the value of the type property of a materialresize event object.
 MaterialEvent
Property detail
extra property
public var extra:Object

A reference to a user defined extra object that is relevant to the event.

material property  
public var material:IMaterial

A reference to the material object that is relevant to the event.

Constructor detail
MaterialEvent () constructor
public function MaterialEvent(type:String, material:IMaterial)
Parameters
type:String - The type of the event. Possible values are: MaterialEvent.RESIZED.
 
material:IMaterial - A reference to the material object that is relevant to the event.
Method detail
clone () method
public override function clone():Event

Creates a copy of the MaterialEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant detail
CHANGED constant
public static const CHANGED:String = "materialchanged"

Defines the value of the type property of a materialchanged event object.

RESIZED constant  
public static const RESIZED:String = "materialresize"

Defines the value of the type property of a materialresize event object.

Wiki link
Click to go to the wiki page for 'away3d.events.MaterialEvent'

Code examples
There are currently no examples for this class

MaterialLibrary

Package away3d.loaders.utils
Class public dynamic class MaterialLibrary
Inheritance MaterialLibrary -> flash.utils.Dictionary
Store for all materials associated with an externally loaded file.
Public Properties
  Property Defined by
    autoLoadTextures : Boolean
Determines whether textures should be loaded automatically.
 MaterialLibrary
    loadRequired : Boolean
Flag to determine if any of the contained textures require a file load.
 MaterialLibrary
    texturePath : String
The root directory path to the texture files.
 MaterialLibrary
Public Methods
  Method Defined by
   
addMaterial(name:String):MaterialData
Adds a material name reference to the library.
 MaterialLibrary
   
texturesLoaded(loadQueue:TextureLoadQueue):void
Called after all textures have been loaded from the TextureLoader class.
 MaterialLibrary
Property detail
autoLoadTextures property
public var autoLoadTextures:Boolean

Determines whether textures should be loaded automatically.

loadRequired property  
public var loadRequired:Boolean

Flag to determine if any of the contained textures require a file load.

texturePath property  
public var texturePath:String

The root directory path to the texture files.

Method detail
addMaterial () method
public function addMaterial(name:String):MaterialData

Adds a material name reference to the library.

Parameters
name:String
Returns
MaterialData
texturesLoaded () method  
public function texturesLoaded(loadQueue:TextureLoadQueue):void

Called after all textures have been loaded from the TextureLoader class.

Parameters
loadQueue:TextureLoadQueue

See also

away3d.loaders.utils.TextureLoader
Wiki link
Click to go to the wiki page for 'away3d.loaders.utils.MaterialLibrary'

Code examples
There are currently no examples for this class

Matrix3D

Package away3d.core.math
Class public final class Matrix3D
A 3D transformation 4x3 matrix
Public Properties
  Property Defined by
    det : Number
[read-only] Returns the 3d matrix object's determinant.
 Matrix3D
    position : Number3D
[read-only] Returns a 3d number representing the translation imposed by the 3dmatrix.
 Matrix3D
    sxx : Number
The value in the first row and first column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    sxy : Number
The value in the first row and second column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    sxz : Number
The value in the first row and third column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    syx : Number
The value in the second row and first column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    syy : Number
The value in the second row and second column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    syz : Number
The value in the second row and third column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    szx : Number
The value in the third row and first column of the Matrix object, which affects the rotation and scaling of a 3d object.
 Matrix3D
    szy : Number
The value in the third row and second column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    szz : Number
The value in the third row and third column of the Matrix object, which affect the rotation and scaling of a 3d object.
 Matrix3D
    tx : Number
The value in the first row and forth column of the Matrix object, which affects the positioning along the x axis of a 3d object.
 Matrix3D
    ty : Number
The value in the second row and fourth column of the Matrix object, which affects the positioning along the y axis of a 3d object.
 Matrix3D
    tz : Number
The value in the third row and fourth column of the Matrix object, which affects the positioning along the z axis of a 3d object.
 Matrix3D
Public Methods
  Method Defined by
   
Matrix3D
()
Creates a new Matrix3D object.
 Matrix3D
   
array2matrix(ar:Array):void
Fills the 3d matrix object with values from an array with 3d matrix values ordered from right to left and up to down.
 Matrix3D
   
clone(m:Matrix3D):Matrix3D
Fill the 3d matrix with all matrix values of the given 3d matrix.
 Matrix3D
   
copy3x3(m:Matrix3D):Matrix3D
Fill the 3d matrix with the 3x3 rotation matrix section of the given 3d matrix.
 Matrix3D
   
inverse(m:Matrix3D):void
Fills the 3d matrix object with the result from the inverse calulation of the given 3d matrix.
 Matrix3D
   
matrix2euler():Number3D
Returns the euler angle represented by the 3x3 matrix rotation.
 Matrix3D
   
multiply(m1:Matrix3D, m2:Matrix3D):void
Fills the 3d matrix object with the result from a 3x4 multipication of two 3d matrix objects.
 Matrix3D
   
multiply3x3(m1:Matrix3D, m2:Matrix3D):void
Fills the 3d matrix object with the result from a 3x3 multipication of two 3d matrix objects.
 Matrix3D
   
quaternion2matrix(quarternion:Quaternion):void
Fills the 3d matrix object with values representing the transformation made by the given quaternion.
 Matrix3D
   
rotationMatrix(u:Number, v:Number, w:Number, angle:Number):void
Fills the 3d matrix object with values representing the given rotation around a vector.
 Matrix3D
   
scale(x:Number, y:Number, z:Number):void
Scales the 3d matrix by the given amount in each dimension
 Matrix3D
   
scaleMatrix(u:Number, v:Number, w:Number):void
Fills the 3d matrix object with values representing the given scaling.
 Matrix3D
   
toString():String
Used to trace the values of a 3d matrix.
 Matrix3D
   
translationMatrix(u:Number, v:Number, w:Number):void
Fills the 3d matrix object with values representing the given translation.
 Matrix3D
Property detail
det property
det:Number  [read-only]

Returns the 3d matrix object's determinant.

Implementation
    public function get det():Number
position property  
position:Number3D  [read-only]

Returns a 3d number representing the translation imposed by the 3dmatrix.

Implementation
    public function get position():Number3D
sxx property  
public var sxx:Number

The value in the first row and first column of the Matrix object, which affect the rotation and scaling of a 3d object.

sxy property  
public var sxy:Number

The value in the first row and second column of the Matrix object, which affect the rotation and scaling of a 3d object.

sxz property  
public var sxz:Number

The value in the first row and third column of the Matrix object, which affect the rotation and scaling of a 3d object.

syx property  
public var syx:Number

The value in the second row and first column of the Matrix object, which affect the rotation and scaling of a 3d object.

syy property  
public var syy:Number

The value in the second row and second column of the Matrix object, which affect the rotation and scaling of a 3d object.

syz property  
public var syz:Number

The value in the second row and third column of the Matrix object, which affect the rotation and scaling of a 3d object.

szx property  
public var szx:Number

The value in the third row and first column of the Matrix object, which affects the rotation and scaling of a 3d object.

szy property  
public var szy:Number

The value in the third row and second column of the Matrix object, which affect the rotation and scaling of a 3d object.

szz property  
public var szz:Number

The value in the third row and third column of the Matrix object, which affect the rotation and scaling of a 3d object.

tx property  
public var tx:Number

The value in the first row and forth column of the Matrix object, which affects the positioning along the x axis of a 3d object.

ty property  
public var ty:Number

The value in the second row and fourth column of the Matrix object, which affects the positioning along the y axis of a 3d object.

tz property  
public var tz:Number

The value in the third row and fourth column of the Matrix object, which affects the positioning along the z axis of a 3d object.

Constructor detail
Matrix3D () constructor
public function Matrix3D()
Method detail
array2matrix () method
public function array2matrix(ar:Array):void

Fills the 3d matrix object with values from an array with 3d matrix values ordered from right to left and up to down.

Parameters
ar:Array
clone () method  
public function clone(m:Matrix3D):Matrix3D

Fill the 3d matrix with all matrix values of the given 3d matrix.

Parameters
m:Matrix3D - THe 3d matrix to copy from.
Returns
Matrix3D
copy3x3 () method  
public function copy3x3(m:Matrix3D):Matrix3D

Fill the 3d matrix with the 3x3 rotation matrix section of the given 3d matrix.

Parameters
m:Matrix3D - THe 3d matrix to copy from.
Returns
Matrix3D
inverse () method  
public function inverse(m:Matrix3D):void

Fills the 3d matrix object with the result from the inverse calulation of the given 3d matrix.

Parameters
m:Matrix3D - The 3d matrix object used for the inverse calulation.
matrix2euler () method  
public function matrix2euler():Number3D

Returns the euler angle represented by the 3x3 matrix rotation.

Returns
Number3D - A 3d number representing the 3 euler angles.
multiply () method  
public function multiply(m1:Matrix3D, m2:Matrix3D):void

Fills the 3d matrix object with the result from a 3x4 multipication of two 3d matrix objects.

Parameters
m1:Matrix3D - The first 3d matrix in the multipication.
 
m2:Matrix3D
multiply3x3 () method  
public function multiply3x3(m1:Matrix3D, m2:Matrix3D):void

Fills the 3d matrix object with the result from a 3x3 multipication of two 3d matrix objects. The translation values are taken from the first matrix.

Parameters
m1:Matrix3D - The first 3d matrix in the multipication.
 
m2:Matrix3D
quaternion2matrix () method  
public function quaternion2matrix(quarternion:Quaternion):void

Fills the 3d matrix object with values representing the transformation made by the given quaternion.

Parameters
quarternion:Quaternion - The quarterion object to convert.
rotationMatrix () method  
public function rotationMatrix(u:Number, v:Number, w:Number, angle:Number):void

Fills the 3d matrix object with values representing the given rotation around a vector.

Parameters
u:Number - The x value of the rotation vector.
 
v:Number - The y value of the rotation vector.
 
w:Number - The z value of the rotation vector.
 
angle:Number - The angle in radians of the rotation.
scale () method  
public function scale(x:Number, y:Number, z:Number):void

Scales the 3d matrix by the given amount in each dimension

Parameters
x:Number - The scale value along the x axis.
 
y:Number - The scale value along the y axis.
 
z:Number - The scale value along the z axis.
scaleMatrix () method  
public function scaleMatrix(u:Number, v:Number, w:Number):void

Fills the 3d matrix object with values representing the given scaling.

Parameters
u:Number - The scale along the x axis.
 
v:Number - The scale along the y axis.
 
w:Number - The scale along the z axis..
toString () method  
public function toString():String

Used to trace the values of a 3d matrix.

Returns
String - A string representation of the 3d matrix object.
translationMatrix () method  
public function translationMatrix(u:Number, v:Number, w:Number):void

Fills the 3d matrix object with values representing the given translation.

Parameters
u:Number - The translation along the x axis.
 
v:Number - The translation along the y axis.
 
w:Number - The translation along the z axis..
Wiki link
Click to go to the wiki page for 'away3d.core.math.Matrix3D'

Code examples
There are currently no examples for this class

Max3DS

Package away3d.loaders
Class public class Max3DS
File loader for the 3DS file format.
Public Properties
  Property Defined by
    container : ObjectContainer3D
3d container object used for storing the parsed 3ds object.
 Max3DS
    materialLibrary : MaterialLibrary
Reference container for all materials used in the 3ds object.
 Max3DS
    meshDataList : Array
Array of mesh data objects used for storing the parsed 3ds data structure.
 Max3DS
Public Methods
  Method Defined by
   
Max3DS
(data:ByteArray, init:Object = null)
Creates a new Max3DS object.
 Max3DS
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses a 3ds file into a 3d container object.
 Max3DS
   
loadTextures(data:*, init:Object = null):Object3DLoader
[static] Loads and parses the textures for a 3ds file into a 3d container object.
 Max3DS
   
parse(data:*, init:Object = null, loader:Object3DLoader = null):ObjectContainer3D
[static] Creates a 3d container object from the raw binary data of a 3ds file.
 Max3DS
Property detail
container property
public var container:ObjectContainer3D

3d container object used for storing the parsed 3ds object.

materialLibrary property  
public var materialLibrary:MaterialLibrary

Reference container for all materials used in the 3ds object.

meshDataList property  
public var meshDataList:Array

Array of mesh data objects used for storing the parsed 3ds data structure.

Constructor detail
Max3DS () constructor
public function Max3DS(data:ByteArray, init:Object = null)
Parameters
data:ByteArray - The binary 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)
  material:Material
  centerMeshes:Boolean (default = false)
  materials:Object

See also

away3d.loaders.Max3DS.parse()
away3d.loaders.Max3DS.load()
Method detail
load () method
public static function load(url:String, init:Object = null):Object3DLoader

Loads and parses a 3ds 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.
loadTextures () method  
public static function loadTextures(data:*, init:Object = null):Object3DLoader

Loads and parses the textures for a 3ds file into a 3d container object.

Parameters
data:* - The binary data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Returns
Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the textures are loading.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):ObjectContainer3D

Creates a 3d container object from the raw binary data of a 3ds file.

Parameters
data:* - The binary data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object3DLoader (default = null) - [optional] Not intended for direct use.
Returns
ObjectContainer3D - A 3d container object representation of the 3ds file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Max3DS'

Code examples
There are currently no examples for this class

Md2

Package away3d.loaders
Class public class Md2
File loader for the Md2 file format.
Public Methods
  Method Defined by
   
Md2
(data:ByteArray, init:Object = null)
Creates a new Md2 object.
 Md2
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses an md2 file into a 3d mesh object.
 Md2
   
parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh
[static] Creates a 3d mesh object from the raw xml data of an md2 file.
 Md2
Constructor detail
Md2 () constructor
public function Md2(data:ByteArray, init:Object = null)
Parameters
data:ByteArray - The binary data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

See also

away3d.loaders.Md2.parse()
away3d.loaders.Md2.load()
Method detail
load () method
public static function load(url:String, init:Object = null):Object3DLoader

Loads and parses an md2 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.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh

Creates a 3d mesh object from the raw xml data of an md2 file.

Parameters
data:* - The binary data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object3DLoader (default = null) - [optional] Not intended for direct use.
Returns
Mesh - A 3d mesh object representation of the md2 file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Md2'

Code examples
There are currently no examples for this class

Md2still

Package away3d.loaders
Class public class Md2still
File loader for the Md2 file format (non-animated version).
Public Methods
  Method Defined by
   
Md2still
(data:ByteArray, init:Object = null)
Creates a new Md2Still object.
 Md2still
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses an md2 file into a 3d mesh object.
 Md2still
   
parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh
[static] Creates a 3d mesh object from the raw xml data of an md2 file.
 Md2still
Constructor detail
Md2still () constructor
public function Md2still(data:ByteArray, init:Object = null)
Parameters
data:ByteArray - The binary 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.Md2Still.parse()
away3d.loaders.Md2Still.load()
Method detail
load () method
public static function load(url:String, init:Object = null):Object3DLoader

Loads and parses an md2 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.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh

Creates a 3d mesh object from the raw xml data of an md2 file.

Parameters
data:* - The binary data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object3DLoader (default = null) - [optional] Not intended for direct use.
Returns
Mesh - A 3d mesh object representation of the md2 file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Md2still'

Code examples
There are currently no examples for this class

Mesh

Package away3d.core.base
Class public class Mesh
Inheritance Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Subclasses AbstractPrimitive, Animator, Lathe, SeaTurtle, SegmentsExtrude, SkinExtrude, Skybox, Skybox6, Triangle
3d object containing face and segment elements
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
    bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
    debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
    elements : Array
[read-only] Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
    faces : Array
[read-only] Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
    material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
    outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Mesh
(init:Object = null)
Creates a new BaseMesh 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
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
   
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
   
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
   
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
   
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
   
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
back property
public var back:ITriangleMaterial

Defines a triangle material to be used for the backface of all faces in the 3d object.

bothsides property  
public var bothsides:Boolean

Indicates whether both the front and reverse sides of a face should be rendered.

debugbb property  
public var debugbb:Boolean

Indicates whether a debug bounding box should be rendered around the 3d object.

elements property  
elements:Array  [read-only]

Returns an array of the elements contained in the mesh object.

Implementation
    public function get elements():Array
faces property  
faces:Array  [read-only]

Returns an array of the faces contained in the mesh object.

Implementation
    public function get faces():Array
indexes property  
public var indexes:Array
material property  
material:ITriangleMaterial  [read-write]

Defines the material used to render the faces in the mesh object. Individual material settings on faces will override this setting.

Implementation
    public function get material():ITriangleMaterial
    public function set material(value:ITriangleMaterial):void

See also

away3d.core.base.Face.material
outline property  
public var outline:ISegmentMaterial

Defines a segment material to be used for outlining the 3d object.

Constructor detail
Mesh () constructor
public function Mesh(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  material:Material
  outline:SegmentMaterial
  back:Material
  bothsides:Boolean (default = false)
  debugbb:Boolean (default = false)
Method detail
addFace () method
public function addFace(face:Face):void

Adds a face object to the mesh object.

Parameters
face:Face - The face object to be added.
asAS3Class () method  
public function asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String

Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.

Parameters
classname:String (default = null) - [optional] Defines the class name used in the output string. Defaults to Away3DObject.
 
packagename:String (default = "") - [optional] Defines the package name used in the output string. Defaults to no package.
 
round:Boolean (default = false) - [optional] Rounds all values to 4 decimal places. Defaults to false.
 
animated:Boolean (default = false) - [optional] Defines whether animation data should be saved. Defaults to false.
Returns
String - A string to be pasted into a new .as file
asXML () method  
public function asXML():XML

Returns an xml representation of the mesh

Returns
XML - An xml object containing mesh information
clone () method  
public override function clone(object:* = null):*

Duplicates the mesh properties to another 3d object.

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied. The default is Mesh.
Returns
* - The new object instance with duplicated properties applied.
invertFaces () method  
public function invertFaces():void

Inverts the geometry of all face objects.

See also

away3d.code.base.Face.invert()
movePivot () method  
public function movePivot(dx:Number, dy:Number, dz:Number):void

Moves the origin point of the mesh without moving the contents.

Parameters
dx:Number - The amount of movement along the local x axis.
 
dy:Number - The amount of movement along the local y axis.
 
dz:Number - The amount of movement along the local z axis.
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawTriangle
away3d.core.draw.DrawSegment
quarterFaces () method  
public function quarterFaces():void

Divides a face object into 4 equal sized face objects. Used to segment a mesh in order to reduce affine persepective distortion.

See also

away3d.primitives.SkyBox
removeFace () method  
public function removeFace(face:Face):void

Removes a face object from the mesh object.

Parameters
face:Face - The face object to be removed.
Wiki link
Click to go to the wiki page for 'away3d.core.base.Mesh'

Code examples
There are currently no examples for this class

MeshData

Package away3d.loaders.data
Class public class MeshData
Inheritance MeshData -> ObjectData
Data class for the mesh data of a 3d object
Public Properties
  Property Defined by
    faces : Array
Array of face data objects.
 MeshData
    materials : Array
Optional assigned materials to the mesh.
 MeshData
  (^) name : String
The name of the 3d object used as a unique reference.
 ObjectData
  (^) transform : Matrix3D
The 3d transformation matrix for the 3d object
 ObjectData
    uvs : Array
Array of uv objects.
 MeshData
    vertices : Array
Array of vertex objects.
 MeshData
Property detail
faces property
public var faces:Array

Array of face data objects.

See also

away3d.loaders.data.FaceData
materials property  
public var materials:Array

Optional assigned materials to the mesh.

uvs property  
public var uvs:Array

Array of uv objects. see

vertices property  
public var vertices:Array

Array of vertex objects.

See also

away3d.core.base.Vertex
Wiki link
Click to go to the wiki page for 'away3d.loaders.data.MeshData'

Code examples
There are currently no examples for this class

MeshElementEvent

Package away3d.events
Class public class MeshElementEvent
Inheritance MeshElementEvent -> flash.events.Event
Passed as a parameter when a meshelement event occurs
Public Properties
  Property Defined by
    element : IMeshElement
A reference to the element object that is relevant to the event.
 MeshElementEvent
Public Methods
  Method Defined by
   
MeshElementEvent
(type:String, element:IMeshElement)
Creates a new MeshElementEvent object.
 MeshElementEvent
   
clone():Event
Creates a copy of the MeshElementEvent object and sets the value of each property to match that of the original.
 MeshElementEvent
Public Constants
  Constant Defined by
    VERTEX_CHANGED : String = "vertexchanged"
[static] Defines the value of the type property of a vertexchanged event object.
 MeshElementEvent
    VERTEXVALUE_CHANGED : String = "vertexvaluechanged"
[static] Defines the value of the type property of a vertexvaluechanged event object.
 MeshElementEvent
    VISIBLE_CHANGED : String = "visiblechanged"
[static] Defines the value of the type property of a visiblechanged event object.
 MeshElementEvent
Property detail
element property
public var element:IMeshElement

A reference to the element object that is relevant to the event.

Constructor detail
MeshElementEvent () constructor
public function MeshElementEvent(type:String, element:IMeshElement)
Parameters
type:String - The type of the event. Possible values are: MeshElementEvent.VERTEX_CHANGED, MeshElementEvent.VERTEXVALUE_CHANGED and MeshElementEvent.VISIBLE_CHANGED.
 
element:IMeshElement - A reference to the element object that is relevant to the event.
Method detail
clone () method
public override function clone():Event

Creates a copy of the MeshElementEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant detail
VERTEX_CHANGED constant
public static const VERTEX_CHANGED:String = "vertexchanged"

Defines the value of the type property of a vertexchanged event object.

VERTEXVALUE_CHANGED constant  
public static const VERTEXVALUE_CHANGED:String = "vertexvaluechanged"

Defines the value of the type property of a vertexvaluechanged event object.

VISIBLE_CHANGED constant  
public static const VISIBLE_CHANGED:String = "visiblechanged"

Defines the value of the type property of a visiblechanged event object.

Wiki link
Click to go to the wiki page for 'away3d.events.MeshElementEvent'

Code examples
There are currently no examples for this class

MeshMaterialData

Package away3d.loaders.data
Class public class MeshMaterialData
Data class for teh material of a 3d object
Public Properties
  Property Defined by
    faceList : Array
A list of faces which are to be drawn with the material.
 MeshMaterialData
    name : String
The name of the material used as a unique reference.
 MeshMaterialData
Property detail
faceList property
public var faceList:Array

A list of faces which are to be drawn with the material.

name property  
public var name:String

The name of the material used as a unique reference.

Wiki link
Click to go to the wiki page for 'away3d.loaders.data.MeshMaterialData'

Code examples
There are currently no examples for this class

Morpher

Package away3d.core.base
Class public class Morpher
Inheritance Morpher -> Object3D -> flash.events.EventDispatcher
Keyframe animation morpher
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 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
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Morpher
(vertices:BaseMesh)
Creates a new Morpher object.
 Morpher
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
   
finish(comp:BaseMesh):void
resets all vertex objects to the external mesh positions
 Morpher
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
   
mix(comp:BaseMesh, k:Number):void
interpolates the vertex objects position values between the current vertex positions and the external vertex positions
 Morpher
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
   
start():void
resets all vertex objects to 0,0,0
 Morpher
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
Morpher () constructor
public function Morpher(vertices:BaseMesh)
Parameters
vertices:BaseMesh - A mesh object used to define the starting vertices.
Method detail
finish () method
public function finish(comp:BaseMesh):void

resets all vertex objects to the external mesh positions

Parameters
comp:BaseMesh - The external mesh used for vertex values
mix () method  
public function mix(comp:BaseMesh, k:Number):void

interpolates the vertex objects position values between the current vertex positions and the external vertex positions

Parameters
comp:BaseMesh - The external mesh used for interpolating values
 
k:Number - The increment used on the weighting value
start () method  
public function start():void

resets all vertex objects to 0,0,0

Wiki link
Click to go to the wiki page for 'away3d.core.base.Morpher'

Code examples
There are currently no examples for this class

MouseEvent3D

Package away3d.events
Class public class MouseEvent3D
Inheritance MouseEvent3D -> flash.events.Event
Passed as a parameter when a 3d mouse event occurs
Public Properties
  Property Defined by
    ctrlKey : Boolean
Indicates whether the Control key is active (true) or inactive (false).
 MouseEvent3D
    drawpri : DrawPrimitive
The draw primitive inside which the event took place.
 MouseEvent3D
    element : Object
The 3d element inside which the event took place.
 MouseEvent3D
    material : IUVMaterial
The material of the 3d element inside which the event took place.
 MouseEvent3D
    object : Object3D
The 3d object inside which the event took place.
 MouseEvent3D
    sceneX : Number
The x coordinate at which the event occurred in global scene coordinates.
 MouseEvent3D
    sceneY : Number
The y coordinate at which the event occurred in global scene coordinates.
 MouseEvent3D
    sceneZ : Number
The z coordinate at which the event occurred in global scene coordinates.
 MouseEvent3D
    screenX : Number
The horizontal coordinate at which the event occurred in view coordinates.
 MouseEvent3D
    screenY : Number
The vertical coordinate at which the event occurred in view coordinates.
 MouseEvent3D
    screenZ : Number
The depth coordinate at which the event occurred in view coordinates.
 MouseEvent3D
    shiftKey : Boolean
Indicates whether the Shift key is active (true) or inactive (false).
 MouseEvent3D
    uv : UV
The uv coordinate inside the draw primitive where the event took place.
 MouseEvent3D
    view : View3D
The view object inside which the event took place.
 MouseEvent3D
Public Methods
  Method Defined by
   
MouseEvent3D
(type:String)
Creates a new MouseEvent3D object.
 MouseEvent3D
   
clone():Event
Creates a copy of the MouseEvent3D object and sets the value of each property to match that of the original.
 MouseEvent3D
Public Constants
  Constant Defined by
    MOUSE_DOWN : String = "mouseDown3D"
[static] Defines the value of the type property of a mouseDown3D event object.
 MouseEvent3D
    MOUSE_MOVE : String = "mouseMove3D"
[static] Defines the value of the type property of a mouseMove3D event object.
 MouseEvent3D
    MOUSE_OUT : String = "mouseOut3D"
[static] Defines the value of the type property of a mouseOut3D event object.
 MouseEvent3D
    MOUSE_OVER : String = "mouseOver3D"
[static] Defines the value of the type property of a mouseOver3D event object.
 MouseEvent3D
    MOUSE_UP : String = "mouseUp3D"
[static] Defines the value of the type property of a mouseUp3D event object.
 MouseEvent3D
Property detail
ctrlKey property
public var ctrlKey:Boolean

Indicates whether the Control key is active (true) or inactive (false).

drawpri property  
public var drawpri:DrawPrimitive

The draw primitive inside which the event took place.

element property  
public var element:Object

The 3d element inside which the event took place.

material property  
public var material:IUVMaterial

The material of the 3d element inside which the event took place.

object property  
public var object:Object3D

The 3d object inside which the event took place.

sceneX property  
public var sceneX:Number

The x coordinate at which the event occurred in global scene coordinates.

sceneY property  
public var sceneY:Number

The y coordinate at which the event occurred in global scene coordinates.

sceneZ property  
public var sceneZ:Number

The z coordinate at which the event occurred in global scene coordinates.

screenX property  
public var screenX:Number

The horizontal coordinate at which the event occurred in view coordinates.

screenY property  
public var screenY:Number

The vertical coordinate at which the event occurred in view coordinates.

screenZ property  
public var screenZ:Number

The depth coordinate at which the event occurred in view coordinates.

shiftKey property  
public var shiftKey:Boolean

Indicates whether the Shift key is active (true) or inactive (false).

uv property  
public var uv:UV

The uv coordinate inside the draw primitive where the event took place.

view property  
public var view:View3D

The view object inside which the event took place.

Constructor detail
MouseEvent3D () constructor
public function MouseEvent3D(type:String)
Parameters
type:String - The type of the event. Possible values are: MouseEvent3D.MOUSE_OVER, MouseEvent3D.MOUSE_OUT, MouseEvent3D.MOUSE_UP, MouseEvent3D.MOUSE_DOWN and MouseEvent3D.MOUSE_MOVE.
Method detail
clone () method
public override function clone():Event

Creates a copy of the MouseEvent3D object and sets the value of each property to match that of the original.

Returns
Event
Constant detail
MOUSE_DOWN constant
public static const MOUSE_DOWN:String = "mouseDown3D"

Defines the value of the type property of a mouseDown3D event object.

MOUSE_MOVE constant  
public static const MOUSE_MOVE:String = "mouseMove3D"

Defines the value of the type property of a mouseMove3D event object.

MOUSE_OUT constant  
public static const MOUSE_OUT:String = "mouseOut3D"

Defines the value of the type property of a mouseOut3D event object.

MOUSE_OVER constant  
public static const MOUSE_OVER:String = "mouseOver3D"

Defines the value of the type property of a mouseOver3D event object.

MOUSE_UP constant  
public static const MOUSE_UP:String = "mouseUp3D"

Defines the value of the type property of a mouseUp3D event object.

Wiki link
Click to go to the wiki page for 'away3d.events.MouseEvent3D'

Code examples

Dynamic Mouse Objects

view.mouseZeroMove=true;

myObject.name='away3D_name';
myObject.addOnMouseOver(mymouseFunction);

function mymouseFunction(event:MouseEvent3D):void {
var temp=event.object;
trace(temp.name);
}

*Lesson_Basic_05_MouseEvents.fla

// import core library
import away3d.core.scene.*;
// import geometry primitives
import away3d.objects.*;
// import materials
import away3d.core.material.*;
// import mesh type
import away3d.core.mesh.*;

// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
// add viewport to the stage
addChild(view);

// create carousel
var plane:Mesh = new RegularPolygon({material:"grey#", radius:500, y:-100, pushback:true});
var sphere1:Mesh = new Sphere({material:"blue#", radius:100, x:350});
var sphere2:Mesh = new Sphere({material:"cyan#", radius:100, x:-350});
var sphere3:Mesh = new Sphere({material:"green#", radius:100, z:350});
var sphere4:Mesh = new Sphere({material:"lime#", radius:100, z:-350});
var carousel:Object3D = new ObjectContainer3D(sphere1, sphere2, sphere3, sphere4, plane);

// add carousel to the scene
view.scene.addChild(carousel);

// register mouse event handler
carousel.addOnMouseDown(onCarouselMouseDown);
function onCarouselMouseDown(event:MouseEvent3D):void {
// set the clicked mesh a new material
(event.object as Mesh).material = new WireColorMaterial("random");
}

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate carousel
carousel.rotationY = getTimer() / 100;
// rerender viewport
view.render();
}

From Lesson_Basic_05_MouseEvents.fla


MovieClipSprite

Package away3d.sprites
Class public class MovieClipSprite
Inheritance MovieClipSprite -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Spherical billboard (always facing the camera) sprite object that uses a movieclip as it's texture. Draws individual display objects inline with z-sorted triangles in a scene.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    deltaZ : Number
An optional offset value added to the z depth used to sort the sprite
 MovieClipSprite
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
    movieclip : DisplayObject
Defines the displayobject to use for the sprite texture.
 MovieClipSprite
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
    rescale : Boolean
Defines whether the sprite should scale with distance from the camera.
 MovieClipSprite
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    scaling : Number
Defines the overall scaling of the sprite object
 MovieClipSprite
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
MovieClipSprite
(movieclip:DisplayObject, init:Object = null)
Creates a new MovieClipSprite object.
 MovieClipSprite
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 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
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 MovieClipSprite
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
deltaZ property
public var deltaZ:Number

An optional offset value added to the z depth used to sort the sprite

movieclip property  
public var movieclip:DisplayObject

Defines the displayobject to use for the sprite texture.

rescale property  
public var rescale:Boolean

Defines whether the sprite should scale with distance from the camera. Defaults to false

scaling property  
public var scaling:Number

Defines the overall scaling of the sprite object

Constructor detail
MovieClipSprite () constructor
public function MovieClipSprite(movieclip:DisplayObject, init:Object = null)
Parameters
movieclip:DisplayObject - The displayobject to use as the sprite texture.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  scaling:Number (default = 1)
  deltaZ:Number (default = 0)
  rescale:Boolean (default = false)
Method detail
primitives () method
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawDisplayObject
Wiki link
Click to go to the wiki page for 'away3d.sprites.MovieClipSprite'

Code examples
There are currently no examples for this class

MovieMaterial

Package away3d.materials
Class public class MovieMaterial
Inheritance MovieMaterial -> TransformBitmapMaterial -> BitmapMaterial -> flash.events.EventDispatcher
Implements ITriangleMaterial, IUVMaterial
Animated movie material.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
    autoUpdate : Boolean
Indicates whether the texture bitmap is updated on every frame
 MovieMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) globalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
 TransformBitmapMaterial
    height : Number
[read-only] Returns the height of the bitmapData being used as the material texture.
 MovieMaterial
    interactive : Boolean
MovieMaterial
    movie : Sprite
Defines the movieclip used for rendering the material
 MovieMaterial
  (^) offsetX : Number
Offsets the x coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) offsetY : Number
Offsets the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) projectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
 TransformBitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
  (^) rotation : Number
Rotates the texture in uv-space
 TransformBitmapMaterial
  (^) scaleX : Number
Scales the x coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) scaleY : Number
Scales the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
  (^) throughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
 TransformBitmapMaterial
  (^) transform : Matrix
Transforms the texture in uv-space
 TransformBitmapMaterial
    transparent : Boolean
Defines the transparent property of the texture bitmap created from the movie
 MovieMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
    width : Number
[read-only] Returns the width of the bitmapData being used as the material texture.
 MovieMaterial
Protected Properties
  Method Defined by
   
MovieMaterial
(movie:Sprite, init:Object = null)
Creates a new BitmapMaterial object.
 MovieMaterial
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 TransformBitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 TransformBitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 TransformBitmapMaterial
   
update():void
Updates the texture bitmap with the current frame of the movieclip object
 MovieMaterial
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 MovieMaterial
Protected Methods
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 TransformBitmapMaterial
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterial
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
autoUpdate property
public var autoUpdate:Boolean

Indicates whether the texture bitmap is updated on every frame

height property  
height:Number  [read-only]

Returns the height of the bitmapData being used as the material texture.

Implementation
    public function get height():Number
interactive property  
public var interactive:Boolean
movie property  
public var movie:Sprite

Defines the movieclip used for rendering the material

transparent property  
public var transparent:Boolean

Defines the transparent property of the texture bitmap created from the movie

See also

movie
width property  
width:Number  [read-only]

Returns the width of the bitmapData being used as the material texture.

Implementation
    public function get width():Number
Constructor detail
MovieMaterial () constructor
public function MovieMaterial(movie:Sprite, init:Object = null)
Parameters
movie:Sprite - The sprite object to be used as the material's texture.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  transparent:Boolean (default = true)
  autoUpdate:Boolean (default = true)
  interactive:Boolean (default = false)
Method detail
update () method
public function update():void

Updates the texture bitmap with the current frame of the movieclip object

See also

movie
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.MovieMaterial'

Code examples

Using MovieMaterial (Animated MovieClip as material)

var materialA:MovieMaterial=new MovieMaterial(mymovieclip);
planeA=new Plane({material:materialA,width:500,height:500,segmentsW:1,segmentsH:1});
planeA.bothsides=true;

Number3D

Package away3d.core.math
Class public final class Number3D
A point in 3D space.
Public Properties
  Property Defined by
    BACKWARD : Number3D
[static] A 3d number object representing a relative direction backward.
 Number3D
    DOWN : Number3D
[static] A 3d number object representing a relative direction down.
 Number3D
    FORWARD : Number3D
[static] A 3d number object representing a relative direction forward.
 Number3D
    LEFT : Number3D
[static] A 3d number object representing a relative direction left.
 Number3D
    modulo : Number
[read-only] The modulo of the 3d number object.
 Number3D
    modulo2 : Number
[read-only] The squared modulo of the 3d number object.
 Number3D
    RIGHT : Number3D
[static] A 3d number object representing a relative direction right.
 Number3D
    UP : Number3D
[static] A 3d number object representing a relative direction up.
 Number3D
    x : Number
The horizontal coordinate of the 3d number object.
 Number3D
    y : Number
The vertical coordinate of the 3d number object.
 Number3D
    z : Number
The depth coordinate of the 3d number object.
 Number3D
Public Methods
  Method Defined by
   
Number3D
(x:Number = 0, y:Number = 0, z:Number = 0, n:Boolean = false)
Creates a new Number3D object.
 Number3D
   
add(v:Number3D, w:Number3D):void
Fills the 3d number object with the result from an addition of two 3d numbers.
 Number3D
   
clone():Number3D
Duplicates the 3d number's properties to another Number3D object
 Number3D
   
closestPointOnPlane(p:Number3D, k:Number3D, n:Number3D):Number3D
Calculates a 3d number object representing the closest point on a given plane to a given 3d point.
 Number3D
   
cross(v:Number3D, w:Number3D):void
Fills the 3d number object with the result from an cross product of two 3d numbers.
 Number3D
   
distance(w:Number3D):Number
Calculates the distance from the 3d number object to the given 3d number.
 Number3D
   
dot(w:Number3D):Number
Calculates the dot product of the 3d number object with the given 3d number.
 Number3D
   
getAngle(w:Number3D = null):Number
Returns the angle in radians made between the 3d number obejct and the given 3d number.
 Number3D
   
normalize(val:Number = 1):void
Normalises the 3d number object.
 Number3D
   
rotate(v:Number3D, m:Matrix3D):void
Fills the 3d number object with the result of a 3d matrix rotation performed on a 3d number.
 Number3D
   
scale(v:Number3D, s:Number):void
Fills the 3d number object with scaled values from the given 3d number.
 Number3D
   
sub(v:Number3D, w:Number3D):void
Fills the 3d number object with the result from a subtraction of two 3d numbers.
 Number3D
   
toString():String
Used to trace the values of a 3d number.
 Number3D
   
transform(v:Number3D, m:Matrix3D):void
Fills the 3d number object with the result of a 3d matrix tranformation performed on a 3d number.
 Number3D
Property detail
BACKWARD property
public static var BACKWARD:Number3D

A 3d number object representing a relative direction backward.

DOWN property  
public static var DOWN:Number3D

A 3d number object representing a relative direction down.

FORWARD property  
public static var FORWARD:Number3D

A 3d number object representing a relative direction forward.

LEFT property  
public static var LEFT:Number3D

A 3d number object representing a relative direction left.

modulo property  
modulo:Number  [read-only]

The modulo of the 3d number object.

Implementation
    public function get modulo():Number
modulo2 property  
modulo2:Number  [read-only]

The squared modulo of the 3d number object.

Implementation
    public function get modulo2():Number
RIGHT property  
public static var RIGHT:Number3D

A 3d number object representing a relative direction right.

UP property  
public static var UP:Number3D

A 3d number object representing a relative direction up.

x property  
public var x:Number

The horizontal coordinate of the 3d number object.

y property  
public var y:Number

The vertical coordinate of the 3d number object.

z property  
public var z:Number

The depth coordinate of the 3d number object.

Constructor detail
Number3D () constructor
public function Number3D(x:Number = 0, y:Number = 0, z:Number = 0, n:Boolean = false)
Parameters
x:Number (default = 0) - [optional] A default value for the horizontal coordinate of the 3d number object. Defaults to 0.
 
y:Number (default = 0) - [optional] A default value for the vertical coordinate of the 3d number object. Defaults to 0.
 
z:Number (default = 0) - [optional] A default value for the depth coordinate of the 3d number object. Defaults to 0.
 
n:Boolean (default = false) - [optional] Determines of the resulting 3d number object should be normalised. Defaults to false.
Method detail
add () method
public function add(v:Number3D, w:Number3D):void

Fills the 3d number object with the result from an addition of two 3d numbers.

Parameters
v:Number3D - The first 3d number in the addition.
 
w:Number3D - The second 3d number in the addition.
clone () method  
public function clone():Number3D

Duplicates the 3d number's properties to another Number3D object

Returns
Number3D - The new 3d number instance with duplicated properties applied
closestPointOnPlane () method  
public function closestPointOnPlane(p:Number3D, k:Number3D, n:Number3D):Number3D

Calculates a 3d number object representing the closest point on a given plane to a given 3d point.

Parameters
p:Number3D - The 3d point used in teh calculation.
 
k:Number3D - The plane offset used in the calculation.
 
n:Number3D - The plane normal used in the calculation.
Returns
Number3D - The resulting 3d point.
cross () method  
public function cross(v:Number3D, w:Number3D):void

Fills the 3d number object with the result from an cross product of two 3d numbers.

Parameters
v:Number3D - The first 3d number in the cross product calculation.
 
w:Number3D - The second 3d number in the cross product calculation.
distance () method  
public function distance(w:Number3D):Number

Calculates the distance from the 3d number object to the given 3d number.

Parameters
w:Number3D - The 3d number object whose distance is calculated.
Returns
Number
dot () method  
public function dot(w:Number3D):Number

Calculates the dot product of the 3d number object with the given 3d number.

Parameters
w:Number3D - The 3d number object to use in the calculation.
Returns
Number - The dot product result.
getAngle () method  
public function getAngle(w:Number3D = null):Number

Returns the angle in radians made between the 3d number obejct and the given 3d number.

Parameters
w:Number3D (default = null) - [optional] The 3d number object to use in the calculation.
Returns
Number - An angle in radians representing the angle between the two 3d number objects.
normalize () method  
public function normalize(val:Number = 1):void

Normalises the 3d number object.

Parameters
val:Number (default = 1) - [optional] A normalisation coefficient representing the length of the resulting 3d number object. Defaults to 1.
rotate () method  
public function rotate(v:Number3D, m:Matrix3D):void

Fills the 3d number object with the result of a 3d matrix rotation performed on a 3d number.

Parameters
v:Number3D - 3d number object to use in the calculation.
 
m:Matrix3D - 3d matrix object representing the rotation.
scale () method  
public function scale(v:Number3D, s:Number):void

Fills the 3d number object with scaled values from the given 3d number.

Parameters
v:Number3D - The 3d number object used for the scaling calculation.
 
s:Number - The scaling value.
sub () method  
public function sub(v:Number3D, w:Number3D):void

Fills the 3d number object with the result from a subtraction of two 3d numbers.

Parameters
v:Number3D - The starting 3d number in the subtraction.
 
w:Number3D - The subtracting 3d number in the subtraction.
toString () method  
public function toString():String

Used to trace the values of a 3d number.

Returns
String - A string representation of the 3d number object.
transform () method  
public function transform(v:Number3D, m:Matrix3D):void

Fills the 3d number object with the result of a 3d matrix tranformation performed on a 3d number.

Parameters
v:Number3D - 3d number object to use in the calculation.
 
m:Matrix3D - 3d matrix object representing the tranformation.
Wiki link
Click to go to the wiki page for 'away3d.core.math.Number3D'

Code examples
There are currently no examples for this class

Obj

Package away3d.loaders
Class public class Obj
File loader for the OBJ file format.

note: Multiple objects support and autoload mtls are supported since Away v 2.1.
Class tested with the following 3D apps:
- Strata CX mac 5.5
- Biturn ver 0.87b4 PC
- LightWave 3D OBJ Export v2.1 PC
- Max2Obj Version 4.0 PC
- AC3D 6.2.025 mac
- geometry supported tags: f,v,vt, g are being used
- geometry unsupported tags:vn,ka, kd r g b, kd, ks r g b,ks,ke r g b,ke,d alpha,d,tr alpha,tr,ns s,ns,illum n,illum,map_Ka,map_Bump
- mtl unsupported tags: kd,ka,ks,ns,tr

export from apps as polygon group or mesh as .obj file.
Public Properties
  Property Defined by
    mesh : Mesh
Obj
Public Methods
  Method Defined by
   
Obj
(data:String, urlbase:String = "", init:Object = null)
Creates a new Obj object.
 Obj
   
load(url:String, init:Object = null):Object3DLoader
[static] Loads and parses a obj file into a 3d mesh object.
 Obj
   
parse(data:*, init:Object = null, loader:Object3DLoader = null):Object3D
[static] Creates a 3d mesh object from the raw ascii data of a obj file.
 Obj
Property detail
mesh property
public var mesh:Mesh
Constructor detail
Obj () constructor
public function Obj(data:String, urlbase:String = "", init:Object = null)
Parameters
data:String - The binary data of a loaded file.
 
urlbase:String (default = "") - The url of the .obj file, required to compose the url mtl adres and be able access the bitmap sources relative to mtl location.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

See also

away3d.loaders.Obj.parse()
away3d.loaders.Obj.load()
Method detail
load () method
public static function load(url:String, init:Object = null):Object3DLoader

Loads and parses a obj 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.
parse () method  
public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):Object3D

Creates a 3d mesh object from the raw ascii data of a obj file.

Parameters
data:* - The ascii data of a loaded file.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
 
loader:Object3DLoader (default = null) - [optional] Not intended for direct use.
Returns
Object3D - A 3d mesh object representation of the obj file.
Wiki link
Click to go to the wiki page for 'away3d.loaders.Obj'

Code examples
There are currently no examples for this class

Object3D

Package away3d.core.base
Class public class Object3D
Inheritance Object3D -> flash.events.EventDispatcher
Implements IClonable
Subclasses AmbientLight3D, BaseMesh, Camera3D, ConvexBlock, DirectionalLight3D, DirSprite2D, DofSprite2D, Morpher, MovieClipSprite, ObjectContainer3D, PointLight3D, Sprite2D
Base class for all 3d objects.
Public Properties
  Property Defined by
    alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
    boundingRadius : Number
[read-only] Returns the bounding radius of the 3d object
 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
    inverseSceneTransform : Matrix3D
Object3D
    maxX : Number
[read-only] Returns the maximum x value of the 3d object
 Object3D
    maxY : Number
[read-only] Returns the maximum y value of the 3d object
 Object3D
    maxZ : Number
[read-only] Returns the maximum z value of the 3d object
 Object3D
    minX : Number
[read-only] Returns the minimum x value of the 3d object
 Object3D
    minY : Number
[read-only] Returns the minimum y value of the 3d object
 Object3D
    minZ : Number
[read-only] Returns the minimum z value of the 3d object
 Object3D
    mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
    name : String
An optional name string for the 3d object.
 Object3D
    ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
    ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
    parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
    position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    projection : Projection
Object3D
    rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    scene : Scene3D
[read-only] Returns the parent scene of the 3d object
 Object3D
    scenePosition : Number3D
[read-only] Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
    sceneTransform : Matrix3D
[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
    sceneTransformed : Boolean
Object3D
    session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
    viewTransform : Matrix3D
Object3D
    visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
    x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Property Defined by
    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.
 Object3D
Public Methods
  Method Defined by
   
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
   
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
   
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
   
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
   
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
   
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
   
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
   
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
   
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
   
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 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
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
   
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
   
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
   
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
   
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
   
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
   
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
   
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
   
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
   
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
   
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
   
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
   
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
   
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
   
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
   
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
   
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
   
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
   
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
   
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
   
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
   
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
   
tick(time:int):void
Called by the TickTraverser.
 Object3D
   
toString():String
Used to trace the values of a 3d object.
 Object3D
   
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
   
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
   
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
   
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
   
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
   
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
   
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
   
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
   
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
   
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
   
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
   
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
alpha property
public var alpha:Number

An optional alpha value that can be applied to the 3d object. Requires ownCanvas to be set to true.

See also

ownCanvas
blendMode property  
public var blendMode:String

An optional blend mode that can be applied to the 3d object. Requires ownCanvas to be set to true.

See also

ownCanvas
boundingRadius property  
boundingRadius:Number  [read-only]

Returns the bounding radius of the 3d object

Implementation
    public function get boundingRadius():Number
extra property  
public var extra:Object

An optional untyped object that can contain used-defined properties

filters property  
public var filters:Array

An optional array of filters that can be applied to the 3d object. Requires ownCanvas to be set to true.

See also

ownCanvas
ini property  
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.

inverseSceneTransform property  
public var inverseSceneTransform:Matrix3D
maxX property  
maxX:Number  [read-only]

Returns the maximum x value of the 3d object

Implementation
    public function get maxX():Number

See also

x
maxY property  
maxY:Number  [read-only]

Returns the maximum y value of the 3d object

Implementation
    public function get maxY():Number

See also

y
maxZ property  
maxZ:Number  [read-only]

Returns the maximum z value of the 3d object

Implementation
    public function get maxZ():Number

See also

z
minX property  
minX:Number  [read-only]

Returns the minimum x value of the 3d object

Implementation
    public function get minX():Number

See also

x
minY property  
minY:Number  [read-only]

Returns the minimum y value of the 3d object

Implementation
    public function get minY():Number

See also

y
minZ property  
minZ:Number  [read-only]

Returns the minimum z value of the 3d object

Implementation
    public function get minZ():Number

See also

z
mouseEnabled property  
public var mouseEnabled:Boolean = true

Defines whether mouse events are received on the 3d object

name property  
public var name:String

An optional name string for the 3d object. Can be used to access specific 3d object in a scene by calling the getChildByName method on the parent ObjectContainer3D.

See also

away3d.containers.ObjectContainer3D.getChildByName()
ownCanvas property  
public var ownCanvas:Boolean = false

Defines whether the contents of the 3d object are rendered inside it's own sprite

ownSession property  
public var ownSession:AbstractRenderSession

Defines whether the contents of the 3d object are rendered using it's own render session

parent property  
parent:ObjectContainer3D  [read-write]

Defines the parent of the 3d object.

Implementation
    public function get parent():ObjectContainer3D
    public function set parent(value:ObjectContainer3D):void
position property  
position:Number3D  [read-write]

Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get position():Number3D
    public function set position(value:Number3D):void
projection property  
public var projection:Projection
rotationX property  
rotationX: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 rotationX():Number
    public function set rotationX(value:Number):void
rotationY property  
rotationY: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 rotationY():Number
    public function set rotationY(value:Number):void
rotationZ property  
rotationZ: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 rotationZ():Number
    public function set rotationZ(value:Number):void
scene property  
scene:Scene3D  [read-only]

Returns the parent scene of the 3d object

Implementation
    public function get scene():Scene3D
scenePosition property  
scenePosition:Number3D  [read-only]

Returns the position of the 3d object, relative to the global coordinates of the Scene3D.

Implementation
    public function get scenePosition():Number3D
sceneTransform property  
sceneTransform:Matrix3D  [read-only]

Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.

Implementation
    public function get sceneTransform():Matrix3D
sceneTransformed property  
public var sceneTransformed:Boolean
session property  
public var session:AbstractRenderSession

The render session used by the 3d object

transform property  
transform:Matrix3D  [read-write]

Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get transform():Matrix3D
    public function set transform(value:Matrix3D):void
useHandCursor property  
public var useHandCursor:Boolean = false

Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.

viewTransform property  
public var viewTransform:Matrix3D
visible property  
public var visible:Boolean = true

Defines whether the 3d object is visible in the scene

x property  
x:Number  [read-write]

Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get x():Number
    public function set x(value:Number):void
y property  
y:Number  [read-write]

Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get y():Number
    public function set y(value:Number):void
z property  
z:Number  [read-write]

Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.

Implementation
    public function get z():Number
    public function set z(value:Number):void
Method detail
addOnDimensionsChange () method
public function addOnDimensionsChange(listener:Function):void

Default method for adding a dimensionschanged event listener

Parameters
listener:Function - The listener function
addOnMouseDown () method  
public function addOnMouseDown(listener:Function):void

Default method for adding a mouseDown3D event listener

Parameters
listener:Function - The listener function
addOnMouseMove () method  
public function addOnMouseMove(listener:Function):void

Default method for adding a mouseMove3D event listener

Parameters
listener:Function - The listener function
addOnMouseOut () method  
public function addOnMouseOut(listener:Function):void

Default method for adding a mouseOut3D event listener

Parameters
listener:Function - The listener function
addOnMouseOver () method  
public function addOnMouseOver(listener:Function):void

Default method for adding a mouseOver3D event listener

Parameters
listener:Function - The listener function
addOnMouseUp () method  
public function addOnMouseUp(listener:Function):void

Default method for adding a mouseUp3D event listener

Parameters
listener:Function - The listener function
addOnRadiusChange () method  
public function addOnRadiusChange(listener:Function):void

Default method for adding a radiuschanged event listener

Parameters
listener:Function - The listener function
addOnSceneChange () method  
public function addOnSceneChange(listener:Function):void

Default method for adding a scenechanged event listener

Parameters
listener:Function - The listener function
addOnSceneTransformChange () method  
public function addOnSceneTransformChange(listener:Function):void

Default method for adding a scenetransformchanged event listener

Parameters
listener:Function - The listener function
addOnTransformChange () method  
public function addOnTransformChange(listener:Function):void

Default method for adding a transformchanged event listener

Parameters
listener:Function - The listener function
clone () method  
public function clone(object:* = null):*

Duplicates the 3d object's properties to another Object3D object

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied
Returns
* - The new object instance with duplicated properties applied
distanceTo () method  
public function distanceTo(obj:Object3D):Number

Calulates the absolute distance between the local 3d object position and the position of the given 3d object

Parameters
obj:Object3D - The 3d object to use for calulating the distance
Returns
Number - The scalar distance between objects

See also

position
lookAt () method  
public function lookAt(target:Number3D, upAxis:Number3D = null):void

Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.

Parameters
target:Number3D - The vector defining the point to be looked at
 
upAxis:Number3D (default = null) - An optional vector used to define the desired up orientation of the 3d object after rotation has occurred
moveBackward () method  
public function moveBackward(distance:Number):void

Moves the 3d object backwards along it's local z axis

Parameters
distance:Number - The length of the movement
moveDown () method  
public function moveDown(distance:Number):void

Moves the 3d object backwards along it's local y axis

Parameters
distance:Number - The length of the movement
moveForward () method  
public function moveForward(distance:Number):void

Moves the 3d object forwards along it's local z axis

Parameters
distance:Number - The length of the movement
moveLeft () method  
public function moveLeft(distance:Number):void

Moves the 3d object backwards along it's local x axis

Parameters
distance:Number - The length of the movement
moveRight () method  
public function moveRight(distance:Number):void

Moves the 3d object forwards along it's local x axis

Parameters
distance:Number - The length of the movement
moveTo () method  
public function moveTo(target:Number3D):void

Moves the 3d object directly to a point in space

Parameters
target:Number3D - A vector defining the new position of the 3d object
moveUp () method  
public function moveUp(distance:Number):void

Moves the 3d object forwards along it's local y axis

Parameters
distance:Number - The length of the movement
pitch () method  
public function pitch(angle:Number):void

Rotates the 3d object around it's local x-axis

Parameters
angle:Number - The amount of rotation in degrees
primitives () method  
public function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawPrimitive
removeOnDimensionsChange () method  
public function removeOnDimensionsChange(listener:Function):void

Default method for removing a dimensionschanged event listener

Parameters
listener:Function - The listener function
removeOnMouseDown () method  
public function removeOnMouseDown(listener:Function):void

Default method for removing a mouseDown3D event listener

Parameters
listener:Function - The listener function
removeOnMouseMove () method  
public function removeOnMouseMove(listener:Function):void

Default method for removing a mouseMove3D event listener

Parameters
listener:Function - The listener function
removeOnMouseOut () method  
public function removeOnMouseOut(listener:Function):void

Default method for removing a mouseOut3D event listener

Parameters
listener:Function - The listener function
removeOnMouseOver () method  
public function removeOnMouseOver(listener:Function):void

Default method for removing a mouseOver3D event listener

Parameters
listener:Function - The listener function
removeOnMouseUp () method  
public function removeOnMouseUp(listener:Function):void

Default method for removing a mouseUp3D event listener

Parameters
listener:Function - The listener function
removeOnRadiusChange () method  
public function removeOnRadiusChange(listener:Function):void

Default method for removing a radiuschanged event listener

Parameters
listener:Function - The listener function
removeOnSceneChange () method  
public function removeOnSceneChange(listener:Function):void

Default method for removing a scenechanged event listener

Parameters
listener:Function - The listener function
removeOnSceneTransformChange () method  
public function removeOnSceneTransformChange(listener:Function):void

Default method for removing a scenetransformchanged event listener

Parameters
listener:Function - The listener function
removeOnTransformChange () method  
public function removeOnTransformChange(listener:Function):void

Default method for removing a transformchanged event listener

Parameters
listener:Function - The listener function
roll () method  
public function roll(angle:Number):void

Rotates the 3d object around it's local z-axis

Parameters
angle:Number - The amount of rotation in degrees
rotate () method  
public function rotate(axis:Number3D, angle:Number):void

Rotates the 3d object around an axis by a defined angle

Parameters
axis:Number3D - The vector defining the axis of rotation
 
angle:Number - The amount of rotation in degrees
scale () method  
public function scale(scale:Number):void

Scales the contents of the 3d object.

Parameters
scale:Number - The scaling value
tick () method  
public function tick(time:int):void

Called by the TickTraverser. Can be overridden to provide updates to the 3d object based on individual render calls from the renderer.

Parameters
time:int - The absolute time at the start of the render cycle

See also

away3d.core.traverse.TickTraverser
toString () method  
public override function toString():String

Used to trace the values of a 3d object.

Returns
String - A string representation of the 3d object.
translate () method  
public function translate(axis:Number3D, distance:Number):void

Moves the 3d object along a vector by a defined length

Parameters
axis:Number3D - The vector defining the axis of movement
 
distance:Number - The length of the movement
traverse () method  
public function traverse(traverser:Traverser):void

Used when traversing the scenegraph

Parameters
traverser:Traverser - The traverser object

See also

away3d.core.traverse.BlockerTraverser
away3d.core.traverse.PrimitiveTraverser
away3d.core.traverse.ProjectionTraverser
away3d.core.traverse.TickTraverser
yaw () method  
public function yaw(angle:Number):void

Rotates the 3d object around it's local y-axis

Parameters
angle:Number - The amount of rotation in degrees
Event detail
dimensionschanged event 
Event object type: away3d.events.Object3DEvent

Dispatched when the bounding dimensions of the 3d object changes.

See also

minX
maxX
minY
maxY
minZ
maxZ
mouseDown3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.

mouseMove3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor while it is over the 3d object.

mouseOut3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor away from the 3d object.

mouseOver3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor over the 3d object.

mouseUp3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.

radiuschanged event   
Event object type: away3d.events.Object3DEvent

Dispatched when the bounding radius of the 3d object changes.

See also

radius
scenechanged event   
Event object type: away3d.events.Object3DEvent

Dispatched when the parent scene of the 3d object changes

See also

scene
scenetransformchanged event   
Event object type: away3d.events.Object3DEvent

Dispatched when the scene transform matrix of the 3d object changes.

See also

sceneTransform
transformchanged event   
Event object type: away3d.events.Object3DEvent

Dispatched when the local transform matrix of the 3d object changes.

See also

transform
Wiki link
Click to go to the wiki page for 'away3d.core.base.Object3D'

Code examples

Simple Camera/Object Mouse Movement in 3D

//IN A FUNCTION/LOOP://</br></br>
myObjectA.moveTo(myObjectB.position);
//Set the initial position</br>
myObjectA.rotationX=mouseX;//set to mouseX rotation</br>
myObjectA.rotationY=mouseY;//set to mouseY rotation</br>
myObjectA.moveBackwards(1000);//RADIUS or ORBIT</br></br>

//myObjectA.lookAt(myObjectC.position);//OPTIONAL lookAt some other object</br></br>

//Pete(flashnine)

Source Files : http://away3d.com

Change the moveBackwards(Radius/Orbit). Also try something like mouseX/9 or mouseX*9 ETC

moveTo(): Move an Object to another Position

myObjectA.moveTo(myObjectB.position);//A moves to B

Look at another object on a single Axis

function lookY(who,enemy,myoffset):void {
who.rotationY=Math.floor(Math.atan2(who.x - enemy.x,who.z - enemy.z) * 180 / Math.PI) + myoffset;
}
//who will look at enemy, only rotating Y axis, myoffset is the number of degrees to offset it

Away3D ownCanvas, Glow+Blur Filters, and BlendMode

var filterA:Array=new Array;
filterA.push(new GlowFilter(0xFFFFFF, 1, 19, 19, 1, 1, false, false));
var blur:BlurFilter = new BlurFilter();
blur.blurX = 10;
blur.blurY = 10;
blur.quality = BitmapFilterQuality.LOW;
filterA.push(blur);
myObjectA.ownCanvas=true;
myObjectA.filters = filterA;
myObjectA.blendMode = BlendMode.MULTIPLY;

How to set values for scaleX, scaleY, scaleZ

objA.scaleX((100)/(objA.maxX-objA.minX));
objA.scaleY((100)/(objA.maxY-objA.minY));
objA.scaleZ((100)/(objA.maxZ-objA.minZ));
//sets an absolute scale of 100

Object3DEvent

Package away3d.events
Class public class Object3DEvent
Inheritance Object3DEvent -> flash.events.Event
Passed as a parameter when a 3d object event occurs
Public Properties
  Property Defined by
    object : Object3D
A reference to the 3d object that is relevant to the event.
 Object3DEvent
Public Methods
  Method Defined by
   
Object3DEvent
(type:String, object:Object3D)
Creates a new MaterialEvent object.
 Object3DEvent
   
clone():Event
Creates a copy of the Object3DEvent object and sets the value of each property to match that of the original.
 Object3DEvent
Public Constants
  Constant Defined by
    DIMENSIONS_CHANGED : String = "dimensionschanged"
[static] Defines the value of the type property of a dimensionschanged event object.
 Object3DEvent
    RADIUS_CHANGED : String = "radiuschanged"
[static] Defines the value of the type property of a radiuschanged event object.
 Object3DEvent
    SCENE_CHANGED : String = "scenechanged"
[static] Defines the value of the type property of a scenechanged event object.
 Object3DEvent
    SCENETRANSFORM_CHANGED : String = "scenetransformchanged"
[static] Defines the value of the type property of a scenetransformchanged event object.
 Object3DEvent
    TRANSFORM_CHANGED : String = "transformchanged"
[static] Defines the value of the type property of a transformchanged event object.
 Object3DEvent
Property detail
object property
public var object:Object3D

A reference to the 3d object that is relevant to the event.

Constructor detail
Object3DEvent () constructor
public function Object3DEvent(type:String, object:Object3D)
Parameters
type:String - The type of the event. Possible values are: Object3DEvent.TRANSFORM_CHANGED, Object3DEvent.SCENETRANSFORM_CHANGED, Object3DEvent.SCENE_CHANGED, Object3DEvent.RADIUS_CHANGED and Object3DEvent.DIMENSIONS_CHANGED.
 
object:Object3D - A reference to the 3d object that is relevant to the event.
Method detail
clone () method
public override function clone():Event

Creates a copy of the Object3DEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant detail
DIMENSIONS_CHANGED constant
public static const DIMENSIONS_CHANGED:String = "dimensionschanged"

Defines the value of the type property of a dimensionschanged event object.

RADIUS_CHANGED constant  
public static const RADIUS_CHANGED:String = "radiuschanged"

Defines the value of the type property of a radiuschanged event object.

SCENE_CHANGED constant  
public static const SCENE_CHANGED:String = "scenechanged"

Defines the value of the type property of a scenechanged event object.

SCENETRANSFORM_CHANGED constant  
public static const SCENETRANSFORM_CHANGED:String = "scenetransformchanged"

Defines the value of the type property of a scenetransformchanged event object.

TRANSFORM_CHANGED constant  
public static const TRANSFORM_CHANGED:String = "transformchanged"

Defines the value of the type property of a transformchanged event object.

Wiki link
Click to go to the wiki page for 'away3d.events.Object3DEvent'

Code examples
There are currently no examples for this class

Object3DLoader

Package away3d.loaders
Class public class Object3DLoader
Inheritance Object3DLoader -> ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
Subclasses CubeLoader
Abstract loader class used as a placeholder for loading 3d content
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 ObjectContainer3D
  (^) children : Array
Returns the children of the container as an array of 3d objects
 ObjectContainer3D
    containerData : ContainerData
Returns the the data container being used by the loaded file.
 Object3DLoader
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
    handle : Object3D
[read-only] Returns a 3d object relating to the currently visible model.
 Object3DLoader
  (^) inverseSceneTransform : Matrix3D
Object3D
    materialLibrary : MaterialLibrary
Returns the material library being used by the loaded file.
 Object3DLoader
  (^) maxX : Number
Returns the maximum x value of the 3d object
 ObjectContainer3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 ObjectContainer3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 ObjectContainer3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 ObjectContainer3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 ObjectContainer3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 ObjectContainer3D
    mode : String
Returns the current loading mode of the 3d object loader.
 Object3DLoader
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
    parse : Function
Function placeholder for the parse method from the correct file loader class.
 Object3DLoader
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    texturePath : String
Returns the filepath to the directory where any required texture files are located.
 Object3DLoader
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    url : String
Returns the url string of the file being loaded.
 Object3DLoader
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Object3DLoader
(init:Object = null)
Creates a new Object3DLoader object.
 Object3DLoader
  (^)
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
  (^)
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
   
addOnError(listener:Function):void
Default method for adding a loaderror event listener
 Object3DLoader
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
   
addOnSuccess(listener:Function):void
Default method for adding a loadsuccess event listener
 Object3DLoader
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
   
removeOnError(listener:Function):void
Default method for removing a loaderror event listener
 Object3DLoader
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
   
removeOnSuccess(listener:Function):void
Default method for removing a loadsuccess event listener
 Object3DLoader
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 ObjectContainer3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
   
onComplete(event:Event):void
Automatically fired on a complete event
 Object3DLoader
   
onError(event:IOErrorEvent):void
Automatically fired on an error event.
 Object3DLoader
   
onProgress(event:ProgressEvent):void
Automatically fired on a progress event
 Object3DLoader
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
   
loaderror
 Dispatched when the 3d object loader fails to load a file. Object3DLoader
   
loadsuccess
 Dispatched when the 3d object loader completes a file load successfully. Object3DLoader
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Public Constants
  Constant Defined by
    LOADING_GEOMETRY : String = "loading_geometry"
Constant value string representing the geometry loading mode of the 3d object loader.
 Object3DLoader
    LOADING_TEXTURES : String = "loading_textures"
Constant value string representing the texture loading mode of the 3d object loader.
 Object3DLoader
Property detail
containerData property
public var containerData:ContainerData

Returns the the data container being used by the loaded file.

handle property  
handle:Object3D  [read-only]

Returns a 3d object relating to the currently visible model. While a file is being loaded, this takes the form of the 3d object loader placeholder. The default placeholder is CubeLoader Once the file has been loaded and is ready to view, the handle returns the parsed 3d object file and the placeholder object is swapped in the scenegraph tree.

Implementation
    public function get handle():Object3D

See also

away3d.loaders.CubeLoader
materialLibrary property  
public var materialLibrary:MaterialLibrary

Returns the material library being used by the loaded file.

mode property  
public var mode:String

Returns the current loading mode of the 3d object loader.

parse property  
public var parse:Function

Function placeholder for the parse method from the correct file loader class.

texturePath property  
public var texturePath:String

Returns the filepath to the directory where any required texture files are located.

url property  
public var url:String

Returns the url string of the file being loaded.

Constructor detail
Object3DLoader () constructor
public function Object3DLoader(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
addOnError () method
public function addOnError(listener:Function):void

Default method for adding a loaderror event listener

Parameters
listener:Function - The listener function
addOnSuccess () method  
public function addOnSuccess(listener:Function):void

Default method for adding a loadsuccess event listener

Parameters
listener:Function - The listener function
onComplete () method  
protected function onComplete(event:Event):void

Automatically fired on a complete event

Parameters
event:Event
onError () method  
protected function onError(event:IOErrorEvent):void

Automatically fired on an error event.

Parameters
event:IOErrorEvent

See also

away3d.loaders.utils.TextureLoadQueue
onProgress () method  
protected function onProgress(event:ProgressEvent):void

Automatically fired on a progress event

Parameters
event:ProgressEvent
removeOnError () method  
public function removeOnError(listener:Function):void

Default method for removing a loaderror event listener

Parameters
listener:Function - The listener function
removeOnSuccess () method  
public function removeOnSuccess(listener:Function):void

Default method for removing a loadsuccess event listener

Parameters
listener:Function - The listener function
Event detail
loaderror event 
Event object type: away3d.events.LoaderEvent

Dispatched when the 3d object loader fails to load a file.

loadsuccess event   
Event object type: away3d.events.LoaderEvent

Dispatched when the 3d object loader completes a file load successfully.

Constant detail
LOADING_GEOMETRY constant
public const LOADING_GEOMETRY:String = "loading_geometry"

Constant value string representing the geometry loading mode of the 3d object loader.

LOADING_TEXTURES constant  
public const LOADING_TEXTURES:String = "loading_textures"

Constant value string representing the texture loading mode of the 3d object loader.

Wiki link
Click to go to the wiki page for 'away3d.loaders.Object3DLoader'

Code examples

Clone a loaded Obj

var loader:Object3DLoader = Obj.load("ship.obj",
{material:"shiptex_04", name:"fighter", scaling:0.1, y:0, x:0, z:0,
loadersize:300});
// add the loader object to the scene
//
view.scene.addChild(loader);
//
//loader.position = new Number3D(0, 0, 0);
//
//
loader.addOnSuccess(onLoaderSuccess);
function onLoaderSuccess(event:Event):void {
var fighter:Object3D = loader.handle.clone();
view.scene.addChild(fighter);
fighter.position = new Number3D(300, 0, 300);
}

*Lesson_Basic_12_Animation.fla

//ogre.md2 can be downloaded here:
//http://www.away3d.com/download/ogre.zip

// import core library
import away3d.core.scene.*;
// import file format loaders
import away3d.loaders.*;

import away3d.core.mesh.*;


// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
// add viewport to the stage
addChild(view);

// start mesh loading
var loader:Object3DLoader = Md2.load("resources/ogre.md2", {material:"turtle_texture", name:"turtle", scaling:0.1, y:50, x:10, z:10, loadersize:300});

// add the loader object to the scene
view.scene.addChild(loader);

loader.addOnSuccess(onLoaderSuccess);
function onLoaderSuccess(event:Event):void {
//    (loader.result as Mesh).frame = "crattack002";
//    (loader.result as Mesh).play({prefix:"stand", fps:12});
(loader.result as Mesh).play({prefix:"run", smooth:true, loop:true, fps:12});
}

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate loader or mesh around Y-axis
loader.handle.rotationY = getTimer() / 100;

// rerender viewport on each frame
view.scene.updateTime();
view.render();
}

From Lesson_Basic_12_Animation.fla

Load a 3D file (like Md2 or OBJ)

import away3d.loaders.*;
var loader:Object3DLoader;

//loader = Obj.load("SeaTurtle.obj", {material:{bitmap:"turtle_texture", lighting:true}, name:"turtle", scaling:1, y:50, x:0, z:0, rotationX:-90, loadersize:300});//load OBJ

loader = Md2.load("tris.md2", {material:{bitmap:"turtle_texture", lighting:true}, name:"turtle", scaling:1, y:50, x:0, z:0, rotationX:-90, loadersize:300});//load MD2

*Lesson_Basic_03_Meshes.fla

// import core library
import away3d.core.scene.*;
// import file format loaders
import away3d.loaders.*;

// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
// add viewport to the stage
addChild(view);

// start mesh loading
var loader:Object3DLoader = Obj.load("resources/turtle.obj", {material:"turtle_texture", name:"turtle", scaling:0.1, y:50, x:10, z:10, rotationX:-90, loadersize:300});
// add the loader object to the scene
view.scene.addChild(loader);

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate loader or mesh around Y-axis
loader.handle.rotationY = getTimer() / 100;

// rerender viewport on each frame
view.render();
}

From Lesson_Basic_03_Meshes.fla


ObjectContainer3D

Package away3d.containers
Class public class ObjectContainer3D
Inheritance ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Subclasses DebugObjectContainer3D, LODObject, Object3DLoader, Scene3D, Trident
3d object container node for other 3d objects in a scene
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
    boundingRadius : Number
[read-only] Returns the bounding radius of the 3d object
 ObjectContainer3D
    children : Array
[read-only] Returns the children of the container as an array of 3d objects
 ObjectContainer3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
    maxX : Number
[read-only] Returns the maximum x value of the 3d object
 ObjectContainer3D
    maxY : Number
[read-only] Returns the maximum y value of the 3d object
 ObjectContainer3D
    maxZ : Number
[read-only] Returns the maximum z value of the 3d object
 ObjectContainer3D
    minX : Number
[read-only] Returns the minimum x value of the 3d object
 ObjectContainer3D
    minY : Number
[read-only] Returns the minimum y value of the 3d object
 ObjectContainer3D
    minZ : Number
[read-only] Returns the minimum z value of the 3d object
 ObjectContainer3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
ObjectContainer3D
(init:Object = null, ... childarray)
Creates a new ObjectContainer3D object
 ObjectContainer3D
   
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
   
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
   
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
   
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
   
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
   
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
   
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
   
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 ObjectContainer3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
boundingRadius property
boundingRadius:Number  [read-only]

Returns the bounding radius of the 3d object

Implementation
    public function get boundingRadius():Number
children property  
children:Array  [read-only]

Returns the children of the container as an array of 3d objects

Implementation
    public function get children():Array
maxX property  
maxX:Number  [read-only]

Returns the maximum x value of the 3d object

Implementation
    public function get maxX():Number
maxY property  
maxY:Number  [read-only]

Returns the maximum y value of the 3d object

Implementation
    public function get maxY():Number
maxZ property  
maxZ:Number  [read-only]

Returns the maximum z value of the 3d object

Implementation
    public function get maxZ():Number
minX property  
minX:Number  [read-only]

Returns the minimum x value of the 3d object

Implementation
    public function get minX():Number
minY property  
minY:Number  [read-only]

Returns the minimum y value of the 3d object

Implementation
    public function get minY():Number
minZ property  
minZ:Number  [read-only]

Returns the minimum z value of the 3d object

Implementation
    public function get minZ():Number
Constructor detail
ObjectContainer3D () constructor
public function ObjectContainer3D(init:Object = null, ... childarray)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties
 
... childarray - An array of 3d objects to be added as children of the container on instatiation
Method detail
addChild () method
public function addChild(child:Object3D):void

Adds a 3d object to the scene as a child of the container

Parameters
child:Object3D - The 3d object to be added

Throws
- ObjectContainer3D.addChild(null)
addChildren () method  
public function addChildren(... childarray):void

Adds an array of 3d objects to the scene as children of the container

Parameters
... childarray - An array of 3d objects to be added
clone () method  
public override function clone(object:* = null):*

Duplicates the 3d object's properties to another ObjectContainer3D object

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied
Returns
* - The new object instance with duplicated properties applied
getChildByName () method  
public function getChildByName(name:String):Object3D

Returns a 3d object specified by name from the child array of the container

Parameters
name:String - The name of the 3d object to be returned
Returns
Object3D - The 3d object, or null if no such child object exists with the specified name
movePivot () method  
public function movePivot(dx:Number, dy:Number, dz:Number):void

Moves the origin point of the 3d object without moving the contents

Parameters
dx:Number - The amount of movement along the local x axis
 
dy:Number - The amount of movement along the local y axis
 
dz:Number - The amount of movement along the local z axis
removeChild () method  
public function removeChild(child:Object3D):void

Removes a 3d object from the child array of the container

Parameters
child:Object3D - The 3d object to be removed

Throws
- ObjectContainer3D.removeChild(null)
removeChildByName () method  
public function removeChildByName(name:String):void

Removes a 3d object from the child array of the container

Parameters
name:String - The name of the 3d object to be removed
scale () method  
public override function scale(scale:Number):void

Scales the contents of the 3d object.

Parameters
scale:Number - The scaling value
traverse () method  
public override function traverse(traverser:Traverser):void

Used when traversing the scenegraph

Parameters
traverser:Traverser - The traverser object
Wiki link
Click to go to the wiki page for 'away3d.containers.ObjectContainer3D'

Code examples

Using ObjectContainer3D (groups)

groupA=new ObjectContainer3D(objA,objB,objC);
//adds three objects to one group

*Lesson_Basic_04_Containers.fla

// import core library
import away3d.core.scene.*;
// import geometry primitives
import away3d.objects.*;

// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
// add viewport to the stage
addChild(view);

// create carousel elements
var plane:Object3D = new RegularPolygon({material:"grey#white", radius:500, y:-100, pushback:true});

var sphere1:Object3D = new Sphere({material:"blue#cyan", radius:50, y:75});
var sphere2:Object3D = new Sphere({material:"blue.jpg", radius:50, y:-75});

var cube1:Object3D = new Cube({material:"green#lime", y:75});
var cube2:Object3D = new Cube({material:"green.jpg", y:-75});

var spheres:Object3D = new ObjectContainer3D({x:400}, sphere1, sphere2);
var cubes:Object3D = new ObjectContainer3D({x:-400}, cube1, cube2);
var torus1:Object3D = new Torus({material:"red.jpg", z:-400});
var torus2:Object3D = new Torus({material:"yellow.jpg", z:400});

// create carousel of the elements
var carousel:Object3D = new ObjectContainer3D(spheres, cubes, torus1, torus2, plane);

// add carousel to the scene
view.scene.addChild(carousel);

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate carousel
carousel.rotationY = getTimer() / 100;

// rotate pairs
spheres.rotationZ = getTimer() / 10;
cubes.rotationX = getTimer() / 10;

// lift tori
torus1.y = Math.sin(getTimer() / 1000) * 50;
torus2.y = Math.cos(getTimer() / 1000) * 50;

// rerender viewport
view.render();
}

From Lesson_Basic_04_Containers.fla


ObjectData

Package away3d.loaders.data
Class public class ObjectData
Subclasses ContainerData, MeshData
Data class for a gneric 3d object
Public Properties
  Property Defined by
    name : String
The name of the 3d object used as a unique reference.
 ObjectData
    transform : Matrix3D
The 3d transformation matrix for the 3d object
 ObjectData
Property detail
name property
public var name:String

The name of the 3d object used as a unique reference.

transform property  
public var transform:Matrix3D

The 3d transformation matrix for the 3d object

Wiki link
Click to go to the wiki page for 'away3d.loaders.data.ObjectData'

Code examples
There are currently no examples for this class

Panel

Package away3d.test
Class public class Panel
Inheritance Panel -> flash.display.Shape
Simple rounded rectangle panel
Public Methods
  Method Defined by
   
Panel
(x:int, y:int, width:int, height:int, alpha:Number = 0.3)
 Panel
Constructor detail
Panel () constructor
public function Panel(x:int, y:int, width:int, height:int, alpha:Number = 0.3)
Parameters
x:int
 
y:int
 
width:int
 
height:int
 
alpha:Number (default = 0.3)
Wiki link
Click to go to the wiki page for 'away3d.test.Panel'

Code examples
There are currently no examples for this class

PhongBitmapMaterial

Package away3d.materials
Class public class PhongBitmapMaterial
Inheritance PhongBitmapMaterial -> CompositeMaterial
Bitmap material with phong shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
  (^) blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
  (^) color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 PhongBitmapMaterial
    specular : Number
Coefficient for specular light level.
 PhongBitmapMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Method Defined by
   
PhongBitmapMaterial
(bitmap:BitmapData, init:Object = null)
Creates a new PhongBitmapMaterial object.
 PhongBitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 CompositeMaterial
Property detail
shininess property
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
PhongBitmapMaterial () constructor
public function PhongBitmapMaterial(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
  shininess:Number (default = 20)
  specular:Number (default = 0.7, min:0, max:1)
Wiki link
Click to go to the wiki page for 'away3d.materials.PhongBitmapMaterial'

Code examples
There are currently no examples for this class

PhongBitmapMaterialCache

Package away3d.materials
Class public class PhongBitmapMaterialCache
Inheritance PhongBitmapMaterialCache -> BitmapMaterialContainer -> BitmapMaterial -> flash.events.EventDispatcher
Bitmap material with cached phong shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) cache : Boolean
Defines whether each created bitmapData surface is to be cached, or updated every frame.
 BitmapMaterialContainer
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 BitmapMaterialContainer
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 PhongBitmapMaterialCache
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
    specular : Number
Coefficient for specular light level.
 PhongBitmapMaterialCache
  (^) 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
  Method Defined by
   
PhongBitmapMaterialCache
(bitmap:BitmapData, init:Object = null)
Creates a new PhongBitmapMaterial object.
 PhongBitmapMaterialCache
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 BitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 BitmapMaterialContainer
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 BitmapMaterial
  (^)
update():void
Clear and updates the currrent bitmapData surface on all faces.
 BitmapMaterialContainer
  (^)
updateMaterial(source:Object3D, view:View3D):void
Creates a new BitmapMaterialContainer object.
 BitmapMaterialContainer
Protected Methods
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 BitmapMaterialContainer
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterialContainer
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
shininess property
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
PhongBitmapMaterialCache () constructor
public function PhongBitmapMaterialCache(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
  shininess:Number (default = 20)
  specular:Number (default = 0.7, min:0, max:1)
Wiki link
Click to go to the wiki page for 'away3d.materials.PhongBitmapMaterialCache'

Code examples
There are currently no examples for this class

PhongColorMaterial

Package away3d.materials
Class public class PhongColorMaterial
Inheritance PhongColorMaterial -> CompositeMaterial
Color material with phong shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
  (^) blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
  (^) color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 PhongColorMaterial
    specular : Number
Coefficient for specular light level.
 PhongColorMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Method Defined by
   
PhongColorMaterial
(color:*, init:Object = null)
Creates a new PhongBitmapMaterial object.
 PhongColorMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
   
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 PhongColorMaterial
Property detail
shininess property
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
PhongColorMaterial () constructor
public function PhongColorMaterial(color:*, init:Object = null)
Parameters
color:* - 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
  shininess:Number (default = 20)
  specular:Number (default = 0.7, min:0, max:1)
Method detail
setColorTransform () method
protected override function setColorTransform():void

Updates the colortransform object applied to the texture from the color and alpha properties.

See also

away3d.materials.CompositeMaterial.color
away3d.materials.CompositeMaterial.alpha
Wiki link
Click to go to the wiki page for 'away3d.materials.PhongColorMaterial'

Code examples
There are currently no examples for this class

PhongColorMaterialCache

Package away3d.materials
Class public class PhongColorMaterialCache
Inheritance PhongColorMaterialCache -> BitmapMaterialContainer -> BitmapMaterial -> flash.events.EventDispatcher
Color material with cached phong shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) cache : Boolean
Defines whether each created bitmapData surface is to be cached, or updated every frame.
 BitmapMaterialContainer
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 BitmapMaterialContainer
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 PhongColorMaterialCache
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
    specular : Number
Coefficient for specular light level.
 PhongColorMaterialCache
  (^) 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
  Method Defined by
   
PhongColorMaterialCache
(color:*, init:Object = null)
Creates a new PhongColorMaterialCache object.
 PhongColorMaterialCache
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
  (^)
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 BitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 BitmapMaterialContainer
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 BitmapMaterial
  (^)
update():void
Clear and updates the currrent bitmapData surface on all faces.
 BitmapMaterialContainer
  (^)
updateMaterial(source:Object3D, view:View3D):void
Creates a new BitmapMaterialContainer object.
 BitmapMaterialContainer
Protected Methods
  Method Defined by
  (^)
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 BitmapMaterialContainer
   
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 PhongColorMaterialCache
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterialContainer
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
shininess property
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
PhongColorMaterialCache () constructor
public function PhongColorMaterialCache(color:*, init:Object = null)
Parameters
color:* - 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
  shininess:Number (default = 20)
  specular:Number (default = 0.7, min:0, max:1)
Method detail
setColorTransform () method
protected override function setColorTransform():void

Updates the colortransform object applied to the texture from the color and alpha properties.

See also

away3d.materials.BitmapMaterialContainer.color
away3d.materials.BitmapMaterialContainer.alpha
Wiki link
Click to go to the wiki page for 'away3d.materials.PhongColorMaterialCache'

Code examples
There are currently no examples for this class

PhongMovieMaterial

Package away3d.materials
Class public class PhongMovieMaterial
Inheritance PhongMovieMaterial -> CompositeMaterial
Animated movie material with phong shading.
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the layer container.
 CompositeMaterial
  (^) blendMode : String
Defines a blendMode value for the layer container.
 CompositeMaterial
  (^) color : uint
Defines a colored tint for the layer container.
 CompositeMaterial
  (^) materials : Array
An array of bitmapmaterial objects to be overlayed sequentially.
 CompositeMaterial
    shininess : Number
The exponential dropoff value used for specular highlights.
 PhongMovieMaterial
    specular : Number
Coefficient for specular light level.
 PhongMovieMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 CompositeMaterial
Protected Properties
  Method Defined by
   
PhongMovieMaterial
(movie:Sprite, init:Object = null)
Creates a new PhongMovieMaterial object.
 PhongMovieMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 CompositeMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CompositeMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CompositeMaterial
Protected Methods
  Method Defined by
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 CompositeMaterial
Property detail
shininess property
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
PhongMovieMaterial () constructor
public function PhongMovieMaterial(movie:Sprite, init:Object = null)
Parameters
movie:Sprite - The movieclip to be used as the material's texture.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  shininess:Number (default = 20)
  specular:Number (default = 0.7, min:0, max:1)
Wiki link
Click to go to the wiki page for 'away3d.materials.PhongMovieMaterial'

Code examples
There are currently no examples for this class

Plane

Package away3d.primitives
Class public class Plane
Inheritance Plane -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d plane primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the plane.
 Plane
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
    segmentsH : Number
Defines the number of vertical segments that make up the plane.
 Plane
    segmentsW : Number
Defines the number of horizontal segments that make up the plane.
 Plane
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
    width : Number
Defines the width of the plane.
 Plane
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the plane points use a yUp orientation (true) or a zUp orientation (false).
 Plane
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Plane
(init:Object = null)
Creates a new Plane object.
 Plane
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Plane
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 Plane
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
height:Number  [read-write]

Defines the height of the plane. Defaults to 100, or the height of the uv material (if one is applied).

Implementation
    public function get height():Number
    public function set height(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the plane. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the plane. Defaults to 1.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
width property  
width:Number  [read-write]

Defines the width of the plane. Defaults to 100, or the width of the uv material (if one is applied).

Implementation
    public function get width():Number
    public function set width(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the plane 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
Plane () constructor
public function Plane(init:Object = null)

Constructor for a plane object. The init object parameters are : 'width'/'height' defines the size of the plane, 'segments' defines the number of segments for width and height unless overriden, 'segmentsW' defines number segments the plane is split into horizontally and 'segmentsH' how many segments plane is split into vertically.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  width:Number (default = 0, min:0)
  height:Number (default = 0, min:0)
  segments:Int (default = 1, min:1)
  segmentsW:Int (default = segments, min:1)
  segmentsH:Int (default = segments, min:1)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(w:int, h:int):Vertex

Returns the vertex from a 2 dimensional representation of the plane's vertex array.
I=horizontal reference.
J=vertical reference.

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
Wiki link
Click to go to the wiki page for 'away3d.primitives.Plane'

Code examples

Creating a Plane

myPlaneA=new Plane({material:{bitmap:"turtle_texture"},width:500,height:500,segmentsW:3,segmentsH:3});
myPlaneA.rotationX=90;//to face forward

Plane3D

Package away3d.core.draw
Class public class Plane3D
Plane in 3D space
Public Properties
  Property Defined by
    a : Number
Plane3D
    b : Number
Plane3D
    c : Number
Plane3D
    d : Number
Plane3D
Public Methods
  Method Defined by
   
Plane3D
(a:Number, b:Number, c:Number, d:Number)
 Plane3D
   
distance(v:Vertex):Number
 Plane3D
   
from3points(v0:Vertex, v1:Vertex, v2:Vertex):Plane3D
[static]
 Plane3D
   
side(v:Vertex):Number
 Plane3D
Property detail
a property
public var a:Number
b property  
public var b:Number
c property  
public var c:Number
d property  
public var d:Number
Constructor detail
Plane3D () constructor
public function Plane3D(a:Number, b:Number, c:Number, d:Number)
Parameters
a:Number
 
b:Number
 
c:Number
 
d:Number
Method detail
distance () method
public function distance(v:Vertex):Number
Parameters
v:Vertex
Returns
Number
from3points () method  
public static function from3points(v0:Vertex, v1:Vertex, v2:Vertex):Plane3D
Parameters
v0:Vertex
 
v1:Vertex
 
v2:Vertex
Returns
Plane3D
side () method  
public function side(v:Vertex):Number
Parameters
v:Vertex
Returns
Number
Wiki link
Click to go to the wiki page for 'away3d.core.draw.Plane3D'

Code examples
There are currently no examples for this class

PointLight

Package away3d.core.light
Class public class PointLight
Inheritance PointLight -> LightPrimitive
Point light primitive
Public Properties
  Property Defined by
  (^) 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 : PointLight3D
A reference to the PointLight3D object used by the light primitive.
 PointLight
  (^) red : Number
Red component level.
 LightPrimitive
  (^) specular : Number
Coefficient for the specular light intensity.
 LightPrimitive
  (^) specularBitmap : BitmapData
Lightmap for specular intensity.
 LightPrimitive
    x : Number
The x coordinates of the PointLight3D object.
 PointLight
    y : Number
The y coordinates of the PointLight3D object.
 PointLight
    z : Number
The z coordinates of the PointLight3D object.
 PointLight
Property detail
light property
public var light:PointLight3D

A reference to the PointLight3D object used by the light primitive.

x property  
public var x:Number

The x coordinates of the PointLight3D object.

y property  
public var y:Number

The y coordinates of the PointLight3D object.

z property  
public var z:Number

The z coordinates of the PointLight3D object.

Wiki link
Click to go to the wiki page for 'away3d.core.light.PointLight'

Code examples
There are currently no examples for this class

PointLight3D

Package away3d.lights
Class public class PointLight3D
Inheritance PointLight3D -> Object3D -> flash.events.EventDispatcher
Implements IClonable, ILightProvider, IPrimitiveProvider
Lightsource that colors all shaded materials proportional to the dot product of the distance vector with the normal vector. The scalar value of the distance is used to calulate intensity using the inverse square law of attenuation.
Public Properties
  Property Defined by
  (^) 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.
 PointLight3D
  (^) 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.
 PointLight3D
    color : int
Defines the color of the light object.
 PointLight3D
    debug : Boolean
Toggles debug mode: light object is visualised in the scene.
 PointLight3D
    diffuse : Number
Defines a coefficient for the diffuse light intensity.
 PointLight3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    specular : Number
Defines a coefficient for the specular light intensity.
 PointLight3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
PointLight3D
(init:Object = null)
Creates a new PointLight3D object.
 PointLight3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
clone(object:* = null):*
Duplicates the light object's properties to another PointLight3D object
 PointLight3D
  (^)
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
Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object
 PointLight3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 PointLight3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
ambient property
public var ambient:Number

Defines a coefficient for the ambient light intensity.

brightness property  
public var brightness:Number

Defines a coefficient for the overall light intensity.

color property  
public var color:int

Defines the color of the light object.

debug property  
public var debug:Boolean

Toggles debug mode: light object is visualised in the scene.

diffuse property  
public var diffuse:Number

Defines a coefficient for the diffuse light intensity.

specular property  
public var specular:Number

Defines a coefficient for the specular light intensity.

Constructor detail
PointLight3D () constructor
public function PointLight3D(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 = 1)
  diffuse:Number (default = 1)
  specular:Number (default = 1)
  brightness:Number (default = 1)
  debug:Boolean (default = false)
Method detail
clone () method
public override function clone(object:* = null):*

Duplicates the light object's properties to another PointLight3D object

Parameters
object:* (default = null) - [optional] The new object instance into which all properties are copied
Returns
* - The new object instance with duplicated properties applied
light () method  
public function light(consumer:ILightConsumer):void

Called from the PrimitiveTraverser when passing LightPrimitive objects to the light consumer object

Parameters
consumer:ILightConsumer - The consumer instance.
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object
Wiki link
Click to go to the wiki page for 'away3d.lights.PointLight3D'

Code examples
There are currently no examples for this class

PrimitiveArray

Package away3d.core.draw
Class public class PrimitiveArray
Implements IPrimitiveConsumer
Array for storing drawing primitives.
Public Properties
  Property Defined by
    blockers : Array
[write-only] Defines the array of blocker primitives to be used on the drawing primitives.
 PrimitiveArray
    clip : Clipping
[write-only] Defines the clipping object to be used on the drawing primitives.
 PrimitiveArray
Public Methods
  Method Defined by
   
list():Array
A list of primitives that have been clipped and blocked.
 PrimitiveArray
   
primitive(pri:DrawPrimitive):void
Adds a drawing primitive to the primitive consumer
 PrimitiveArray
Property detail
blockers property
blockers:Array  [write-only]

Defines the array of blocker primitives to be used on the drawing primitives.

Implementation
    public function set blockers(value:Array):void
clip property  
clip:Clipping  [write-only]

Defines the clipping object to be used on the drawing primitives.

Implementation
    public function set clip(value:Clipping):void
Method detail
list () method
public function list():Array

A list of primitives that have been clipped and blocked.

Returns
Array - An array containing the primitives to be rendered.
primitive () method  
public function primitive(pri:DrawPrimitive):void

Adds a drawing primitive to the primitive consumer

Parameters
pri:DrawPrimitive - The drawing primitive to add.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.PrimitiveArray'

Code examples
There are currently no examples for this class

PrimitiveQuadrantTree

Package away3d.core.draw
Class public final class PrimitiveQuadrantTree
Implements IPrimitiveConsumer
Quadrant tree for storing drawing primitives
Public Properties
  Property Defined by
    clip : Clipping
Defines the clipping object to be used on the drawing primitives.
 PrimitiveQuadrantTree
Public Methods
  Method Defined by
   
get(pri:DrawPrimitive, ex:Object3D = null):Array
Returns an array containing all primiives overlapping the specifed primitive's quadrant.
 PrimitiveQuadrantTree
   
list():Array
A list of primitives that have been clipped.
 PrimitiveQuadrantTree
   
primitive(pri:DrawPrimitive):void
Adds a drawing primitive to the primitive consumer
 PrimitiveQuadrantTree
   
remove(pri:DrawPrimitive):void
removes a drawing primitive from the quadrant tree.
 PrimitiveQuadrantTree
   
render():void
Calls the render function on all primitives in the quadrant tree
 PrimitiveQuadrantTree
Property detail
clip property
clip:Clipping  [read-write]

Defines the clipping object to be used on the drawing primitives.

Implementation
    public function get clip():Clipping
    public function set clip(value:Clipping):void
Method detail
get () method
public function get(pri:DrawPrimitive, ex:Object3D = null):Array

Returns an array containing all primiives overlapping the specifed primitive's quadrant.

Parameters
pri:DrawPrimitive - The drawing primitive to check.
 
ex:Object3D (default = null) - [optional] Excludes primitives that are children of the 3d object.
Returns
Array - An array of drawing primitives.
list () method  
public function list():Array

A list of primitives that have been clipped.

Returns
Array - An array containing the primitives to be rendered.
primitive () method  
public function primitive(pri:DrawPrimitive):void

Adds a drawing primitive to the primitive consumer

Parameters
pri:DrawPrimitive - The drawing primitive to add.
remove () method  
public function remove(pri:DrawPrimitive):void

removes a drawing primitive from the quadrant tree.

Parameters
pri:DrawPrimitive - The drawing primitive to remove.
render () method  
public function render():void

Calls the render function on all primitives in the quadrant tree

Wiki link
Click to go to the wiki page for 'away3d.core.draw.PrimitiveQuadrantTree'

Code examples
There are currently no examples for this class

PrimitiveQuadrantTreeNode

Package away3d.core.draw
Class public final class PrimitiveQuadrantTreeNode
Quadrant tree node
Public Properties
  Property Defined by
    center : Array
Array of primitives that lie in the center of the quadrant.
 PrimitiveQuadrantTreeNode
    create : Function
Placeholder function for creating new quadrant node from a cache of objects.
 PrimitiveQuadrantTreeNode
    leftbottom : PrimitiveQuadrantTreeNode
The quadrant tree node for the bottom left quadrant.
 PrimitiveQuadrantTreeNode
    leftbottomFlag : Boolean
Determines if the bounds of the bottom left quadrant need re-calculating.
 PrimitiveQuadrantTreeNode
    lefttop : PrimitiveQuadrantTreeNode
The quadrant tree node for the top left quadrant.
 PrimitiveQuadrantTreeNode
    lefttopFlag : Boolean
Determines if the bounds of the top left quadrant need re-calculating.
 PrimitiveQuadrantTreeNode
    onlysource : Object3D
hold the 3d object referenced when onlysourceFlag is true.
 PrimitiveQuadrantTreeNode
    onlysourceFlag : Boolean = true
Determines if the quadrant node contains only one source.
 PrimitiveQuadrantTreeNode
    parent : PrimitiveQuadrantTreeNode
The quadrant parent.
 PrimitiveQuadrantTreeNode
    rightbottom : PrimitiveQuadrantTreeNode
The quadrant tree node for the bottom right quadrant.
 PrimitiveQuadrantTreeNode
    rightbottomFlag : Boolean
Determines if the bounds of the bottom right quadrant need re-calculating.
 PrimitiveQuadrantTreeNode
    righttop : PrimitiveQuadrantTreeNode
The quadrant tree node for the top right quadrant.
 PrimitiveQuadrantTreeNode
    righttopFlag : Boolean
Determines if the bounds of the top right quadrant need re-calculating.
 PrimitiveQuadrantTreeNode
    xdiv : Number
The x coordinate of the quadrant division.
 PrimitiveQuadrantTreeNode
    ydiv : Number
The x coordinate of the quadrant division.
 PrimitiveQuadrantTreeNode
Public Methods
  Method Defined by
   
PrimitiveQuadrantTreeNode
(xdiv:Number, ydiv:Number, width:Number, height:Number, level:int, parent:PrimitiveQuadrantTreeNode = null)
Creates a new PrimitiveQuadrantTreeNode object.
 PrimitiveQuadrantTreeNode
   
push(pri:DrawPrimitive):void
Adds a primitive to the quadrant
 PrimitiveQuadrantTreeNode
   
render(limit:Number):void
Sorts and renders the contents of the quadrant tree
 PrimitiveQuadrantTreeNode
   
reset(xdiv:Number, ydiv:Number, width:Number, height:Number):void
Clears the quadrant of all primitives and child nodes
 PrimitiveQuadrantTreeNode
Property detail
center property
public var center:Array

Array of primitives that lie in the center of the quadrant.

create property  
public var create:Function

Placeholder function for creating new quadrant node from a cache of objects. Saves recreating objects and GC problems.

leftbottom property  
public var leftbottom:PrimitiveQuadrantTreeNode

The quadrant tree node for the bottom left quadrant.

leftbottomFlag property  
public var leftbottomFlag:Boolean

Determines if the bounds of the bottom left quadrant need re-calculating.

lefttop property  
public var lefttop:PrimitiveQuadrantTreeNode

The quadrant tree node for the top left quadrant.

lefttopFlag property  
public var lefttopFlag:Boolean

Determines if the bounds of the top left quadrant need re-calculating.

onlysource property  
public var onlysource:Object3D

hold the 3d object referenced when onlysourceFlag is true.

onlysourceFlag property  
public var onlysourceFlag:Boolean = true

Determines if the quadrant node contains only one source.

parent property  
public var parent:PrimitiveQuadrantTreeNode

The quadrant parent.

rightbottom property  
public var rightbottom:PrimitiveQuadrantTreeNode

The quadrant tree node for the bottom right quadrant.

rightbottomFlag property  
public var rightbottomFlag:Boolean

Determines if the bounds of the bottom right quadrant need re-calculating.

righttop property  
public var righttop:PrimitiveQuadrantTreeNode

The quadrant tree node for the top right quadrant.

righttopFlag property  
public var righttopFlag:Boolean

Determines if the bounds of the top right quadrant need re-calculating.

xdiv property  
public var xdiv:Number

The x coordinate of the quadrant division.

ydiv property  
public var ydiv:Number

The x coordinate of the quadrant division.

Constructor detail
PrimitiveQuadrantTreeNode () constructor
public function PrimitiveQuadrantTreeNode(xdiv:Number, ydiv:Number, width:Number, height:Number, level:int, parent:PrimitiveQuadrantTreeNode = null)
Parameters
xdiv:Number - The x coordinate for the division between left and right child quadrants.
 
ydiv:Number - The y coordinate for the division between top and bottom child quadrants.
 
width:Number - The width of the quadrant node.
 
height:Number - The height of the quadrant node.
 
level:int - The iteration number of the quadrant node.
 
parent:PrimitiveQuadrantTreeNode (default = null) - The parent quadrant of the quadrant node.
Method detail
push () method
public function push(pri:DrawPrimitive):void

Adds a primitive to the quadrant

Parameters
pri:DrawPrimitive
render () method  
public function render(limit:Number):void

Sorts and renders the contents of the quadrant tree

Parameters
limit:Number
reset () method  
public function reset(xdiv:Number, ydiv:Number, width:Number, height:Number):void

Clears the quadrant of all primitives and child nodes

Parameters
xdiv:Number
 
ydiv:Number
 
width:Number
 
height:Number
Wiki link
Click to go to the wiki page for 'away3d.core.draw.PrimitiveQuadrantTreeNode'

Code examples
There are currently no examples for this class

PrimitiveTraverser

Package away3d.core.traverse
Class public class PrimitiveTraverser
Inheritance PrimitiveTraverser -> Traverser
Traverser that gathers drawing primitives to render the scene.
Public Properties
  Property Defined by
    consumer : IPrimitiveConsumer
Defines the primitive consumer being used.
 PrimitiveTraverser
    session : AbstractRenderSession
Defines the render session being used.
 PrimitiveTraverser
Public Methods
  Method Defined by
   
PrimitiveTraverser
()
Creates a new PrimitiveTraverser object.
 PrimitiveTraverser
   
apply(node:Object3D):void
Executed when the traverser is applied to the node.
 PrimitiveTraverser
   
enter(node:Object3D):void
Executed when the traverser enters the node.
 PrimitiveTraverser
   
leave(node:Object3D):void
Executed when the traverser leaves the node.
 PrimitiveTraverser
   
match(node:Object3D):Boolean
Determines if the specified node is required to be traversed.
 PrimitiveTraverser
Property detail
consumer property
public var consumer:IPrimitiveConsumer

Defines the primitive consumer being used.

session property  
session:AbstractRenderSession  [read-write]

Defines the render session being used.

Implementation
    public function get session():AbstractRenderSession
    public function set session(value:AbstractRenderSession):void
Constructor detail
PrimitiveTraverser () constructor
public function PrimitiveTraverser()
Method detail
apply () method
public override function apply(node:Object3D):void

Executed when the traverser is applied to the node.

Parameters
node:Object3D
enter () method  
public override function enter(node:Object3D):void

Executed when the traverser enters the node.

Parameters
node:Object3D
leave () method  
public override function leave(node:Object3D):void

Executed when the traverser leaves the node.

Parameters
node:Object3D
match () method  
public override function match(node:Object3D):Boolean

Determines if the specified node is required to be traversed.

Parameters
node:Object3D - The 3d object to be tested.
Returns
Boolean - The result of the test.
Wiki link
Click to go to the wiki page for 'away3d.core.traverse.PrimitiveTraverser'

Code examples
There are currently no examples for this class

PrimitiveVolumeBlock

Package away3d.core.draw
Class public class PrimitiveVolumeBlock
Implements IPrimitiveConsumer
Volume block tree for storing drawing primitives
Public Properties
  Property Defined by
    clip : Clipping
Defines the clipping object to be used on the drawing primitives.
 PrimitiveVolumeBlock
Public Methods
  Method Defined by
   
blocks():Array
A list of volume blocks contained in the scene.
 PrimitiveVolumeBlock
   
getTouching(target:PrimitiveVolumeBlockNode):Array
 PrimitiveVolumeBlock
   
list():Array
A list of primitives that have been clipped.
 PrimitiveVolumeBlock
   
primitive(pri:DrawPrimitive):void
Adds a drawing primitive to the primitive consumer
 PrimitiveVolumeBlock
   
remove(pri:DrawPrimitive):void
removes a drawing primitive from the volume block.
 PrimitiveVolumeBlock
Property detail
clip property
clip:Clipping  [read-write]

Defines the clipping object to be used on the drawing primitives.

Implementation
    public function get clip():Clipping
    public function set clip(value:Clipping):void
Method detail
blocks () method
public function blocks():Array

A list of volume blocks contained in the scene.

Returns
Array - An array containing all volume blocks in the scene.
getTouching () method  
public function getTouching(target:PrimitiveVolumeBlockNode):Array
Parameters
target:PrimitiveVolumeBlockNode
Returns
Array
list () method  
public function list():Array

A list of primitives that have been clipped.

Returns
Array - An array containing the primitives to be rendered.
primitive () method  
public function primitive(pri:DrawPrimitive):void

Adds a drawing primitive to the primitive consumer

Parameters
pri:DrawPrimitive - The drawing primitive to add.
remove () method  
public function remove(pri:DrawPrimitive):void

removes a drawing primitive from the volume block.

Parameters
pri:DrawPrimitive - The drawing primitive to remove.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.PrimitiveVolumeBlock'

Code examples
There are currently no examples for this class

PrimitiveVolumeBlockNode

Package away3d.core.draw
Class public class PrimitiveVolumeBlockNode
Volume block tree node
Public Properties
  Property Defined by
    list : Array
The list of drawing primitives inside the volume block.
 PrimitiveVolumeBlockNode
    maxX : Number
Returns the maximum x value of the drawing primitives contained in the volume block node.
 PrimitiveVolumeBlockNode
    maxY : Number
Returns the maximum y value of the drawing primitives contained in the volume block node.
 PrimitiveVolumeBlockNode
    maxZ : Number
Returns the maximum z value of the drawing primitives contained in the volume block node.
 PrimitiveVolumeBlockNode
    minX : Number = Infinity
Returns the minimum x value of the drawing primitives contained in the volume block node.
 PrimitiveVolumeBlockNode
    minY : Number = Infinity
Returns the minimum y value of the drawing primitives contained in the volume block node.
 PrimitiveVolumeBlockNode
    minZ : Number = Infinity
Returns the minimum z value of the drawing primitives contained in the volume block node.
 PrimitiveVolumeBlockNode
    source : Object3D
Reference to the 3d object represented by the volume block node.
 PrimitiveVolumeBlockNode
Public Methods
  Method Defined by
   
PrimitiveVolumeBlockNode
(source:Object3D)
Creates a new PrimitiveQuadrantTreeNode object.
 PrimitiveVolumeBlockNode
   
push(pri:DrawPrimitive):void
Adds a primitive to the volume block
 PrimitiveVolumeBlockNode
   
remove(pri:DrawPrimitive):void
Removes a primitive from the volume block
 PrimitiveVolumeBlockNode
Property detail
list property
public var list:Array

The list of drawing primitives inside the volume block.

maxX property  
public var maxX:Number

Returns the maximum x value of the drawing primitives contained in the volume block node.

maxY property  
public var maxY:Number

Returns the maximum y value of the drawing primitives contained in the volume block node.

maxZ property  
public var maxZ:Number

Returns the maximum z value of the drawing primitives contained in the volume block node.

minX property  
public var minX:Number = Infinity

Returns the minimum x value of the drawing primitives contained in the volume block node.

minY property  
public var minY:Number = Infinity

Returns the minimum y value of the drawing primitives contained in the volume block node.

minZ property  
public var minZ:Number = Infinity

Returns the minimum z value of the drawing primitives contained in the volume block node.

source property  
public var source:Object3D

Reference to the 3d object represented by the volume block node.

Constructor detail
PrimitiveVolumeBlockNode () constructor
public function PrimitiveVolumeBlockNode(source:Object3D)
Parameters
source:Object3D - A reference to the 3d object represented by the volume block node.
Method detail
push () method
public function push(pri:DrawPrimitive):void

Adds a primitive to the volume block

Parameters
pri:DrawPrimitive
remove () method  
public function remove(pri:DrawPrimitive):void

Removes a primitive from the volume block

Parameters
pri:DrawPrimitive
Wiki link
Click to go to the wiki page for 'away3d.core.draw.PrimitiveVolumeBlockNode'

Code examples
There are currently no examples for this class

Projection

Package away3d.core.render
Class public class Projection
Data object for camera transform, focus and zoom properties.
Public Properties
  Property Defined by
    focus : Number
Defines the focus for the camera object being used by the view.
 Projection
    time : int
Defines the unique timestamp for the view render.
 Projection
    view : Matrix3D
Defines the current view transform matrix that resolves the transformation tree.
 Projection
    zoom : Number
Defines the zoom for the camera object being used by the view.
 Projection
Public Methods
  Method Defined by
   
Projection
()
Creates a new Projection object.
 Projection
Property detail
focus property
public var focus:Number

Defines the focus for the camera object being used by the view.

time property  
public var time:int

Defines the unique timestamp for the view render.

view property  
public var view:Matrix3D

Defines the current view transform matrix that resolves the transformation tree.

zoom property  
public var zoom:Number

Defines the zoom for the camera object being used by the view.

Constructor detail
Projection () constructor
public function Projection()
Wiki link
Click to go to the wiki page for 'away3d.core.render.Projection'

Code examples
There are currently no examples for this class

ProjectionTraverser

Package away3d.core.traverse
Class public class ProjectionTraverser
Inheritance ProjectionTraverser -> Traverser
Traverser that resolves the transform tree in a scene, ready for rendering.
Public Properties
  Property Defined by
    view : View3D
Defines the view being used.
 ProjectionTraverser
Public Methods
  Method Defined by
   
ProjectionTraverser
()
Creates a new ProjectionTraverser object.
 ProjectionTraverser
  (^)
apply(node:Object3D):void
Executed when the traverser is applied to the node.
 Traverser
   
enter(node:Object3D):void
Executed when the traverser enters the node.
 ProjectionTraverser
  (^)
leave(node:Object3D):void
Executed when the traverser leaves the node.
 Traverser
   
match(node:Object3D):Boolean
Determines if the specified node is required to be traversed.
 ProjectionTraverser
Property detail
view property
view:View3D  [read-write]

Defines the view being used.

Implementation
    public function get view():View3D
    public function set view(value:View3D):void
Constructor detail
ProjectionTraverser () constructor
public function ProjectionTraverser()
Method detail
enter () method
public override function enter(node:Object3D):void

Executed when the traverser enters the node.

Parameters
node:Object3D
match () method  
public override function match(node:Object3D):Boolean

Determines if the specified node is required to be traversed.

Parameters
node:Object3D - The 3d object to be tested.
Returns
Boolean - The result of the test.
Wiki link
Click to go to the wiki page for 'away3d.core.traverse.ProjectionTraverser'

Code examples
There are currently no examples for this class

QuadrantRenderer

Package away3d.core.render
Class public class QuadrantRenderer
Implements IRenderer
Renderer that uses quadrant tree for storing and operating drawing primitives. Quadrant tree speeds up all proximity based calculations.
Public Properties
  Property Defined by
    session : AbstractRenderSession
Defines the render session object used by the renderer.
 QuadrantRenderer
Public Methods
  Method Defined by
   
QuadrantRenderer
(... filters)
Creates a new QuadrantRenderer object.
 QuadrantRenderer
   
render(view:View3D):Array
Executes the render pipe that resolves the 3d scene into the view.
 QuadrantRenderer
   
toString():String
Used to trace the values of a renderer.
 QuadrantRenderer
Property detail
session property
session:AbstractRenderSession  [read-write]

Defines the render session object used by the renderer.

Implementation
    public function get session():AbstractRenderSession
    public function set session(value:AbstractRenderSession):void
Constructor detail
QuadrantRenderer () constructor
public function QuadrantRenderer(... filters)
Parameters
... filters - [optional] An array of filters to use on projected drawing primitives before rendering them to screen.
Method detail
render () method
public function render(view:View3D):Array

Executes the render pipe that resolves the 3d scene into the view.

Parameters
view:View3D
Returns
Array
toString () method  
public function toString():String

Used to trace the values of a renderer.

Returns
String - A string representation of the renderer object.
Wiki link
Click to go to the wiki page for 'away3d.core.render.QuadrantRenderer'

Code examples
There are currently no examples for this class

QuadrantRiddleFilter

Package away3d.core.filter
Class public class QuadrantRiddleFilter
Implements IPrimitiveQuadrantFilter
Splits all intersecting triangles and line segments.
Public Methods
  Method Defined by
   
QuadrantRiddleFilter
(maxdelay:int = 60000)
Creates a new QuadrantRiddleFilter object.
 QuadrantRiddleFilter
   
filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void
Applies the filter to the quadrant tree.
 QuadrantRiddleFilter
   
toString():String
Used to trace the values of a filter.
 QuadrantRiddleFilter
Constructor detail
QuadrantRiddleFilter () constructor
public function QuadrantRiddleFilter(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
filter () method
public function filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void

Applies the filter to the quadrant tree.

Parameters
pritree:PrimitiveQuadrantTree - The quadrant tree to be filtered.
 
scene:Scene3D - The scene to which the quadrant tree belongs.
 
camera:Camera3D - The camera being used in the renderer for the quadrant tree
 
clip:Clipping - The clipping object used in the renderer for the quadrant tree's view.
toString () method  
public function toString():String

Used to trace the values of a filter.

Returns
String - A string representation of the filter object.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.QuadrantRiddleFilter'

Code examples
There are currently no examples for this class

Quaternion

Package away3d.core.math
Class public final class Quaternion
A Quaternion object.
Public Properties
  Property Defined by
    magnitude : Number
[read-only] Returns the magnitude of the quaternion object.
 Quaternion
    w : Number
The w value of the quatertion.
 Quaternion
    x : Number
The x value of the quatertion.
 Quaternion
    y : Number
The y value of the quatertion.
 Quaternion
    z : Number
The z value of the quatertion.
 Quaternion
Public Methods
  Method Defined by
   
axis2quaternion(x:Number, y:Number, z:Number, angle:Number):void
Fills the quaternion object with values representing the given rotation around a vector.
 Quaternion
   
euler2quaternion(ax:Number, ay:Number, az:Number):void
Fills the quaternion object with values representing the given euler rotation.
 Quaternion
   
multiply(qa:Quaternion, qb:Quaternion):void
Fills the quaternion object with the result from a multipication of two quaternion objects.
 Quaternion
   
normalize(val:Number = 1):void
Normalises the quaternion object.
 Quaternion
   
toString():String
Used to trace the values of a quaternion.
 Quaternion
Property detail
magnitude property
magnitude:Number  [read-only]

Returns the magnitude of the quaternion object.

Implementation
    public function get magnitude():Number
w property  
public var w:Number

The w value of the quatertion.

x property  
public var x:Number

The x value of the quatertion.

y property  
public var y:Number

The y value of the quatertion.

z property  
public var z:Number

The z value of the quatertion.

Method detail
axis2quaternion () method
public function axis2quaternion(x:Number, y:Number, z:Number, angle:Number):void

Fills the quaternion object with values representing the given rotation around a vector.

Parameters
x:Number - The x value of the rotation vector.
 
y:Number - The y value of the rotation vector.
 
z:Number - The z value of the rotation vector.
 
angle:Number - The angle in radians of the rotation.
euler2quaternion () method  
public function euler2quaternion(ax:Number, ay:Number, az:Number):void

Fills the quaternion object with values representing the given euler rotation.

Parameters
ax:Number - The angle in radians of the rotation around the x axis.
 
ay:Number - The angle in radians of the rotation around the y axis.
 
az:Number - The angle in radians of the rotation around the z axis.
multiply () method  
public function multiply(qa:Quaternion, qb:Quaternion):void

Fills the quaternion object with the result from a multipication of two quaternion objects.

Parameters
qa:Quaternion - The first quaternion in the multipication.
 
qb:Quaternion - The second quaternion in the multipication.
normalize () method  
public function normalize(val:Number = 1):void

Normalises the quaternion object.

Parameters
val:Number (default = 1)
toString () method  
public function toString():String

Used to trace the values of a quaternion.

Returns
String - A string representation of the quaternion object.
Wiki link
Click to go to the wiki page for 'away3d.core.math.Quaternion'

Code examples
There are currently no examples for this class

RectangleClipping

Package away3d.core.clip
Class public class RectangleClipping
Inheritance RectangleClipping -> Clipping
Rectangle clipping
Public Properties
  Property Defined by
  (^) maxX : Number = 1000000
Maximum allowed x value for primitives
 Clipping
  (^) maxY : Number = 1000000
Maximum allowed y value for primitives
 Clipping
  (^) minX : Number = -1000000
Minimum allowed x value for primitives
 Clipping
  (^) minY : Number = -1000000
Minimum allowed y value for primitives
 Clipping
Public Methods
  Method Defined by
   
RectangleClipping
(minX:Number = -1000000, minY:Number = -1000000, maxX:Number = 1000000, maxY:Number = 1000000)
 RectangleClipping
   
asRectangleClipping():RectangleClipping
Returns a rectangle clipping object representing the bounding box of the clipping object.
 RectangleClipping
   
check(pri:DrawPrimitive):Boolean
Checks a drawing primitive for clipping.
 RectangleClipping
   
rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean
Checks a bounding rectangle for clipping.
 RectangleClipping
  (^)
screen(container:Sprite):Clipping
Returns a rectangle 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.
 RectangleClipping
Constructor detail
RectangleClipping () constructor
public function RectangleClipping(minX:Number = -1000000, minY:Number = -1000000, maxX:Number = 1000000, maxY:Number = 1000000)
Parameters
minX:Number (default = -1000000)
 
minY:Number (default = -1000000)
 
maxX:Number (default = 1000000)
 
maxY:Number (default = 1000000)
Method detail
asRectangleClipping () method
public override function asRectangleClipping():RectangleClipping

Returns a rectangle clipping object representing the bounding box of the clipping object.

Returns
RectangleClipping
check () method  
public override function check(pri:DrawPrimitive):Boolean

Checks a drawing primitive for clipping.

Parameters
pri:DrawPrimitive - The drawing primitive being checked.
Returns
Boolean - The clipping result - false for clipped, true for non-clipped.
rect () method  
public override 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.
toString () method  
public function toString():String

Used to trace the values of a rectangle clipping object.

Returns
String - A string representation of the rectangle clipping object.
Wiki link
Click to go to the wiki page for 'away3d.core.clip.RectangleClipping'

Code examples
There are currently no examples for this class

RegularPolygon

Package away3d.primitives
Class public class RegularPolygon
Inheritance RegularPolygon -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a regular polygon.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the polygon.
 RegularPolygon
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    sides : Number
Defines the number of sides of the polygon.
 RegularPolygon
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
    subdivision : Number
Defines the subdivision of the polygon.
 RegularPolygon
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the polygon points use a yUp orientation (true) or a zUp orientation (false).
 RegularPolygon
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
RegularPolygon
(init:Object = null)
Creates a new RegularPolygon object.
 RegularPolygon
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 RegularPolygon
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
radius property
radius:Number  [read-write]

Defines the radius of the polygon. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
sides property  
sides:Number  [read-write]

Defines the number of sides of the polygon. Defaults to 8 (octohedron).

Implementation
    public function get sides():Number
    public function set sides(value:Number):void
subdivision property  
subdivision:Number  [read-write]

Defines the subdivision of the polygon. Defaults to 1.

Implementation
    public function get subdivision():Number
    public function set subdivision(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the polygon 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
RegularPolygon () constructor
public function RegularPolygon(init:Object = null)

Constructor for a regular polygon object. The init object parameters are : 'radius' defines the radius of the polygon, 'sections' determines the type of polygon created (e.g. 3=triangle, 4=square, 5=pentagon, etc) and 'mapping' which determines the method of UV material mapping to use.

Values for 'mapping' can be either 'rotate' or 'planar'.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  radius:Number (default = 100, min:0)
  sides:Int (default = 8, min:3)
  subdivision:Int (default = 1, min:1)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.RegularPolygon'

Code examples
There are currently no examples for this class

Renderer

Package away3d.core.render
Class public class Renderer
A static class for an easy access to the most useful renderers.
Public Properties
  Property Defined by
    BASIC : IRenderer
[static][read-only] Fastest and simplest renderer, useful for many applications.
 Renderer
    CORRECT_Z_ORDER : IRenderer
[static][read-only] Perform reordering of triangles after sorting to guarantee their correct rendering.
 Renderer
    INTERSECTING_OBJECTS : IRenderer
[static][read-only] Perform triangles splitting to correctly render scenes with intersecting objects.
 Renderer
Property detail
BASIC property
BASIC:IRenderer  [read-only]

Fastest and simplest renderer, useful for many applications.

Implementation
    public static function get BASIC():IRenderer

See also

away3d.core.render.BasicRenderer
CORRECT_Z_ORDER property  
CORRECT_Z_ORDER:IRenderer  [read-only]

Perform reordering of triangles after sorting to guarantee their correct rendering.

Implementation
    public static function get CORRECT_Z_ORDER():IRenderer

See also

away3d.core.render.QuadrantRenderer
away3d.core.render.AnotherRivalFilter
INTERSECTING_OBJECTS property  
INTERSECTING_OBJECTS:IRenderer  [read-only]

Perform triangles splitting to correctly render scenes with intersecting objects.

Implementation
    public static function get INTERSECTING_OBJECTS():IRenderer

See also

away3d.core.render.QuadrantRenderer
away3d.core.render.QuadrantRiddleFilter
away3d.core.render.AnotherRivalFilter
Wiki link
Click to go to the wiki page for 'away3d.core.render.Renderer'

Code examples

*Lesson_Intermediate_01_ZOrdering.fla

// import core library
import away3d.core.scene.*;
// import geometry primitives
import away3d.objects.*;
// import materials
import away3d.core.material.*;
// import mesh type
import away3d.core.mesh.*;
// import basic and correct-z-order renderers
import away3d.core.render.*;

// create a 3D-viewport. use BASIC renderer for now
var view:View3D = new View3D({x:300, y:200, renderer:Renderer.BASIC});
// add viewport to the stage
addChild(view);

// create scene
var cube:Mesh = new Cube({material:"grey#", size:400});
var cubetop:Object3D = new Cube({material:"yellow#", y:255});
var cubeleft:Object3D = new Cube({material:"cyan#", x:-255});
var cuberight:Object3D = new Cube({material:"green#", x:255});
var cubefront:Object3D = new Cube({material:"magenta#", z:-255});
var cubeback:Object3D = new Cube({material:"slateblue#", z:255});
var cubes:Object3D = new ObjectContainer3D(cube, cubetop, cubeleft, cuberight, cubefront, cubeback);
view.scene.addChild(cubes);

// what renderer do we use
var correctzorder:Boolean = false;

// register mouse event handler
cubes.addOnMouseDown(onCubesMouseDown);
function onCubesMouseDown(event:MouseEvent3D):void {
if (correctzorder)
{
// switch to basic renderer - just sort triangle by their centers
view.renderer = Renderer.BASIC;
cube.material = new WireColorMaterial("grey");
correctzorder = false;
}
else
{
// switch to correct-z-order renderer - reorder triangles after sorting
view.renderer = Renderer.CORRECT_Z_ORDER;
cube.material = new WireColorMaterial("white");
correctzorder = true;
}
}

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate cubes
cubes.rotationY = getTimer() / 100;
// rerender viewport
view.render();
}

From Lesson_Intermediate_01_ZOrdering.fla


Scene3D

Package away3d.containers
Class public class Scene3D
Inheritance Scene3D -> ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
The root container of all 3d objects in a single scene
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 ObjectContainer3D
  (^) children : Array
Returns the children of the container as an array of 3d objects
 ObjectContainer3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 ObjectContainer3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 ObjectContainer3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 ObjectContainer3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 ObjectContainer3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 ObjectContainer3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 ObjectContainer3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
    parent : ObjectContainer3D
Cannot parent a Scene3D object
 Scene3D
    physics : IPhysicsScene
Interface for physics (not implemented)
 Scene3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
    sceneTransform : Matrix3D
[read-only] Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Scene3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    tickTraverser : TickTraverser
Traverser object for all custom tick() methods
 Scene3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Scene3D
(init:Object = null, ... objects)
Creates a new Scene3D object
 Scene3D
  (^)
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
  (^)
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 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
   
updateTime(time:int = -1):void
Calling manually will update 3d objects that execute updates on their tick() methods.
 Scene3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
parent property
parent:ObjectContainer3D  [read-write]

Cannot parent a Scene3D object

Implementation
    public function get parent():ObjectContainer3D
    public function set parent(value:ObjectContainer3D):void
Throws
- Scene can't be parented
physics property  
public var physics:IPhysicsScene

Interface for physics (not implemented)

sceneTransform property  
sceneTransform:Matrix3D  [read-only]

Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.

Implementation
    public function get sceneTransform():Matrix3D
tickTraverser property  
public var tickTraverser:TickTraverser

Traverser object for all custom tick() methods

See also

away3d.core.base.Object3D.tick()
Constructor detail
Scene3D () constructor
public function Scene3D(init:Object = null, ... objects)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties
 
... objects - An array of 3d objects to be added as children on instatiation
Init Parameters
  physics:Object
Method detail
updateTime () method
public function updateTime(time:int = -1):void

Calling manually will update 3d objects that execute updates on their tick() methods. Uses the TickTraverser to traverse all tick methods in the scene.

Parameters
time:int (default = -1)

See also

away3d.core.base.Object3D.tick()
away3d.core.traverse.TickTraverser
Wiki link
Click to go to the wiki page for 'away3d.containers.Scene3D'

Code examples
There are currently no examples for this class

ScreenVertex

Package away3d.core.draw
Class public final class ScreenVertex
representation of a 3d vertex resolved to the view.
Public Properties
  Property Defined by
    num : Number
A numbder containing user defined properties.
 ScreenVertex
    visible : Boolean
Indicates whether the vertex is visible after projection.
 ScreenVertex
    x : Number
The x position of the vertex in the view.
 ScreenVertex
    y : Number
The y position of the vertex in the view.
 ScreenVertex
    z : Number
The z position of the vertex in the view.
 ScreenVertex
Public Methods
  Method Defined by
   
ScreenVertex
(x:Number = 0, y:Number = 0, z:Number = 0)
Creates a new PrimitiveQuadrantTreeNode object.
 ScreenVertex
   
deperspective(focus:Number):Vertex
Converts a screen vertex back to a vertex object.
 ScreenVertex
   
distance(b:ScreenVertex):Number
Calculates the distance between two screen vertex objects.
 ScreenVertex
   
distanceSqr(b:ScreenVertex):Number
Calculates the squared distance between two screen vertex objects.
 ScreenVertex
   
distortSqr(b:ScreenVertex, focus:Number):Number
Calculates affine distortion present at the midpoint between two screen vertex objects.
 ScreenVertex
   
median(a:ScreenVertex, b:ScreenVertex, focus:Number):ScreenVertex
[static] Returns the median screen vertex between the two given screen vertex objects.
 ScreenVertex
   
toString():String
Used to trace the values of a vertex.
 ScreenVertex
   
weighted(a:ScreenVertex, b:ScreenVertex, aw:Number, bw:Number, focus:Number):ScreenVertex
[static] Returns a screen vertex with values given by a weighted mean calculation.
 ScreenVertex
Property detail
num property
public var num:Number

A numbder containing user defined properties.

visible property  
public var visible:Boolean

Indicates whether the vertex is visible after projection.

x property  
public var x:Number

The x position of the vertex in the view.

y property  
public var y:Number

The y position of the vertex in the view.

z property  
public var z:Number

The z position of the vertex in the view.

Constructor detail
ScreenVertex () constructor
public function ScreenVertex(x:Number = 0, y:Number = 0, z:Number = 0)
Parameters
x:Number (default = 0) - [optional] The x position of the vertex in the view. Defaults to 0.
 
y:Number (default = 0) - [optional] The y position of the vertex in the view. Defaults to 0.
 
z:Number (default = 0) - [optional] The z position of the vertex in the view. Defaults to 0.
Method detail
deperspective () method
public function deperspective(focus:Number):Vertex

Converts a screen vertex back to a vertex object.

Parameters
focus:Number - The focus value to use for deperspective calulations.
Returns
Vertex - The deperspectived vertex object.
distance () method  
public function distance(b:ScreenVertex):Number

Calculates the distance between two screen vertex objects.

Parameters
b:ScreenVertex - The second screen vertex object to use for the calcation.
Returns
Number - The scalar value of the vector between this and the given screen vertex.
distanceSqr () method  
public function distanceSqr(b:ScreenVertex):Number

Calculates the squared distance between two screen vertex objects.

Parameters
b:ScreenVertex - The screen vertex object to use for the calcation.
Returns
Number - The squared scalar value of the vector between this and the given scren vertex.
distortSqr () method  
public function distortSqr(b:ScreenVertex, focus:Number):Number

Calculates affine distortion present at the midpoint between two screen vertex objects.

Parameters
b:ScreenVertex - The second screen vertex object to use for the calcation.
 
focus:Number - The focus value used for the distortion calulations.
Returns
Number - The scalar value of the vector between this and the given screen vertex.
median () method  
public static function median(a:ScreenVertex, b:ScreenVertex, focus:Number):ScreenVertex

Returns the median screen vertex between the two given screen vertex objects.

Parameters
a:ScreenVertex - The first screen vertex to use for the calculation.
 
b:ScreenVertex - The second screen vertex to use for the calculation.
 
focus:Number - The focus value used for the median calulations.
Returns
ScreenVertex - The resulting screen vertex.
toString () method  
public function toString():String

Used to trace the values of a vertex.

Returns
String - A string representation of the vertex object.
weighted () method  
public static function weighted(a:ScreenVertex, b:ScreenVertex, aw:Number, bw:Number, focus:Number):ScreenVertex

Returns a screen vertex with values given by a weighted mean calculation.

Parameters
a:ScreenVertex - The first screen vertex to use for the calculation.
 
b:ScreenVertex - The second screen vertex to use for the calculation.
 
aw:Number - The first screen vertex weighting.
 
bw:Number - The second screen vertex weighting.
 
focus:Number - The focus value used for the weighting calulations.
Returns
ScreenVertex - The resulting screen vertex.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.ScreenVertex'

Code examples
There are currently no examples for this class

SeaTurtle

Package away3d.primitives
Class public class SeaTurtle
Inheritance SeaTurtle -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a sea turtle model (exported using asAS3Class).

See also

away3d.core.Mesh.asAS3Class()
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
SeaTurtle
(init:Object = null)
 SeaTurtle
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
SeaTurtle () constructor
public function SeaTurtle(init:Object = null)

Constructor for the sea turtle object.

Parameters
init:Object (default = null)
Wiki link
Click to go to the wiki page for 'away3d.primitives.SeaTurtle'

Code examples
There are currently no examples for this class

Segment

Package away3d.core.base
Class public class Segment
Inheritance Segment -> BaseMeshElement -> flash.events.EventDispatcher
A line element used in the wiremesh and mesh object

See also

away3d.core.base.WireMesh
away3d.core.base.Mesh
Public Properties
  Property Defined by
    extra : Object
An optional untyped object that can contain used-defined properties.
 Segment
    material : ISegmentMaterial
Defines the material of the segment.
 Segment
    maxX : Number
[read-only] Returns the maximum x value of the segment
 Segment
    maxY : Number
[read-only] Returns the maximum y value of the segment
 Segment
    maxZ : Number
[read-only] Returns the maximum z value of the segment
 Segment
    minX : Number
[read-only] Returns the minimum x value of the face
 Segment
    minY : Number
[read-only] Returns the minimum y value of the face
 Segment
    minZ : Number
[read-only] Returns the minimum y value of the face
 Segment
    parent : BaseMesh
Defines the parent 3d object of the segment.
 Segment
    radius2 : Number
[read-only] Returns the squared bounding radius of the face.
 Segment
    v0 : Vertex
Defines the v0 vertex of the segment.
 Segment
    v1 : Vertex
Defines the v1 vertex of the segment.
 Segment
    vertices : Array
[read-only] Returns an array of vertex objects that are used by the segment.
 Segment
  (^) visible : Boolean
Defines whether the 3d element is visible in the scene.
 BaseMeshElement
Public Methods
  Method Defined by
   
Segment
(v0:Vertex, v1:Vertex, material:ISegmentMaterial = null)
Creates a new Face object.
 Segment
   
addOnMaterialChange(listener:Function):void
Default method for adding a materialchanged event listener
 Segment
  (^)
addOnVertexChange(listener:Function):void
Default method for adding a vertexchanged event listener
 BaseMeshElement
  (^)
addOnVertexValueChange(listener:Function):void
Default method for adding a vertexvaluechanged event listener
 BaseMeshElement
  (^)
addOnVisibleChange(listener:Function):void
Default method for adding a visiblechanged event listener
 BaseMeshElement
   
removeOnMaterialChange(listener:Function):void
Default method for removing a materialchanged event listener
 Segment
  (^)
removeOnVertexChange(listener:Function):void
Default method for removing a vertexchanged event listener
 BaseMeshElement
  (^)
removeOnVertexValueChange(listener:Function):void
Default method for removing a vertexvaluechanged event listener
 BaseMeshElement
  (^)
removeOnVisibleChange(listener:Function):void
Default method for removing a visiblechanged event listener
 BaseMeshElement
Events
  Event Summary Defined by
   
materialchanged
 Dispatched when the material of the segment changes. Segment
  (^)
vertexchanged
 Dispatched when the vertex of a 3d element changes. BaseMeshElement
  (^)
vertexvaluechanged
 Dispatched when the vertex value of a 3d element changes. BaseMeshElement
  (^)
visiblechanged
 Dispatched when the visiblity of a 3d element changes. BaseMeshElement
Property detail
extra property
public var extra:Object

An optional untyped object that can contain used-defined properties.

material property  
material:ISegmentMaterial  [read-write]

Defines the material of the segment.

Implementation
    public function get material():ISegmentMaterial
    public function set material(value:ISegmentMaterial):void
maxX property  
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]

Returns the maximum y value of the segment

Implementation
    public function get maxY():Number

See also

maxZ property  
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]

Returns the minimum x value of the face

Implementation
    public function get minX():Number

See also

minY property  
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]

Returns the minimum y value of the face

Implementation
    public function get minZ():Number

See also

parent property  
public var parent:BaseMesh

Defines the parent 3d object of the segment.

radius2 property  
radius2:Number  [read-only]

Returns the squared bounding radius of the face.

Implementation
    public function get radius2():Number
v0 property  
v0:Vertex  [read-write]

Defines the v0 vertex of the segment.

Implementation
    public function get v0():Vertex
    public function set v0(value:Vertex):void
v1 property  
v1:Vertex  [read-write]

Defines the v1 vertex of the segment.

Implementation
    public function get v1():Vertex
    public function set v1(value:Vertex):void
vertices property  
vertices:Array  [read-only]

Returns an array of vertex objects that are used by the segment.

Implementation
    public function get vertices():Array
Constructor detail
Segment () constructor
public function Segment(v0:Vertex, v1:Vertex, material:ISegmentMaterial = null)
Parameters
v0:Vertex - [optional] An initialisation object for specifying default instance properties
 
v1:Vertex
 
material:ISegmentMaterial (default = null)
Method detail
addOnMaterialChange () method
public function addOnMaterialChange(listener:Function):void

Default method for adding a materialchanged event listener

Parameters
listener:Function - The listener function
removeOnMaterialChange () method  
public function removeOnMaterialChange(listener:Function):void

Default method for removing a materialchanged event listener

Parameters
listener:Function - The listener function
Event detail
materialchanged event 
Event object type: away3d.events.FaceEvent

Dispatched when the material of the segment changes.

Wiki link
Click to go to the wiki page for 'away3d.core.base.Segment'

Code examples
There are currently no examples for this class

SegmentEvent

Package away3d.events
Class public class SegmentEvent
Inheritance SegmentEvent -> flash.events.Event
Passed as a parameter when a segment event occurs
Public Properties
  Property Defined by
    segment : Segment
A reference to the segment object that is relevant to the event.
 SegmentEvent
Public Methods
  Method Defined by
   
SegmentEvent
(type:String, segment:Segment)
Creates a new SegmentEvent object.
 SegmentEvent
   
clone():Event
Creates a copy of the SegmentEvent object and sets the value of each property to match that of the original.
 SegmentEvent
Public Constants
  Constant Defined by
    MATERIAL_CHANGED : String = "materialchanged"
[static] Defines the value of the type property of a materialchanged event object.
 SegmentEvent
Property detail
segment property
public var segment:Segment

A reference to the segment object that is relevant to the event.

Constructor detail
SegmentEvent () constructor
public function SegmentEvent(type:String, segment:Segment)
Parameters
type:String - The type of the event. Possible values are: SegmentEvent.MATERIAL_CHANGED.
 
segment:Segment - A reference to the segment object that is relevant to the event.
Method detail
clone () method
public override function clone():Event

Creates a copy of the SegmentEvent object and sets the value of each property to match that of the original.

Returns
Event
Constant detail
MATERIAL_CHANGED constant
public static const MATERIAL_CHANGED:String = "materialchanged"

Defines the value of the type property of a materialchanged event object.

Wiki link
Click to go to the wiki page for 'away3d.events.SegmentEvent'

Code examples
There are currently no examples for this class

SegmentsExtrude

Package away3d.extrusions
Class public class SegmentsExtrude
Inheritance SegmentsExtrude -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
SegmentsExtrude
(aPoints:*, init:Object = null)
 SegmentsExtrude
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
SegmentsExtrude () constructor
public function SegmentsExtrude(aPoints:*, init:Object = null)

Class generate an extrusion from a series of Number3D

Parameters
aPoints:*
 
init:Object (default = null)
Wiki link
Click to go to the wiki page for 'away3d.extrusions.SegmentsExtrude'

Code examples
There are currently no examples for this class

ShadingColorMaterial

Package away3d.materials
Class public class ShadingColorMaterial
Inheritance ShadingColorMaterial -> CenterLightingMaterial -> flash.events.EventDispatcher
Color material with flat shading.
Public Properties
  Property Defined by
  (^) ak : Number = 20
Coefficient for shininess level
 CenterLightingMaterial
    alpha : Number
Defines an alpha value for the texture.
 ShadingColorMaterial
    ambient : int
Defines a color value for ambient light.
 ShadingColorMaterial
  (^) ambient_brightness : Number = 1
Coefficient for ambient light level
 CenterLightingMaterial
    cache : Boolean
Defines whether the resulting shaded color of the surface should be cached.
 ShadingColorMaterial
    diffuse : int
Defines a color value for diffuse light.
 ShadingColorMaterial
  (^) diffuse_brightness : Number = 1
Coefficient for diffuse light level
 CenterLightingMaterial
    specular : int
Defines a color value for specular light.
 ShadingColorMaterial
  (^) specular_brightness : Number = 1
Coefficient for specular light level
 CenterLightingMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 ShadingColorMaterial
Protected Properties
  Method Defined by
   
ShadingColorMaterial
(color:* = null, init:Object = null)
Creates a new ShadingColorMaterial object.
 ShadingColorMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CenterLightingMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CenterLightingMaterial
Protected Methods
  Method Defined by
   
renderTri(tri:DrawTriangle, session:AbstractRenderSession, kar:Number, kag:Number, kab:Number, kdr:Number, kdg:Number, kdb:Number, ksr:Number, ksg:Number, ksb:Number):void
 ShadingColorMaterial
Property detail
alpha property
public var alpha:Number

Defines an alpha value for the texture.

ambient property  
public var ambient:int

Defines a color value for ambient light.

cache property  
public var cache:Boolean

Defines whether the resulting shaded color of the surface should be cached.

diffuse property  
public var diffuse:int

Defines a color value for diffuse light.

specular property  
public var specular:int

Defines a color value for specular light.

visible property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
Constructor detail
ShadingColorMaterial () constructor
public function ShadingColorMaterial(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
  ambient:Color (default = color)
  diffuse:Color (default = color)
  specular:Color (default = color)
  alpha:Number (default = 1)
  cache:Boolean (default = false)
Method detail
renderTri () method
protected override function renderTri(tri:DrawTriangle, session:AbstractRenderSession, kar:Number, kag:Number, kab:Number, kdr:Number, kdg:Number, kdb:Number, ksr:Number, ksg:Number, ksb:Number):void
Parameters
tri:DrawTriangle
 
session:AbstractRenderSession
 
kar:Number
 
kag:Number
 
kab:Number
 
kdr:Number
 
kdg:Number
 
kdb:Number
 
ksr:Number
 
ksg:Number
 
ksb:Number
Wiki link
Click to go to the wiki page for 'away3d.materials.ShadingColorMaterial'

Code examples
There are currently no examples for this class

SkinExtrude

Package away3d.extrusions
Class public class SkinExtrude
Inheritance SkinExtrude -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
SkinExtrude
(aPoints:*, init:Object = null)
 SkinExtrude
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
SkinExtrude () constructor
public function SkinExtrude(aPoints:*, init:Object = null)
Parameters
aPoints:*
 
init:Object (default = null)
Wiki link
Click to go to the wiki page for 'away3d.extrusions.SkinExtrude'

Code examples
There are currently no examples for this class

Skybox

Package away3d.primitives
Class public class Skybox
Inheritance Skybox -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
QTVR-style 360 panorama renderer that is initialized with six images. A skybox contains six sides that are arranged like the inside of a cube.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Skybox
(front:ITriangleMaterial, left:ITriangleMaterial, back:ITriangleMaterial, right:ITriangleMaterial, up:ITriangleMaterial, down:ITriangleMaterial)
Creates a new Skybox object.
 Skybox
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
Skybox () constructor
public function Skybox(front:ITriangleMaterial, left:ITriangleMaterial, back:ITriangleMaterial, right:ITriangleMaterial, up:ITriangleMaterial, down:ITriangleMaterial)

Constructor for a sky box object used to provide background imagery for the full scene whatever the camera rotation. Each parameter defines a material that maps on to the box to create impresssion of sky, floor and 360 degree horizon.

Parameters
front:ITriangleMaterial - The material to use for the skybox front.
 
left:ITriangleMaterial - The material to use for the skybox left.
 
back:ITriangleMaterial - The material to use for the skybox back.
 
right:ITriangleMaterial - The material to use for the skybox right.
 
up:ITriangleMaterial - The material to use for the skybox up.
 
down:ITriangleMaterial - The material to use for the skybox down.
Wiki link
Click to go to the wiki page for 'away3d.primitives.Skybox'

Code examples
There are currently no examples for this class

Skybox6

Package away3d.primitives
Class public class Skybox6
Inheritance Skybox6 -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
QTVR-style 360 panorama renderer that is initialized with one solid image. A skybox contains six sides that are arranged like the inside of a cube.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Skybox6
(material:ITriangleMaterial)
Creates a new Skybox6 object.
 Skybox6
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
Skybox6 () constructor
public function Skybox6(material:ITriangleMaterial)

Constructor for a sky box 6 object used to provide background imagery for the full scene whatever the camera rotation. Unlike the SkyBox object, this object constructor only takes a single material parameter which defines the entire set of box panels in a single bitmap.

Parameters
material:ITriangleMaterial - The material to use for generating all six skybox sides.
Wiki link
Click to go to the wiki page for 'away3d.primitives.Skybox6'

Code examples
There are currently no examples for this class

Slide

Package away3d.test
Class public class Slide
Represents a single slide of the demo
Public Properties
  Property Defined by
    desc : String
Slide
    renderer : IRenderer
Slide
    scene : Scene3D
Slide
    session : AbstractRenderSession
Slide
    title : String
Slide
Public Methods
  Method Defined by
   
Slide
(title:String, desc:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession)
 Slide
Property detail
desc property
public var desc:String
renderer property  
public var renderer:IRenderer
scene property  
public var scene:Scene3D
session property  
public var session:AbstractRenderSession
title property  
public var title:String
Constructor detail
Slide () constructor
public function Slide(title:String, desc:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession)
Parameters
title:String
 
desc:String
 
scene:Scene3D
 
renderer:IRenderer
 
session:AbstractRenderSession
Wiki link
Click to go to the wiki page for 'away3d.test.Slide'

Code examples
There are currently no examples for this class

SpecularPhongShader

Package away3d.materials.shaders
Class public class SpecularPhongShader
Inheritance SpecularPhongShader -> AbstractShader -> flash.events.EventDispatcher
Specular shader class for directional lighting.

See also

away3d.lights.DirectionalLight3D
Public Properties
  Property Defined by
  (^) 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
    shininess : Number
The exponential dropoff value used for specular highlights.
 SpecularPhongShader
  (^) smooth : Boolean
Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen
 AbstractShader
    specular : Number
Coefficient for specular light level.
 SpecularPhongShader
  (^) visible : Boolean
Indicates whether the material is visible
 AbstractShader
Protected Properties
  Method Defined by
   
SpecularPhongShader
(init:Object = null)
Creates a new SpecularPhongShader object.
 SpecularPhongShader
  (^)
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 AbstractShader
   
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 SpecularPhongShader
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 SpecularPhongShader
Protected Methods
  Method Defined by
   
clearFaceDictionary(source:Object3D, view:View3D):void
Clears face value objects when shader requires updating
 SpecularPhongShader
  (^)
getLightingShape(layer:Sprite, light:LightPrimitive):Shape
Returns a shape object for use by light shaders
 AbstractShader
  (^)
getShape(layer:Sprite):Shape
Returns a shape object for use by environment shaders.
 AbstractShader
   
renderShader(face:Face):void
Renders the shader to the specified face.
 SpecularPhongShader
Property detail
shininess property
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 property  
specular:Number  [read-write]

Coefficient for specular light level.

Implementation
    public function get specular():Number
    public function set specular(value:Number):void
Constructor detail
SpecularPhongShader () constructor
public function SpecularPhongShader(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Method detail
clearFaceDictionary () method
protected override function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters
source:Object3D - The parent 3d object of the face.
 
view:View3D - The view rendering the draw triangle.
renderLayer () method  
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.
renderShader () method  
protected override function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters
face:Face - The face object being rendered.
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.shaders.SpecularPhongShader'

Code examples
There are currently no examples for this class

Sphere

Package away3d.primitives
Class public class Sphere
Inheritance Sphere -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d sphere primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the sphere.
 Sphere
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
    segmentsH : Number
Defines the number of vertical segments that make up the sphere.
 Sphere
    segmentsW : Number
Defines the number of horizontal segments that make up the sphere.
 Sphere
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the sphere points use a yUp orientation (true) or a zUp orientation (false).
 Sphere
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Sphere
(init:Object = null)
Creates a new Sphere object.
 Sphere
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Sphere
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 Sphere
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
radius property
radius:Number  [read-write]

Defines the radius of the sphere. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the sphere. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the sphere. Defaults to 8.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the sphere 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
Sphere () constructor
public function Sphere(init:Object = null)

Constructor for a sphere object.

The init object parameters are : 'radius' defines the radius of the sphere, 'segmentsW' defines the number of segments horizontally around the sphere and 'segmentsH' which defines number of segments vertically between the poles of the sphere.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  radius:Number (default = 100, min:0)
  segmentsW:Int (default = 8, min:3)
  segmentsH:Int (default = 6, min:2)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(w:int, h:int):Vertex

Returns the vertex from a 2 dimensional representation of the sphere's vertex array.
I=horizontal reference.
J=vertical reference (0 = base of the sphere)

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
Wiki link
Click to go to the wiki page for 'away3d.primitives.Sphere'

Code examples

How to couple Away and the Wow engine

package {

//Away3d
import away3d.objects.Plane;
import away3d.objects.Sphere;
import away3d.core.material.*;
import away3d.core.scene.*;
import away3d.core.render.*;
import away3d.core.math.Number3D;

//wow
import fr.seraf.wow.primitive.WSphere;
import fr.seraf.wow.core.WOWEngine;
import fr.seraf.wow.core.data.WVector;
import fr.seraf.wow.math.WVectorMath;
import fr.seraf.wow.primitive.WOWPlane;

//flash
import flash.events.Event;
import flash.display.Sprite;
import flash.display.BitmapData;
import flash.display.StageAlign;
import flash.display.StageScaleMode;
import flash.events.*;
//
public class AwayWow extends Sprite {

private var scene:Scene3D;
private var view:View3D;
private var zero:Number3D;

private var wow:WOWEngine;
private var sphereArray:Array;

public function AwayWow() {
setupStage();
setupAway();
setupWow();
createGround();
//we create 20 balls
sphereArray=new Array();
var ballCount:int=20;
while(ballCount--) {
createOneSphere(int(-500+Math.random()*1000),int(Math.random()*500+300),int(-500+Math.random()*1000) , int(Math.random()*50)+1);
}

// and we run the engines (away3d, wow-engine) each frame
addEventListener(Event.ENTER_FRAME, enterFrameHandler);
addEventListener(Event.RESIZE, onResize);

addEventListener(MouseEvent.MOUSE_DOWN, reset);

}

/**
* initial setup for the Swf Stage.
*/
public function setupStage(): void
{
stage.scaleMode = StageScaleMode.NO_SCALE;
stage.align = StageAlign.TOP_LEFT;
}

/**
* initial setup for Away3D.
*/
private function setupAway():void
{
zero = new Number3D(0,0,0);
scene = new Scene3D();
view = new View3D({scene:scene,  renderer:Renderer.BASIC});
view.x = stage.stageWidth * .5;
view.y = stage.stageHeight * .5;
view.camera.x = 0;
view.camera.y = 0;
view.camera.z = -2000;
addChild(view);
view.camera.lookAt(zero);
}
/**
* initial setup for WOW-Engine.
*/
public function setupWow(): void
{
//this is the physics engine
wow=new WOWEngine(.3);
wow.collisionResponseMode = wow.SELECTIVE;
//setup the gravity
wow.addMasslessForce(new WVector(0,6,0));
}
/**
*  create a ground
*/
public function createGround(): void
{
//we create a ground on the physics engine
var ground:WOWPlane = new WOWPlane(0,0,0);
ground.elasticity=0.6;
ground.friction=0.3;
wow.addParticle(ground);

// Away ground plane
var mat:BitmapMaterial = new BitmapMaterial(new BitmapData(256,256, false, 0x006699), {smooth:false, debug:true});
var plane:Plane = new Plane({material:mat , width:1000, height:1000, segmentsH:12, segmentsW:12} );
scene.addChild(plane);

}
/**
* create one Sphere for physics and one for rendering
*/
public function createOneSphere(x:int,y:int,z:int,radius:int): void
{
//we create a physics sphere the param is position x,y,z the radius, if it's fixed or not and the mass
var wowSphere:WSphere = new WSphere(x,y,z,radius,false,0.1);
wowSphere.elasticity=0.5;
wowSphere.friction=0.02;
wow.addParticle(wowSphere);

//Away Object starting by the material...
var mat:BitmapMaterial = new BitmapMaterial(new BitmapData(256,256, false, 0x999900), {smooth:false, debug:true});
var sphere:Sphere = new Sphere({material:mat , radius:radius, segmentsH:6, segmentsW:6} );
sphere.x=-wowSphere.px;
sphere.y=-wowSphere.py;
sphere.z=-wowSphere.pz;
scene.addChild(sphere);
//
sphereArray.push({physics:wowSphere,render:sphere});
}
private function enterFrameHandler( event : Event ):void
{
//we update the physics engine
wow.step()

// we link the  physics sphere to the rendered sphere
var ballCount:int=sphereArray.length;
var physics:WSphere;
var render:Sphere;
while(ballCount--){
physics = sphereArray[ballCount].physics;
render = sphereArray[ballCount].render;
render.x=physics.px;
render.y=-physics.py;
render.z=physics.pz;
}

//we update the 3d view
var procent = (mouseY/stage.stageHeight)*100;
var distance:Number = 2000-(mouseY*2);
view.camera.moveTo(zero);
var destx =  (view.y-(mouseX )) /2;
view.camera.y = (20*procent);
view.camera.rotationY = destx;
view.camera.moveBackward(distance);
view.camera.lookAt(zero);

view.render();
}

private function reset(event:MouseEvent):void
{
var ballCount:int=sphereArray.length;

var physics:WSphere;
var render:Sphere;
var nx:int;
var ny:int;
var nz:int;
while(ballCount--){
physics = sphereArray[ballCount].physics;
render = sphereArray[ballCount].render;
nx =  -200+Math.random()*400;
ny =  Math.random()*500+500;
nz =  -200+Math.random()*400;
render.x = physics.py = nx;
render.y = ny;
physics.py = -ny;
render.z = physics.pz = nz;

}
}

private function onResize(event:Event):void
{
this.view.x = stage.stageWidth *.5;
this.view.y = stage.stageHeight *.5;
}
}
}

Source Files : http://seraf.mediabox.fr/wow-engine/

SWF Example : http://www.closier.nl/playground/WoW_away.swf

Wow and polygonal labs libraries need to be installed as well.

Away3d HelloFlex.mxml

<!-- Sebastiaan Holtrop, the factore, www.tfe.nl -->
<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute">
<mx:Script>
<![CDATA[

import away3d.core.material.*;
import away3d.core.scene.*;
import away3d.objects.*;
import mx.core.UIComponent;

public var view:View3D;
public var sphere:Sphere;

public function createScene() {
this.view = new View3D({x:300, y:200});

var holderUI:UIComponent = new UIComponent();
this.addChild(holderUI);
holderUI.addChild(view);


this.sphere = new Sphere({material:"blue#cyan", radius:250, segmentsW:12, segmentsH:9, y:50, x:10, z:10});

this.view.scene.addChild(this.sphere);
this.view.camera.lookAt(this.sphere.position);

this.addEventListener(Event.ENTER_FRAME, onEnterFrame);

}

private function onEnterFrame(event:Event):void {
this.view.render();
this.sphere.rotationY += 5;
}

]]>
</mx:Script>

<mx:Button label="hello world" click="createScene();" />

</mx:Application>

Flex Example

*Lesson_Basic_01_HelloAway3D.fla

// import core library
import away3d.core.scene.*;
// import geometry primitives
import away3d.objects.*;

// create a 3D-viewport
var view:View3D = new View3D({x:300, y:200});
// add viewport to the stage
addChild(view);

// create a sphere
var sphere:Object3D = new Sphere({material:"blue#cyan", radius:250, segmentsW:12, segmentsH:9, y:50, x:10, z:10});
// add the sphere to the scene
view.scene.addChild(sphere);

// point camera at the sphere
view.camera.lookAt(sphere.position);

// every frame
addEventListener(Event.ENTER_FRAME, onEnterFrame);
function onEnterFrame(event:Event):void {
// rotate sphere around the Y-axis
sphere.rotationY = getTimer() / 100;
// rerender viewport on each frame
view.render();
}

From Lesson_Basic_01_HelloAway3D.fla

**HelloWorld.as

package {
import flash.display.*;
import flash.events.*;
import away3d.objects.*;
import away3d.core.scene.*;
import away3d.core.material.*;
public class HelloWorld extends Sprite {
var view:View3D;
var sphereA:Sphere;
function HelloWorld() {
stage.frameRate=60;
addEventListener(Event.ENTER_FRAME,away3dloop);
away3dcreate();
}
function away3dcreate():void {
addChild(view=new View3D({x:stage.stageWidth/2, y:stage.stageHeight/2}));
sphereA=new Sphere({material:new WireColorMaterial()});
view.scene.addChild(sphereA);
}
function away3dloop(event:Event):void {
view.camera.moveTo(sphereA.position);
view.camera.rotationY=mouseX/2;
view.camera.rotationX=mouseY/2;
view.camera.moveBackward(500);
sphereA.rotationY+=1;
view.render();
}
}
}
//sphereA=new Sphere({material:new WireColorMaterial(0xAA33DD),z:1, segmentsW:8,segmentsH:8,radius:100,x:0, bothsides:false});

Source Files : http://away3d.com/swfs/HelloWorld.html

SWF Example : http://away3d.com/swfs/HelloWorld.html

Right click on the purple ball in the SWF to see Stat window


Sprite2D

Package away3d.sprites
Class public class Sprite2D
Inheritance Sprite2D -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Spherical billboard (always facing the camera) sprite object that uses a bitmapData object as it's texture. Draws 2d images inline with z-sorted triangles in a scene.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    bitmap : BitmapData
Defines the bitmapData object to use for the sprite texture.
 Sprite2D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
    deltaZ : Number
An optional offset value added to the z depth used to sort the sprite
 Sprite2D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
    rotation : Number
Defines the overall 2d rotation of the sprite object
 Sprite2D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    scaling : Number
Defines the overall scaling of the sprite object
 Sprite2D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    smooth : Boolean
Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen
 Sprite2D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Sprite2D
(bitmap:BitmapData, init:Object = null)
Creates a new Sprite2D object.
 Sprite2D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 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
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Sprite2D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
bitmap property
public var bitmap:BitmapData

Defines the bitmapData object to use for the sprite texture.

deltaZ property  
public var deltaZ:Number

An optional offset value added to the z depth used to sort the sprite

rotation property  
public var rotation:Number

Defines the overall 2d rotation of the sprite object

scaling property  
public var scaling:Number

Defines the overall scaling of the sprite object

smooth property  
public var smooth:Boolean

Defines whether the texture bitmap is smoothed (bilinearly filtered) when drawn to screen

Constructor detail
Sprite2D () constructor
public function Sprite2D(bitmap:BitmapData, init:Object = null)
Parameters
bitmap:BitmapData - The bitmapData object to be used as the sprite's texture.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  scaling:Number (default = 1, min:0)
  rotation:Number (default = 0)
  smooth:Boolean (default = false)
  deltaZ:Number (default = 0)
Method detail
primitives () method
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawScaledBitmap
Wiki link
Click to go to the wiki page for 'away3d.sprites.Sprite2D'

Code examples
There are currently no examples for this class

SpriteRenderSession

Package away3d.core.render
Class public class SpriteRenderSession
Inheritance SpriteRenderSession -> AbstractRenderSession
Drawing session object that renders all drawing primitives into a Sprite container.
Public Properties
  Property Defined by
  (^) children : Dictionary
Dictionary of child displayobjects.
 AbstractRenderSession
  (^) graphics : Graphics
Reference to the current graphics object being used for drawing.
 AbstractRenderSession
  (^) lightarray : LightArray
Defines the light provider object for the render sesion.
 AbstractRenderSession
  (^) newLayer : Sprite
Holds the last added layer sprite.
 AbstractRenderSession
  (^) sessions : Dictionary
Dictionary of child sessions.
 AbstractRenderSession
  (^) spriteLayers : Array
Dictionary of sprite layers for rendering composite materials.
 AbstractRenderSession
    view : View3D
Defines the view object used for the render session.
 SpriteRenderSession
Public Methods
  Method Defined by
   
SpriteRenderSession
()
Creates a new SpriteRenderSession object.
 SpriteRenderSession
   
addDisplayObject(child:DisplayObject):void
Adds a display object to the render session display list.
 SpriteRenderSession
   
addLayerObject(child:Sprite):void
Adds a layer sprite to the render session display list.
 SpriteRenderSession
   
clear():void
Clears the render session.
 SpriteRenderSession
   
clone():AbstractRenderSession
Duplicates the render session's properties to another render session.
 SpriteRenderSession
   
flush():void
Flushes any cached drawing operations to screen.
 SpriteRenderSession
   
getContainer(view:View3D):DisplayObject
Returns a display object representing the container for the specified view.
 SpriteRenderSession
  (^)
registerChildSession(session:AbstractRenderSession):void
Adds a session as a child of the session object.
 AbstractRenderSession
  (^)
renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void
Draws a non-scaled bitmap into the graphics object.
 AbstractRenderSession
  (^)
renderFogColor(color:int, alpha:Number):void
Draws a fog element into the graphics object.
 AbstractRenderSession
  (^)
renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void
Draws a segment element into the graphics object.
 AbstractRenderSession
  (^)
renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void
Draws a bitmap with a precalculated matrix into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void
Draws a triangle element with a bitmap texture into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a triangle element with a fill color into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element into the graphics object.
 AbstractRenderSession
  (^)
renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void
Draws a wire triangle element with a fill color into the graphics object.
 AbstractRenderSession
Protected Methods
  Method Defined by
   
createLayer():void
Creates a new render layer for rendering composite materials.
 SpriteRenderSession
Property detail
view property
view:View3D  [read-write]

Defines the view object used for the render session.

Implementation
    public function get view():View3D
    public function set view(value:View3D):void
Constructor detail
SpriteRenderSession () constructor
public function SpriteRenderSession()
Method detail
addDisplayObject () method
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.
addLayerObject () method  
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.
clear () method  
public override function clear():void

Clears the render session.

clone () method  
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
createLayer () method  
protected override function createLayer():void

Creates a new render layer for rendering composite materials.

flush () method  
public override function flush():void

Flushes any cached drawing operations to screen.

getContainer () method  
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.
Wiki link
Click to go to the wiki page for 'away3d.core.render.SpriteRenderSession'

Code examples
There are currently no examples for this class

Stats

Package away3d.core.stats
Class public class Stats
Inheritance Stats -> flash.display.Sprite
Public Properties
  Property Defined by
    displayMenu : Sprite = null
Stats
    facecount : int
Stats
    geomMenu : Sprite = null
Stats
    scopeMenu : View3D = null
Stats
    sourceURL : String
Stats
    stats : String = ""
Stats
    type : String
Stats
    url : String
Stats
Public Methods
  Method Defined by
   
Stats
(scope:View3D, framerate:Number = 0)
 Stats
   
addObject(node:BaseMesh):void
 Stats
   
addSourceURL(url:String):void
 Stats
   
clearObjects():void
 Stats
   
displayStats(e:ContextMenuEvent):void
 Stats
   
updateStats(renderedfaces:int, camera:Camera3D):void
 Stats
   
viewSource(e:ContextMenuEvent):void
 Stats
   
visitWebsite(e:ContextMenuEvent):void
 Stats
Property detail
displayMenu property
public var displayMenu:Sprite = null
facecount property  
public var facecount:int
geomMenu property  
public var geomMenu:Sprite = null
scopeMenu property  
public var scopeMenu:View3D = null
sourceURL property  
public var sourceURL:String
stats property  
public var stats:String = ""
type property  
public var type:String
url property  
public var url:String
Constructor detail
Stats () constructor
public function Stats(scope:View3D, framerate:Number = 0)
Parameters
scope:View3D
 
framerate:Number (default = 0)
Method detail
addObject () method
public function addObject(node:BaseMesh):void
Parameters
node:BaseMesh
addSourceURL () method  
public function addSourceURL(url:String):void
Parameters
url:String
clearObjects () method  
public function clearObjects():void
displayStats () method  
public function displayStats(e:ContextMenuEvent):void
Parameters
e:ContextMenuEvent
updateStats () method  
public function updateStats(renderedfaces:int, camera:Camera3D):void
Parameters
renderedfaces:int
 
camera:Camera3D
viewSource () method  
public function viewSource(e:ContextMenuEvent):void
Parameters
e:ContextMenuEvent
visitWebsite () method  
public function visitWebsite(e:ContextMenuEvent):void
Parameters
e:ContextMenuEvent
Wiki link
Click to go to the wiki page for 'away3d.core.stats.Stats'

Code examples
There are currently no examples for this class

TargetCamera3D

Package away3d.cameras
Class public class TargetCamera3D
Inheritance TargetCamera3D -> Camera3D -> Object3D -> flash.events.EventDispatcher
Subclasses HoverCamera3D
Extended camera used to automatically look at a specified target object.

See also

away3d.containers.View3D
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) aperture : Number
Used in DofSprite2D.
 Camera3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 Object3D
  (^) dof : Boolean
Used in DofSprite2D.
 Camera3D
  (^) doflevels : Number = 16
Used in DofSprite2D.
 Camera3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) focus : Number
A divisor value for the perspective depth of the view.
 Camera3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxblur : Number = 150
Used in DofSprite2D.
 Camera3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 Object3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 Object3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 Object3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 Object3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 Object3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 Object3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
    parent : ObjectContainer3D
[write-only] Cannot parent a TargetCamera3D object.
 TargetCamera3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    target : Object3D
The 3d object targeted by the camera.
 TargetCamera3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
    view : Matrix3D
[read-only] Returns the transformation matrix used to resolve the scene to the view.
 TargetCamera3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) zoom : Number
Provides an overall scale value to the view
 Camera3D
Protected Properties
  Method Defined by
   
TargetCamera3D
(init:Object = null)
Creates a new TargetCamera3D object.
 TargetCamera3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the camera's properties to another Camera3D object.
 Camera3D
  (^)
disableDof():void
Used in DofSprite2D
 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
Used in DofSprite2D.
 Camera3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pan(angle:Number):void
Rotates the camera in its horizontal plane.
 Camera3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 Object3D
  (^)
screen(object:Object3D, vertex:Vertex = null):ScreenVertex
Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.
 Camera3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
tilt(angle:Number):void
Rotates the camera in its vertical plane.
 Camera3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
parent property
parent:ObjectContainer3D  [write-only]

Cannot parent a TargetCamera3D object.

Implementation
    public function set parent(value:ObjectContainer3D):void
Throws
- TargetCamera can't be parented.
target property  
public var target:Object3D

The 3d object targeted by the camera.

view property  
view:Matrix3D  [read-only]

Returns the transformation matrix used to resolve the scene to the view. Used in the ProjectionTraverser class

Implementation
    public function get view():Matrix3D
Constructor detail
TargetCamera3D () constructor
public function TargetCamera3D(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  target:Object3D
Wiki link
Click to go to the wiki page for 'away3d.cameras.TargetCamera3D'

Code examples
There are currently no examples for this class

TextureLoader

Package away3d.loaders.utils
Class public class TextureLoader
Inheritance TextureLoader -> flash.display.Loader
Used to store the name and loader reference of an external texture image.
Public Properties
  Property Defined by
    filename : String
[read-only]
 TextureLoader
Public Methods
  Method Defined by
   
TextureLoader
()
 TextureLoader
   
load(request:URLRequest, context:LoaderContext = null):void
 TextureLoader
Property detail
filename property
filename:String  [read-only]
Implementation
    public function get filename():String
Constructor detail
TextureLoader () constructor
public function TextureLoader()
Method detail
load () method
public override function load(request:URLRequest, context:LoaderContext = null):void
Parameters
request:URLRequest
 
context:LoaderContext (default = null)
Wiki link
Click to go to the wiki page for 'away3d.loaders.utils.TextureLoader'

Code examples
There are currently no examples for this class

TextureLoadQueue

Package away3d.loaders.utils
Class public class TextureLoadQueue
Inheritance TextureLoadQueue -> flash.events.EventDispatcher
Creates a queue of textures that load sequentially
Public Properties
  Property Defined by
    currentItemIndex : int
[read-only] Returns the index of the current texture baing loaded
 TextureLoadQueue
    currentLoader : TextureLoader
[read-only] Returns the loader object for the current texture being loaded
 TextureLoadQueue
    currentURLRequest : URLRequest
[read-only] Returns the url request object for the current texture being loaded
 TextureLoadQueue
    images : Array
[read-only] Returns an array of loader objects containing the loaded images
 TextureLoadQueue
    numItems : int
[read-only] Returns the number of items whating in the queue to be loaded.
 TextureLoadQueue
    percentLoaded : Number
[read-only] Returns the overall progress of the loader queue as a percentage.
 TextureLoadQueue
    progress : Number
[read-only] Returns the overall progress of the loader queue.
 TextureLoadQueue
Public Methods
  Method Defined by
   
TextureLoadQueue
()
Creates a new TextureLoadQueue object.
 TextureLoadQueue
   
addItem(loader:TextureLoader, request:URLRequest):void
Adds a new loader and request object to the load queue.
 TextureLoadQueue
   
start():void
Starts the load queue loading.
 TextureLoadQueue
Events
  Event Summary Defined by
   
complete
   TextureLoadQueue
   
httpStatus
   TextureLoadQueue
   
ioError
   TextureLoadQueue
   
progress
   TextureLoadQueue
   
securityError
   TextureLoadQueue
Property detail
currentItemIndex property
currentItemIndex:int  [read-only]

Returns the index of the current texture baing loaded

Implementation
    public function get currentItemIndex():int
currentLoader property  
currentLoader:TextureLoader  [read-only]

Returns the loader object for the current texture being loaded

Implementation
    public function get currentLoader():TextureLoader
currentURLRequest property  
currentURLRequest:URLRequest  [read-only]

Returns the url request object for the current texture being loaded

Implementation
    public function get currentURLRequest():URLRequest
images property  
images:Array  [read-only]

Returns an array of loader objects containing the loaded images

Implementation
    public function get images():Array
numItems property  
numItems:int  [read-only]

Returns the number of items whating in the queue to be loaded.

Implementation
    public function get numItems():int
percentLoaded property  
percentLoaded:Number  [read-only]

Returns the overall progress of the loader queue as a percentage.

Implementation
    public function get percentLoaded():Number
progress property  
progress:Number  [read-only]

Returns the overall progress of the loader queue. Progress of 0 means that nothing has loaded. Progress of 1 means that all the items are fully loaded

Implementation
    public function get progress():Number
Constructor detail
TextureLoadQueue () constructor
public function TextureLoadQueue()
Method detail
addItem () method
public function addItem(loader:TextureLoader, request:URLRequest):void

Adds a new loader and request object to the load queue.

Parameters
loader:TextureLoader - The laoder object to add to the queue.
 
request:URLRequest - The url request object to add tp the queue.
start () method  
public function start():void

Starts the load queue loading.

Event detail
complete event 
Event object type: flash.events.Event
httpStatus event   
Event object type: flash.events.HTTPStatusEvent
ioError event   
Event object type: flash.events.IOErrorEvent
progress event   
Event object type: flash.events.ProgressEvent
securityError event   
Event object type: flash.events.SecurityErrorEvent
Wiki link
Click to go to the wiki page for 'away3d.loaders.utils.TextureLoadQueue'

Code examples
There are currently no examples for this class

TickTraverser

Package away3d.core.traverse
Class public class TickTraverser
Inheritance TickTraverser -> Traverser
Traverser that fires a time-based method for all objects in scene
Public Properties
  Property Defined by
    now : int
Defines the current time in milliseconds from the start of the flash movie.
 TickTraverser
Public Methods
  Method Defined by
   
TickTraverser
()
Creates a new TickTraverser object.
 TickTraverser
  (^)
apply(node:Object3D):void
Executed when the traverser is applied to the node.
 Traverser
   
enter(node:Object3D):void
Executed when the traverser enters the node.
 TickTraverser
  (^)
leave(node:Object3D):void
Executed when the traverser leaves the node.
 Traverser
  (^)
match(node:Object3D):Boolean
Determines if the specified node is required to be traversed.
 Traverser
Property detail
now property
public var now:int

Defines the current time in milliseconds from the start of the flash movie.

Constructor detail
TickTraverser () constructor
public function TickTraverser()
Method detail
enter () method
public override function enter(node:Object3D):void

Executed when the traverser enters the node.

Parameters
node:Object3D
Wiki link
Click to go to the wiki page for 'away3d.core.traverse.TickTraverser'

Code examples
There are currently no examples for this class

Torus

Package away3d.primitives
Class public class Torus
Inheritance Torus -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d torus primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the overall radius of the torus.
 Torus
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractPrimitive
  (^) sceneTransformed : Boolean
Object3D
    segmentsR : Number
Defines the number of radial segments that make up the torus.
 Torus
    segmentsT : Number
Defines the number of tubular segments that make up the torus.
 Torus
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    tube : Number
Defines the tube radius of the torus.
 Torus
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the torus points use a yUp orientation (true) or a zUp orientation (false).
 Torus
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Torus
(init:Object = null)
Creates a new Torus object.
 Torus
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 Torus
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(r:int, t:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 Torus
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
radius property
radius:Number  [read-write]

Defines the overall radius of the torus. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsR property  
segmentsR:Number  [read-write]

Defines the number of radial segments that make up the torus. Defaults to 8.

Implementation
    public function get segmentsR():Number
    public function set segmentsR(value:Number):void
segmentsT property  
segmentsT:Number  [read-write]

Defines the number of tubular segments that make up the torus. Defaults to 6.

Implementation
    public function get segmentsT():Number
    public function set segmentsT(value:Number):void
tube property  
tube:Number  [read-write]

Defines the tube radius of the torus. Defaults to 40.

Implementation
    public function get tube():Number
    public function set tube(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the torus 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
Torus () constructor
public function Torus(init:Object = null)

Constructor for a torus object.

The init object parameters are : 'radius' defines the radius of the torus, 'tube' defines the tube radius (thickness), 'segmentsR' defines the number of segments the torus is divided into around rotationally around the circumference of the circle defined by the radius and 'segmentsT' which defines number of segments for the tube, around it's cross-section.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  radius:Number (default = 100, min:0)
  tube:Number (default = 40, min:0, max:radius)
  segmentsR:Int (default = 8, min:3)
  segmentsT:Int (default = 6, min:3)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(r:int, t:int):Vertex

Returns the vertex from a 2 dimensional representation of the torus' vertex array.
I=horizontal reference.
J=vertical reference

Returns the vertex object specified by the grid position of the mesh.

Parameters
r:int - The radial position on the primitive mesh.
 
t:int - The tubular position on the primitive mesh.
Returns
Vertex
Wiki link
Click to go to the wiki page for 'away3d.primitives.Torus'

Code examples
There are currently no examples for this class

TransformBitmapMaterial

Package away3d.materials
Class public class TransformBitmapMaterial
Inheritance TransformBitmapMaterial -> BitmapMaterial -> flash.events.EventDispatcher
Implements ITriangleMaterial, IUVMaterial
Subclasses AnimatedBitmapMaterial, BitmapFileMaterial, MovieMaterial
Basic bitmap texture material
Public Properties
  Property Defined by
  (^) alpha : Number
Defines an alpha value for the texture bitmap.
 BitmapMaterial
  (^) bitmap : BitmapData
Returns the bitmapData object being used as the material texture.
 BitmapMaterial
  (^) blendMode : String
Defines a blendMode value for the texture bitmap.
 BitmapMaterial
  (^) color : uint
Defines a colored tint for the texture bitmap.
 BitmapMaterial
  (^) debug : Boolean = false
Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.
 BitmapMaterial
    globalProjection : Boolean
Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.
 TransformBitmapMaterial
  (^) height : Number
Returns the height of the bitmapData being used as the material texture.
 BitmapMaterial
    offsetX : Number
Offsets the x coordinates of the texture in uv-space
 TransformBitmapMaterial
    offsetY : Number
Offsets the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) precision : Number
Corrects distortion caused by the affine transformation (non-perpective) of textures.
 BitmapMaterial
    projectionVector : Number3D
Projects the texture in object space, ignoring the uv coordinates of the vertex objects.
 TransformBitmapMaterial
  (^) repeat : Boolean = false
Determines if texture bitmap will tile in uv-space
 BitmapMaterial
    rotation : Number
Rotates the texture in uv-space
 TransformBitmapMaterial
    scaleX : Number
Scales the x coordinates of the texture in uv-space
 TransformBitmapMaterial
    scaleY : Number
Scales the y coordinates of the texture in uv-space
 TransformBitmapMaterial
  (^) smooth : Boolean = false
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.
 BitmapMaterial
    throughProjection : Boolean
Determines whether a projected texture is visble on the faces pointing away from the projection.
 TransformBitmapMaterial
    transform : Matrix
Transforms the texture in uv-space
 TransformBitmapMaterial
  (^) visible : Boolean
Indicates whether the material is visible
 BitmapMaterial
  (^) width : Number
Returns the width of the bitmapData being used as the material texture.
 BitmapMaterial
Protected Properties
  Method Defined by
   
TransformBitmapMaterial
(bitmap:BitmapData, init:Object = null)
Creates a new TransformBitmapMaterial object.
 TransformBitmapMaterial
  (^)
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 BitmapMaterial
   
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 TransformBitmapMaterial
  (^)
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 BitmapMaterial
   
renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO
Renders a bitmapData surface object for the speficied face.
 TransformBitmapMaterial
  (^)
renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void
Renders a material layer for the specified triangle.
 BitmapMaterial
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 TransformBitmapMaterial
   
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 TransformBitmapMaterial
Protected Methods
  Method Defined by
   
getMapping(tri:DrawTriangle):Matrix
Calculates the mapping matrix required to draw the triangle texture to screen.
 TransformBitmapMaterial
  (^)
setColorTransform():void
Updates the colortransform object applied to the texture from the color and alpha properties.
 BitmapMaterial
  (^)
updateRenderBitmap():void
Updates the texture bitmapData with the colortransform determined from the color and alpha properties.
 BitmapMaterial
Events
  Event Summary Defined by
  (^)
materialresize
 Dispatched when the bitmapData used for the material texture is resized. BitmapMaterial
Property detail
globalProjection property
globalProjection:Boolean  [read-write]

Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.

Implementation
    public function get globalProjection():Boolean
    public function set globalProjection(value:Boolean):void

See also

projectionVector
offsetX
offsetY
offsetX property  
offsetX:Number  [read-write]

Offsets the x coordinates of the texture in uv-space

Implementation
    public function get offsetX():Number
    public function set offsetX(value:Number):void
offsetY property  
offsetY:Number  [read-write]

Offsets the y coordinates of the texture in uv-space

Implementation
    public function get offsetY():Number
    public function set offsetY(value:Number):void
projectionVector property  
projectionVector:Number3D  [read-write]

Projects the texture in object space, ignoring the uv coordinates of the vertex objects. Texture renders normally when set to null.

Implementation
    public function get projectionVector():Number3D
    public function set projectionVector(value:Number3D):void
rotation property  
rotation:Number  [read-write]

Rotates the texture in uv-space

Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
scaleX property  
scaleX:Number  [read-write]

Scales the x coordinates of the texture in uv-space

Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleY property  
scaleY:Number  [read-write]

Scales the y coordinates of the texture in uv-space

Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
throughProjection property  
throughProjection:Boolean  [read-write]

Determines whether a projected texture is visble on the faces pointing away from the projection.

Implementation
    public function get throughProjection():Boolean
    public function set throughProjection(value:Boolean):void

See also

projectionVector
transform property  
transform:Matrix  [read-write]

Transforms the texture in uv-space

Implementation
    public function get transform():Matrix
    public function set transform(value:Matrix):void
Constructor detail
TransformBitmapMaterial () constructor
public function TransformBitmapMaterial(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
  transform:Object (default = Matrix)
  scaleX:Number (default = _scaleX)
  scaleY:Number (default = _scaleY)
  offsetX:Number (default = _offsetX)
  offsetY:Number (default = _offsetY)
  rotation:Number (default = _rotation)
  projectionVector:Object (default = Number3D)
  throughProjection:Boolean (default = true)
  globalProjection:Boolean (default = false)
Method detail
getMapping () method
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.
getPixel32 () method  
public override 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.
renderFace () method  
public override function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters
face:Face - The face object onto which the rendered sufrace is applied.
 
containerRect:Rectangle - The rectangle object defining the bounds of the face in uv-space.
 
parentFaceVO:FaceVO - The value object of the preceeding surface.
Returns
FaceVO
renderTriangle () method  
public override function renderTriangle(tri:DrawTriangle):void

Sends data from the material coupled with data from the DrawTriangle primitive to the render session.

Parameters
tri:DrawTriangle
updateMaterial () method  
public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters
source:Object3D
 
view:View3D
Wiki link
Click to go to the wiki page for 'away3d.materials.TransformBitmapMaterial'

Code examples
There are currently no examples for this class

Traverser

Package away3d.core.traverse
Class public class Traverser
Subclasses BlockerTraverser, PrimitiveTraverser, ProjectionTraverser, TickTraverser
Abstract class for all traverser that perform actions on the whole scene.
Public Methods
  Method Defined by
   
apply(node:Object3D):void
Executed when the traverser is applied to the node.
 Traverser
   
enter(node:Object3D):void
Executed when the traverser enters the node.
 Traverser
   
leave(node:Object3D):void
Executed when the traverser leaves the node.
 Traverser
   
match(node:Object3D):Boolean
Determines if the specified node is required to be traversed.
 Traverser
Method detail
apply () method
public function apply(node:Object3D):void

Executed when the traverser is applied to the node.

Parameters
node:Object3D
enter () method  
public function enter(node:Object3D):void

Executed when the traverser enters the node.

Parameters
node:Object3D
leave () method  
public function leave(node:Object3D):void

Executed when the traverser leaves the node.

Parameters
node:Object3D
match () method  
public function match(node:Object3D):Boolean

Determines if the specified node is required to be traversed.

Parameters
node:Object3D - The 3d object to be tested.
Returns
Boolean - The result of the test.
Wiki link
Click to go to the wiki page for 'away3d.core.traverse.Traverser'

Code examples
There are currently no examples for this class

Triangle

Package away3d.primitives
Class public class Triangle
Inheritance Triangle -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d triangle.
Public Properties
  Property Defined by
    a : Vertex
Defines the first vertex that makes up the triangle.
 Triangle
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
    b : Vertex
Defines the second vertex that makes up the triangle.
 Triangle
  (^) back : ITriangleMaterial
Defines a triangle material to be used for the backface of all faces in the 3d object.
 Mesh
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) bothsides : Boolean
Indicates whether both the front and reverse sides of a face should be rendered.
 Mesh
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
    c : Vertex
Defines the third vertex that makes up the triangle.
 Triangle
  (^) debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
 Mesh
  (^) elements : Array
Returns an array of the elements contained in the mesh object.
 Mesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) faces : Array
Returns an array of the faces contained in the mesh object.
 Mesh
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) indexes : Array
Mesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ITriangleMaterial
Defines the material used to render the faces in the mesh object.
 Mesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) outline : ISegmentMaterial
Defines a segment material to be used for outlining the 3d object.
 Mesh
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Triangle
(init:Object = null)
Creates a new Triangle object.
 Triangle
  (^)
addFace(face:Face):void
Adds a face object to the mesh object.
 Mesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String
Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.
 Mesh
  (^)
asXML():XML
Returns an xml representation of the mesh
 Mesh
  (^)
clone(object:* = null):*
Duplicates the mesh properties to another 3d object.
 Mesh
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
invertFaces():void
Inverts the geometry of all face objects.
 Mesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the mesh without moving the contents.
 Mesh
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Mesh
  (^)
quarterFaces():void
Divides a face object into 4 equal sized face objects.
 Mesh
  (^)
removeFace(face:Face):void
Removes a face object from the mesh object.
 Mesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
a property
a:Vertex  [read-write]

Vertex A of the triangle

Defines the first vertex that makes up the triangle.

Implementation
    public function get a():Vertex
    public function set a(value:Vertex):void
b property  
b:Vertex  [read-write]

Vertex B of the triangle

Defines the second vertex that makes up the triangle.

Implementation
    public function get b():Vertex
    public function set b(value:Vertex):void
c property  
c:Vertex  [read-write]

Vertex C of the triangle

Defines the third vertex that makes up the triangle.

Implementation
    public function get c():Vertex
    public function set c(value:Vertex):void
Constructor detail
Triangle () constructor
public function Triangle(init:Object = null)

Constructor for a triangle object.

The init object parameter 'edge' defines the length of each of the sides of the triangle.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  edge:Number (default = 100, min:0)
  yUp:Boolean (default = true)
Wiki link
Click to go to the wiki page for 'away3d.primitives.Triangle'

Code examples
There are currently no examples for this class

Trident

Package away3d.primitives
Class public class Trident
Inheritance Trident -> ObjectContainer3D -> Object3D -> flash.events.EventDispatcher
Creates an axis trident.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 ObjectContainer3D
  (^) children : Array
Returns the children of the container as an array of 3d objects
 ObjectContainer3D
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) maxX : Number
Returns the maximum x value of the 3d object
 ObjectContainer3D
  (^) maxY : Number
Returns the maximum y value of the 3d object
 ObjectContainer3D
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 ObjectContainer3D
  (^) minX : Number
Returns the minimum x value of the 3d object
 ObjectContainer3D
  (^) minY : Number
Returns the minimum y value of the 3d object
 ObjectContainer3D
  (^) minZ : Number
Returns the minimum z value of the 3d object
 ObjectContainer3D
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
Trident
(len:Number = 1000)
Creates a new Trident object.
 Trident
  (^)
addChild(child:Object3D):void
Adds a 3d object to the scene as a child of the container
 ObjectContainer3D
  (^)
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
 ObjectContainer3D
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another ObjectContainer3D object
 ObjectContainer3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
getChildByName(name:String):Object3D
Returns a 3d object specified by name from the child array of the container
 ObjectContainer3D
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the origin point of the 3d object without moving the contents
 ObjectContainer3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 Object3D
  (^)
removeChild(child:Object3D):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeChildByName(name:String):void
Removes a 3d object from the child array of the container
 ObjectContainer3D
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the 3d object.
 ObjectContainer3D
  (^)
tick(time:int):void
Called by the TickTraverser.
 Object3D
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 ObjectContainer3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Events
  Event Summary Defined by
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Constructor detail
Trident () constructor
public function Trident(len:Number = 1000)
Parameters
len:Number (default = 1000) - The length of the trident axes.
Wiki link
Click to go to the wiki page for 'away3d.primitives.Trident'

Code examples
There are currently no examples for this class

UV

Package away3d.core.base
Class public class UV
Inheritance UV -> ValueObject -> flash.events.EventDispatcher
Texture coordinates value object. Properties u and v represent the horizontal and vertical texture axes.
Public Properties
  Property Defined by
    extra : Object
An optional untyped object that can contain used-defined properties.
 UV
    u : Number
Defines the horizontal corrdinate of the texture value.
 UV
    v : Number
Defines the vertical corrdinate of the texture value.
 UV
Public Methods
  Method Defined by
   
UV
(u:Number = 0, v:Number = 0)
Creates a new UV object.
 UV
  (^)
addOnChange(listener:Function):void
 ValueObject
   
clone():UV
Duplicates the vertex properties to another Vertex object
 UV
  (^)
removeOnChange(listener:Function):void
 ValueObject
   
toString():String
Used to trace the values of a uv object.
 UV
Protected Methods
  Method Defined by
  (^)
notifyChange():void
 ValueObject
Property detail
extra property
public var extra:Object

An optional untyped object that can contain used-defined properties.

u property  
u:Number  [read-write]

Defines the horizontal corrdinate of the texture value.

Implementation
    public function get u():Number
    public function set u(value:Number):void
v property  
v:Number  [read-write]

Defines the vertical corrdinate of the texture value.

Implementation
    public function get v():Number
    public function set v(value:Number):void
Constructor detail
UV () constructor
public function UV(u:Number = 0, v:Number = 0)
Parameters
u:Number (default = 0) - [optional] The horizontal corrdinate of the texture value. Defaults to 0.
 
v:Number (default = 0) - [optional] The vertical corrdinate of the texture value. Defaults to 0.
Method detail
clone () method
public function clone():UV

Duplicates the vertex properties to another Vertex object

Returns
UV - The new vertex instance with duplicated properties applied
toString () method  
public override function toString():String

Used to trace the values of a uv object.

Returns
String - A string representation of the uv object.
Wiki link
Click to go to the wiki page for 'away3d.core.base.UV'

Code examples
There are currently no examples for this class

ValueObject

Package away3d.core.utils
Class public class ValueObject
Inheritance ValueObject -> flash.events.EventDispatcher
Subclasses UV, Vertex
Public Methods
  Method Defined by
   
addOnChange(listener:Function):void
 ValueObject
   
removeOnChange(listener:Function):void
 ValueObject
Protected Methods
  Method Defined by
   
notifyChange():void
 ValueObject
Method detail
addOnChange () method
public function addOnChange(listener:Function):void
Parameters
listener:Function
notifyChange () method  
protected function notifyChange():void
removeOnChange () method  
public function removeOnChange(listener:Function):void
Parameters
listener:Function
Wiki link
Click to go to the wiki page for 'away3d.core.utils.ValueObject'

Code examples
There are currently no examples for this class

Vertex

Package away3d.core.base
Class public class Vertex
Inheritance Vertex -> ValueObject -> flash.events.EventDispatcher
A vertex coordinate value object. Properties x, y and z represent a 3d point in space.
Public Properties
  Property Defined by
    extra : Object
An object that contains user defined properties.
 Vertex
    position : Number3D
The vertex position vector
 Vertex
    x : Number
Defines the x coordinate of the vertex relative to the local coordinates of the parent mesh object.
 Vertex
    y : Number
Defines the y coordinate of the vertex relative to the local coordinates of the parent mesh object.
 Vertex
    z : Number
Defines the z coordinate of the vertex relative to the local coordinates of the parent mesh object.
 Vertex
Public Methods
  Method Defined by
   
Vertex
(x:Number = 0, y:Number = 0, z:Number = 0)
Creates a new Vertex object.
 Vertex
  (^)
addOnChange(listener:Function):void
 ValueObject
   
clone():Vertex
Duplicates the vertex properties to another Vertex object
 Vertex
   
project(projection:Projection):ScreenVertex
Projects the vertex to the screen space of the view.
 Vertex
  (^)
removeOnChange(listener:Function):void
 ValueObject
   
toString():String
Used to trace the values of a vertex object.
 Vertex
Protected Methods
  Method Defined by
  (^)
notifyChange():void
 ValueObject
Property detail
extra property
public var extra:Object

An object that contains user defined properties. Defaults to null.

position property  
position:Number3D  [read-write]

The vertex position vector

Implementation
    public function get position():Number3D
    public function set position(value:Number3D):void
x property  
x:Number  [read-write]

Defines the x coordinate of the vertex relative to the local coordinates of the parent mesh object.

Implementation
    public function get x():Number
    public function set x(value:Number):void
y property  
y:Number  [read-write]

Defines the y coordinate of the vertex relative to the local coordinates of the parent mesh object.

Implementation
    public function get y():Number
    public function set y(value:Number):void
z property  
z:Number  [read-write]

Defines the z coordinate of the vertex relative to the local coordinates of the parent mesh object.

Implementation
    public function get z():Number
    public function set z(value:Number):void
Constructor detail
Vertex () constructor
public function Vertex(x:Number = 0, y:Number = 0, z:Number = 0)
Parameters
x:Number (default = 0) - [optional] The local x position of the vertex. Defaults to 0.
 
y:Number (default = 0) - [optional] The local y position of the vertex. Defaults to 0.
 
z:Number (default = 0) - [optional] The local z position of the vertex. Defaults to 0.
Method detail
clone () method
public function clone():Vertex

Duplicates the vertex properties to another Vertex object

Returns
Vertex - The new vertex instance with duplicated properties applied
project () method  
public function project(projection:Projection):ScreenVertex

Projects the vertex to the screen space of the view.

Parameters
projection:Projection
Returns
ScreenVertex
toString () method  
public override function toString():String

Used to trace the values of a vertex object.

Returns
String - A string representation of the vertex object.
Wiki link
Click to go to the wiki page for 'away3d.core.base.Vertex'

Code examples

Vertex Place (Place an object at a vertex)

vertplace(objectA,objectB, 5);//places objectA at objectB's vertice #5

function vertplace(who,whob,vert):void {
var vvTemp:Vertex  =whob.vertices[vert];
who.x=whob.x + vvTemp.x;
who.y=whob.y + vvTemp.y;
who.z=whob.z + vvTemp.z;
}

VertexPosition

Package away3d.core.base
Class public class VertexPosition
Vertex position value object.
Public Properties
  Property Defined by
    vertex : Vertex
VertexPosition
    x : Number
Defines the x coordinate.
 VertexPosition
    y : Number
Defines the y coordinate.
 VertexPosition
    z : Number
Defines the z coordinate.
 VertexPosition
Public Methods
  Method Defined by
   
VertexPosition
(vertex:Vertex)
Creates a new VertexPosition object.
 VertexPosition
   
adjust(k:Number = 1):void
Adjusts the position of the vertex object incrementally.
 VertexPosition
Property detail
vertex property
public var vertex:Vertex
x property  
public var x:Number

Defines the x coordinate.

y property  
public var y:Number

Defines the y coordinate.

z property  
public var z:Number

Defines the z coordinate.

Constructor detail
VertexPosition () constructor
public function VertexPosition(vertex:Vertex)
Parameters
vertex:Vertex - The vertex object used to define the default x, y and z values.
Method detail
adjust () method
public function adjust(k:Number = 1):void

Adjusts the position of the vertex object incrementally.

Parameters
k:Number (default = 1) - The fraction by which to adjust the vertex values.
Wiki link
Click to go to the wiki page for 'away3d.core.base.VertexPosition'

Code examples
There are currently no examples for this class

View3D

Package away3d.containers
Class public class View3D
Inheritance View3D -> flash.display.Sprite
Sprite container used for storing camera, scene, session, renderer and clip references, and resolving mouse events
Public Properties
  Property Defined by
    background : Sprite
A background sprite positioned under the rendered scene.
 View3D
    camera : Camera3D
Camera used when rendering.
 View3D
    clip : Clipping
Clipping area used when rendering.
 View3D
    findhit : FindHit
Traverser used to find the current object under the mouse.
 View3D
    hud : Sprite
A container for 2D overlays positioned over the rendered scene.
 View3D
    mouseMaterial : IUVMaterial
Current material under the mouse.
 View3D
    mouseObject : Object3D
Current object under the mouse.
 View3D
    mouseZeroMove : Boolean
Forces mousemove events to fire even when cursor is static.
 View3D
    primitives : Array
temporary store for rendered primitives.
 View3D
    renderer : IRenderer
Renderer object used to traverse the scenegraph and output the drawing primitives required to render the scene to the view.
 View3D
    scene : Scene3D
Scene used when rendering.
 View3D
    session : AbstractRenderSession
Session object used to draw all drawing primitives returned from the renderer to the view container.
 View3D
    sourceURL : String
Optional string for storing source url.
 View3D
    stats : Boolean
Enables/Disables stats panel.
 View3D
    statsOpen : Boolean
Keeps track of whether the stats panel is currently open.
 View3D
    statsPanel : Stats
Object instance of the stats panel.
 View3D
Public Methods
  Method Defined by
   
View3D
(init:Object = null)
Creates a new View3D object.
 View3D
   
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener.
 View3D
   
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener.
 View3D
   
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener.
 View3D
   
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener.
 View3D
   
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener.
 View3D
   
addSourceURL(url:String):void
Defines a source url string that can be accessed though a View Source option in the right-click menu.
 View3D
   
clear():void
Clears previuosly rendered view from the session.
 View3D
   
fireMouseMoveEvent(force:Boolean = false):void
Manually fires a mouseMove3D event.
 View3D
   
flush():void
Completes the rendering of a view by flushing the session
 View3D
   
getBitmapData():BitmapData
Returns the bitmapData of the rendered scene.
 View3D
   
getContainer():DisplayObject
Returns the DisplayObject container of the rendered scene.
 View3D
   
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener.
 View3D
   
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener.
 View3D
   
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener.
 View3D
   
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener.
 View3D
   
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener.
 View3D
   
render():void
Renders a snapshot of the view to the render session's view container.
 View3D
Events
  Event Summary Defined by
   
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over a 3d object View3D
   
mouseMove3D
 Dispatched when a user moves the cursor while it is over a 3d object View3D
   
mouseOut3D
 Dispatched when a user moves the cursor away from a 3d object View3D
   
mouseOver3D
 Dispatched when a user moves the cursor over a 3d object View3D
   
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over a 3d object View3D
Property detail
background property
public var background:Sprite

A background sprite positioned under the rendered scene.

camera property  
public var camera:Camera3D

Camera used when rendering.

See also

render()
clip property  
public var clip:Clipping

Clipping area used when rendering. If null, the visible edges of the screen are located with the Clipping.screen() method.

See also

render()
away3d.core.render.Clipping.scene()
findhit property  
public var findhit:FindHit

Traverser used to find the current object under the mouse.

See also

fireMouseEvent
hud property  
public var hud:Sprite

A container for 2D overlays positioned over the rendered scene.

_interactiveLayer property  
arcane var _interactiveLayer:Sprite
mouseMaterial property  
public var mouseMaterial:IUVMaterial

Current material under the mouse.

mouseObject property  
public var mouseObject:Object3D

Current object under the mouse.

mouseZeroMove property  
public var mouseZeroMove:Boolean

Forces mousemove events to fire even when cursor is static.

primitives property  
public var primitives:Array

temporary store for rendered primitives.

renderer property  
renderer:IRenderer  [read-write]

Renderer object used to traverse the scenegraph and output the drawing primitives required to render the scene to the view.

Implementation
    public function get renderer():IRenderer
    public function set renderer(value:IRenderer):void
scene property  
public var scene:Scene3D

Scene used when rendering.

See also

render()
session property  
session:AbstractRenderSession  [read-write]

Session object used to draw all drawing primitives returned from the renderer to the view container.

Implementation
    public function get session():AbstractRenderSession
    public function set session(value:AbstractRenderSession):void

See also

renderer
getContainer()
sourceURL property  
public var sourceURL:String

Optional string for storing source url.

stats property  
public var stats:Boolean

Enables/Disables stats panel.

See also

away3d.core.stats.Stats
statsOpen property  
public var statsOpen:Boolean

Keeps track of whether the stats panel is currently open.

See also

away3d.core.stats.Stats
statsPanel property  
public var statsPanel:Stats

Object instance of the stats panel.

See also

away3d.core.stats.Stats
Constructor detail
View3D () constructor
public function View3D(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  stats:Boolean (default = true)
  scene:ObjectOrInit (default = Scene3D)
  camera:ObjectOrInit (default = Camera3D)
  renderer:Object
  session:Object
  clip:Object (default = Clipping)
  x:Number (default = 0)
  y:Number (default = 0)
Method detail
addOnMouseDown () method
public function addOnMouseDown(listener:Function):void

Default method for adding a mouseDown3D event listener.

Parameters
listener:Function - The listener function.
addOnMouseMove () method  
public function addOnMouseMove(listener:Function):void

Default method for adding a mouseMove3D event listener.

Parameters
listener:Function - The listener function.
addOnMouseOut () method  
public function addOnMouseOut(listener:Function):void

Default method for adding a mouseOut3D event listener.

Parameters
listener:Function - The listener function.
addOnMouseOver () method  
public function addOnMouseOver(listener:Function):void

Default method for adding a mouseOver3D event listener.

Parameters
listener:Function - The listener function.
addOnMouseUp () method  
public function addOnMouseUp(listener:Function):void

Default method for adding a mouseUp3D event listener.

Parameters
listener:Function - The listener function.
addSourceURL () method  
public function addSourceURL(url:String):void

Defines a source url string that can be accessed though a View Source option in the right-click menu. Requires the stats panel to be enabled.

Parameters
url:String - The url to the source files.
clear () method  
public function clear():void

Clears previuosly rendered view from the session.

See also

session
dispatchMouseEvent () method  
arcane function dispatchMouseEvent(event:MouseEvent3D):void
Parameters
event:MouseEvent3D
fireMouseMoveEvent () method  
public function fireMouseMoveEvent(force:Boolean = false):void

Manually fires a mouseMove3D event.

Parameters
force:Boolean (default = false)
flush () method  
public function flush():void

Completes the rendering of a view by flushing the session

See also

session
getBitmapData () method  
public function getBitmapData():BitmapData

Returns the bitmapData of the rendered scene. session is required to be an instance of BitmapRenderSession, otherwise an error is thrown.

Returns
BitmapData - The rendered view image.

Throws
- incorrect session object - require BitmapRenderSession.

See also

session
away3d.core.render.BitmapRenderSession
getContainer () method  
public function getContainer():DisplayObject

Returns the DisplayObject container of the rendered scene.

Returns
DisplayObject - The DisplayObject containing the output from the render session of the view.

See also

session
away3d.core.render.BitmapRenderSession
away3d.core.render.SpriteRenderSession
removeOnMouseDown () method  
public function removeOnMouseDown(listener:Function):void

Default method for removing a mouseDown3D event listener.

Parameters
listener:Function - The listener function.
removeOnMouseMove () method  
public function removeOnMouseMove(listener:Function):void

Default method for removing a mouseMove3D event listener.

Parameters
listener:Function - The listener function.
removeOnMouseOut () method  
public function removeOnMouseOut(listener:Function):void

Default method for removing a mouseOut3D event listener.

Parameters
listener:Function - The listener function.
removeOnMouseOver () method  
public function removeOnMouseOver(listener:Function):void

Default method for removing a mouseOver3D event listener.

Parameters
listener:Function - The listener function.
removeOnMouseUp () method  
public function removeOnMouseUp(listener:Function):void

Default method for removing a mouseUp3D event listener.

Parameters
listener:Function - The listener function.
render () method  
public function render():void

Renders a snapshot of the view to the render session's view container.

See also

session
Event detail
mouseDown3D event 
Event object type: away3d.events.MouseEvent3D

Dispatched when a user presses the let hand mouse button while the cursor is over a 3d object

mouseMove3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor while it is over a 3d object

mouseOut3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor away from a 3d object

mouseOver3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user moves the cursor over a 3d object

mouseUp3D event   
Event object type: away3d.events.MouseEvent3D

Dispatched when a user releases the let hand mouse button while the cursor is over a 3d object

Wiki link
Click to go to the wiki page for 'away3d.containers.View3D'

Code examples

Place View3D in the middle of your SWF

var swd:Number=640;
var swh:Number=480;
var view:View3D=new View3D({x:swd / 2,y:swh / 2});

WhiteShadingBitmapMaterial

Package away3d.materials
Class public class WhiteShadingBitmapMaterial
Inheritance WhiteShadingBitmapMaterial -> CenterLightingMaterial -> flash.events.EventDispatcher
Implements IUVMaterial
Bitmap material with flat white lighting
Public Properties
  Property Defined by
  (^) ak : Number = 20
Coefficient for shininess level
 CenterLightingMaterial
  (^) ambient_brightness : Number = 1
Coefficient for ambient light level
 CenterLightingMaterial
    bitmap : BitmapData
[read-only] Returns the bitmapData object being used as the material texture.
 WhiteShadingBitmapMaterial
  (^) diffuse_brightness : Number = 1
Coefficient for diffuse light level
 CenterLightingMaterial
    height : Number
[read-only] Returns the height of the bitmapData being used as the material texture.
 WhiteShadingBitmapMaterial
    repeat : Boolean
Determines if texture bitmap will tile in uv-space
 WhiteShadingBitmapMaterial
    smooth : Boolean
Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen
 WhiteShadingBitmapMaterial
  (^) specular_brightness : Number = 1
Coefficient for specular light level
 CenterLightingMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 WhiteShadingBitmapMaterial
    width : Number
[read-only] Returns the width of the bitmapData being used as the material texture.
 WhiteShadingBitmapMaterial
Protected Properties
  Method Defined by
   
WhiteShadingBitmapMaterial
(bitmap:BitmapData, init:Object = null)
Creates a new WhiteShadingBitmapMaterial object.
 WhiteShadingBitmapMaterial
   
addOnResize(listener:Function):void
Default method for adding a materialresize event listener
 WhiteShadingBitmapMaterial
   
doubleStepTo(limit:int):void
 WhiteShadingBitmapMaterial
   
getPixel32(u:Number, v:Number):uint
Returns the argb value of the bitmapData pixel at the given u v coordinate.
 WhiteShadingBitmapMaterial
   
removeOnResize(listener:Function):void
Default method for removing a materialresize event listener
 WhiteShadingBitmapMaterial
  (^)
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 CenterLightingMaterial
  (^)
updateMaterial(source:Object3D, view:View3D):void
Called once per render loop when material is visible.
 CenterLightingMaterial
Property detail
bitmap property
bitmap:BitmapData  [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
    public function get bitmap():BitmapData
height property  
height:Number  [read-only]

Returns the height of the bitmapData being used as the material texture.

Implementation
    public function get height():Number
repeat property  
public var repeat:Boolean

Determines if texture bitmap will tile in uv-space

smooth property  
public var smooth:Boolean

Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen

visible property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
width property  
width:Number  [read-only]

Returns the width of the bitmapData being used as the material texture.

Implementation
    public function get width():Number
Constructor detail
WhiteShadingBitmapMaterial () constructor
public function WhiteShadingBitmapMaterial(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)
  repeat:Boolean (default = false)
Method detail
addOnResize () method
public function addOnResize(listener:Function):void

Default method for adding a materialresize event listener

Parameters
listener:Function - The listener function
doubleStepTo () method  
public function doubleStepTo(limit:int):void
Parameters
limit:int
getPixel32 () method  
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.
removeOnResize () method  
public function removeOnResize(listener:Function):void

Default method for removing a materialresize event listener

Parameters
listener:Function - The listener function
Wiki link
Click to go to the wiki page for 'away3d.materials.WhiteShadingBitmapMaterial'

Code examples
There are currently no examples for this class

WireCircle

Package away3d.primitives
Class public class WireCircle
Inheritance WireCircle -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire polygon.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the polygon.
 WireCircle
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
    sides : Number
Defines the number of sides of the polygon.
 WireCircle
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the polygon points use a yUp orientation (true) or a zUp orientation (false).
 WireCircle
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireCircle
(init:Object = null)
Creates a new WireCircle object.
 WireCircle
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WireCircle
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
radius property
radius:Number  [read-write]

Defines the radius of the polygon. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
sides property  
sides:Number  [read-write]

Defines the number of sides of the polygon. Defaults to 8 (octohedron).

Implementation
    public function get sides():Number
    public function set sides(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the polygon 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
WireCircle () constructor
public function WireCircle(init:Object = null)

Constructor for a wire frame circle object.

The init object parameters are : 'radius' which is the radius of the circle and 'segments' which determines how many segments the circle divided into.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  radius:Number (default = 100, min:0)
  sides:Int (default = 8, min:3)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.WireCircle'

Code examples
There are currently no examples for this class

WireColorMaterial

Package away3d.materials
Class public class WireColorMaterial
Implements ITriangleMaterial
Wire material for solid color drawing with optional face border outlining
Public Properties
  Property Defined by
    alpha : Number
Determines the alpha value of the material
 WireColorMaterial
    color : int
Determines the color value of the material
 WireColorMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 WireColorMaterial
    width : Number
Determines the wire width
 WireColorMaterial
    wirealpha : Number
Determines the alpha value of the border wire
 WireColorMaterial
    wirecolor : int
Determines the color value of the border wire
 WireColorMaterial
Protected Properties
  Property Defined by
    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.
 WireColorMaterial
Public Methods
  Method Defined by
   
WireColorMaterial
(color:* = null, init:Object = null)
Creates a new WireColorMaterial object.
 WireColorMaterial
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 WireColorMaterial
Property detail
alpha property
public var alpha:Number

Determines the alpha value of the material

color property  
public var color:int

Determines the color value of the material

ini property  
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 property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
width property  
public var width:Number

Determines the wire width

wirealpha property  
public var wirealpha:Number

Determines the alpha value of the border wire

wirecolor property  
public var wirecolor:int

Determines the color value of the border wire

Constructor detail
WireColorMaterial () constructor
public function WireColorMaterial(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)
  wirecolor:Color (default = 0x000000)
  width:Number (default = 1, min:0)
  wirealpha:Number (default = 1, min:0, max:1)
Method detail
renderTriangle () method
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
Wiki link
Click to go to the wiki page for 'away3d.materials.WireColorMaterial'

Code examples

Changing Materials and Outline

objA.material = Cast.material("newma");
//change bitmap from library
objA.material = Cast.material({color:"blue", lighting:true});
//change light color
objA.material = new WireColorMaterial();
objA.material = new ShadingColorMaterial( );

objA.outline = new WireframeMaterial("yellow", {width:20});//outline size

WireCone

Package away3d.primitives
Class public class WireCone
Inheritance WireCone -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire cone primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the wire cone.
 WireCone
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the wire cone base.
 WireCone
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
    segmentsH : Number
Defines the number of vertical segments that make up the wire cone.
 WireCone
    segmentsW : Number
Defines the number of horizontal segments that make up the wire cone.
 WireCone
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the wire cone points use a yUp orientation (true) or a zUp orientation (false).
 WireCone
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireCone
(init:Object = null)
Creates a new WireCone object.
 WireCone
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WireCone
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 WireCone
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
height:Number  [read-write]

Defines the height of the wire cone. Defaults to 200.

Implementation
    public function get height():Number
    public function set height(value:Number):void
radius property  
radius:Number  [read-write]

Defines the radius of the wire cone base. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the wire cone. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the wire cone. Defaults to 8.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the wire 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
WireCone () constructor
public function WireCone(init:Object = null)

Constructor for the wire cone object. The init object parameters are : 'radius' defines 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)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(w:int, h:int):Vertex

Returns the vertex from a 2 dimensional representation of the wire 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
Wiki link
Click to go to the wiki page for 'away3d.primitives.WireCone'

Code examples
There are currently no examples for this class

WireCube

Package away3d.primitives
Class public class WireCube
Inheritance WireCube -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire cube primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
    depth : Number
Defines the depth of the cube.
 WireCube
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the cube.
 WireCube
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
    v000 : Vertex
WireCube
    v001 : Vertex
WireCube
    v010 : Vertex
WireCube
    v011 : Vertex
WireCube
    v100 : Vertex
WireCube
    v101 : Vertex
WireCube
    v110 : Vertex
WireCube
    v111 : Vertex
WireCube
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
    width : Number
Defines the width of the cube.
 WireCube
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireCube
(init:Object = null)
Creates a new WireCube object.
 WireCube
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WireCube
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
depth property
depth:Number  [read-write]

Defines the depth of the cube. Defaults to 100.

Implementation
    public function get depth():Number
    public function set depth(value:Number):void
height property  
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
v000 property  
public var v000:Vertex

One of the wire cube's vertices

v001 property  
public var v001:Vertex

One of the wire cube's vertices

v010 property  
public var v010:Vertex

One of the wire cube's vertices

v011 property  
public var v011:Vertex

One of the wire cube's vertices

v100 property  
public var v100:Vertex

One of the wire cube's vertices

v101 property  
public var v101:Vertex

One of the wire cube's vertices

v110 property  
public var v110:Vertex

One of the wire cube's vertices

v111 property  
public var v111:Vertex

One of the wire cube's vertices

width property  
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
WireCube () constructor
public function WireCube(init:Object = null)

Constructor for a wire cube object. The init object parameters are : 'width'/'height'/'depth' define the geometry of the cube object.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  width:Number (default = 100, min:0)
  height:Number (default = 100, min:0)
  depth:Number (default = 100, min:0)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

Wiki link
Click to go to the wiki page for 'away3d.primitives.WireCube'

Code examples
There are currently no examples for this class

WireCylinder

Package away3d.primitives
Class public class WireCylinder
Inheritance WireCylinder -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire cylinder primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the wire cylinder.
 WireCylinder
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the wire cylinder.
 WireCylinder
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
    segmentsH : Number
Defines the number of vertical segments that make up the wire cylinder.
 WireCylinder
    segmentsW : Number
Defines the number of horizontal segments that make up the wire cylinder.
 WireCylinder
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the wire cylinder points use a yUp orientation (true) or a zUp orientation (false).
 WireCylinder
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireCylinder
(init:Object = null)
Creates a new WireCylinder object.
 WireCylinder
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WireCylinder
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 WireCylinder
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
height:Number  [read-write]

Defines the height of the wire cylinder. Defaults to 200.

Implementation
    public function get height():Number
    public function set height(value:Number):void
radius property  
radius:Number  [read-write]

Defines the radius of the wire cylinder. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the wire cylinder. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the wire cylinder. Defaults to 8.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the wire 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
WireCylinder () constructor
public function WireCylinder(init:Object = null)

Constructor for a wire cylinder object. The init object parameters are : 'radius' defines the radius of the wire cylinder, 'height' defines the height, 'segmentsW' defines how many segments are the circumference is split into and 'segmentsH' how many segments the wire 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)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(w:int, h:int):Vertex

Returns the vertex from a 2 dimensional representation of the wire cylinders's vertex array.
I=horizontal reference.
J=vertical reference (0 = base of the wire 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
Wiki link
Click to go to the wiki page for 'away3d.primitives.WireCylinder'

Code examples
There are currently no examples for this class

WireframeMaterial

Package away3d.materials
Class public class WireframeMaterial
Implements ISegmentMaterial, ITriangleMaterial
Wire material for face border outlining only
Public Properties
  Property Defined by
    alpha : Number
Determines the alpha value of the wire
 WireframeMaterial
    color : int
Determines the color value of the wire
 WireframeMaterial
    visible : Boolean
[read-only] Indicates whether the material is visible
 WireframeMaterial
    width : Number
Determines the width value of the wire
 WireframeMaterial
Protected Properties
  Property Defined by
    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.
 WireframeMaterial
Public Methods
  Method Defined by
   
WireframeMaterial
(color:* = null, init:Object = null)
Creates a new WireframeMaterial object.
 WireframeMaterial
   
renderSegment(seg:DrawSegment):void
Sends data from the material coupled with data from the DrawSegment primitive to the render session.
 WireframeMaterial
   
renderTriangle(tri:DrawTriangle):void
Sends data from the material coupled with data from the DrawTriangle primitive to the render session.
 WireframeMaterial
Property detail
alpha property
public var alpha:Number

Determines the alpha value of the wire

color property  
public var color:int

Determines the color value of the wire

ini property  
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 property  
visible:Boolean  [read-only]

Indicates whether the material is visible

Implementation
    public function get visible():Boolean
width property  
public var width:Number

Determines the width value of the wire

Constructor detail
WireframeMaterial () constructor
public function WireframeMaterial(color:* = null, init:Object = null)
Parameters
color:* (default = null) - A string, hex value or colorname representing the color of the wire.
 
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  alpha:Number (default = 1, min:0, max:1)
  width:Number (default = 1, min:0)
Method detail
renderSegment () method
public function renderSegment(seg:DrawSegment):void

Sends data from the material coupled with data from the DrawSegment primitive to the render session.

Parameters
seg:DrawSegment
renderTriangle () method  
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
Wiki link
Click to go to the wiki page for 'away3d.materials.WireframeMaterial'

Code examples
There are currently no examples for this class

WireMesh

Package away3d.core.base
Class public class WireMesh
Inheritance WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Implements IPrimitiveProvider
Subclasses AbstractWirePrimitive, LineSegment
3d object containing segment elements
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
    elements : Array
[read-only] Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
    material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransformed : Boolean
Object3D
    segments : Array
[read-only] Returns an array of the segments contained in the wiremesh object.
 WireMesh
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireMesh
(init:Object = null)
Creates a new WireMesh object.
 WireMesh
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
   
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
   
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
   
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
elements property
elements:Array  [read-only]

Returns an array of the elements contained in the wiremesh object.

Implementation
    public function get elements():Array
material property  
public var material:ISegmentMaterial

Defines the material used to render the segments in the wiremesh object. Individual material settings on segments will override this setting.

See also

away3d.core.base.Segment.material
segments property  
segments:Array  [read-only]

Returns an array of the segments contained in the wiremesh object.

Implementation
    public function get segments():Array
Constructor detail
WireMesh () constructor
public function WireMesh(init:Object = null)
Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  material:SegmentMaterial
Method detail
addSegment () method
public function addSegment(segment:Segment):void

Adds a segment object to the wiremesh object.

Parameters
segment:Segment - The segment object to be added.
primitives () method  
public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object

Parameters
consumer:IPrimitiveConsumer - The consumer instance
 
session:AbstractRenderSession - The render session of the 3d object

See also

away3d.core.traverse.PrimitiveTraverser
away3d.core.draw.DrawSegment
removeSegment () method  
public function removeSegment(segment:Segment):void

Removes a segment object to the wiremesh object.

Parameters
segment:Segment - The segment object to be removed.
Wiki link
Click to go to the wiki page for 'away3d.core.base.WireMesh'

Code examples
There are currently no examples for this class

WirePlane

Package away3d.primitives
Class public class WirePlane
Inheritance WirePlane -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire plane primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
    height : Number
Defines the height of the wire plane.
 WirePlane
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
    segmentsH : Number
Defines the number of vertical segments that make up the wire plane.
 WirePlane
    segmentsW : Number
Defines the number of horizontal segments that make up the wire plane.
 WirePlane
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
    width : Number
Defines the width of the wire plane.
 WirePlane
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the wire plane points use a yUp orientation (true) or a zUp orientation (false).
 WirePlane
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WirePlane
(init:Object = null)
Creates a new buildWirePlane object.
 WirePlane
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WirePlane
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(i:int, j:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 WirePlane
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
height property
height:Number  [read-write]

Defines the height of the wire plane. Defaults to 100.

Implementation
    public function get height():Number
    public function set height(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the wire plane. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the wire plane. Defaults to 1.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
width property  
width:Number  [read-write]

Defines the width of the wire plane. Defaults to 100.

Implementation
    public function get width():Number
    public function set width(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the wire plane 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
WirePlane () constructor
public function WirePlane(init:Object = null)

Constructor for a wire frame plane object. The init object parameters are : 'width'/'height' defines the size of the plane, 'segments' defines the number of segments for width and height unless overriden, 'segmentsW' defines number segments the plane is split into horizontally and 'segmentsH' how many segments plane is split into vertically.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  width:Number (default = 100, min:0)
  height:Number (default = 100, min:0)
  segments:Int (default = 1, min:1)
  segmentsW:Int (default = segments, min:1)
  segmentsH:Int (default = segments, min:1)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(i:int, j:int):Vertex

Returns the vertex from a 2 dimensional representation of the wire frame plane's vertex array.
I=horizontal reference.
J=vertical reference.

Returns the vertex object specified by the grid position of the mesh.

Parameters
i:int - The horizontal position on the primitive mesh.
 
j:int - The vertical position on the primitive mesh.
Returns
Vertex
Wiki link
Click to go to the wiki page for 'away3d.primitives.WirePlane'

Code examples
There are currently no examples for this class

WireSphere

Package away3d.primitives
Class public class WireSphere
Inheritance WireSphere -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire sphere primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the radius of the wire sphere.
 WireSphere
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
    segmentsH : Number
Defines the number of vertical segments that make up the wire sphere.
 WireSphere
    segmentsW : Number
Defines the number of horizontal segments that make up the wire sphere.
 WireSphere
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the wire sphere points use a yUp orientation (true) or a zUp orientation (false).
 WireSphere
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireSphere
(init:Object = null)
Creates a new WireSphere object.
 WireSphere
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WireSphere
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(w:int, h:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 WireSphere
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
radius property
radius:Number  [read-write]

Defines the radius of the wire sphere. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsH property  
segmentsH:Number  [read-write]

Defines the number of vertical segments that make up the wire sphere. Defaults to 1.

Implementation
    public function get segmentsH():Number
    public function set segmentsH(value:Number):void
segmentsW property  
segmentsW:Number  [read-write]

Defines the number of horizontal segments that make up the wire sphere. Defaults to 8.

Implementation
    public function get segmentsW():Number
    public function set segmentsW(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the wire sphere 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
WireSphere () constructor
public function WireSphere(init:Object = null)

Constructor for a wire frame sphere object.

The init object parameters are : 'radius' defines the radius of the wire sphere, 'segmentsW' defines the number of segments horizontally around the sphere and 'segmentsH' which defines number of segments vertically between the poles of the sphere.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  radius:Number (default = 100, min:0)
  segmentsW:Int (default = 8, min:3)
  segmentsH:Int (default = 6, min:2)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(w:int, h:int):Vertex

Returns the vertex from a 2 dimensional representation of the sphere's vertex array.
I=horizontal reference.
J=vertical reference (0 = base of the wire frame sphere)

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
Wiki link
Click to go to the wiki page for 'away3d.primitives.WireSphere'

Code examples
There are currently no examples for this class

WireTorus

Package away3d.primitives
Class public class WireTorus
Inheritance WireTorus -> AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Creates a 3d wire torus primitive.
Public Properties
  Property Defined by
  (^) alpha : Number
An optional alpha value that can be applied to the 3d object.
 Object3D
  (^) blendMode : String
An optional blend mode that can be applied to the 3d object.
 Object3D
  (^) boundingRadius : Number
Returns the bounding radius of the 3d object
 BaseMesh
  (^) elements : Array
Returns an array of the elements contained in the wiremesh object.
 WireMesh
  (^) extra : Object
An optional untyped object that can contain used-defined properties
 Object3D
  (^) filters : Array
An optional array of filters that can be applied to the 3d object.
 Object3D
  (^) fps : int
Determines the frames per second at which the animation will run.
 BaseMesh
  (^) frame : int
Indicates the current frame of animation
 BaseMesh
  (^) framenames : Dictionary
A dictionary containing all frame names of the mesh
 BaseMesh
  (^) frames : Dictionary
A dictionary containing all frames of the mesh
 BaseMesh
  (^) hasCycleEvent : Boolean
Indicates whether the animation has a cycle event listener
 BaseMesh
  (^) hasSequenceEvent : Boolean
Indicates whether the animation has a sequencedone event listener
 BaseMesh
  (^) inverseSceneTransform : Matrix3D
Object3D
  (^) isRunning : Boolean
Indicates whether the animation is currently running.
 BaseMesh
  (^) loop : Boolean
Determines whether the animation will loop.
 BaseMesh
  (^) material : ISegmentMaterial
Defines the material used to render the segments in the wiremesh object.
 WireMesh
  (^) maxX : Number
Returns the maximum x value of the 3d object
 BaseMesh
  (^) maxY : Number
Returns the maximum y value of the 3d object
 BaseMesh
  (^) maxZ : Number
Returns the maximum z value of the 3d object
 BaseMesh
  (^) minX : Number
Returns the minimum x value of the 3d object
 BaseMesh
  (^) minY : Number
Returns the minimum y value of the 3d object
 BaseMesh
  (^) minZ : Number
Returns the minimum z value of the 3d object
 BaseMesh
  (^) mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
 Object3D
  (^) name : String
An optional name string for the 3d object.
 Object3D
  (^) ownCanvas : Boolean = false
Defines whether the contents of the 3d object are rendered inside it's own sprite
 Object3D
  (^) ownSession : AbstractRenderSession
Defines whether the contents of the 3d object are rendered using it's own render session
 Object3D
  (^) parent : ObjectContainer3D
Defines the parent of the 3d object.
 Object3D
  (^) position : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) projection : Projection
Object3D
  (^) pushback : Boolean
Elements use their furthest point from the camera when z-sorting
 BaseMesh
  (^) pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
 BaseMesh
    radius : Number
Defines the overall radius of the wire torus.
 WireTorus
  (^) rotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) rotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) scene : Scene3D
Returns the parent scene of the 3d object
 Object3D
  (^) scenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D.
 Object3D
  (^) sceneTransform : Matrix3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D.
 AbstractWirePrimitive
  (^) sceneTransformed : Boolean
Object3D
  (^) segments : Array
Returns an array of the segments contained in the wiremesh object.
 WireMesh
    segmentsR : Number
Defines the number of radial segments that make up the wire torus.
 WireTorus
    segmentsT : Number
Defines the number of tubular segments that make up the wire torus.
 WireTorus
  (^) session : AbstractRenderSession
The render session used by the 3d object
 Object3D
  (^) smooth : Boolean
Determines whether the animation will smooth motion (interpolate) between frames.
 BaseMesh
  (^) transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    tube : Number
Defines the tube radius of the wire torus.
 WireTorus
  (^) type : String
String defining the type of class used to generate the mesh.
 BaseMesh
  (^) url : String
String defining the source of the mesh.
 BaseMesh
  (^) useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
 Object3D
  (^) vertices : Array
Returns an array of the vertices contained in the mesh object
 BaseMesh
  (^) viewTransform : Matrix3D
Object3D
  (^) visible : Boolean = true
Defines whether the 3d object is visible in the scene
 Object3D
  (^) x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^) y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
    yUp : Boolean
Defines whether the coordinates of the wire torus points use a yUp orientation (true) or a zUp orientation (false).
 WireTorus
  (^) z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
Protected Properties
  Method Defined by
   
WireTorus
(init:Object = null)
Creates a new WireTorus object.
 WireTorus
  (^)
addOnCycle(listener:Function):void
Default method for adding a cycle event listener
 BaseMesh
  (^)
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
 Object3D
  (^)
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
 Object3D
  (^)
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
 Object3D
  (^)
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
 Object3D
  (^)
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
 Object3D
  (^)
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
 Object3D
  (^)
addOnRadiusChange(listener:Function):void
Default method for adding a radiuschanged event listener
 Object3D
  (^)
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
 Object3D
  (^)
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
 Object3D
  (^)
addOnSequenceDone(listener:Function):void
Default method for adding a squencedone event listener
 BaseMesh
  (^)
addOnTransformChange(listener:Function):void
Default method for adding a transformchanged event listener
 Object3D
  (^)
addSegment(segment:Segment):void
Adds a segment object to the wiremesh object.
 WireMesh
   
buildPrimitive():void
Builds the vertex, face and uv objects that make up the 3d primitive.
 WireTorus
  (^)
clone(object:* = null):*
Duplicates the 3d object's properties to another Object3D object
 Object3D
  (^)
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
 Object3D
  (^)
gotoAndPlay(value:int):void
Starts playing the animation at the specified frame.
 BaseMesh
  (^)
gotoAndStop(value:int):void
Brings the animation to the specifed frame and stops it there.
 BaseMesh
  (^)
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
 Object3D
  (^)
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
 Object3D
  (^)
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
 Object3D
  (^)
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
 Object3D
  (^)
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
 Object3D
  (^)
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
 Object3D
  (^)
moveTo(target:Number3D):void
Moves the 3d object directly to a point in space
 Object3D
  (^)
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
 Object3D
  (^)
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
 Object3D
  (^)
play(sequence:AnimationSequence):void
Plays a sequence of frames
 BaseMesh
  (^)
primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void
Called from the PrimitiveTraverser when passing DrawPrimitive objects to the primitive consumer object
 WireMesh
  (^)
removeOnCycle(listener:Function):void
Default method for removing a cycle event listener
 BaseMesh
  (^)
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
 Object3D
  (^)
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
 Object3D
  (^)
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
 Object3D
  (^)
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
 Object3D
  (^)
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
 Object3D
  (^)
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
 Object3D
  (^)
removeOnRadiusChange(listener:Function):void
Default method for removing a radiuschanged event listener
 Object3D
  (^)
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
 Object3D
  (^)
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
 Object3D
  (^)
removeOnSequenceDone(listener:Function):void
Default method for removing a squencedone event listener
 BaseMesh
  (^)
removeOnTransformChange(listener:Function):void
Default method for removing a transformchanged event listener
 Object3D
  (^)
removeSegment(segment:Segment):void
Removes a segment object to the wiremesh object.
 WireMesh
  (^)
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
 Object3D
  (^)
rotate(axis:Number3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
 Object3D
  (^)
scale(scale:Number):void
Scales the contents of the mesh.
 BaseMesh
  (^)
scaleAnimation(scale:Number):void
Scales the vertex positions contained within all animation frames
 BaseMesh
  (^)
scaleX(scaleX:Number):void
Scales the contents of the mesh along the x-axis.
 BaseMesh
  (^)
scaleY(scaleY:Number):void
Scales the contents of the mesh along the y-axis.
 BaseMesh
  (^)
scaleZ(scaleZ:Number):void
Scales the contents of the mesh along the z-axis.
 BaseMesh
  (^)
setPlaySequences(playlist:Array, loopLast:Boolean = false):void
Passes an array of animationsequence objects to be added to the animation.
 BaseMesh
  (^)
tick(time:int):void
Called by the TickTraverser.
 BaseMesh
  (^)
toString():String
Used to trace the values of a 3d object.
 Object3D
  (^)
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
 Object3D
  (^)
traverse(traverser:Traverser):void
Used when traversing the scenegraph
 Object3D
   
vertex(r:int, t:int):Vertex
Returns the vertex object specified by the grid position of the mesh.
 WireTorus
  (^)
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
 Object3D
Protected Methods
  Method Defined by
  (^)
addElement(element:IMeshElement):void
Adds an element to the mesh object.
 BaseMesh
  (^)
removeElement(element:IMeshElement):void
Removes an element to the mesh object.
 BaseMesh
  (^)
scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void
Scales the contents of the mesh using 3 axis values.
 BaseMesh
Events
  Event Summary Defined by
  (^)
cycle
 Dispatched when the animation object completes a single sequence cycle. BaseMesh
  (^)
dimensionschanged
 Dispatched when the bounding dimensions of the 3d object changes. Object3D
  (^)
mouseDown3D
 Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
mouseMove3D
 Dispatched when a user moves the cursor while it is over the 3d object. Object3D
  (^)
mouseOut3D
 Dispatched when a user moves the cursor away from the 3d object. Object3D
  (^)
mouseOver3D
 Dispatched when a user moves the cursor over the 3d object. Object3D
  (^)
mouseUp3D
 Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object. Object3D
  (^)
radiuschanged
 Dispatched when the bounding radius of the 3d object changes. Object3D
  (^)
scenechanged
 Dispatched when the parent scene of the 3d object changes Object3D
  (^)
scenetransformchanged
 Dispatched when the scene transform matrix of the 3d object changes. Object3D
  (^)
sequencedone
 Dispatched when the animation object completes all frame sequences. BaseMesh
  (^)
transformchanged
 Dispatched when the local transform matrix of the 3d object changes. Object3D
Property detail
radius property
radius:Number  [read-write]

Defines the overall radius of the wire torus. Defaults to 100.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
segmentsR property  
segmentsR:Number  [read-write]

Defines the number of radial segments that make up the wire torus. Defaults to 8.

Implementation
    public function get segmentsR():Number
    public function set segmentsR(value:Number):void
segmentsT property  
segmentsT:Number  [read-write]

Defines the number of tubular segments that make up the wire torus. Defaults to 6.

Implementation
    public function get segmentsT():Number
    public function set segmentsT(value:Number):void
tube property  
tube:Number  [read-write]

Defines the tube radius of the wire torus. Defaults to 40.

Implementation
    public function get tube():Number
    public function set tube(value:Number):void
yUp property  
yUp:Boolean  [read-write]

Defines whether the coordinates of the wire torus 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
WireTorus () constructor
public function WireTorus(init:Object = null)

Constructor for a wire frame torus object.

The init object parameters are : 'radius' defines the radius of the torus, 'tube' defines the tube radius (thickness), 'segmentsR' defines the number of segments the torus is divided into around rotationally around the circumference of the circle defined by the radius and 'segmentsT' which defines number of segments for the tube, around it's cross-section.

Parameters
init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.
Init Parameters
  radius:Number (default = 100, min:0)
  tube:Number (default = 40, min:0, max:radius)
  segmentsR:Int (default = 8, min:3)
  segmentsT:Int (default = 6, min:3)
  yUp:Boolean (default = true)
Method detail
buildPrimitive () method
public override function buildPrimitive():void

Builds the vertex, face and uv objects that make up the 3d primitive.

vertex () method  
public function vertex(r:int, t:int):Vertex

Returns the vertex from a 2 dimensional representation of the torus' vertex array.
I=horizontal reference.
J=vertical reference

Returns the vertex object specified by the grid position of the mesh.

Parameters
r:int - The radial position on the primitive mesh.
 
t:int - The tubular position on the primitive mesh.
Returns
Vertex
Wiki link
Click to go to the wiki page for 'away3d.primitives.WireTorus'

Code examples
There are currently no examples for this class

ZDepthFilter

Package away3d.core.filter
Class public class ZDepthFilter
Implements IPrimitiveFilter
Defines a maximum z value for rendering primitives
Public Methods
  Method Defined by
   
ZDepthFilter
(maxZ:Number)
Creates a new ZDepthFilter object.
 ZDepthFilter
   
filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array
Applies the filter to the primitive array.
 ZDepthFilter
   
toString():String
Used to trace the values of a filter.
 ZDepthFilter
Constructor detail
ZDepthFilter () constructor
public function ZDepthFilter(maxZ:Number)
Parameters
maxZ:Number - A maximum allowed depth value for drawing primitives.
Method detail
filter () method
public function filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array

Applies the filter to the primitive array.

Parameters
primitives:Array - The primitives to be filtered.
 
scene:Scene3D - The scene to which the primitives belongs.
 
camera:Camera3D - The camera being used in the renderer for the primitives.
 
clip:Clipping - The clipping object used in the renderer for the primitive's view.
Returns
Array
toString () method  
public function toString():String

Used to trace the values of a filter.

Returns
String - A string representation of the filter object.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.ZDepthFilter'

Code examples
There are currently no examples for this class

ZSortFilter

Package away3d.core.filter
Class public class ZSortFilter
Implements IPrimitiveFilter
Sorts drawing primitives by z coordinate.
Public Methods
  Method Defined by
   
filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array
Applies the filter to the primitive array.
 ZSortFilter
   
toString():String
Used to trace the values of a filter.
 ZSortFilter
Method detail
filter () method
public function filter(primitives:Array, scene:Scene3D, camera:Camera3D, clip:Clipping):Array

Applies the filter to the primitive array.

Parameters
primitives:Array - The primitives to be filtered.
 
scene:Scene3D - The scene to which the primitives belongs.
 
camera:Camera3D - The camera being used in the renderer for the primitives.
 
clip:Clipping - The clipping object used in the renderer for the primitive's view.
Returns
Array
toString () method  
public function toString():String

Used to trace the values of a filter.

Returns
String - A string representation of the filter object.
Wiki link
Click to go to the wiki page for 'away3d.core.filter.ZSortFilter'

Code examples
There are currently no examples for this class