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

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

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.

	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

	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

	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.

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.

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.

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

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

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

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

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.

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.

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

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.

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.

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.

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

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

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.

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)

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

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

	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

	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

	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		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

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

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

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

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

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

	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

	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

	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

	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		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

	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

	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

	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

	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

	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