Away3D API Reference: V2.1

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

AbstractPrimitive

Package	away3d.primitives
Class	public class AbstractPrimitive
Inheritance	AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses	Cone, Cube, Cylinder, GeodesicSphere, Plane, RegularPolygon, Sphere, Torus

Creates a 3d cone primitive.

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	BaseMesh
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Mesh
(^)	elements : Array Returns an array of the elements contained in the mesh object.	Mesh
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	BaseMesh
(^)	frame : int Indicates the current frame of animation	BaseMesh
(^)	framenames : Dictionary A dictionary containing all frame names of the mesh	BaseMesh
(^)	frames : Dictionary A dictionary containing all frames of the mesh	BaseMesh
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	BaseMesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	BaseMesh
(^)	indexes : Array	Mesh
(^)	inverseSceneTransform : Matrix3D	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	BaseMesh
(^)	loop : Boolean Determines whether the animation will loop.	BaseMesh
(^)	material : ITriangleMaterial Defines the material used to render the faces in the mesh object.	Mesh
(^)	maxX : Number Returns the maximum x value of the 3d object	BaseMesh
(^)	maxY : Number Returns the maximum y value of the 3d object	BaseMesh
(^)	maxZ : Number Returns the maximum z value of the 3d object	BaseMesh
(^)	minX : Number Returns the minimum x value of the 3d object	BaseMesh
(^)	minY : Number Returns the minimum y value of the 3d object	BaseMesh
(^)	minZ : Number Returns the minimum z value of the 3d object	BaseMesh
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	BaseMesh
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	BaseMesh
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
	sceneTransform : Matrix3D [read-only] Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	AbstractPrimitive
(^)	sceneTransformed : Boolean	Object3D
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	BaseMesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	type : String String defining the type of class used to generate the mesh.	BaseMesh
(^)	url : String String defining the source of the mesh.	BaseMesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object	BaseMesh
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D

Protected Properties

Method		Defined by
	AbstractPrimitive (init:Object = null) Creates a new `AbstractPrimitive` object.	AbstractPrimitive
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	BaseMesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a squencedone event listener	BaseMesh
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
	buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive.	AbstractPrimitive
(^)	clone(object:* = null):* Duplicates the mesh properties to another 3d object.	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	BaseMesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	BaseMesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	movePivot(dx:Number, dy:Number, dz:Number):void Moves the origin point of the mesh without moving the contents.	Mesh
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	BaseMesh
(^)	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	Mesh
(^)	quarterFaces():void Divides a face object into 4 equal sized face objects.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	BaseMesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a squencedone event listener	BaseMesh
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the mesh.	BaseMesh
(^)	scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames	BaseMesh
(^)	scaleX(scaleX:Number):void Scales the contents of the mesh along the x-axis.	BaseMesh
(^)	scaleY(scaleY:Number):void Scales the contents of the mesh along the y-axis.	BaseMesh
(^)	scaleZ(scaleZ:Number):void Scales the contents of the mesh along the z-axis.	BaseMesh
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	BaseMesh
(^)	tick(time:int):void Called by the `TickTraverser`.	BaseMesh
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	addElement(element:IMeshElement):void Adds an element to the mesh object.	BaseMesh
(^)	removeElement(element:IMeshElement):void Removes an element to the mesh object.	BaseMesh
(^)	scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void Scales the contents of the mesh using 3 axis values.	BaseMesh

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when the animation object completes a single sequence cycle.	BaseMesh
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
(^)	sequencedone	Dispatched when the animation object completes all frame sequences.	BaseMesh
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

sceneTransform

property

sceneTransform:Matrix3D [read-only]

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

Implementation
public function get sceneTransform():Matrix3D

Constructor detail

AbstractPrimitive

()

constructor

public function AbstractPrimitive(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties

Method detail

buildPrimitive

()

method

public function buildPrimitive():void

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

Wiki link

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

Code examples

There are currently no examples for this class

AbstractRenderSession

Package	away3d.core.render
Class	public class AbstractRenderSession
Subclasses	BitmapRenderSession, SpriteRenderSession

Abstract Drawing session object containing the method used for drawing the view to screen. Not intended for direct use - use SpriteRenderSession or BitmapRenderSession.

Public Properties

	Property		Defined by
		children : Dictionary Dictionary of child displayobjects.	AbstractRenderSession
		graphics : Graphics Reference to the current graphics object being used for drawing.	AbstractRenderSession
		lightarray : LightArray Defines the light provider object for the render sesion.	AbstractRenderSession
		newLayer : Sprite Holds the last added layer sprite.	AbstractRenderSession
		sessions : Dictionary Dictionary of child sessions.	AbstractRenderSession
		spriteLayers : Array Dictionary of sprite layers for rendering composite materials.	AbstractRenderSession
		view : View3D Defines the view object used for the render session.	AbstractRenderSession

Public Methods

	Method		Defined by
		addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list.	AbstractRenderSession
		addLayerObject(child:Sprite):void Adds a layer sprite to the render session display list.	AbstractRenderSession
		clear():void Clears the render session.	AbstractRenderSession
		clone():AbstractRenderSession Duplicates the render session's properties to another render session.	AbstractRenderSession
		flush():void Flushes any cached drawing operations to screen.	AbstractRenderSession
		getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view.	AbstractRenderSession
		registerChildSession(session:AbstractRenderSession):void Adds a session as a child of the session object.	AbstractRenderSession
		renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void Draws a non-scaled bitmap into the graphics object.	AbstractRenderSession
		renderFogColor(color:int, alpha:Number):void Draws a fog element into the graphics object.	AbstractRenderSession
		renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object.	AbstractRenderSession
		renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void Draws a bitmap with a precalculated matrix into the graphics object.	AbstractRenderSession
		renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object.	AbstractRenderSession
		renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a triangle element with a fill color into the graphics object.	AbstractRenderSession
		renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element into the graphics object.	AbstractRenderSession
		renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element with a fill color into the graphics object.	AbstractRenderSession

Protected Methods

	Method		Defined by
		createLayer():void Creates a new render layer for rendering composite materials.	AbstractRenderSession

Property detail

children

property

public var children:Dictionary

Dictionary of child displayobjects.

doActive

property

arcane var doActive:Array

Array for storing added displayobjects to the canvas

doStore

property

arcane var doStore:Array

Array for storing old displayobjects to the canvas

graphics

property

public var graphics:Graphics

Reference to the current graphics object being used for drawing.

lightarray

property

lightarray:LightArray [read-write]

Defines the light provider object for the render sesion.

Implementation
public function get lightarray():LightArray
public function set lightarray(value:LightArray):void

newLayer

property

public var newLayer:Sprite

Holds the last added layer sprite.

sessions

property

public var sessions:Dictionary

Dictionary of child sessions.

spriteLayers

property

public var spriteLayers:Array

Dictionary of sprite layers for rendering composite materials.

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.

Public Properties

	Property		Defined by
		blendMode : String Defines a blendMode value for the shader bitmap.	AbstractShader
		debug : Boolean Determines if faces with the shader applied are drawn with outlines	AbstractShader
		smooth : Boolean Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen	AbstractShader
		visible : Boolean [read-only] Indicates whether the material is visible	AbstractShader

Protected Properties

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

Public Methods

	Method		Defined by
		AbstractShader (init:Object = null) Creates a new `AbstractShader` object.	AbstractShader
		renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face.	AbstractShader
		renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	AbstractShader
		updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	AbstractShader

Protected Methods

	Method		Defined by
		clearFaceDictionary(source:Object3D, view:View3D):void Clears face value objects when shader requires updating	AbstractShader
		getLightingShape(layer:Sprite, light:LightPrimitive):Shape Returns a shape object for use by light shaders	AbstractShader
		getShape(layer:Sprite):Shape Returns a shape object for use by environment shaders.	AbstractShader
		renderShader(face:Face):void Renders the shader to the specified face.	AbstractShader

Property detail

blendMode

property

public var blendMode:String

Defines a blendMode value for the shader bitmap.

debug

property

public var debug:Boolean

Determines if faces with the shader applied are drawn with outlines

ini

property

protected var ini:Init

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

smooth

property

public var smooth:Boolean

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

visible

property

visible:Boolean [read-only]

Indicates whether the material is visible

Implementation
public function get visible():Boolean

Constructor detail

AbstractShader

()

constructor

public function AbstractShader(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`smooth:Boolean` (default = false)
	`debug:Boolean` (default = false)
	`blendMode:String` (default = BlendMode.NORMAL)

Method detail

clearFaceDictionary

()

method

protected function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters

	`source:Object3D` - The parent 3d object of the face.

	`view:View3D` - The view rendering the draw triangle.

See also

away3d.core.utils.FaceVO

getLightingShape

()

method

protected function getLightingShape(layer:Sprite, light:LightPrimitive):Shape

Returns a shape object for use by light shaders

Parameters

	`layer:Sprite` - The parent layer of the triangle.

	`light:LightPrimitive` - The light primitive.

Returns

Shape - The resolved shape object to use for drawing.

getShape

()

method

protected function getShape(layer:Sprite):Shape

Returns a shape object for use by environment shaders.

Parameters

layer:Sprite - The parent layer of the triangle

Returns

Shape - The resolved shape object to use for drawing

renderFace

()

method

public function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters

	`face:Face` - The face object onto which the rendered sufrace is applied.

	`containerRect:Rectangle` - The rectangle object defining the bounds of the face in uv-space.

	`parentFaceVO:FaceVO` - The value object of the preceeding surface.

Returns

FaceVO

renderLayer

()

method

public function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void

Renders a material layer for the specified triangle.

Parameters

	`tri:DrawTriangle` - The drawtriangle used for render information.

	`layer:Sprite` - The parent layer into which the triangle is drawn.

	`level:int` - Defines the sprite level for the layer.

renderShader

()

method

protected function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters

face:Face - The face object being rendered.

updateMaterial

()

method

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

Called once per render loop when material is visible.

Parameters

	`source:Object3D`

	`view:View3D`

Wiki link

Click to go to the wiki page for 'away3d.materials.shaders.AbstractShader'

Code examples

There are currently no examples for this class

AbstractWirePrimitive

Package	away3d.primitives
Class	public class AbstractWirePrimitive
Inheritance	AbstractWirePrimitive -> WireMesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses	GridPlane, WireCircle, WireCone, WireCube, WireCylinder, WirePlane, WireSphere, WireTorus

Creates a 3d cone primitive.

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	BaseMesh
(^)	elements : Array Returns an array of the elements contained in the wiremesh object.	WireMesh
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	BaseMesh
(^)	frame : int Indicates the current frame of animation	BaseMesh
(^)	framenames : Dictionary A dictionary containing all frame names of the mesh	BaseMesh
(^)	frames : Dictionary A dictionary containing all frames of the mesh	BaseMesh
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	BaseMesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	BaseMesh
(^)	inverseSceneTransform : Matrix3D	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	BaseMesh
(^)	loop : Boolean Determines whether the animation will loop.	BaseMesh
(^)	material : ISegmentMaterial Defines the material used to render the segments in the wiremesh object.	WireMesh
(^)	maxX : Number Returns the maximum x value of the 3d object	BaseMesh
(^)	maxY : Number Returns the maximum y value of the 3d object	BaseMesh
(^)	maxZ : Number Returns the maximum z value of the 3d object	BaseMesh
(^)	minX : Number Returns the minimum x value of the 3d object	BaseMesh
(^)	minY : Number Returns the minimum y value of the 3d object	BaseMesh
(^)	minZ : Number Returns the minimum z value of the 3d object	BaseMesh
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	BaseMesh
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	BaseMesh
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
	sceneTransform : Matrix3D [read-only] Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	AbstractWirePrimitive
(^)	sceneTransformed : Boolean	Object3D
(^)	segments : Array Returns an array of the segments contained in the wiremesh object.	WireMesh
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	BaseMesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	type : String String defining the type of class used to generate the mesh.	BaseMesh
(^)	url : String String defining the source of the mesh.	BaseMesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object	BaseMesh
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D

Protected Properties

Method		Defined by
	AbstractWirePrimitive (init:Object = null) Creates a new `AbstractPrimitive` object.	AbstractWirePrimitive
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	BaseMesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a squencedone event listener	BaseMesh
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	addSegment(segment:Segment):void Adds a segment object to the wiremesh object.	WireMesh
	buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive.	AbstractWirePrimitive
(^)	clone(object:* = null):* Duplicates the 3d object's properties to another `Object3D` object	Object3D
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	BaseMesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	BaseMesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	BaseMesh
(^)	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	WireMesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	BaseMesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a squencedone event listener	BaseMesh
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	removeSegment(segment:Segment):void Removes a segment object to the wiremesh object.	WireMesh
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the mesh.	BaseMesh
(^)	scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames	BaseMesh
(^)	scaleX(scaleX:Number):void Scales the contents of the mesh along the x-axis.	BaseMesh
(^)	scaleY(scaleY:Number):void Scales the contents of the mesh along the y-axis.	BaseMesh
(^)	scaleZ(scaleZ:Number):void Scales the contents of the mesh along the z-axis.	BaseMesh
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	BaseMesh
(^)	tick(time:int):void Called by the `TickTraverser`.	BaseMesh
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	addElement(element:IMeshElement):void Adds an element to the mesh object.	BaseMesh
(^)	removeElement(element:IMeshElement):void Removes an element to the mesh object.	BaseMesh
(^)	scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void Scales the contents of the mesh using 3 axis values.	BaseMesh

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when the animation object completes a single sequence cycle.	BaseMesh
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
(^)	sequencedone	Dispatched when the animation object completes all frame sequences.	BaseMesh
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

sceneTransform

property

sceneTransform:Matrix3D [read-only]

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

Implementation
public function get sceneTransform():Matrix3D

Constructor detail

AbstractWirePrimitive

()

constructor

public function AbstractWirePrimitive(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties

Method detail

buildPrimitive

()

method

public function buildPrimitive():void

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

Wiki link

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

Code examples

There are currently no examples for this class

AmbientLight

Package	away3d.core.light
Class	public class AmbientLight
Inheritance	AmbientLight -> LightPrimitive

Ambient light primitive

Public Properties

Property		Defined by
(^)	ambient : Number Coefficient for the ambient light intensity.	LightPrimitive
(^)	ambientBitmap : BitmapData Lightmap for ambient intensity.	LightPrimitive
(^)	ambientDiffuseBitmap : BitmapData Combined lightmap for ambient and diffuse intensities.	LightPrimitive
(^)	blue : Number Blue component level.	LightPrimitive
(^)	diffuse : Number Coefficient for the diffuse light intensity.	LightPrimitive
(^)	diffuseBitmap : BitmapData Lightmap for diffuse intensity.	LightPrimitive
(^)	green : Number Green component level.	LightPrimitive
	light : AmbientLight3D A reference to the `AmbientLight3D` object used by the light primitive.	AmbientLight
(^)	red : Number Red component level.	LightPrimitive
(^)	specular : Number Coefficient for the specular light intensity.	LightPrimitive
(^)	specularBitmap : BitmapData Lightmap for specular intensity.	LightPrimitive

Public Methods

	Method		Defined by
		updateAmbientBitmap(ambient:Number):void Updates the bitmapData object used as the lightmap for ambient light shading.	AmbientLight

Property detail

light

property

public var light:AmbientLight3D

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

Method detail

updateAmbientBitmap

()

method

public function updateAmbientBitmap(ambient:Number):void

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

Parameters

ambient:Number - The coefficient for ambient light intensity.

Wiki link

Click to go to the wiki page for 'away3d.core.light.AmbientLight'

Code examples

There are currently no examples for this class

AmbientLight3D

Package	away3d.lights
Class	public class AmbientLight3D
Inheritance	AmbientLight3D -> Object3D -> flash.events.EventDispatcher
Implements	IClonable, ILightProvider, IPrimitiveProvider

Lightsource that colors all shaded materials evenly from any angle

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
	ambient : Number Defines a coefficient for the ambient light intensity.	AmbientLight3D
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
	color : int Defines the color of the light object.	AmbientLight3D
	debug : Boolean Toggles debug mode: light object is visualised in the scene.	AmbientLight3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	inverseSceneTransform : Matrix3D	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransformed : Boolean	Object3D
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D

Protected Properties

Method		Defined by
	AmbientLight3D (init:Object = null) Creates a new `AmbientLight3D` object.	AmbientLight3D
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
	clone(object:* = null):* Duplicates the light object's properties to another `AmbientLight3D` object	AmbientLight3D
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
	light(consumer:ILightConsumer):void Called from the `PrimitiveTraverser` when passing `LightPrimitive` objects to the light consumer object	AmbientLight3D
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	AmbientLight3D
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
(^)	tick(time:int):void Called by the `TickTraverser`.	Object3D
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Events

Event		Summary	Defined by
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

ambient

property

ambient:Number [read-write]

Defines a coefficient for the ambient light intensity.

Implementation
public function get ambient():Number
public function set ambient(value:Number):void

color

property

color:int [read-write]

Defines the color of the light object.

Implementation
public function get color():int
public function set color(value:int):void

debug

property

public var debug:Boolean

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

Constructor detail

AmbientLight3D

()

constructor

public function AmbientLight3D(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`color:Color` (default = 0xFFFFFF)
	`ambient:Number` (default = 0.5, min:0, max:1)
	`debug:Boolean` (default = false)

Method detail

clone

()

method

public override function clone(object:* = null):*

Duplicates the light object's properties to another AmbientLight3D object

Parameters

object:* (default = null) - [optional] The new object instance into which all properties are copied

Returns

* - The new object instance with duplicated properties applied

light

()

method

public function light(consumer:ILightConsumer):void

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

Parameters

consumer:ILightConsumer - The consumer instance.

primitives

()

method

public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

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

Parameters

	`consumer:IPrimitiveConsumer` - The consumer instance

	`session:AbstractRenderSession` - The render session of the 3d object

Wiki link

Click to go to the wiki page for 'away3d.lights.AmbientLight3D'

Code examples

There are currently no examples for this class

AmbientShader

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

Shader class for ambient lighting

See also

away3d.lights.AmbientLight3D

Public Properties

Property		Defined by
(^)	blendMode : String Defines a blendMode value for the shader bitmap.	AbstractShader
	color : uint Defines a 24 bit color value used by the shader	AmbientShader
(^)	debug : Boolean Determines if faces with the shader applied are drawn with outlines	AbstractShader
(^)	smooth : Boolean Determines if the shader bitmap is smoothed (bilinearly filtered) when drawn to screen	AbstractShader
(^)	visible : Boolean Indicates whether the material is visible	AbstractShader

Protected Properties

Method		Defined by
	AmbientShader (init:Object = null) Creates a new `AmbientShader` object.	AmbientShader
(^)	renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face.	AbstractShader
	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	AmbientShader
	updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	AmbientShader

Protected Methods

Method		Defined by
	clearFaceDictionary(source:Object3D, view:View3D):void Clears face value objects when shader requires updating	AmbientShader
(^)	getLightingShape(layer:Sprite, light:LightPrimitive):Shape Returns a shape object for use by light shaders	AbstractShader
(^)	getShape(layer:Sprite):Shape Returns a shape object for use by environment shaders.	AbstractShader
	renderShader(face:Face):void Renders the shader to the specified face.	AmbientShader

Property detail

color

property

public var color:uint

Defines a 24 bit color value used by the shader

Constructor detail

AmbientShader

()

constructor

public function AmbientShader(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

Method detail

clearFaceDictionary

()

method

protected override function clearFaceDictionary(source:Object3D, view:View3D):void

Clears face value objects when shader requires updating

Parameters

	`source:Object3D` - The parent 3d object of the face.

	`view:View3D` - The view rendering the draw triangle.

renderLayer

()

method

public override function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void

Renders a material layer for the specified triangle.

Parameters

	`tri:DrawTriangle` - The drawtriangle used for render information.

	`layer:Sprite` - The parent layer into which the triangle is drawn.

	`level:int` - Defines the sprite level for the layer.

renderShader

()

method

protected override function renderShader(face:Face):void

Renders the shader to the specified face.

Parameters

face:Face - The face object being rendered.

updateMaterial

()

method

public override function updateMaterial(source:Object3D, view:View3D):void

Called once per render loop when material is visible.

Parameters

	`source:Object3D`

	`view:View3D`

Wiki link

Click to go to the wiki page for 'away3d.materials.shaders.AmbientShader'

Code examples

There are currently no examples for this class

AnimatedBitmapMaterial

Package	away3d.materials
Class	public class AnimatedBitmapMaterial
Inheritance	AnimatedBitmapMaterial -> TransformBitmapMaterial -> BitmapMaterial -> flash.events.EventDispatcher
Implements	ITriangleMaterial, IUVMaterial

Bitmap material that allows fast rendering of animations by caching bitmapdata objects for each frame. Not suitable for use with long animations, where the initialisation time will be lengthy and the memory footprint large. If interactive movieclip properties are required, please refer to MovieMaterial.

Public Properties

Property		Defined by
(^)	alpha : Number Defines an alpha value for the texture bitmap.	BitmapMaterial
	autoplay : Boolean Indicates whether the animation will start playing on initialisation.	AnimatedBitmapMaterial
(^)	bitmap : BitmapData Returns the bitmapData object being used as the material texture.	BitmapMaterial
(^)	blendMode : String Defines a blendMode value for the texture bitmap.	BitmapMaterial
(^)	color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
(^)	debug : Boolean = false Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
(^)	globalProjection : Boolean Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.	TransformBitmapMaterial
(^)	height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
	index : int [write-only] Manually sets the frame index of the animation.	AnimatedBitmapMaterial
	loop : Boolean Indicates whether the animation will loop.	AnimatedBitmapMaterial
(^)	offsetX : Number Offsets the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	offsetY : Number Offsets the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
(^)	projectionVector : Number3D Projects the texture in object space, ignoring the uv coordinates of the vertex objects.	TransformBitmapMaterial
(^)	repeat : Boolean = false Determines if texture bitmap will tile in uv-space	BitmapMaterial
(^)	rotation : Number Rotates the texture in uv-space	TransformBitmapMaterial
(^)	scaleX : Number Scales the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	scaleY : Number Scales the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	smooth : Boolean = false Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
(^)	throughProjection : Boolean Determines whether a projected texture is visble on the faces pointing away from the projection.	TransformBitmapMaterial
(^)	transform : Matrix Transforms the texture in uv-space	TransformBitmapMaterial
(^)	visible : Boolean Indicates whether the material is visible	BitmapMaterial
(^)	width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

Method		Defined by
	AnimatedBitmapMaterial (movie:MovieClip, init:Object = null) Creates a new `AnimatedBitmapMaterial` object.	AnimatedBitmapMaterial
(^)	addOnResize(listener:Function):void Default method for adding a materialresize event listener	BitmapMaterial
(^)	getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	TransformBitmapMaterial
	play():void Resumes playback of the animation	AnimatedBitmapMaterial
(^)	removeOnResize(listener:Function):void Default method for removing a materialresize event listener	BitmapMaterial
(^)	renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face.	TransformBitmapMaterial
(^)	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
(^)	renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	TransformBitmapMaterial
	setFrames(sources:Array):void Resets the cached bitmapData objects making up the animation with a pre-defined array.	AnimatedBitmapMaterial
	setMovie(movie:MovieClip):void Resets the movieclip used by the material.	AnimatedBitmapMaterial
	stop():void Halts playback of the animation	AnimatedBitmapMaterial
(^)	updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	TransformBitmapMaterial

Protected Methods

Method		Defined by
(^)	getMapping(tri:DrawTriangle):Matrix Calculates the mapping matrix required to draw the triangle texture to screen.	TransformBitmapMaterial
(^)	setColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
(^)	updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterial

Events

	Event		Summary	Defined by
	(^)	materialresize	Dispatched when the bitmapData used for the material texture is resized.	BitmapMaterial

Property detail

autoplay

property

public var autoplay:Boolean

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

index

property

index:int [write-only]

Manually sets the frame index of the animation.

Implementation
public function set index(value:int):void

loop

property

public var loop:Boolean

Indicates whether the animation will loop.

Constructor detail

AnimatedBitmapMaterial

()

constructor

public function AnimatedBitmapMaterial(movie:MovieClip, init:Object = null)
Parameters

	`movie:MovieClip` - The movieclip to be bitmap cached for use in the material.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Method detail

play

()

method

public function play():void

Resumes playback of the animation

setFrames

()

method

public function setFrames(sources:Array):void

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

Parameters

sources:Array

setMovie

()

method

public function setMovie(movie:MovieClip):void

Resets the movieclip used by the material.

Parameters

movie:MovieClip - The movieclip to be bitmap cached for use in the material.

stop

()

method

public function stop():void

Halts playback of the animation

Wiki link

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

Code examples

There are currently no examples for this class

Animation

Package	away3d.core.base
Class	public class Animation
Inheritance	Animation -> flash.events.EventDispatcher
Implements	IAnimation

Holds information about the current state of a mesh animation.

Public Properties

	Property		Defined by
		cycleEvent : Boolean = false Determines whether the animation will fire cycle events.	Animation
		delay : Number = 0 Determines the delay time between animation cycles if loop is set to true.	Animation
		fps : Number = 24 The frames per second at which the animation will run.	Animation
		frame : Number = 0 The current frame of the animation.	Animation
		isRunning : Boolean [read-only] Indicates whether the animation is currently running.	Animation
		latest : uint [read-only] Returns the number of the latest frame displayed.	Animation
		loop : Boolean = false Determines whether the animation will loop.	Animation
		object : BaseMesh The Mesh on which the animation is occurring.	Animation
		sequence : Array Holds an array of animation frames.	Animation
		sequenceEvent : Boolean = false Determines whether the animation will fire sequence events.	Animation
		smooth : Boolean = false Determines whether the animation will smooth motion (interpolate) between frames.	Animation

Public Methods

	Method		Defined by
		Animation (obj:BaseMesh) Creates a new `Animation` object.	Animation
		start():void Jumps to the beginning of the animation and start playing	Animation
		stop():void Stops the animation at it's current position.	Animation
		update(mesh:BaseMesh):void Updates the positions of vertex objects in the mesh to the current frame values	Animation

Events

	Event		Summary	Defined by
		cycle	Dispatched when all frame sequences are complete	Animation
		sequenceupdate	Dispatched when the current frame sequence is complete	Animation

Property detail

cycleEvent

property

public var cycleEvent:Boolean = false

Determines whether the animation will fire cycle events.

See also

away3d.events.AnimationEvent

delay

property

public var delay:Number = 0

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

See also

loop

fps

property

public var fps:Number = 24

The frames per second at which the animation will run.

frame

property

public var frame:Number = 0

The current frame of the animation.

isRunning

property

isRunning:Boolean [read-only]

Indicates whether the animation is currently running.

Implementation
public function get isRunning():Boolean

latest

property

latest:uint [read-only]

Returns the number of the latest frame displayed.

Implementation
public function get latest():uint

loop

property

public var loop:Boolean = false

Determines whether the animation will loop.

object

property

public var object:BaseMesh

The Mesh on which the animation is occurring.

sequence

property

public var sequence:Array

Holds an array of animation frames.

See also

away3d.core.base.AnimationFrame

sequenceEvent

property

public var sequenceEvent:Boolean = false

Determines whether the animation will fire sequence events.

See also

away3d.events.AnimationEvent

smooth

property

public var smooth:Boolean = false

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

Constructor detail

Animation

()

constructor

public function Animation(obj:BaseMesh)
Parameters

obj:BaseMesh - The mesh object that the animation acts on.

Method detail

start

()

method

public function start():void

Jumps to the beginning of the animation and start playing

stop

()

method

public function stop():void

Stops the animation at it's current position.

update

()

method

public function update(mesh:BaseMesh):void

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

Parameters

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

Event detail

cycle

event

Event object type: away3d.events.AnimationEvent

Dispatched when all frame sequences are complete

sequenceupdate

event

Event object type: away3d.events.AnimationEvent

Dispatched when the current frame sequence is complete

Wiki link

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

Code examples

There are currently no examples for this class

AnimationEvent

Package	away3d.events
Class	public class AnimationEvent
Inheritance	AnimationEvent -> flash.events.Event

Passed as a parameter when an animation event occurs

Public Properties

	Property		Defined by
		animation : Animation A reference to the animation object that is relevant to the event.	AnimationEvent

Public Methods

	Method		Defined by
		AnimationEvent (type:String, animation:Animation) Creates a new `AnimationEvent` object.	AnimationEvent
		clone():Event Creates a copy of the AnimationEvent object and sets the value of each property to match that of the original.	AnimationEvent

Public Constants

	Constant		Defined by
		CYCLE : String = "cycle" [static] Defines the value of the type property of a cycle event object.	AnimationEvent
		SQUENCE_DONE : String = "squencedone" [static] Defines the value of the type property of a sequence done event object.	AnimationEvent
		SQUENCE_UPDATE : String = "squenceupdate" [static] Defines the value of the type property of a sequence update event object.	AnimationEvent

Property detail

animation

property

public var animation:Animation

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

Constructor detail

AnimationEvent

()

constructor

public function AnimationEvent(type:String, animation:Animation)
Parameters

	`type:String` - The type of the event. Possible values are: `AnimationEvent.CYCLE`, `AnimationEvent.SQUENCE_UPDATE` and `AnimationEvent.SQUENCE_DONE`.

	`animation:Animation` - A reference to the animation object that is relevant to the event.

Method detail

clone

()

method

public override function clone():Event

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

Returns

Event

Constant detail

CYCLE

constant

public static const CYCLE:String = "cycle"

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

SQUENCE_DONE

constant

public static const SQUENCE_DONE:String = "squencedone"

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

SQUENCE_UPDATE

constant

public static const SQUENCE_UPDATE:String = "squenceupdate"

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

Wiki link

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

Code examples

There are currently no examples for this class

AnimationFrame

Package	away3d.core.base
Class	public class AnimationFrame

Holds information about a single animation frame.

Public Properties

	Property		Defined by
		frame : Number Frame number.	AnimationFrame
		sort : String An optional sort string used to order the animation frames.	AnimationFrame
		time : uint Time from the start of the animation.	AnimationFrame

Public Methods

	Method		Defined by
		AnimationFrame (frame:Number, sort:String = null) Creates a new `AnimationFrame` object.	AnimationFrame

Property detail

frame

property

public var frame:Number

Frame number.

sort

property

public var sort:String

An optional sort string used to order the animation frames.

time

property

public var time:uint

Time from the start of the animation.

Constructor detail

AnimationFrame

()

constructor

public function AnimationFrame(frame:Number, sort:String = null)
Parameters

	`frame:Number` - The number of the frame in it's sequence.

	`sort:String` (default = `null`) - An optional sort string used to order the animation frames.

Wiki link

Click to go to the wiki page for 'away3d.core.base.AnimationFrame'

Code examples

There are currently no examples for this class

AnimationGroup

Package	away3d.core.base
Class	public class AnimationGroup

Holds information about a list of animation sequences.

Public Properties

	Property		Defined by
		fps : uint Determines the speed of playback in frames per second.	AnimationGroup
		loop : Boolean Determines whether the animation sequence should loop.	AnimationGroup
		loopLast : Boolean Determines if the last animation sequence should be looped.	AnimationGroup
		playlist : Array An array of animation sequence objects.	AnimationGroup

Public Methods

	Method		Defined by
		AnimationGroup (playlist:Array = null, loopLast:Boolean = false) Creates a new `AnimationSequence` object.	AnimationGroup

Property detail

fps

property

public var fps:uint

Determines the speed of playback in frames per second.

loop

property

public var loop:Boolean

Determines whether the animation sequence should loop.

loopLast

property

public var loopLast:Boolean

Determines if the last animation sequence should be looped.

playlist

property

public var playlist:Array

An array of animation sequence objects.

Constructor detail

AnimationGroup

()

constructor

public function AnimationGroup(playlist:Array = null, loopLast:Boolean = false)
Parameters

	`playlist:Array` (default = `null`) - An array of animation sequence objects.

	`loopLast:Boolean` (default = `false`) - Determines if the last animation sequence should be looped.

Wiki link

Click to go to the wiki page for 'away3d.core.base.AnimationGroup'

Code examples

There are currently no examples for this class

AnimationSequence

Package	away3d.core.base
Class	public class AnimationSequence

Holds information about a sequence of animation frames.

Public Properties

	Property		Defined by
		fps : Number Determines the speed of playback in frames per second.	AnimationSequence
		loop : Boolean Determines whether the animation sequence should loop.	AnimationSequence
		prefix : String The prefix string defining frames in the sequence.	AnimationSequence
		smooth : Boolean Determines if the animation should be smoothed (interpolated) between frames.	AnimationSequence

Public Methods

	Method		Defined by
		AnimationSequence (prefix:String, smooth:Boolean = false, loop:Boolean = false, fps:Number = 24) Creates a new `AnimationSequence` object.	AnimationSequence

Property detail

fps

property

public var fps:Number

Determines the speed of playback in frames per second.

loop

property

public var loop:Boolean

Determines whether the animation sequence should loop.

prefix

property

public var prefix:String

The prefix string defining frames in the sequence.

smooth

property

public var smooth:Boolean

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

Constructor detail

AnimationSequence

()

constructor

public function AnimationSequence(prefix:String, smooth:Boolean = false, loop:Boolean = false, fps:Number = 24)
Parameters

	`prefix:String` - The prefix string defining frames in the sequence.

	`smooth:Boolean` (default = `false`) - Determines if the animation should be smoothed (interpolated) between frames.

	`loop:Boolean` (default = `false`) - Determines whether the animation sequence should loop.

	`fps:Number` (default = `24`) - Determines the speed of playback in frames per second.

Wiki link

Click to go to the wiki page for 'away3d.core.base.AnimationSequence'

Code examples

There are currently no examples for this class

Animator

Package	away3d.animation
Class	public class Animator
Inheritance	Animator -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	BaseMesh
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Mesh
(^)	elements : Array Returns an array of the elements contained in the mesh object.	Mesh
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	BaseMesh
(^)	frame : int Indicates the current frame of animation	BaseMesh
	framelist : Array [read-only]	Animator
(^)	framenames : Dictionary A dictionary containing all frame names of the mesh	BaseMesh
(^)	frames : Dictionary A dictionary containing all frames of the mesh	BaseMesh
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	BaseMesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	BaseMesh
(^)	indexes : Array	Mesh
(^)	inverseSceneTransform : Matrix3D	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	BaseMesh
(^)	loop : Boolean Determines whether the animation will loop.	BaseMesh
(^)	material : ITriangleMaterial Defines the material used to render the faces in the mesh object.	Mesh
(^)	maxX : Number Returns the maximum x value of the 3d object	BaseMesh
(^)	maxY : Number Returns the maximum y value of the 3d object	BaseMesh
(^)	maxZ : Number Returns the maximum z value of the 3d object	BaseMesh
(^)	minX : Number Returns the minimum x value of the 3d object	BaseMesh
(^)	minY : Number Returns the minimum y value of the 3d object	BaseMesh
(^)	minZ : Number Returns the minimum z value of the 3d object	BaseMesh
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	BaseMesh
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	BaseMesh
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransformed : Boolean	Object3D
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	BaseMesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	type : String String defining the type of class used to generate the mesh.	BaseMesh
(^)	url : String String defining the source of the mesh.	BaseMesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object	BaseMesh
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D

Protected Properties

Method		Defined by
	Animator (baseObject:Mesh, aFrames:Array, init:Object = null, doloop:Boolean = false)	Animator
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
	addFrames(aFrames:Array):void	Animator
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	BaseMesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a squencedone event listener	BaseMesh
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
(^)	clone(object:* = null):* Duplicates the mesh properties to another 3d object.	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
	generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void	Animator
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	BaseMesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	BaseMesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	movePivot(dx:Number, dy:Number, dz:Number):void Moves the origin point of the mesh without moving the contents.	Mesh
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	BaseMesh
(^)	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	Mesh
(^)	quarterFaces():void Divides a face object into 4 equal sized face objects.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	BaseMesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a squencedone event listener	BaseMesh
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the mesh.	BaseMesh
(^)	scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames	BaseMesh
(^)	scaleX(scaleX:Number):void Scales the contents of the mesh along the x-axis.	BaseMesh
(^)	scaleY(scaleY:Number):void Scales the contents of the mesh along the y-axis.	BaseMesh
(^)	scaleZ(scaleZ:Number):void Scales the contents of the mesh along the z-axis.	BaseMesh
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	BaseMesh
(^)	tick(time:int):void Called by the `TickTraverser`.	BaseMesh
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	addElement(element:IMeshElement):void Adds an element to the mesh object.	BaseMesh
(^)	removeElement(element:IMeshElement):void Removes an element to the mesh object.	BaseMesh
(^)	scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void Scales the contents of the mesh using 3 axis values.	BaseMesh

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when the animation object completes a single sequence cycle.	BaseMesh
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
(^)	sequencedone	Dispatched when the animation object completes all frame sequences.	BaseMesh
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

framelist

property

framelist:Array [read-only]
Implementation
public function get framelist():Array

Constructor detail

Animator

()

constructor

public function Animator(baseObject:Mesh, aFrames:Array, init:Object = null, doloop:Boolean = false)
Parameters

	`baseObject:Mesh`

	`aFrames:Array`

	`init:Object` (default = `null`)

	`doloop:Boolean` (default = `false`)

Method detail

addFrames

()

method

public function addFrames(aFrames:Array):void
Parameters

aFrames:Array

generate

()

method

public function generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void
Parameters

	`baseObject:Mesh`

	`aFrames:Array`

	`doloop:Boolean`

Wiki link

Click to go to the wiki page for 'away3d.animation.Animator'

Code examples

There are currently no examples for this class

AnotherRivalFilter

Package	away3d.core.filter
Class	public class AnotherRivalFilter
Implements	IPrimitiveQuadrantFilter

Corrects triangle z-sorting

Public Methods

	Method		Defined by
		AnotherRivalFilter (maxdelay:int = 60000) Creates a new `AnotherRivalFilter` object.	AnotherRivalFilter
		filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void Applies the filter to the quadrant tree.	AnotherRivalFilter
		toString():String Used to trace the values of a filter.	AnotherRivalFilter

Constructor detail

AnotherRivalFilter

()

constructor

public function AnotherRivalFilter(maxdelay:int = 60000)
Parameters

maxdelay:int (default = 60000) - [optional] The maximum time the filter can take to resolve z-depth before timing out.

Method detail

filter

()

method

public function filter(pritree:PrimitiveQuadrantTree, scene:Scene3D, camera:Camera3D, clip:Clipping):void

Applies the filter to the quadrant tree.

Parameters

	`pritree:PrimitiveQuadrantTree` - The quadrant tree to be filtered.

	`scene:Scene3D` - The scene to which the quadrant tree belongs.

	`camera:Camera3D` - The camera being used in the renderer for the quadrant tree

	`clip:Clipping` - The clipping object used in the renderer for the quadrant tree's view.

toString

()

method

public function toString():String

Used to trace the values of a filter.

Returns

String - A string representation of the filter object.

Wiki link

Click to go to the wiki page for 'away3d.core.filter.AnotherRivalFilter'

Code examples

There are currently no examples for this class

Ase

Package	away3d.loaders
Class	public class Ase

File loader for the ASE file format.

Public Methods

	Method		Defined by
		Ase (data:String, init:Object = null) Creates a new `Ase` object.	Ase
		load(url:String, init:Object = null):Object3DLoader [static] Loads and parses an ase file into a 3d mesh object.	Ase
		parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh [static] Creates a 3d mesh object from the raw ascii data of the ase file.	Ase

Constructor detail

Ase

()

constructor

public function Ase(data:String, init:Object = null)
Parameters

	`data:String` - The ascii data of a loaded file.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

scaling:Number (default = 1)

Method detail

load

()

method

public static function load(url:String, init:Object = null):Object3DLoader

Loads and parses an ase file into a 3d mesh object.

Parameters

	`url:String` - The url location of the file to load.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Returns

Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the file is loading.

parse

()

method

public static function parse(data:*, init:Object = null, loader:Object3DLoader = null):Mesh

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

Parameters

	`data:*` - The ascii data of a loaded file.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

	`loader:Object3DLoader` (default = `null`) - [optional] Not intended for direct use.

Returns

Mesh - A 3d mesh object representation of the ase file.

Wiki link

Click to go to the wiki page for 'away3d.loaders.Ase'

Code examples

There are currently no examples for this class

BaseDemo

Package	away3d.test
Class	public class BaseDemo
Inheritance	BaseDemo -> flash.display.Sprite

Base class for Away3D demos

Protected Properties

	Property		Defined by
		camera : HoverCamera3D	BaseDemo
		centergroup : Sprite	BaseDemo
		infogroup : Sprite	BaseDemo
		lefttopgroup : Sprite	BaseDemo
		startlabel : TextField	BaseDemo
		statsgroup : Sprite	BaseDemo
		titlegroup : Sprite	BaseDemo
		view : View3D	BaseDemo

Public Methods

	Method		Defined by
		BaseDemo (title:String, infogroupheight:Number = 410)	BaseDemo

Protected Methods

	Method		Defined by
		addSlide(title:String, text:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession):void	BaseDemo

Property detail

camera

property

protected var camera:HoverCamera3D

centergroup

property

protected var centergroup:Sprite

infogroup

property

protected var infogroup:Sprite

lefttopgroup

property

protected var lefttopgroup:Sprite

startlabel

property

protected var startlabel:TextField

statsgroup

property

protected var statsgroup:Sprite

titlegroup

property

protected var titlegroup:Sprite

view

property

protected var view:View3D

Constructor detail

BaseDemo

()

constructor

public function BaseDemo(title:String, infogroupheight:Number = 410)
Parameters

	`title:String`

	`infogroupheight:Number` (default = `410`)

Method detail

addSlide

()

method

protected function addSlide(title:String, text:String, scene:Scene3D, renderer:IRenderer, session:AbstractRenderSession):void

Parameters

	`title:String`

	`text:String`

	`scene:Scene3D`

	`renderer:IRenderer`

	`session:AbstractRenderSession`

Wiki link

Click to go to the wiki page for 'away3d.test.BaseDemo'

Code examples

Away3D HelloAway3D.as

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

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

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

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

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

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

addEventListener(Event.ENTER_FRAME, onEnterFrame);
}

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

}

}

From HelloAway3D.as

BaseMesh

Package	away3d.core.base
Class	public class BaseMesh
Inheritance	BaseMesh -> Object3D -> flash.events.EventDispatcher
Subclasses	Mesh, WireMesh

Abstract 3d object containing unspecified elements. Not intended for direct use - use Mesh or WireMesh.

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
	boundingRadius : Number [read-only] Returns the bounding radius of the 3d object	BaseMesh
	elements : Array [read-only] Returns an array of the elements contained in the mesh object	BaseMesh
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
	fps : int [write-only] Determines the frames per second at which the animation will run.	BaseMesh
	frame : int Indicates the current frame of animation	BaseMesh
	framenames : Dictionary A dictionary containing all frame names of the mesh	BaseMesh
	frames : Dictionary A dictionary containing all frames of the mesh	BaseMesh
	hasCycleEvent : Boolean [read-only] Indicates whether the animation has a cycle event listener	BaseMesh
	hasSequenceEvent : Boolean [read-only] Indicates whether the animation has a sequencedone event listener	BaseMesh
(^)	inverseSceneTransform : Matrix3D	Object3D
	isRunning : Boolean [read-only] Indicates whether the animation is currently running.	BaseMesh
	loop : Boolean [write-only] Determines whether the animation will loop.	BaseMesh
	maxX : Number [read-only] Returns the maximum x value of the 3d object	BaseMesh
	maxY : Number [read-only] Returns the maximum y value of the 3d object	BaseMesh
	maxZ : Number [read-only] Returns the maximum z value of the 3d object	BaseMesh
	minX : Number [read-only] Returns the minimum x value of the 3d object	BaseMesh
	minY : Number [read-only] Returns the minimum y value of the 3d object	BaseMesh
	minZ : Number [read-only] Returns the minimum z value of the 3d object	BaseMesh
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
	pushback : Boolean Elements use their furthest point from the camera when z-sorting	BaseMesh
	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	BaseMesh
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransformed : Boolean	Object3D
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
	smooth : Boolean [write-only] Determines whether the animation will smooth motion (interpolate) between frames.	BaseMesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
	type : String String defining the type of class used to generate the mesh.	BaseMesh
	url : String String defining the source of the mesh.	BaseMesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
	vertices : Array [read-only] Returns an array of the vertices contained in the mesh object	BaseMesh
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D

Protected Properties

Method		Defined by
	BaseMesh (init:Object = null) Creates a new `BaseMesh` object.	BaseMesh
	addOnCycle(listener:Function):void Default method for adding a cycle event listener	BaseMesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
	addOnSequenceDone(listener:Function):void Default method for adding a squencedone event listener	BaseMesh
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	clone(object:* = null):* Duplicates the 3d object's properties to another `Object3D` object	Object3D
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	BaseMesh
	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	BaseMesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
	play(sequence:AnimationSequence):void Plays a sequence of frames	BaseMesh
	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	BaseMesh
	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	BaseMesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
	removeOnSequenceDone(listener:Function):void Default method for removing a squencedone event listener	BaseMesh
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
	scale(scale:Number):void Scales the contents of the mesh.	BaseMesh
	scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames	BaseMesh
	scaleX(scaleX:Number):void Scales the contents of the mesh along the x-axis.	BaseMesh
	scaleY(scaleY:Number):void Scales the contents of the mesh along the y-axis.	BaseMesh
	scaleZ(scaleZ:Number):void Scales the contents of the mesh along the z-axis.	BaseMesh
	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	BaseMesh
	tick(time:int):void Called by the `TickTraverser`.	BaseMesh
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

	Method		Defined by
		addElement(element:IMeshElement):void Adds an element to the mesh object.	BaseMesh
		removeElement(element:IMeshElement):void Removes an element to the mesh object.	BaseMesh
		scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void Scales the contents of the mesh using 3 axis values.	BaseMesh

Events

Event		Summary	Defined by
	cycle	Dispatched when the animation object completes a single sequence cycle.	BaseMesh
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
	sequencedone	Dispatched when the animation object completes all frame sequences.	BaseMesh
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

boundingRadius

property

boundingRadius:Number [read-only]

Returns the bounding radius of the 3d object

Implementation
public function get boundingRadius():Number

elements

property

elements:Array [read-only]

Returns an array of the elements contained in the mesh object

Implementation
public function get elements():Array

Throws

- Not implemented

fps

property

fps:int [write-only]

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

Implementation
public function set fps(value:int):void

frame

property

frame:int [read-write]

Indicates the current frame of animation

Implementation
public function get frame():int
public function set frame(value:int):void

framenames

property

public var framenames:Dictionary

A dictionary containing all frame names of the mesh

frames

property

public var frames:Dictionary

A dictionary containing all frames of the mesh

hasCycleEvent

property

hasCycleEvent:Boolean [read-only]

Indicates whether the animation has a cycle event listener

Implementation
public function get hasCycleEvent():Boolean

hasSequenceEvent

property

hasSequenceEvent:Boolean [read-only]

Indicates whether the animation has a sequencedone event listener

Implementation
public function get hasSequenceEvent():Boolean

isRunning

property

isRunning:Boolean [read-only]

Indicates whether the animation is currently running.

Implementation
public function get isRunning():Boolean

loop

property

loop:Boolean [write-only]

Determines whether the animation will loop.

Implementation
public function set loop(value:Boolean):void

maxX

property

maxX:Number [read-only]

Returns the maximum x value of the 3d object

Implementation
public function get maxX():Number

maxY

property

maxY:Number [read-only]

Returns the maximum y value of the 3d object

Implementation
public function get maxY():Number

maxZ

property

maxZ:Number [read-only]

Returns the maximum z value of the 3d object

Implementation
public function get maxZ():Number

minX

property

minX:Number [read-only]

Returns the minimum x value of the 3d object

Implementation
public function get minX():Number

minY

property

minY:Number [read-only]

Returns the minimum y value of the 3d object

Implementation
public function get minY():Number

minZ

property

minZ:Number [read-only]

Returns the minimum z value of the 3d object

Implementation
public function get minZ():Number

pushback

property

public var pushback:Boolean

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

pushfront

property

public var pushfront:Boolean

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

smooth

property

smooth:Boolean [write-only]

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

Implementation
public function set smooth(value:Boolean):void

type

property

public var type:String

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

See also

away3d.core.stats.Stats

url

property

public var url:String

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

See also

away3d.core.stats.Stats

vertices

property

vertices:Array [read-only]

Returns an array of the vertices contained in the mesh object

Implementation
public function get vertices():Array

Constructor detail

BaseMesh

()

constructor

public function BaseMesh(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties

Init Parameters

	`pushback:Boolean` (default = false)
	`pushfront:Boolean` (default = false)

Method detail

addElement

()

method

protected function addElement(element:IMeshElement):void

Adds an element to the mesh object.

Parameters

element:IMeshElement - The element to be added to the mesh.

addOnCycle

()

method

public function addOnCycle(listener:Function):void

Default method for adding a cycle event listener

Parameters

listener:Function - The listener function

addOnSequenceDone

()

method

public function addOnSequenceDone(listener:Function):void

Default method for adding a squencedone event listener

Parameters

listener:Function - The listener function

gotoAndPlay

()

method

public function gotoAndPlay(value:int):void

Starts playing the animation at the specified frame.

Parameters

value:int - A number representing the frame number.

gotoAndStop

()

method

public function gotoAndStop(value:int):void

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

Parameters

value:int - A number representing the frame number.

play

()

method

public function play(sequence:AnimationSequence):void

Plays a sequence of frames

Parameters

sequence:AnimationSequence - The animationsequence to play

primitives

()

method

public override function primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void

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

Parameters

	`consumer:IPrimitiveConsumer` - The consumer instance

	`session:AbstractRenderSession` - The render session of the 3d object

removeElement

()

method

protected function removeElement(element:IMeshElement):void

Removes an element to the mesh object.

Parameters

element:IMeshElement - The element to be removed from the mesh.

removeOnCycle

()

method

public function removeOnCycle(listener:Function):void

Default method for removing a cycle event listener

Parameters

listener:Function - The listener function

removeOnSequenceDone

()

method

public function removeOnSequenceDone(listener:Function):void

Default method for removing a squencedone event listener

Parameters

listener:Function - The listener function

scale

()

method

public override function scale(scale:Number):void

Scales the contents of the mesh.

Parameters

scale:Number - The scaling value

scaleAnimation

()

method

public function scaleAnimation(scale:Number):void

Scales the vertex positions contained within all animation frames

Parameters

scale:Number - The scaling value

scaleX

()

method

public function scaleX(scaleX:Number):void

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

Parameters

scaleX:Number - The scaling value

scaleXYZ

()

method

protected function scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void

Scales the contents of the mesh using 3 axis values.

Parameters

	`scaleX:Number` - The scaling value along the x-axis

	`scaleY:Number` - The scaling value along the y-axis

	`scaleZ:Number` - The scaling value along the z-axis

scaleY

()

method

public function scaleY(scaleY:Number):void

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

Parameters

scaleY:Number - The scaling value

scaleZ

()

method

public function scaleZ(scaleZ:Number):void

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

Parameters

scaleZ:Number - The scaling value

setPlaySequences

()

method

public function setPlaySequences(playlist:Array, loopLast:Boolean = false):void

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

Parameters

	`playlist:Array` - An array of animationsequence objects.

	`loopLast:Boolean` (default = `false`) - [optional] Determines whether the last sequence will loop. Defaults to false.

tick

()

method

public override function tick(time:int):void

Called by the TickTraverser. updates the animation object

Parameters

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

See also

away3d.core.traverse.TickTraverser
away3d.core.basr.Animation.update()

Event detail

cycle

event

Event object type: away3d.events.AnimationEvent

Dispatched when the animation object completes a single sequence cycle.

sequencedone

event

Event object type: away3d.events.AnimationEvent

Dispatched when the animation object completes all frame sequences.

Wiki link

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

Code examples

There are currently no examples for this class

BaseMeshElement

Package	away3d.core.base
Class	public class BaseMeshElement
Inheritance	BaseMeshElement -> flash.events.EventDispatcher
Implements	IMeshElement
Subclasses	Face, Segment

Basic 3d element object Not intended for direct use - use Segment or Face.

Public Properties

	Property		Defined by
		maxX : Number [read-only] Returns the maximum x value of the 3d element	BaseMeshElement
		maxY : Number [read-only] Returns the minimum y value of the 3d element	BaseMeshElement
		maxZ : Number [read-only] Returns the minimum z value of the 3d element	BaseMeshElement
		minX : Number [read-only] Returns the minimum x value of the 3d element	BaseMeshElement
		minY : Number [read-only] Returns the maximum y value of the 3d element	BaseMeshElement
		minZ : Number [read-only] Returns the maximum z value of the 3d element	BaseMeshElement
		radius2 : Number [read-only] Returns the squared bounding radius of the 3d element	BaseMeshElement
		vertices : Array [read-only] Returns an array of vertex objects that make up the 3d element.	BaseMeshElement
		visible : Boolean Defines whether the 3d element is visible in the scene.	BaseMeshElement

Public Methods

	Method		Defined by
		addOnVertexChange(listener:Function):void Default method for adding a vertexchanged event listener	BaseMeshElement
		addOnVertexValueChange(listener:Function):void Default method for adding a vertexvaluechanged event listener	BaseMeshElement
		addOnVisibleChange(listener:Function):void Default method for adding a visiblechanged event listener	BaseMeshElement
		removeOnVertexChange(listener:Function):void Default method for removing a vertexchanged event listener	BaseMeshElement
		removeOnVertexValueChange(listener:Function):void Default method for removing a vertexvaluechanged event listener	BaseMeshElement
		removeOnVisibleChange(listener:Function):void Default method for removing a visiblechanged event listener	BaseMeshElement

Events

	Summary	Defined by
vertexchanged	Dispatched when the vertex of a 3d element changes.	BaseMeshElement
vertexvaluechanged	Dispatched when the vertex value of a 3d element changes.	BaseMeshElement
visiblechanged	Dispatched when the visiblity of a 3d element changes.	BaseMeshElement

Property detail

maxX

property

maxX:Number [read-only]

Returns the maximum x value of the 3d element

Implementation
public function get maxX():Number

maxY

property

maxY:Number [read-only]

Returns the minimum y value of the 3d element

Implementation
public function get maxY():Number

maxZ

property

maxZ:Number [read-only]

Returns the minimum z value of the 3d element

Implementation
public function get maxZ():Number

minX

property

minX:Number [read-only]

Returns the minimum x value of the 3d element

Implementation
public function get minX():Number

minY

property

minY:Number [read-only]

Returns the maximum y value of the 3d element

Implementation
public function get minY():Number

minZ

property

minZ:Number [read-only]

Returns the maximum z value of the 3d element

Implementation
public function get minZ():Number

radius2

property

radius2:Number [read-only]

Returns the squared bounding radius of the 3d element

Implementation
public function get radius2():Number

vertices

property

vertices:Array [read-only]

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

Implementation
public function get vertices():Array

visible

property

visible:Boolean [read-write]

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

Implementation
public function get visible():Boolean
public function set visible(value:Boolean):void

Method detail

addOnVertexChange

()

method

public function addOnVertexChange(listener:Function):void

Default method for adding a vertexchanged event listener

Parameters

listener:Function - The listener function

addOnVertexValueChange

()

method

public function addOnVertexValueChange(listener:Function):void

Default method for adding a vertexvaluechanged event listener

Parameters

listener:Function - The listener function

addOnVisibleChange

()

method

public function addOnVisibleChange(listener:Function):void

Default method for adding a visiblechanged event listener

Parameters

listener:Function - The listener function

removeOnVertexChange

()

method

public function removeOnVertexChange(listener:Function):void

Default method for removing a vertexchanged event listener

Parameters

listener:Function - The listener function

removeOnVertexValueChange

()

method

public function removeOnVertexValueChange(listener:Function):void

Default method for removing a vertexvaluechanged event listener

Parameters

listener:Function - The listener function

removeOnVisibleChange

()

method

public function removeOnVisibleChange(listener:Function):void

Default method for removing a visiblechanged event listener

Parameters

listener:Function - The listener function

Event detail

vertexchanged

event

Event object type: away3d.events.MeshElementEvent

Dispatched when the vertex of a 3d element changes.

vertexvaluechanged

event

Event object type: away3d.events.MeshElementEvent

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

visiblechanged

event

Event object type: away3d.events.MeshElementEvent

Dispatched when the visiblity of a 3d element changes.

Wiki link

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

Code examples

There are currently no examples for this class

BasicRenderer

Package	away3d.core.render
Class	public class BasicRenderer
Implements	IRenderer

Default renderer for a view. Contains the main render loop for rendering a scene to a view, which resolves the projection, culls any drawing primitives that are occluded or outside the viewport, and then z-sorts and renders them to screen.

Public Properties

	Property		Defined by
		session : AbstractRenderSession Defines the render session object used by the renderer.	BasicRenderer

Public Methods

	Method		Defined by
		BasicRenderer (... filters) Creates a new `BasicRenderer` object.	BasicRenderer
		render(view:View3D):Array Executes the render pipe that resolves the 3d scene into the view.	BasicRenderer
		toString():String Used to trace the values of a renderer.	BasicRenderer

Property detail

session

property

session:AbstractRenderSession [read-write]

Defines the render session object used by the renderer.

Implementation
public function get session():AbstractRenderSession
public function set session(value:AbstractRenderSession):void

Constructor detail

BasicRenderer

()

constructor

public function BasicRenderer(... filters)
Parameters

... filters - [optional] An array of filters to use on projected drawing primitives before rendering them to screen.

Method detail

render

()

method

public function render(view:View3D):Array

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

Parameters

view:View3D

Returns

Array

toString

()

method

public function toString():String

Used to trace the values of a renderer.

Returns

String - A string representation of the renderer object.

Wiki link

Click to go to the wiki page for 'away3d.core.render.BasicRenderer'

Code examples

There are currently no examples for this class

BitmapFileMaterial

Package	away3d.materials
Class	public class BitmapFileMaterial
Inheritance	BitmapFileMaterial -> TransformBitmapMaterial -> BitmapMaterial -> flash.events.EventDispatcher
Implements	ITriangleMaterial, IUVMaterial

Bitmap material that loads it's texture from an external bitmapasset file.

Public Properties

Property		Defined by
(^)	alpha : Number Defines an alpha value for the texture bitmap.	BitmapMaterial
(^)	bitmap : BitmapData Returns the bitmapData object being used as the material texture.	BitmapMaterial
(^)	blendMode : String Defines a blendMode value for the texture bitmap.	BitmapMaterial
(^)	color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
(^)	debug : Boolean = false Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
(^)	globalProjection : Boolean Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.	TransformBitmapMaterial
(^)	height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
(^)	offsetX : Number Offsets the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	offsetY : Number Offsets the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
(^)	projectionVector : Number3D Projects the texture in object space, ignoring the uv coordinates of the vertex objects.	TransformBitmapMaterial
(^)	repeat : Boolean = false Determines if texture bitmap will tile in uv-space	BitmapMaterial
(^)	rotation : Number Rotates the texture in uv-space	TransformBitmapMaterial
(^)	scaleX : Number Scales the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	scaleY : Number Scales the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	smooth : Boolean = false Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
(^)	throughProjection : Boolean Determines whether a projected texture is visble on the faces pointing away from the projection.	TransformBitmapMaterial
(^)	transform : Matrix Transforms the texture in uv-space	TransformBitmapMaterial
(^)	visible : Boolean Indicates whether the material is visible	BitmapMaterial
(^)	width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

Method		Defined by
	BitmapFileMaterial (url:String = "", init:Object = null) Creates a new `BitmapFileMaterial` object.	BitmapFileMaterial
(^)	addOnResize(listener:Function):void Default method for adding a materialresize event listener	BitmapMaterial
(^)	getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	TransformBitmapMaterial
(^)	removeOnResize(listener:Function):void Default method for removing a materialresize event listener	BitmapMaterial
(^)	renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face.	TransformBitmapMaterial
(^)	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
(^)	renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	TransformBitmapMaterial
(^)	updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	TransformBitmapMaterial

Protected Methods

Method		Defined by
(^)	getMapping(tri:DrawTriangle):Matrix Calculates the mapping matrix required to draw the triangle texture to screen.	TransformBitmapMaterial
(^)	setColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
(^)	updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterial

Events

	Event		Summary	Defined by
	(^)	materialresize	Dispatched when the bitmapData used for the material texture is resized.	BitmapMaterial

Constructor detail

BitmapFileMaterial

()

constructor

public function BitmapFileMaterial(url:String = "", init:Object = null)
Parameters

	`url:String` (default = "") - The location of the bitmapasset to load.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Wiki link

Click to go to the wiki page for 'away3d.materials.BitmapFileMaterial'

Code examples

There are currently no examples for this class

BitmapMaterial

Package	away3d.materials
Class	public class BitmapMaterial
Inheritance	BitmapMaterial -> flash.events.EventDispatcher
Implements	ILayerMaterial, ITriangleMaterial, IUpdatingMaterial, IUVMaterial
Subclasses	BitmapMaterialContainer, TransformBitmapMaterial

Basic bitmap material

Public Properties

	Property		Defined by
		alpha : Number Defines an alpha value for the texture bitmap.	BitmapMaterial
		bitmap : BitmapData [read-only] Returns the bitmapData object being used as the material texture.	BitmapMaterial
		blendMode : String Defines a blendMode value for the texture bitmap.	BitmapMaterial
		color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
		debug : Boolean = false Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
		height : Number [read-only] Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
		precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
		repeat : Boolean = false Determines if texture bitmap will tile in uv-space	BitmapMaterial
		smooth : Boolean = false Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
		visible : Boolean [read-only] Indicates whether the material is visible	BitmapMaterial
		width : Number [read-only] Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

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

Public Methods

	Method		Defined by
		BitmapMaterial (bitmap:BitmapData, init:Object = null) Creates a new `BitmapMaterial` object.	BitmapMaterial
		addOnResize(listener:Function):void Default method for adding a materialresize event listener	BitmapMaterial
		getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	BitmapMaterial
		removeOnResize(listener:Function):void Default method for removing a materialresize event listener	BitmapMaterial
		renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face.	BitmapMaterial
		renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
		renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	BitmapMaterial
		updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	BitmapMaterial

Protected Methods

	Method		Defined by
		getMapping(tri:DrawTriangle):Matrix Calculates the mapping matrix required to draw the triangle texture to screen.	BitmapMaterial
		setColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
		updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterial

Events

	Event		Summary	Defined by
		materialresize	Dispatched when the bitmapData used for the material texture is resized.	BitmapMaterial

Property detail

alpha

property

alpha:Number [read-write]

Defines an alpha value for the texture bitmap.

Implementation
public function get alpha():Number
public function set alpha(value:Number):void

bitmap

property

bitmap:BitmapData [read-only]

Returns the bitmapData object being used as the material texture.

Implementation
public function get bitmap():BitmapData

blendMode

property

blendMode:String [read-write]

Defines a blendMode value for the texture bitmap. Applies to materials rendered as children of BitmapMaterialContainer or CompositeMaterial.

Implementation
public function get blendMode():String
public function set blendMode(value:String):void

color

property

color:uint [read-write]

Defines a colored tint for the texture bitmap.

Implementation
public function get color():uint
public function set color(value:uint):void

debug

property

public var debug:Boolean = false

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

height

property

height:Number [read-only]

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

Implementation
public function get height():Number

ini

property

protected var ini:Init

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

precision

property

precision:Number [read-write]

Corrects distortion caused by the affine transformation (non-perpective) of textures. The number refers to the pixel correction value - ie. a value of 2 means a distorion correction to within 2 pixels of the correct perspective distortion. 0 performs no precision.

Implementation
public function get precision():Number
public function set precision(value:Number):void

repeat

property

public var repeat:Boolean = false

Determines if texture bitmap will tile in uv-space

smooth

property

public var smooth:Boolean = false

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

visible

property

visible:Boolean [read-only]

Indicates whether the material is visible

Implementation
public function get visible():Boolean

width

property

width:Number [read-only]

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

Implementation
public function get width():Number

Constructor detail

BitmapMaterial

()

constructor

public function BitmapMaterial(bitmap:BitmapData, init:Object = null)
Parameters

	`bitmap:BitmapData` - The bitmapData object to be used as the material's texture.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`smooth:Boolean` (default = smooth)
	`debug:Boolean` (default = debug)
	`repeat:Boolean` (default = repeat)
	`precision:Number` (default = 0)
	`blendMode:String` (default = BlendMode.NORMAL)
	`alpha:Number` (default = _alpha, min:0, max:1)
	`color:Color` (default = _color)

Method detail

addOnResize

()

method

public function addOnResize(listener:Function):void

Default method for adding a materialresize event listener

Parameters

listener:Function - The listener function

getMapping

()

method

protected function getMapping(tri:DrawTriangle):Matrix

Calculates the mapping matrix required to draw the triangle texture to screen.

Parameters

tri:DrawTriangle - The data object holding all information about the triangle to be drawn.

Returns

Matrix - The required matrix object.

getPixel32

()

method

public function getPixel32(u:Number, v:Number):uint

Returns the argb value of the bitmapData pixel at the given u v coordinate.

Parameters

	`u:Number` - The u (horizontal) texture coordinate.

	`v:Number` - The v (verical) texture coordinate.

Returns

uint - The argb pixel value.

removeOnResize

()

method

public function removeOnResize(listener:Function):void

Default method for removing a materialresize event listener

Parameters

listener:Function - The listener function

renderFace

()

method

public function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters

	`face:Face` - The face object onto which the rendered sufrace is applied.

	`containerRect:Rectangle` - The rectangle object defining the bounds of the face in uv-space.

	`parentFaceVO:FaceVO` - The value object of the preceeding surface.

Returns

FaceVO

renderLayer

()

method

public function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void

Renders a material layer for the specified triangle.

Parameters

	`tri:DrawTriangle` - The drawtriangle used for render information.

	`layer:Sprite` - The parent layer into which the triangle is drawn.

	`level:int` - Defines the sprite level for the layer.

renderTriangle

()

method

public function renderTriangle(tri:DrawTriangle):void

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

Parameters

tri:DrawTriangle

setColorTransform

()

method

protected function setColorTransform():void

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

See also

color
alpha

updateMaterial

()

method

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

Called once per render loop when material is visible.

Parameters

	`source:Object3D`

	`view:View3D`

updateRenderBitmap

()

method

protected function updateRenderBitmap():void

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

See also

color
alpha
setColorTransform()

Event detail

materialresize

event

Event object type: away3d.events.MaterialEvent

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

Wiki link

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

Code examples

There are currently no examples for this class

BitmapMaterialContainer

Package	away3d.materials
Class	public class BitmapMaterialContainer
Inheritance	BitmapMaterialContainer -> BitmapMaterial -> flash.events.EventDispatcher
Implements	ILayerMaterial, ITriangleMaterial, IUpdatingMaterial
Subclasses	Dot3BitmapMaterialCache, EnviroBitmapMaterialCache, PhongBitmapMaterialCache, PhongColorMaterialCache

Container for caching multiple bitmapmaterial objects. Renders each material by caching a bitmapData surface object for each face. For continually updating materials, use CompositeMaterial.

See also

away3d.materials.CompositeMaterial

Public Properties

Property		Defined by
(^)	alpha : Number Defines an alpha value for the texture bitmap.	BitmapMaterial
(^)	bitmap : BitmapData Returns the bitmapData object being used as the material texture.	BitmapMaterial
(^)	blendMode : String Defines a blendMode value for the texture bitmap.	BitmapMaterial
	cache : Boolean Defines whether each created bitmapData surface is to be cached, or updated every frame.	BitmapMaterialContainer
(^)	color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
(^)	debug : Boolean = false Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
(^)	height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
	materials : Array An array of bitmapmaterial objects to be overlayed sequentially.	BitmapMaterialContainer
(^)	precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
(^)	repeat : Boolean = false Determines if texture bitmap will tile in uv-space	BitmapMaterial
(^)	smooth : Boolean = false Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
	transparent : Boolean Defines whether the caching bitmapData objects are transparent	BitmapMaterialContainer
(^)	visible : Boolean Indicates whether the material is visible	BitmapMaterial
(^)	width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

Method		Defined by
	BitmapMaterialContainer (width:int, height:int, init:Object = null) Creates a new `BitmapMaterialContainer` object.	BitmapMaterialContainer
(^)	addOnResize(listener:Function):void Default method for adding a materialresize event listener	BitmapMaterial
(^)	getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	BitmapMaterial
(^)	removeOnResize(listener:Function):void Default method for removing a materialresize event listener	BitmapMaterial
	renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO Renders a bitmapData surface object for the speficied face.	BitmapMaterialContainer
(^)	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
(^)	renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	BitmapMaterial
	update():void Clear and updates the currrent bitmapData surface on all faces.	BitmapMaterialContainer
	updateMaterial(source:Object3D, view:View3D):void Creates a new `BitmapMaterialContainer` object.	BitmapMaterialContainer

Protected Methods

Method		Defined by
	getMapping(tri:DrawTriangle):Matrix Calculates the mapping matrix required to draw the triangle texture to screen.	BitmapMaterialContainer
(^)	setColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
	updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterialContainer

Events

	Event		Summary	Defined by
	(^)	materialresize	Dispatched when the bitmapData used for the material texture is resized.	BitmapMaterial

Property detail

cache

property

cache:Boolean [read-write]

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

Implementation
public function get cache():Boolean
public function set cache(value:Boolean):void

materials

property

public var materials:Array

An array of bitmapmaterial objects to be overlayed sequentially.

transparent

property

public var transparent:Boolean

Defines whether the caching bitmapData objects are transparent

Constructor detail

BitmapMaterialContainer

()

constructor

public function BitmapMaterialContainer(width:int, height:int, init:Object = null)
Parameters

	`width:int` - The containing width of the texture, applied to all child materials.

	`height:int` - The containing height of the texture, applied to all child materials.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`materials:Array`
	`transparent:Boolean` (default = true)
	`cache:Boolean` (default = true)

Method detail

getMapping

()

method

protected override function getMapping(tri:DrawTriangle):Matrix

Calculates the mapping matrix required to draw the triangle texture to screen.

Parameters

tri:DrawTriangle - The data object holding all information about the triangle to be drawn.

Returns

Matrix - The required matrix object.

renderFace

()

method

public override function renderFace(face:Face, containerRect:Rectangle, parentFaceVO:FaceVO):FaceVO

Renders a bitmapData surface object for the speficied face.

Parameters

	`face:Face` - The face object onto which the rendered sufrace is applied.

	`containerRect:Rectangle` - The rectangle object defining the bounds of the face in uv-space.

	`parentFaceVO:FaceVO` - The value object of the preceeding surface.

Returns

FaceVO

update

()

method

public function update():void

Clear and updates the currrent bitmapData surface on all faces.

updateMaterial

()

method

public override function updateMaterial(source:Object3D, view:View3D):void

Creates a new BitmapMaterialContainer object.

Parameters

	`source:Object3D` - The containing width of the texture, applied to all child materials.

	`view:View3D` - The containing height of the texture, applied to all child materials.

updateRenderBitmap

()

method

protected override function updateRenderBitmap():void

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

Wiki link

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

Code examples

There are currently no examples for this class

BitmapRenderSession

Package	away3d.core.render
Class	public class BitmapRenderSession
Inheritance	BitmapRenderSession -> AbstractRenderSession

Drawing session object that renders all drawing primitives into a Bitmap container.

Public Properties

Property		Defined by
(^)	children : Dictionary Dictionary of child displayobjects.	AbstractRenderSession
(^)	graphics : Graphics Reference to the current graphics object being used for drawing.	AbstractRenderSession
(^)	lightarray : LightArray Defines the light provider object for the render sesion.	AbstractRenderSession
(^)	newLayer : Sprite Holds the last added layer sprite.	AbstractRenderSession
(^)	sessions : Dictionary Dictionary of child sessions.	AbstractRenderSession
(^)	spriteLayers : Array Dictionary of sprite layers for rendering composite materials.	AbstractRenderSession
	view : View3D Defines the view object used for the render session.	BitmapRenderSession

Public Methods

Method		Defined by
	BitmapRenderSession (scale:Number = 2) Creates a new `BitmapRenderSession` object.	BitmapRenderSession
	addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list.	BitmapRenderSession
	addLayerObject(child:Sprite):void Adds a layer sprite to the render session display list.	BitmapRenderSession
	clear():void Clears the render session.	BitmapRenderSession
	clone():AbstractRenderSession Duplicates the render session's properties to another render session.	BitmapRenderSession
	flush():void Flushes any cached drawing operations to screen.	BitmapRenderSession
	getBitmapData(view:View3D):BitmapData Returns a bitmapData object containing the rendered view.	BitmapRenderSession
	getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view.	BitmapRenderSession
(^)	registerChildSession(session:AbstractRenderSession):void Adds a session as a child of the session object.	AbstractRenderSession
(^)	renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void Draws a non-scaled bitmap into the graphics object.	AbstractRenderSession
(^)	renderFogColor(color:int, alpha:Number):void Draws a fog element into the graphics object.	AbstractRenderSession
(^)	renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object.	AbstractRenderSession
(^)	renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void Draws a bitmap with a precalculated matrix into the graphics object.	AbstractRenderSession
(^)	renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object.	AbstractRenderSession
(^)	renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a triangle element with a fill color into the graphics object.	AbstractRenderSession
(^)	renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element into the graphics object.	AbstractRenderSession
(^)	renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element with a fill color into the graphics object.	AbstractRenderSession

Protected Methods

	Method		Defined by
		createLayer():void Creates a new render layer for rendering composite materials.	BitmapRenderSession

Property detail

view

property

view:View3D [read-write]

Defines the view object used for the render session.

Implementation
public function get view():View3D
public function set view(value:View3D):void

Constructor detail

BitmapRenderSession

()

constructor

public function BitmapRenderSession(scale:Number = 2)
Parameters

scale:Number (default = 2) - [optional] Defines the scale of the pixel resolution in base pixels. Default value is 2.

Method detail

addDisplayObject

()

method

public override function addDisplayObject(child:DisplayObject):void

Adds a display object to the render session display list.

Parameters

child:DisplayObject - The display object to add.

addLayerObject

()

method

public override function addLayerObject(child:Sprite):void

Adds a layer sprite to the render session display list. Doesn't update graphics so that elements in comosite materials can render in separate layers.

Parameters

child:Sprite - The display object to add.

clear

()

method

public override function clear():void

Clears the render session.

clone

()

method

public override function clone():AbstractRenderSession

Duplicates the render session's properties to another render session.

Returns

AbstractRenderSession - The new render session instance with duplicated properties applied

createLayer

()

method

protected override function createLayer():void

Creates a new render layer for rendering composite materials.

flush

()

method

public override function flush():void

Flushes any cached drawing operations to screen.

getBitmapData

()

method

public function getBitmapData(view:View3D):BitmapData

Returns a bitmapData object containing the rendered view.

Parameters

view:View3D - The view object being rendered.

Returns

BitmapData - The bitmapData object.

getContainer

()

method

public override function getContainer(view:View3D):DisplayObject

Returns a display object representing the container for the specified view.

Parameters

view:View3D - The view object being rendered.

Returns

DisplayObject - The display object container.

Wiki link

Click to go to the wiki page for 'away3d.core.render.BitmapRenderSession'

Code examples

There are currently no examples for this class

Blocker

Package	away3d.core.block
Class	public class Blocker
Inheritance	Blocker -> DrawPrimitive
Subclasses	ConvexBlocker

Abstract primitive that can block other primitives from drawing

Public Properties

Property		Defined by
(^)	create : Function Placeholder function for creating new drawing primitives from a cache of objects.	DrawPrimitive
(^)	maxX : Number Indicates the maximum x value of the drawing primitive.	DrawPrimitive
(^)	maxY : Number Indicates the maximum y value of the drawing primitive.	DrawPrimitive
(^)	maxZ : Number Indicates the maximum z value of the drawing primitive.	DrawPrimitive
(^)	minX : Number Indicates the minimum x value of the drawing primitive.	DrawPrimitive
(^)	minY : Number Indicates the minimum y value of the drawing primitive.	DrawPrimitive
(^)	minZ : Number Indicates the minimum z value of the drawing primitive.	DrawPrimitive
(^)	projection : Projection Reference to the last projection object used for the primitive	DrawPrimitive
(^)	quadrant : PrimitiveQuadrantTreeNode Reference to the last quadrant used by the drawing primitive.	DrawPrimitive
(^)	screenZ : Number Indicates the screen z value of the drawing primitive (used for z-sorting).	DrawPrimitive
(^)	source : Object3D The parent 3d object of the drawing primitive.	DrawPrimitive

Public Methods

Method		Defined by
	block(pri:DrawPrimitive):Boolean Return value signifies whether the given drawprimitive should be blocked.	Blocker
(^)	calc():void Calculates the min, max and screen properties required for rendering the drawing primitive.	DrawPrimitive
(^)	clear():void Deletes the data currently held by the drawing primitive.	DrawPrimitive
(^)	contains(x:Number, y:Number):Boolean Determines whether the given point lies inside the drawing primitive	DrawPrimitive
(^)	getZ(x:Number, y:Number):Number Calulates the screen z value of a precise point on the drawing primitive.	DrawPrimitive
(^)	quarter(focus:Number):Array Cuts the drawing primitive into 4 equally sized drawing primitives.	DrawPrimitive
(^)	render():void Draws the primitive to the view.	DrawPrimitive
(^)	toString():String Used to trace the values of a drawing primitive.	DrawPrimitive

Method detail

block

()

method

public function block(pri:DrawPrimitive):Boolean

Return value signifies whether the given drawprimitive should be blocked. Called from the PrimitiveArray object on each blocker in the blockers array.

Parameters

pri:DrawPrimitive

Returns

Boolean

See also

away3d.core.draw.PrimitiveArray

Wiki link

Click to go to the wiki page for 'away3d.core.block.Blocker'

Code examples

There are currently no examples for this class

BlockerArray

Package	away3d.core.block
Class	public class BlockerArray
Implements	IBlockerConsumer

Array for storing blocker objects

Public Properties

	Property		Defined by
		clip : Clipping Determines the viewport clipping to be used on blocker primitives.	BlockerArray

Public Methods

	Method		Defined by
		blocker(block:Blocker):void Adds blocker primitive to the consumer.	BlockerArray
		list():Array Returns a sorted list of blocker primitives for use in `BasicRender`	BlockerArray

Property detail

clip

property

clip:Clipping [read-write]

Determines the viewport clipping to be used on blocker primitives.

Implementation
public function get clip():Clipping
public function set clip(value:Clipping):void

Method detail

blocker

()

method

public function blocker(block:Blocker):void

Adds blocker primitive to the consumer.

Parameters

block:Blocker - The blocker primitive to add.

list

()

method

public function list():Array

Returns a sorted list of blocker primitives for use in BasicRender

Returns

Array

See also

away3d.core.render.BasicRender

Wiki link

Click to go to the wiki page for 'away3d.core.block.BlockerArray'

Code examples

There are currently no examples for this class

BlockerTraverser

Package	away3d.core.traverse
Class	public class BlockerTraverser
Inheritance	BlockerTraverser -> Traverser

Traverser that gathers blocker primitives for occlusion culling.

Public Properties

	Property		Defined by
		consumer : IBlockerConsumer Defines the blocker consumer being used.	BlockerTraverser
		view : View3D Defines the view being used.	BlockerTraverser

Public Methods

Method		Defined by
	BlockerTraverser () Creates a new `BlockerTraverser` object.	BlockerTraverser
	apply(node:Object3D):void Executed when the traverser is applied to the node.	BlockerTraverser
(^)	enter(node:Object3D):void Executed when the traverser enters the node.	Traverser
(^)	leave(node:Object3D):void Executed when the traverser leaves the node.	Traverser
	match(node:Object3D):Boolean Determines if the specified node is required to be traversed.	BlockerTraverser

Property detail

consumer

property

public var consumer:IBlockerConsumer

Defines the blocker consumer being used.

view

property

public var view:View3D

Defines the view being used.

Constructor detail

BlockerTraverser

()

constructor

public function BlockerTraverser()

Method detail

apply

()

method

public override function apply(node:Object3D):void

Executed when the traverser is applied to the node.

Parameters

node:Object3D

match

()

method

public override function match(node:Object3D):Boolean

Determines if the specified node is required to be traversed.

Parameters

node:Object3D - The 3d object to be tested.

Returns

Boolean - The result of the test.

Wiki link

Click to go to the wiki page for 'away3d.core.traverse.BlockerTraverser'

Code examples

There are currently no examples for this class

Button

Package	away3d.test
Class	public class Button
Inheritance	Button -> flash.display.SimpleButton

Simple rounded rectangle button

Public Properties

	Property		Defined by
		selected : Boolean = false	Button

Public Methods

	Method		Defined by
		Button (text:String, pwidth:int = 80, pheight:int = 20)	Button

Property detail

selected

property

public var selected:Boolean = false

Constructor detail

Button

()

constructor

public function Button(text:String, pwidth:int = 80, pheight:int = 20)
Parameters

	`text:String`

	`pwidth:int` (default = `80`)

	`pheight:int` (default = `20`)

Wiki link

Click to go to the wiki page for 'away3d.test.Button'

Code examples

There are currently no examples for this class

CacheStore

Package	away3d.core.utils
Class	public class CacheStore

Public Properties

	Property		Defined by
		whiteShadingCache : Dictionary [static]	CacheStore

Property detail

whiteShadingCache

property

public static var whiteShadingCache:Dictionary

Wiki link

Click to go to the wiki page for 'away3d.core.utils.CacheStore'

Code examples

There are currently no examples for this class

Camera3D

Package	away3d.cameras
Class	public class Camera3D
Inheritance	Camera3D -> Object3D -> flash.events.EventDispatcher
Subclasses	TargetCamera3D

Basic camera used to resolve a view.

See also

away3d.containers.View3D

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
	aperture : Number Used in `DofSprite2D`.	Camera3D
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
	dof : Boolean Used in `DofSprite2D`.	Camera3D
	doflevels : Number = 16 Used in `DofSprite2D`.	Camera3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
	focus : Number A divisor value for the perspective depth of the view.	Camera3D
(^)	inverseSceneTransform : Matrix3D	Object3D
	maxblur : Number = 150 Used in `DofSprite2D`.	Camera3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransformed : Boolean	Object3D
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
	view : Matrix3D [read-only] Returns the transformation matrix used to resolve the scene to the view.	Camera3D
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
	zoom : Number Provides an overall scale value to the view	Camera3D

Protected Properties

Method		Defined by
	Camera3D (init:Object = null) Creates a new `Camera3D` object.	Camera3D
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
	clone(object:* = null):* Duplicates the camera's properties to another `Camera3D` object.	Camera3D
	disableDof():void Used in `DofSprite2D`	Camera3D
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
	enableDof():void Used in `DofSprite2D`.	Camera3D
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
	pan(angle:Number):void Rotates the camera in its horizontal plane.	Camera3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	Object3D
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
	screen(object:Object3D, vertex:Vertex = null):ScreenVertex Returns a `ScreenVertex` object describing the resolved x and y position of the given `Vertex` object.	Camera3D
(^)	tick(time:int):void Called by the `TickTraverser`.	Object3D
	tilt(angle:Number):void Rotates the camera in its vertical plane.	Camera3D
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Events

Event		Summary	Defined by
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

aperture

property

aperture:Number [read-write]

Used in DofSprite2D.

Implementation
public function get aperture():Number
public function set aperture(value:Number):void

See also

away3d.sprites.DofSprite2D

dof

property

dof:Boolean [read-write]

Used in DofSprite2D.

Implementation
public function get dof():Boolean
public function set dof(value:Boolean):void

See also

away3d.sprites.DofSprite2D

doflevels

property

public var doflevels:Number = 16

Used in DofSprite2D.

See also

away3d.sprites.DofSprite2D

focus

property

focus:Number [read-write]

A divisor value for the perspective depth of the view.

Implementation
public function get focus():Number
public function set focus(value:Number):void

maxblur

property

public var maxblur:Number = 150

Used in DofSprite2D.

See also

away3d.sprites.DofSprite2D

view

property

view:Matrix3D [read-only]

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

Implementation
public function get view():Matrix3D

zoom

property

public var zoom:Number

Provides an overall scale value to the view

Constructor detail

Camera3D

()

constructor

public function Camera3D(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`zoom:Number` (default = 10)
	`focus:Number` (default = 100)
	`aperture:Number` (default = 22)
	`maxblur:Number` (default = 150)
	`doflevels:Number` (default = 16)
	`dof:Boolean` (default = false)
	`lookat:Position`

Method detail

clone

()

method

public override function clone(object:* = null):*

Duplicates the camera's properties to another Camera3D object.

Parameters

object:* (default = null) - [optional] The new object instance into which all properties are copied.

Returns

* - The new object instance with duplicated properties applied.

disableDof

()

method

public function disableDof():void

Used in DofSprite2D

See also

away3d.sprites.DofSprite2D

enableDof

()

method

public function enableDof():void

Used in DofSprite2D.

See also

away3d.sprites.DofSprite2D

pan

()

method

public function pan(angle:Number):void

Rotates the camera in its horizontal plane. Panning the camera results in a motion similar to someone shaking their head "no".

Parameters

angle:Number - Angle to pan the camera.

screen

()

method

public function screen(object:Object3D, vertex:Vertex = null):ScreenVertex

Returns a ScreenVertex object describing the resolved x and y position of the given Vertex object.

Parameters

	`object:Object3D` - The local object for the Vertex. If none exists, use the `Scene3D` object.

	`vertex:Vertex` (default = `null`) - The vertex to be resolved.

Returns

ScreenVertex

See also

away3d.containers.Scene3D

tilt

()

method

public function tilt(angle:Number):void

Rotates the camera in its vertical plane. Tilting the camera results in a motion similar to someone nodding their head "yes".

Parameters

angle:Number - Angle to tilt the camera.

Wiki link

Click to go to the wiki page for 'away3d.cameras.Camera3D'

Code examples

lookAt() an Object

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

Cast

Package	away3d.core.utils
Class	public class Cast

Helper class for casting assets to usable objects

Public Methods

	Method		Defined by
		bitmap(data:*):BitmapData [static]	Cast
		bytearray(data:*):ByteArray [static]	Cast
		color(data:*):uint [static]	Cast
		material(data:*):ITriangleMaterial [static]	Cast
		string(data:*):String [static]	Cast
		tryclass(name:String):Object [static]	Cast
		trycolor(data:*):uint [static]	Cast
		wirematerial(data:*):ISegmentMaterial [static]	Cast
		xml(data:*):XML [static]	Cast

Method detail

bitmap

()

method

public static function bitmap(data:*):BitmapData
Parameters

data:*

Returns

BitmapData

bytearray

()

method

public static function bytearray(data:*):ByteArray
Parameters

data:*

Returns

ByteArray

color

()

method

public static function color(data:*):uint
Parameters

data:*

Returns

uint

material

()

method

public static function material(data:*):ITriangleMaterial
Parameters

data:*

Returns

ITriangleMaterial

string

()

method

public static function string(data:*):String
Parameters

data:*

Returns

String

tryclass

()

method

public static function tryclass(name:String):Object
Parameters

name:String

Returns

Object

trycolor

()

method

public static function trycolor(data:*):uint
Parameters

data:*

Returns

uint

wirematerial

()

method

public static function wirematerial(data:*):ISegmentMaterial
Parameters

data:*

Returns

ISegmentMaterial

xml

()

method

public static function xml(data:*):XML
Parameters

data:*

Returns

XML

Wiki link

Click to go to the wiki page for 'away3d.core.utils.Cast'

Code examples

There are currently no examples for this class

CastError

Package	away3d.core.utils
Class	public class CastError
Inheritance	CastError -> Error

Public Methods

	Method		Defined by
		CastError (message:String)	CastError

Constructor detail

CastError

()

constructor

public function CastError(message:String)
Parameters

message:String

Wiki link

Click to go to the wiki page for 'away3d.core.utils.CastError'

Code examples

There are currently no examples for this class

CenterLightingMaterial

Package	away3d.materials
Class	public class CenterLightingMaterial
Inheritance	CenterLightingMaterial -> flash.events.EventDispatcher
Implements	ITriangleMaterial, IUpdatingMaterial
Subclasses	ShadingColorMaterial, WhiteShadingBitmapMaterial

Abstract class for materials that calculate lighting for the face's center Not intended for direct use - use ShadingColorMaterial or WhiteShadingBitmapMaterial.

Public Properties

	Property		Defined by
		ak : Number = 20 Coefficient for shininess level	CenterLightingMaterial
		ambient_brightness : Number = 1 Coefficient for ambient light level	CenterLightingMaterial
		diffuse_brightness : Number = 1 Coefficient for diffuse light level	CenterLightingMaterial
		specular_brightness : Number = 1 Coefficient for specular light level	CenterLightingMaterial

Protected Properties

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

Public Methods

	Method		Defined by
		renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	CenterLightingMaterial
		updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	CenterLightingMaterial

Property detail

property

public var ak:Number = 20

Coefficient for shininess level

ambient_brightness

property

public var ambient_brightness:Number = 1

Coefficient for ambient light level

diffuse_brightness

property

public var diffuse_brightness:Number = 1

Coefficient for diffuse light level

ini

property

protected var ini:Init

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

specular_brightness

property

public var specular_brightness:Number = 1

Coefficient for specular light level

Method detail

renderTriangle

()

method

public function renderTriangle(tri:DrawTriangle):void

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

Parameters

tri:DrawTriangle

updateMaterial

()

method

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

Called once per render loop when material is visible.

Parameters

	`source:Object3D`

	`view:View3D`

Wiki link

Click to go to the wiki page for 'away3d.materials.CenterLightingMaterial'

Code examples

There are currently no examples for this class

Clipping

Package	away3d.core.clip
Class	public class Clipping
Subclasses	RectangleClipping

Base clipping class for no clipping.

Public Properties

	Property		Defined by
		maxX : Number = 1000000 Maximum allowed x value for primitives	Clipping
		maxY : Number = 1000000 Maximum allowed y value for primitives	Clipping
		minX : Number = -1000000 Minimum allowed x value for primitives	Clipping
		minY : Number = -1000000 Minimum allowed y value for primitives	Clipping

Public Methods

	Method		Defined by
		asRectangleClipping():RectangleClipping Returns a rectangle clipping object representing the bounding box of the clipping object.	Clipping
		check(pri:DrawPrimitive):Boolean Checks a drawing primitive for clipping.	Clipping
		rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean Checks a bounding rectangle for clipping.	Clipping
		screen(container:Sprite):Clipping Returns a rectangle clipping object initilised with the edges of the flash movie as the clipping bounds.	Clipping

Property detail

maxX

property

public var maxX:Number = 1000000

Maximum allowed x value for primitives

maxY

property

public var maxY:Number = 1000000

Maximum allowed y value for primitives

minX

property

public var minX:Number = -1000000

Minimum allowed x value for primitives

minY

property

public var minY:Number = -1000000

Minimum allowed y value for primitives

Method detail

asRectangleClipping

()

method

public function asRectangleClipping():RectangleClipping

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

Returns

RectangleClipping

check

()

method

public function check(pri:DrawPrimitive):Boolean

Checks a drawing primitive for clipping.

Parameters

pri:DrawPrimitive - The drawing primitive being checked.

Returns

Boolean - The clipping result - false for clipped, true for non-clipped.

rect

()

method

public function rect(minX:Number, minY:Number, maxX:Number, maxY:Number):Boolean

Checks a bounding rectangle for clipping.

Parameters

	`minX:Number` - The x value for the left side of the rectangle.

	`minY:Number` - The y value for the top side of the rectangle.

	`maxX:Number` - The x value for the right side of the rectangle.

	`maxY:Number` - The y value for the bottom side of the rectangle.

Returns

Boolean - The clipping result - false for clipped, true for non-clipped.

screen

()

method

public function screen(container:Sprite):Clipping

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

Parameters

container:Sprite

Returns

Clipping

Wiki link

Click to go to the wiki page for 'away3d.core.clip.Clipping'

Code examples

There are currently no examples for this class

Collada

Package	away3d.loaders
Class	public class Collada

File loader for the Collada file format.

Public Properties

	Property		Defined by
		container : ObjectContainer3D 3d container object used for storing the parsed collada scene.	Collada
		containerData : ContainerData Container data object used for storing the parsed collada data structure.	Collada
		materialLibrary : MaterialLibrary Reference container for all materials used in the collada scene.	Collada

Public Methods

	Method		Defined by
		Collada (xml:XML, init:Object = null) Creates a new `Collada` object.	Collada
		load(url:String, init:Object = null):Object3DLoader [static] Loads and parses a collada file into a 3d container object.	Collada
		loadTextures(data:*, init:Object = null):Object3DLoader [static] Loads and parses the textures for a collada file into a 3d container object.	Collada
		parse(data:*, init:Object = null, loader:Object = null):ObjectContainer3D [static] Creates a 3d container object from the raw xml data of a collada file.	Collada

Property detail

container

property

public var container:ObjectContainer3D

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

containerData

property

public var containerData:ContainerData

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

materialLibrary

property

public var materialLibrary:MaterialLibrary

Reference container for all materials used in the collada scene.

Constructor detail

Collada

()

constructor

public function Collada(xml:XML, init:Object = null)
Parameters

	`xml:XML` - The xml data of a loaded file.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`texturePath:String` (default = "")
	`autoLoadTextures:Boolean` (default = true)
	`scaling:Number` (default = 1)
	`material:Material`
	`centerMeshes:Boolean` (default = false)
	`materials:Object`

Method detail

load

()

method

public static function load(url:String, init:Object = null):Object3DLoader

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

Parameters

	`url:String` - The url location of the file to load.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Returns

Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the file is loading.

loadTextures

()

method

public static function loadTextures(data:*, init:Object = null):Object3DLoader

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

Parameters

	`data:*` - The xml data of a loaded file.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Returns

Object3DLoader - A 3d loader object that can be used as a placeholder in a scene while the textures are loading.

parse

()

method

public static function parse(data:*, init:Object = null, loader:Object = null):ObjectContainer3D

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

Parameters

	`data:*` - The xml data of a loaded file.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

	`loader:Object` (default = `null`) - [optional] Not intended for direct use.

Returns

ObjectContainer3D - A 3d container object representation of the collada file.

Wiki link

Click to go to the wiki page for 'away3d.loaders.Collada'

Code examples

There are currently no examples for this class

CollisionMap

Package	away3d.extrusions
Class	public class CollisionMap
Inheritance	CollisionMap -> flash.events.EventDispatcher

Public Properties

	Property		Defined by
		offsetx : Number [write-only]	CollisionMap
		offsety : Number [write-only]	CollisionMap

Public Methods

	Method		Defined by
		CollisionMap (source:BitmapData, view:Object, factorX:Number = 0, factorY:Number = 0)	CollisionMap
		getColorAt(x:Number, y:Number):Number	CollisionMap
		read(x:Number, y:Number):void	CollisionMap
		setColorEvent(color:Number, eventID:String, listener:Function):void	CollisionMap

Property detail

offsetx

property

offsetx:Number [write-only]
Implementation
public function set offsetx(value:Number):void

offsety

property

offsety:Number [write-only]
Implementation
public function set offsety(value:Number):void

Constructor detail

CollisionMap

()

constructor

public function CollisionMap(source:BitmapData, view:Object, factorX:Number = 0, factorY:Number = 0)
Parameters

	`source:BitmapData`

	`view:Object`

	`factorX:Number` (default = `0`)

	`factorY:Number` (default = `0`)

Method detail

getColorAt

()

method

public function getColorAt(x:Number, y:Number):Number
Parameters

	`x:Number`

	`y:Number`

Returns

Number

read

()

method

public function read(x:Number, y:Number):void
Parameters

	`x:Number`

	`y:Number`

setColorEvent

()

method

public function setColorEvent(color:Number, eventID:String, listener:Function):void
Parameters

	`color:Number`

	`eventID:String`

	`listener:Function`

Wiki link

Click to go to the wiki page for 'away3d.extrusions.CollisionMap'

Code examples

There are currently no examples for this class

Color

Package	away3d.core.utils
Class	public class Color

Static helper class for color manipulations

Public Methods

	Method		Defined by
		add(colora:int, colorb:int):int [static]	Color
		fromFloats(red:Number, green:Number, blue:Number):int [static]	Color
		fromHSV(hue:Number, saturation:Number, value:Number):int [static]	Color
		fromInts(red:int, green:int, blue:int):int [static]	Color
		fromIntsCheck(red:int, green:int, blue:int):int [static]	Color
		inverseAdd(colora:int, colorb:int):int [static]	Color
		multiply(color:int, k:Number):int [static]	Color

Public Constants

	Constant		Defined by
		black : int = 0x000000 [static]	Color
		blue : int = 0x0000FF [static]	Color
		cyan : int = 0x00FFFF [static]	Color
		green : int = 0x00FF00 [static]	Color
		purple : int = 0xFF00FF [static]	Color
		red : int = 0xFF0000 [static]	Color
		white : int = 0xFFFFFF [static]	Color
		yellow : int = 0xFFFF00 [static]	Color

Method detail

add

()

method

public static function add(colora:int, colorb:int):int
Parameters

	`colora:int`

	`colorb:int`

Returns

int

fromFloats

()

method

public static function fromFloats(red:Number, green:Number, blue:Number):int
Parameters

	`red:Number`

	`green:Number`

	`blue:Number`

Returns

int

fromHSV

()

method

public static function fromHSV(hue:Number, saturation:Number, value:Number):int
Parameters

	`hue:Number`

	`saturation:Number`

	`value:Number`

Returns

int

fromInts

()

method

public static function fromInts(red:int, green:int, blue:int):int
Parameters

	`red:int`

	`green:int`

	`blue:int`

Returns

int

fromIntsCheck

()

method

public static function fromIntsCheck(red:int, green:int, blue:int):int
Parameters

	`red:int`

	`green:int`

	`blue:int`

Returns

int

inverseAdd

()

method

public static function inverseAdd(colora:int, colorb:int):int
Parameters

	`colora:int`

	`colorb:int`

Returns

int

multiply

()

method

public static function multiply(color:int, k:Number):int
Parameters

	`color:int`

	`k:Number`

Returns

int

Constant detail

black

constant

public static const black:int = 0x000000

blue

constant

public static const blue:int = 0x0000FF

cyan

constant

public static const cyan:int = 0x00FFFF

green

constant

public static const green:int = 0x00FF00

purple

constant

public static const purple:int = 0xFF00FF

red

constant

public static const red:int = 0xFF0000

white

constant

public static const white:int = 0xFFFFFF

yellow

constant

public static const yellow:int = 0xFFFF00

Wiki link

Click to go to the wiki page for 'away3d.core.utils.Color'

Code examples

There are currently no examples for this class

ColorMaterial

Package	away3d.materials
Class	public class ColorMaterial
Implements	IFogMaterial, ITriangleMaterial

Material for solid color drawing

Public Properties

	Property		Defined by
		alpha : Number Determines the alpha value of the material	ColorMaterial
		color : uint 24 bit color value representing the material color	ColorMaterial
		visible : Boolean [read-only] Indicates whether the material is visible	ColorMaterial

Protected Properties

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

Public Methods

	Method		Defined by
		ColorMaterial (color:* = null, init:Object = null) Creates a new `ColorMaterial` object.	ColorMaterial
		clone():IFogMaterial Duplicates the material's properties to another `IFogMaterial` object	ColorMaterial
		renderFog(fog:DrawFog):void Sends the material data coupled with data from the DrawFog primitive to the render session	ColorMaterial
		renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	ColorMaterial

Property detail

alpha

property

alpha:Number [read-write]

Determines the alpha value of the material

Implementation
public function get alpha():Number
public function set alpha(value:Number):void

color

property

public var color:uint

24 bit color value representing the material color

ini

property

protected var ini:Init

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

visible

property

visible:Boolean [read-only]

Indicates whether the material is visible

Implementation
public function get visible():Boolean

Constructor detail

ColorMaterial

()

constructor

public function ColorMaterial(color:* = null, init:Object = null)
Parameters

	`color:*` (default = `null`) - A string, hex value or colorname representing the color of the material.

	`init:Object` (default = `null`) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

alpha:Number (default = 1, min:0, max:1)

Method detail

clone

()

method

public function clone():IFogMaterial

Duplicates the material's properties to another IFogMaterial object

Returns

IFogMaterial - The new object instance with duplicated properties applied

renderFog

()

method

public function renderFog(fog:DrawFog):void

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

Parameters

fog:DrawFog

renderTriangle

()

method

public function renderTriangle(tri:DrawTriangle):void

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

Parameters

tri:DrawTriangle

Wiki link

Click to go to the wiki page for 'away3d.materials.ColorMaterial'

Code examples

There are currently no examples for this class

CompositeMaterial

Package	away3d.materials
Class	public class CompositeMaterial
Implements	ILayerMaterial, ITriangleMaterial, IUpdatingMaterial
Subclasses	Dot3BitmapMaterial, Dot3MovieMaterial, EnviroBitmapMaterial, PhongBitmapMaterial, PhongColorMaterial, PhongMovieMaterial

Container for layering multiple material objects. Renders each material by drawing one triangle per meterial layer. For static bitmap materials, use BitmapMaterialContainer.

Public Properties

	Property		Defined by
		alpha : Number Defines an alpha value for the layer container.	CompositeMaterial
		blendMode : String Defines a blendMode value for the layer container.	CompositeMaterial
		color : uint Defines a colored tint for the layer container.	CompositeMaterial
		materials : Array An array of bitmapmaterial objects to be overlayed sequentially.	CompositeMaterial
		visible : Boolean [read-only] Indicates whether the material is visible	CompositeMaterial

Protected Properties

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

Public Methods

	Method		Defined by
		CompositeMaterial (init:Object = null) Creates a new `CompositeMaterial` object.	CompositeMaterial
		renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	CompositeMaterial
		renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	CompositeMaterial
		updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	CompositeMaterial

Protected Methods

	Method		Defined by
		setColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	CompositeMaterial

Property detail

alpha

property

alpha:Number [read-write]

Defines an alpha value for the layer container.

Implementation
public function get alpha():Number
public function set alpha(value:Number):void

blendMode

property

public var blendMode:String

Defines a blendMode value for the layer container.

color

property

color:uint [read-write]

Defines a colored tint for the layer container.

Implementation
public function get color():uint
public function set color(value:uint):void

ini

property

protected var ini:Init

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

materials

property

public var materials:Array

An array of bitmapmaterial objects to be overlayed sequentially.

visible

property

visible:Boolean [read-only]

Indicates whether the material is visible

Implementation
public function get visible():Boolean

Constructor detail

CompositeMaterial

()

constructor

public function CompositeMaterial(init:Object = null)
Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`materials:Array`
	`blendMode:String` (default = BlendMode.NORMAL)
	`alpha:Number` (default = 1, min:0, max:1)
	`color:Color` (default = 0xFFFFFF)

Method detail

renderLayer

()

method

public function renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void

Renders a material layer for the specified triangle.

Parameters

	`tri:DrawTriangle` - The drawtriangle used for render information.

	`layer:Sprite` - The parent layer into which the triangle is drawn.

	`level:int` - Defines the sprite level for the layer.

renderTriangle

()

method

public function renderTriangle(tri:DrawTriangle):void

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

Parameters

tri:DrawTriangle

setColorTransform

()

method

protected function setColorTransform():void

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

See also

color
alpha

updateMaterial

()

method

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

Called once per render loop when material is visible.

Parameters

	`source:Object3D`

	`view:View3D`

Wiki link

Click to go to the wiki page for 'away3d.materials.CompositeMaterial'

Code examples

There are currently no examples for this class

Cone

Package	away3d.primitives
Class	public class Cone
Inheritance	Cone -> AbstractPrimitive -> Mesh -> BaseMesh -> Object3D -> flash.events.EventDispatcher

Creates a 3d cone primitive.

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	BaseMesh
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Mesh
(^)	elements : Array Returns an array of the elements contained in the mesh object.	Mesh
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	BaseMesh
(^)	frame : int Indicates the current frame of animation	BaseMesh
(^)	framenames : Dictionary A dictionary containing all frame names of the mesh	BaseMesh
(^)	frames : Dictionary A dictionary containing all frames of the mesh	BaseMesh
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	BaseMesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	BaseMesh
	height : Number Defines the height of the cone.	Cone
(^)	indexes : Array	Mesh
(^)	inverseSceneTransform : Matrix3D	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	BaseMesh
(^)	loop : Boolean Determines whether the animation will loop.	BaseMesh
(^)	material : ITriangleMaterial Defines the material used to render the faces in the mesh object.	Mesh
(^)	maxX : Number Returns the maximum x value of the 3d object	BaseMesh
(^)	maxY : Number Returns the maximum y value of the 3d object	BaseMesh
(^)	maxZ : Number Returns the maximum z value of the 3d object	BaseMesh
(^)	minX : Number Returns the minimum x value of the 3d object	BaseMesh
(^)	minY : Number Returns the minimum y value of the 3d object	BaseMesh
(^)	minZ : Number Returns the minimum z value of the 3d object	BaseMesh
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
	openEnded : Boolean Defines whether the end of the cone is left open (true) or closed (false).	Cone
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	BaseMesh
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	BaseMesh
	radius : Number Defines the radius of the cone base.	Cone
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationY : Number Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	rotationZ : Number Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D`.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D`.	AbstractPrimitive
(^)	sceneTransformed : Boolean	Object3D
	segmentsH : Number Defines the number of vertical segments that make up the cone.	Cone
	segmentsW : Number Defines the number of horizontal segments that make up the cone.	Cone
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	BaseMesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	type : String String defining the type of class used to generate the mesh.	BaseMesh
(^)	url : String String defining the source of the mesh.	BaseMesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object	BaseMesh
(^)	viewTransform : Matrix3D	Object3D
(^)	visible : Boolean = true Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
	yUp : Boolean Defines whether the coordinates of the cone points use a yUp orientation (true) or a zUp orientation (false).	Cone
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D

Protected Properties

Method		Defined by
	Cone (init:Object = null) Creates a new `Cone` object.	Cone
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	BaseMesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnRadiusChange(listener:Function):void Default method for adding a radiuschanged event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a squencedone event listener	BaseMesh
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
	buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive.	Cone
(^)	clone(object:* = null):* Duplicates the mesh properties to another 3d object.	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	BaseMesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	BaseMesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	moveBackward(distance:Number):void Moves the 3d object backwards along it's local z axis	Object3D
(^)	moveDown(distance:Number):void Moves the 3d object backwards along it's local y axis	Object3D
(^)	moveForward(distance:Number):void Moves the 3d object forwards along it's local z axis	Object3D
(^)	moveLeft(distance:Number):void Moves the 3d object backwards along it's local x axis	Object3D
(^)	movePivot(dx:Number, dy:Number, dz:Number):void Moves the origin point of the mesh without moving the contents.	Mesh
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(target:Number3D):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	BaseMesh
(^)	primitives(consumer:IPrimitiveConsumer, session:AbstractRenderSession):void Called from the `PrimitiveTraverser` when passing `DrawPrimitive` objects to the primitive consumer object	Mesh
(^)	quarterFaces():void Divides a face object into 4 equal sized face objects.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	BaseMesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnRadiusChange(listener:Function):void Default method for removing a radiuschanged event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a squencedone event listener	BaseMesh
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the mesh.	BaseMesh
(^)	scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames	BaseMesh
(^)	scaleX(scaleX:Number):void Scales the contents of the mesh along the x-axis.	BaseMesh
(^)	scaleY(scaleY:Number):void Scales the contents of the mesh along the y-axis.	BaseMesh
(^)	scaleZ(scaleZ:Number):void Scales the contents of the mesh along the z-axis.	BaseMesh
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	BaseMesh
(^)	tick(time:int):void Called by the `TickTraverser`.	BaseMesh
(^)	toString():String Used to trace the values of a 3d object.	Object3D
(^)	translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
(^)	traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
	vertex(w:int, h:int):Vertex Returns the vertex object specified by the grid position of the mesh.	Cone
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	addElement(element:IMeshElement):void Adds an element to the mesh object.	BaseMesh
(^)	removeElement(element:IMeshElement):void Removes an element to the mesh object.	BaseMesh
(^)	scaleXYZ(scaleX:Number, scaleY:Number, scaleZ:Number):void Scales the contents of the mesh using 3 axis values.	BaseMesh

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when the animation object completes a single sequence cycle.	BaseMesh
(^)	dimensionschanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown3D	Dispatched when a user presses the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove3D	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut3D	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver3D	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp3D	Dispatched when a user releases the let hand mouse button while the cursor is over the 3d object.	Object3D
(^)	radiuschanged	Dispatched when the bounding radius of the 3d object changes.	Object3D
(^)	scenechanged	Dispatched when the parent scene of the 3d object changes	Object3D
(^)	scenetransformchanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
(^)	sequencedone	Dispatched when the animation object completes all frame sequences.	BaseMesh
(^)	transformchanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

height

property

height:Number [read-write]

Defines the height of the cone. Defaults to 200.

Implementation
public function get height():Number
public function set height(value:Number):void

openEnded

property

openEnded:Boolean [read-write]

Defines whether the end of the cone is left open (true) or closed (false). Defaults to false.

Implementation
public function get openEnded():Boolean
public function set openEnded(value:Boolean):void

radius

property

radius:Number [read-write]

Defines the radius of the cone base. Defaults to 100.

Implementation
public function get radius():Number
public function set radius(value:Number):void

segmentsH

property

segmentsH:Number [read-write]

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

Implementation
public function get segmentsH():Number
public function set segmentsH(value:Number):void

segmentsW

property

segmentsW:Number [read-write]

Defines the number of horizontal segments that make up the cone. Defaults to 8.

Implementation
public function get segmentsW():Number
public function set segmentsW(value:Number):void

yUp

property

yUp:Boolean [read-write]

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

Implementation
public function get yUp():Boolean
public function set yUp(value:Boolean):void

Constructor detail

Cone

()

constructor

public function Cone(init:Object = null)

Cone constructor takes an init object has a single parameter. The init object can define the 'radius' of the base of the cone, 'height' the height, 'segmentsW' the number of segments around the cone horizontally and 'segmentsH' the number of segments vertically.

Parameters

init:Object (default = null) - [optional] An initialisation object for specifying default instance properties.

Init Parameters

	`radius:Number` (default = 100, min:0)
	`height:Number` (default = 200, min:0)
	`segmentsW:Int` (default = 8, min:3)
	`segmentsH:Int` (default = 1, min:1)
	`openEnded:Boolean` (default = false)
	`yUp:Boolean` (default = true)

Method detail

buildPrimitive

()

method

public override function buildPrimitive():void

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

vertex

()

method

public function vertex(w:int, h:int):Vertex

Returns the vertex from a 2 dimensional representation of the cone's vertex array.
I=horizontal reference.
J=vertical reference (0 = base of the cone)

Returns the vertex object specified by the grid position of the mesh.

Parameters

	`w:int` - The horizontal position on the primitive mesh.

	`h:int` - The vertical position on the primitive mesh.

Returns

Vertex

Wiki link

Click to go to the wiki page for 'away3d.primitives.Cone'

Code examples

Cone Creation

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

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

Simple object creation tutorial

ContainerData

Package	away3d.loaders.data
Class	public class ContainerData
Inheritance	ContainerData -> ObjectData

Data class for 3d object containers.

Public Properties

Property		Defined by
	children : Array An array containing the child 3d objects of the container.	ContainerData
(^)	name : String The name of the 3d object used as a unique reference.	ObjectData
(^)	transform : Matrix3D The 3d transformation matrix for the 3d object	ObjectData

Property detail

children

property

public var children:Array

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

Wiki link

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

Code examples

There are currently no examples for this class

ConvexBlock

Package	away3d.blockers
Class	public class ConvexBlock
Inheritance	ConvexBlock -> Object3D -> flash.events.EventDispatcher
Implements	IBlockerProvider, IPrimitiveProvider

Convex hull blocking all drawing primitives underneath.

Public Properties

Property		Defined by
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
	debug : Boolean Toggles debug mode: blocker is visualised in the scene.	ConvexBlock
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	inverseSceneTransform : Matrix3D	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	ownCanvas : Boolean = false Defines whether the contents of the 3d object are rendered inside it's own sprite	Object3D
(^)	ownSession : AbstractRenderSession Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projection : Projection	Object3D
(^)	rotationX : Number Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D