Away3D API Reference: V2.3

	Package	Description
	away3d.animators
	IMeshAnimation	Interface for objects containing animation information for meshes.
	Animator
	PathAnimator
	SkinAnimation
	TimeBase
	away3d.animators.data
	AnimationFrame	Holds information about a single animation frame.
	AnimationGroup	Holds information about a list of animation sequences.
	AnimationSequence	Holds information about a sequence of animation frames.
	CurveSegment	Holds information about a segment of a curve.
	Path	Holds information about a single Path definition.
	away3d.animators.skin
	Bone
	Channel
	SkinController
	SkinVertex
	away3d.animators.utils
	AWTweener
	PathUtils	Geometry handlers for classes using Path objects
	away3d.blockers
	ConvexBlock	Convex hull blocking all drawing primitives underneath.
	away3d.cameras
	Camera3D	Basic camera used to resolve a view.
	HoverCamera3D	Extended camera used to hover round a specified target object.
	SpringCam	A 1st and 3d person camera(depending on positionOffset!), hooked on a physical spring on an optional target.
	TargetCamera3D	Extended camera used to automatically look at a specified target object.
	away3d.cameras.lenses
	ILens
	AbstractLens	Abstract lens for resolving perspective using the
	OrthogonalLens
	PerspectiveLens
	SphericalLens
	ZoomFocusLens
	away3d.containers
	ILODObject	Interface for objects that can toggle their visibily depending on view and distance to camera
	IPhysicsScene
	LODObject	3d object container that is drawn only if its scaling to perspective falls within a given range.
	ObjectContainer3D	3d object container node for other 3d objects in a scene
	Scene3D	The root container of all 3d objects in a single scene
	View3D	Sprite container used for storing camera, scene, session, renderer and clip references, and resolving mouse events
	away3d.core.base
	IAnimation	Interface for objects that can animate the vertex values in a mesh
	IFrame	Interface for objects that store the vertex values for a single frame of animation
	Animation	Holds information about the current state of a mesh animation.
	AnimationTransition	Holds information about the current state of animation to transition into another animation.
	Billboard	A graphics element used to represent objects that always face the camera
	Element	Basic 3d element object Not intended for direct use - use
	Face	A triangle element used in the mesh object
	Frame	Holds vertexposition information about a single animation frame.
	Geometry	3d object containing face and segment elements
	Mesh	3d object containing face and segment elements
	Morpher	Keyframe animation morpher
	Object3D	Base class for all 3d objects.
	Segment	A line element used in the wiremesh and mesh object
	UV	Texture coordinates value object.
	Vertex	A vertex coordinate value object.
	VertexClassification
	VertexPosition	Vertex position value object.
	away3d.core.block
	IBlockerConsumer	Interface for containers capable of storing blockers.
	IBlockerProvider	Interface for objects that provide blocker instances for occlusion culling in the renderer.
	Blocker	Abstract primitive that can block other primitives from drawing
	BlockerArray	Array for storing blocker objects
	ConvexBlocker	Convex hull primitive that blocks all primitives behind and contained completely inside.
	away3d.core.clip
	Clipping	Base clipping class for no clipping.
	FrustumClipping	Frustum Clipping
	NearfieldClipping	Rectangle clipping combined with nearfield clipping
	RectangleClipping	Rectangle clipping
	away3d.core.draw
	IPrimitiveConsumer	Interface for containers capable of drawing primitives
	IPrimitiveProvider	Interface for objects that provide drawing primitives to the rendering process
	DrawBillboard	Billboard primitive
	DrawBitmap	Unscaled bitmap drawing primitive
	DrawDisplayObject	Displayobject container drawing primitive.
	DrawFog	Fog drawing primitive
	DrawPrimitive	Abstract class for all drawing primitives
	DrawScaledBitmap	Scaled bitmap primitive
	DrawSegment	Line segment drawing primitive
	DrawTriangle	Triangle drawing primitive
	PrimitiveQuadrantTreeNode	Quadrant tree node
	PrimitiveVolumeBlock	Volume block containing drawing primitives
	PrimitiveVolumeBlockNode	Volume block tree node
	ScreenVertex	representation of a 3d vertex resolved to the view.
	away3d.core.filter
	IPrimitiveFilter	Interface for filters that work on primitive arrays
	IPrimitiveQuadrantFilter	Interface for filters that work on primitive quadrant trees
	IPrimitiveVolumeBlockFilter	Interface for filters that work on primitive volume blocks
	AnotherRivalFilter	Corrects triangle z-sorting
	FogFilter	Adds fog layers to a view and provides automatic farfield filtering for primitives outside the furthest fog layers.
	QuadrantRiddleFilter	Splits all intersecting triangles and line segments.
	ZDepthFilter	Defines a maximum z value for rendering primitives
	ZSortFilter	Sorts drawing primitives by z coordinate.
	away3d.core.geom
	Frustum
	Line2D	Line in 2D space
	Plane3D	Plane in 3D space
	away3d.core.light
	ILightConsumer	Interface for containers capable of storing lighting info
	ILightProvider	Interface for objects that provide lighting to the scene
	AmbientLight	Ambient light primitive
	DirectionalLight	Directional light primitive.
	LightArray	Array for storing light primitives.
	LightPrimitive	Abstract light primitve.
	PointLight	Point light primitive
	away3d.core.math
	Matrix3D	A 3D transformation 4x4 matrix
	Number2D	A point in 2D space.
	Number3D	A point in 3D space.
	Quaternion	A Quaternion object.
	away3d.core.project
	ConvexBlockProjector
	DirSpriteProjector
	DofSpriteProjector
	MeshProjector
	MovieClipSpriteProjector
	ObjectContainerProjector
	ProjectorType
	SpriteProjector
	away3d.core.render
	IRenderer	Interface for renderers capable of rendering a scene to a view
	AbstractRenderSession	Abstract Drawing session object containing the method used for drawing the view to screen.
	BasicRenderer	Default renderer for a view.
	BitmapRenderSession	Drawing session object that renders all drawing primitives into a
	QuadrantRenderer	Renderer that uses quadrant tree for storing and operating drawing primitives.
	Renderer	A static class for an easy access to the most useful renderers.
	SpriteRenderSession	Drawing session object that renders all drawing primitives into a
	away3d.core.stats
	Stats
	away3d.core.traverse
	LightTraverser	Traverser that gathers blocker primitives for occlusion culling.
	PrimitiveTraverser	Traverser that gathers drawing primitives to render the scene.
	ProjectionTraverser	Traverser that resolves the transform tree in a scene, ready for rendering.
	SessionTraverser	Traverser that gathers blocker primitives for occlusion culling.
	TickTraverser	Traverser that fires a time-based method for all objects in scene
	Traverser	Abstract class for all traverser that perform actions on the whole scene.
	away3d.core.utils
	IClonable	Interface for object that can be cloned
	CacheStore
	CameraVarsStore
	Cast	Helper class for casting assets to usable objects
	CastError
	Color	Static helper class for color manipulations
	Debug	Class for emmiting debuging messages, warnings and errors
	DofCache	Provides static pre-blurred bitmap images for depth of field-effect when used together with billboarded sprites, such as Billboards.
	DrawPrimitiveStore
	FaceDictionaryVO
	FaceMaterialVO
	FaceVO
	Init	Convinient object initialization support
	ValueObject

	away3d.exporters
	AS3Exporter
	Elevation2AS3	Class Elevation2AS3 generates a string class of the elevation to pass to the SkinClass and ElevationReader in order to save space and processing time.
	ObjExporter	Class ObjExporter generates a string in the WaveFront obj format representing the object3D(s).
	away3d.extrusions
	CollisionMap
	Elevation	Class Elevation returns a multidimentional array of Number3D's to pass to the SkinClass in order to generate an elevated mesh from
	ElevationModifier	Class ElevationModifier updates the vertexes of a flat Mesh such as a Plane, RegularPolygon with a bimap information
	ElevationReader
	Lathe
	Mirror	Class Mirror an Object3D geometry and its uv's
	NormalUVModifier
	PathDuplicator
	PathExtrude
	SegmentsExtrude
	SkinExtrude
	away3d.lights
	AmbientLight3D	Lightsource that colors all shaded materials evenly from any angle
	DirectionalLight3D	Lightsource that colors all shaded materials proportional to the dot product of the offset vector with the normal vector.
	PointLight3D	Lightsource that colors all shaded materials proportional to the dot product of the distance vector with the normal vector.
	away3d.loaders
	AbstractParser
	Ase	File loader for the ASE file format.
	Collada	File loader for the Collada file format with animation.
	CubeLoader	Default loader class used as a placeholder for loading 3d content
	Kmz	File loader for the KMZ 4 file format (exported from Google Sketchup).
	Max3DS	File loader for the 3DS file format.
	Md2	File loader for the Md2 file format.
	Md2still	File loader for the Md2 file format (non-animated version).
	Obj	File loader for the OBJ file format.
	Object3DLoader	Abstract loader class used as a placeholder for loading 3d content
	away3d.loaders.data
	AnimationData	Data class for the animation of a mesh.
	BoneData	Data class for a bone used in SkinAnimation.
	ChannelData	Data class for an animation channel
	ContainerData	Data class for 3d object containers.
	FaceData	Data class for a face object.
	GeometryData	Data class for the geometry data used in a mesh object
	MaterialData	Data class for the material data of a face.
	MeshData	Data class for the mesh data of a 3d object
	MeshMaterialData	Data class for teh material of a 3d object
	ObjectData	Data class for a generic 3d object
	away3d.loaders.utils
	AnimationLibrary	Store for all animations associated with an externally loaded file.
	ChannelLibrary	Store for all animation channels associated with an externally loaded file.
	GeometryLibrary	Store for all geometries associated with an externally loaded file.
	MaterialLibrary	Store for all materials associated with an externally loaded file.
	TextureLoader	Used to store the name and loader reference of an external texture image.
	TextureLoadQueue	Creates a queue of textures that load sequentially
	away3d.materials
	IBillboardMaterial	Interface for materials that are capable of drawing billboards.
	IFogMaterial	Interface for fog filter materials
	ILayerMaterial	Interface for materials that can be layered using
	IMaterial	Interface for all objects that can serve as a material
	ISegmentMaterial	Interface for materials that are capable of drawing line segments.
	ITriangleMaterial	Interface for materials that are capable of rendering triangle faces.
	IUVMaterial	Interface for materials that use uv texture coordinates
	AnimatedBitmapMaterial	Bitmap material that allows fast rendering of animations by caching bitmapdata objects for each frame.
	BitmapFileMaterial	Bitmap material that loads it's texture from an external bitmapasset file.
	BitmapMaterial	Basic bitmap material
	BitmapMaterialContainer	Container for caching multiple bitmapmaterial objects.
	CenterLightingMaterial	Abstract class for materials that calculate lighting for the face's center Not intended for direct use - use
	ColorMaterial	Material for solid color drawing
	CompositeMaterial	Container for layering multiple material objects.
	Dot3BitmapMaterial	Bitmap material with DOT3 shading.
	Dot3BitmapMaterialCache	Bitmap material with cached DOT3 shading.
	Dot3MovieMaterial	Animated movie material with DOT3 shading.
	EnviroBitmapMaterial	Bitmap material with environment shading.
	EnviroBitmapMaterialCache	Bitmap material with cached environment shading.
	EnviroColorMaterial	Color material with environment shading.
	MovieMaterial	Animated movie material.
	PhongBitmapMaterial	Bitmap material with phong shading.
	PhongBitmapMaterialCache	Bitmap material with cached phong shading.
	PhongColorMaterial	Color material with phong shading.
	PhongColorMaterialCache	Color material with cached phong shading.
	PhongMovieMaterial	Animated movie material with phong shading.
	ShadingColorMaterial	Color material with flat shading.
	TransformBitmapMaterial	Basic bitmap texture material
	VideoMaterial
	WhiteShadingBitmapMaterial	Bitmap material with flat white lighting
	WireColorMaterial	Wire material for solid color drawing with optional face border outlining
	WireframeMaterial	Wire material for face border outlining only
	away3d.materials.shaders
	AbstractShader	Base class for shaders.
	AmbientShader	Shader class for ambient lighting
	DiffuseDot3Shader	Diffuse Dot3 shader class for directional lighting.
	DiffusePhongShader	Diffuse shader class for directional lighting.
	EnviroShader	Shader class for environment lighting.
	SpecularPhongShader	Specular shader class for directional lighting.
	away3d.materials.utils
	NormalBumpMaker	Utility class, principally to transform bump map data into normal map data.
	NormalMapGenerator
	SimpleShadow	This class generates a top projection shadow from vertex information of a given Object3D, Most suitable for still objects.
	away3d.primitives
	AbstractPrimitive	Abstract base class for shaded primitives
	AbstractWirePrimitive	Abstract base class for wire primitives
	BezierPatch	BezierPatch primitive creates a smooth mesh based on a 4x4 vertex patch using a cubic bezier curve.
	Cone	Creates a 3d cone primitive.
	Cube	Creates a 3d Cube primitive.
	Cylinder	Creates a 3d cylinder primitive.
	GeodesicSphere	Creates a 3d geodesic sphere primitive.
	GridPlane	Creates a 3d grid primitive.
	LineSegment	Creates a 3d line segment.
	Plane	Creates a 3d plane primitive.
	RegularPolygon	Creates a regular polygon.
	RoundedCube	Creates a 3d roundedcube primitive.
	SeaTurtle	Creates a sea turtle model (exported using asAS3Class).
	Skybox	QTVR-style 360 panorama renderer that is initialized with six images.
	Skybox6	QTVR-style 360 panorama renderer that is initialized with one solid image.
	Sphere	Creates a 3d sphere primitive.
	Torus	Creates a 3d torus primitive.
	Triangle	Creates a 3d triangle.
	Trident	Creates an axis trident.
	WireCircle	Creates a 3d wire polygon.
	WireCone	Creates a 3d wire cone primitive.
	WireCube	Creates a 3d wire cube primitive.
	WireCylinder	Creates a 3d wire cylinder primitive.
	WirePlane	Creates a 3d wire plane primitive.
	WireSphere	Creates a 3d wire sphere primitive.
	WireTorus	Creates a 3d wire torus primitive.
	away3d.primitives.data
	CubeMaterialsData	Data structure for individual materials on the sides of a cube.
	PatchData	PatchData definition for constructing BezierPatches.
	away3d.sprites
	DirSprite2D	Spherical billboard (always facing the camera) sprite object that uses an array of bitmapData objects defined with viewing direction vectors.
	DofSprite2D	Spherical billboard (always facing the camera) sprite object that uses a cached array of bitmapData objects as it's texture.
	MovieClipSprite	Spherical billboard (always facing the camera) sprite object that uses a movieclip as it's texture.
	Sprite2D	Spherical billboard (always facing the camera) sprite object that uses a bitmapData object as it's texture.
	away3d.test
	BaseDemo	Base class for Away3D demos
	Button	Simple rounded rectangle button
	Panel	Simple rounded rectangle panel
	SimpleView	SimpleView
	Slide	Represents a single slide of the demo

AbstractLens

Package	away3d.cameras.lenses
Class	public class AbstractLens
Subclasses	OrthogonalLens, PerspectiveLens, SphericalLens, ZoomFocusLens

Abstract lens for resolving perspective using the Camera3D object's position and properties

Protected Properties

	Property		Defined by
		_camera : Camera3D	AbstractLens
		_cameraVarsStore : CameraVarsStore	AbstractLens
		classification : int	AbstractLens
		_clipBottom : Number	AbstractLens
		_clipHeight : Number	AbstractLens
		_clipLeft : Number	AbstractLens
		_clipping : Clipping	AbstractLens
		_clipRight : Number	AbstractLens
		_clipTop : Number	AbstractLens
		_clipWidth : Number	AbstractLens
		_drawPrimitiveStore : DrawPrimitiveStore	AbstractLens
		_far : Number	AbstractLens
		_focusOverZoom : Number	AbstractLens
		_frustum : Frustum	AbstractLens
		_len : Number	AbstractLens
		_near : Number	AbstractLens
		_persp : Number	AbstractLens
		_plane : Plane3D	AbstractLens
		_projected : ScreenVertex	AbstractLens
		_screenVertex : ScreenVertex	AbstractLens
		_scz : Number	AbstractLens
		_sw : Number	AbstractLens
		_sx : Number	AbstractLens
		_sy : Number	AbstractLens
		_sz : Number	AbstractLens
		_view : View3D	AbstractLens
		view : Matrix3D	AbstractLens
		viewTransform : Matrix3D	AbstractLens
		_vx : Number	AbstractLens
		_vy : Number	AbstractLens
		_vz : Number	AbstractLens
		_zoom2 : Number	AbstractLens

Public Methods

	Method		Defined by
		setView(val:View3D):void	AbstractLens

Protected Constants

	Constant		Defined by
		toDEGREES : Number	AbstractLens
		toRADIANS : Number	AbstractLens

Property detail

_camera

property

protected var _camera:Camera3D

_cameraVarsStore

property

protected var _cameraVarsStore:CameraVarsStore

classification

property

protected var classification:int

_clipBottom

property

protected var _clipBottom:Number

_clipHeight

property

protected var _clipHeight:Number

_clipLeft

property

protected var _clipLeft:Number

_clipping

property

protected var _clipping:Clipping

_clipRight

property

protected var _clipRight:Number

_clipTop

property

protected var _clipTop:Number

_clipWidth

property

protected var _clipWidth:Number

_drawPrimitiveStore

property

protected var _drawPrimitiveStore:DrawPrimitiveStore

_far

property

protected var _far:Number

_focusOverZoom

property

protected var _focusOverZoom:Number

_frustum

property

protected var _frustum:Frustum

_len

property

protected var _len:Number

_near

property

protected var _near:Number

_persp

property

protected var _persp:Number

_plane

property

protected var _plane:Plane3D

_projected

property

protected var _projected:ScreenVertex

_screenVertex

property

protected var _screenVertex:ScreenVertex

_scz

property

protected var _scz:Number

_sw

property

protected var _sw:Number

_sx

property

protected var _sx:Number

_sy

property

protected var _sy:Number

_sz

property

protected var _sz:Number

_view

property

protected var _view:View3D

view

property

protected var view:Matrix3D

viewTransform

property

protected var viewTransform:Matrix3D

_vx

property

protected var _vx:Number

_vy

property

protected var _vy:Number

_vz

property

protected var _vz:Number

_zoom2

property

protected var _zoom2:Number

Method detail

setView

()

method

public function setView(val:View3D):void
Parameters

val:View3D

Constant detail

toDEGREES

constant

protected const toDEGREES:Number

toRADIANS

constant

protected const toRADIANS:Number

Wiki link

Click to go to the wiki page for 'away3d.cameras.lenses.AbstractLens'

Code examples

There are currently no examples for this class

AbstractParser

Package	away3d.loaders
Class	public class AbstractParser
Inheritance	AbstractParser -> flash.events.EventDispatcher
Subclasses	Ase, Collada, Kmz, Max3DS, Md2, Md2still, Obj

Public Properties

	Property		Defined by
		container : Object3D 3d container object used for storing the parsed 3ds object.	AbstractParser
		parsedChunks : int [read-only] Returns the total number of data chunks parsed	AbstractParser
		totalChunks : int [read-only] Returns the total number of data chunks available	AbstractParser

Public Methods

	Method		Defined by
		parseNext():void Processes the next chunk in the parser	AbstractParser

Property detail

container

property

public var container:Object3D

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

parsedChunks

property

parsedChunks:int [read-only]

Returns the total number of data chunks parsed

Implementation
public function get parsedChunks():int

totalChunks

property

totalChunks:int [read-only]

Returns the total number of data chunks available

Implementation
public function get totalChunks():int

Method detail

parseNext

()

method

public function parseNext():void

Processes the next chunk in the parser

Wiki link

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

Code examples

There are currently no examples for this class

AbstractPrimitive

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

Abstract base class for shaded primitives

Public Properties

Property		Defined by
(^)	activePrefix : String return the prefix of the animation actually started.	Mesh
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	billboardMaterial : IBillboardMaterial	Mesh
(^)	billboards : Array Returns an array of the billboards contained in the mesh object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
(^)	center : Vertex	Object3D
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
(^)	debugBoundingBox : WireCube	Object3D
(^)	debugBoundingSphere : WireSphere	Object3D
(^)	debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
(^)	elements : Array Returns an array of all elements contained in the mesh object.	Mesh
(^)	eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faceMaterial : ITriangleMaterial	Mesh
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	Mesh
(^)	frame : int Indicates the current frame of animation	Mesh
(^)	geometry : Geometry Defines the geometry object used for the mesh.	Mesh
(^)	geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	Mesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	Mesh
(^)	indexes : Array Placeholder for md2 frame indexes	Mesh
(^)	inverseSceneTransform : Matrix3D Returns the inverse of sceneTransform.	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	Mesh
(^)	lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
(^)	loop : Boolean Determines whether the animation will loop.	Mesh
(^)	material : IMaterial Defines the material used to render the faces, segments or billboards in the geometry object.	Mesh
(^)	materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
(^)	objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
(^)	objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
(^)	ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
(^)	pivotZero : Boolean	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projectorType : String	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
(^)	renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	Object3D
(^)	rotationX : Number 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
(^)	scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
(^)	scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
(^)	scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePivotPoint : Number3D	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	segmentMaterial : ISegmentMaterial	Mesh
(^)	segments : Array Returns an array of the segments contained in the mesh object.	Mesh
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	Mesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	transitionValue : Number	Mesh
(^)	type : String = "mesh" String defining the type of class used to generate the mesh.	Mesh
(^)	url : String String defining the source of the mesh.	Mesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object.	Mesh
(^)	visible : Boolean Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number 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
(^)	addBillboard(billboard:Billboard):void Adds a billboard object to the mesh object.	Mesh
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	Mesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
(^)	addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
(^)	addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a sequenceDone event listener	Mesh
(^)	addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	addSegment(segment:Segment):void Adds a segment object to the mesh object.	Mesh
(^)	applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the geometry without altering the appearance of the mesh	Mesh
(^)	applyRotations():void Apply the local rotations to the geometry without altering the appearance of the mesh	Mesh
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
	buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive.	AbstractPrimitive
(^)	clone(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object	Mesh
(^)	cloneAll(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object, including geometry	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	Mesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	Mesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void 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 local point around which the object rotates.	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	Mesh
(^)	playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void Plays a sequence of frames.	Mesh
(^)	quarterFace(face:Face):void Divides a face object into 4 equal sized face objects.	Mesh
(^)	quarterFaces():void Divides all faces objects of a Mesh into 4 equal sized face objects.	Mesh
(^)	removeBillboard(billboard:Billboard):void Removes a billboard object from the mesh object.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	Mesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
(^)	removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
(^)	removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a sequenceDone event listener	Mesh
(^)	removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	removeSegment(segment:Segment):void Removes a segment object from the mesh object.	Mesh
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	Mesh
(^)	splitFace(face:Face, side:int = 0):void Divides a face object into 2 face objects.	Mesh
(^)	splitFaces(side:int = 0):void Divides all faces objects of a Mesh into 2 face objects.	Mesh
(^)	tick(time:int):void 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
(^)	triFace(face:Face):void Divides a face object into 3 face objects.	Mesh
(^)	triFaces():void Divides all faces objects of a Mesh into 3 face objects.	Mesh
(^)	updateMaterials(source:Object3D, view:View3D):void Updates the materials in the mesh object	Mesh
	updateObject():void	AbstractPrimitive
(^)	updateSession():void	Object3D
(^)	updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void update vertex information.	Mesh
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	getDefaultMaterial():IMaterial	Mesh
(^)	updateDimensions():void	Mesh
(^)	updateTransform():void	Object3D

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when a single animation in a sequence completes.	Mesh
(^)	dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
(^)	rollOver	Dispatched when a user rolls over the 3d object.	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 a sequence of animations completes.	Mesh
(^)	sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
(^)	sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
(^)	transformChanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

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.

updateObject

()

method

public override function updateObject():void

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
Inheritance	AbstractRenderSession -> flash.events.EventDispatcher
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
		alpha : Number = 1 Placeholder for alpha property of containers	AbstractRenderSession
		blendMode : String Placeholder for blendMode property of containers	AbstractRenderSession
		children : Dictionary Dictionary of child displayobjects.	AbstractRenderSession
		consumer : IPrimitiveConsumer	AbstractRenderSession
		filters : Array Placeholder for filters property of containers	AbstractRenderSession
		graphics : Graphics Reference to the current graphics object being used for drawing.	AbstractRenderSession
		newLayer : Sprite Holds the last added layer sprite.	AbstractRenderSession
		parent : AbstractRenderSession	AbstractRenderSession
		priconsumers : Dictionary	AbstractRenderSession
		primitives : Array	AbstractRenderSession
		renderer : IPrimitiveConsumer	AbstractRenderSession
		sessions : Array Array of child sessions.	AbstractRenderSession
		spriteLayers : Array Dictionary of sprite layers for rendering composite materials.	AbstractRenderSession
		updated : Boolean	AbstractRenderSession

Public Methods

	Method		Defined by
		addChildSession(session:AbstractRenderSession):void Adds a session as a child of the session object.	AbstractRenderSession
		addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list.	AbstractRenderSession
		addLayerObject(child:Sprite):void Adds a layer sprite to the render session display list.	AbstractRenderSession
		addOnSessionUpdate(listener:Function):void Default method for adding a sessionUpdated event listener	AbstractRenderSession
		clear(view:View3D):void Clears the render session.	AbstractRenderSession
		clearChildSessions():void	AbstractRenderSession
		clearRenderers():void	AbstractRenderSession
		clone():AbstractRenderSession Duplicates the render session's properties to another render session.	AbstractRenderSession
		getConsumer(view:View3D):IPrimitiveConsumer	AbstractRenderSession
		getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view.	AbstractRenderSession
		getTotalFaces(view:View3D):int	AbstractRenderSession
		removeChildSession(session:AbstractRenderSession):void Removes a child session of the session object.	AbstractRenderSession
		removeOnSessionUpdate(listener:Function):void Default method for removing a sessionUpdated event listener	AbstractRenderSession
		render(view:View3D):void	AbstractRenderSession
		renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void Draws a billboard element with a fill bitmap into the graphics object.	AbstractRenderSession
		renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void Draws a billboard element with a fill color into the graphics object.	AbstractRenderSession
		renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void Draws a non-scaled bitmap into the graphics object.	AbstractRenderSession
		renderFogColor(clip:Clipping, color:int, alpha:Number):void Draws a fog element into the graphics object.	AbstractRenderSession
		renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object.	AbstractRenderSession
		renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void Draws a bitmap with a precalculated matrix into the graphics object.	AbstractRenderSession
		renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object.	AbstractRenderSession
		renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, layerGraphics:Graphics = null):void Draws a triangle element with a fill color into the graphics object.	AbstractRenderSession
		renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element into the graphics object.	AbstractRenderSession
		renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element with a fill color into the graphics object.	AbstractRenderSession

Protected Methods

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

Events

	Event		Summary	Defined by
		sessionUpdated	Dispatched when the render contents of the session require updating.	AbstractRenderSession

Property detail

alpha

property

public var alpha:Number = 1

Placeholder for alpha property of containers

blendMode

property

public var blendMode:String

Placeholder for blendMode property of containers

children

property

public var children:Dictionary

Dictionary of child displayobjects.

consumer

property

public var consumer:IPrimitiveConsumer

_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

filters

property

public var filters:Array

Placeholder for filters property of containers

graphics

property

public var graphics:Graphics

Reference to the current graphics object being used for drawing.

newLayer

property

public var newLayer:Sprite

Holds the last added layer sprite.

parent

property

public var parent:AbstractRenderSession

priconsumers

property

public var priconsumers:Dictionary

primitives

property

public var primitives:Array

renderer

property

renderer:IPrimitiveConsumer  [read-write]
Implementation
    public function get renderer():IPrimitiveConsumer
    public function set renderer(value:IPrimitiveConsumer):void

sessions

property

public var sessions:Array

Array of child sessions.

spriteLayers

property

public var spriteLayers:Array

Dictionary of sprite layers for rendering composite materials.

updated

property

public var updated:Boolean

Method detail

addChildSession

()

method

public function addChildSession(session:AbstractRenderSession):void

Adds a session as a child of the session object.

Parameters

session:AbstractRenderSession — The session object to be added as a child.

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.

addOnSessionUpdate

()

method

public function addOnSessionUpdate(listener:Function):void

Default method for adding a sessionUpdated event listener

Parameters

listener:Function — The listener function

clear

()

method

public function clear(view:View3D):void

Clears the render session.

Parameters

view:View3D

clearChildSessions

()

method

public function clearChildSessions():void

clearRenderers

()

method

public function clearRenderers():void

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.

getConsumer

()

method

public function getConsumer(view:View3D):IPrimitiveConsumer
Parameters

view:View3D

Returns

IPrimitiveConsumer

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.

getTotalFaces

()

method

public function getTotalFaces(view:View3D):int
Parameters

view:View3D

Returns

int

onSessionUpdate

()

method

protected function onSessionUpdate(event:SessionEvent):void
Parameters

event:SessionEvent

removeChildSession

()

method

public function removeChildSession(session:AbstractRenderSession):void

Removes a child session of the session object.

Parameters

session:AbstractRenderSession — The session object to be removed.

removeOnSessionUpdate

()

method

public function removeOnSessionUpdate(listener:Function):void

Default method for removing a sessionUpdated event listener

Parameters

listener:Function — The listener function

render

()

method

public function render(view:View3D):void
Parameters

view:View3D

renderBillboardBitmap

()

method

public function renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void

Draws a billboard element with a fill bitmap into the graphics object.

Parameters

	`bitmap:BitmapData`

	`primitive:DrawBillboard`

	`smooth:Boolean`

renderBillboardColor

()

method

public function renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void

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

Parameters

	`color:int`

	`alpha:Number`

	`primitive:DrawBillboard`

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(clip:Clipping, color:int, alpha:Number):void

Draws a fog element into the graphics object.

Parameters

	`clip:Clipping`

	`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, layerGraphics:Graphics = null):void

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

Parameters

	`color:int`

	`alpha:Number`

	`v0:ScreenVertex`

	`v1:ScreenVertex`

	`v2:ScreenVertex`

	`layerGraphics:Graphics` (default = `null`)

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`

Event detail

sessionUpdated

event

Event object type: away3d.events.SessionEvent

Dispatched when the render contents of the session require updating.

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
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
		addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	AbstractShader
		getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO	AbstractShader
		removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	AbstractShader
		renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face.	AbstractShader
		renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	AbstractShader
		updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	AbstractShader

Protected Methods

	Method		Defined by
		getLightingShape(layer:Sprite, light:LightPrimitive):Shape Returns a shape object for use by light shaders	AbstractShader
		getShape(layer:Sprite):Shape Returns a shape object for use by environment shaders.	AbstractShader
		renderShader(tri:DrawTriangle):void Renders the shader to the specified face.	AbstractShader

Property detail

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

addOnMaterialUpdate

()

method

public function addOnMaterialUpdate(listener:Function):void

Default method for adding a materialupdated event listener

Parameters

listener:Function — The listener function

getFaceMaterialVO

()

method

public function getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
Parameters

	`faceVO:FaceVO`

	`source:Object3D` (default = `null`)

	`view:View3D` (default = `null`)

Returns

FaceMaterialVO

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

removeOnMaterialUpdate

()

method

public function removeOnMaterialUpdate(listener:Function):void

Default method for removing a materialupdated event listener

Parameters

listener:Function — The listener function

renderBitmapLayer

()

method

public function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO

Renders a bitmapData surface object for the speficied face.

Parameters

	`tri:DrawTriangle` — The face object onto which the rendered sufrace is applied.

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

	`parentFaceMaterialVO:FaceMaterialVO` — The value object of the preceeding surface.

Returns

FaceMaterialVO

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(tri:DrawTriangle):void

Renders the shader to the specified face.

Parameters

tri:DrawTriangle — 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 -> Mesh -> Object3D -> flash.events.EventDispatcher
Subclasses	GridPlane, WireCircle, WireCone, WireCube, WireCylinder, WirePlane, WireSphere, WireTorus

Abstract base class for wire primitives

Public Properties

Property		Defined by
(^)	activePrefix : String return the prefix of the animation actually started.	Mesh
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	billboardMaterial : IBillboardMaterial	Mesh
(^)	billboards : Array Returns an array of the billboards contained in the mesh object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
(^)	center : Vertex	Object3D
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
(^)	debugBoundingBox : WireCube	Object3D
(^)	debugBoundingSphere : WireSphere	Object3D
(^)	debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
(^)	elements : Array Returns an array of all elements contained in the mesh object.	Mesh
(^)	eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faceMaterial : ITriangleMaterial	Mesh
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	Mesh
(^)	frame : int Indicates the current frame of animation	Mesh
(^)	geometry : Geometry Defines the geometry object used for the mesh.	Mesh
(^)	geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	Mesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	Mesh
(^)	indexes : Array Placeholder for md2 frame indexes	Mesh
(^)	inverseSceneTransform : Matrix3D Returns the inverse of sceneTransform.	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	Mesh
(^)	lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
(^)	loop : Boolean Determines whether the animation will loop.	Mesh
(^)	material : IMaterial Defines the material used to render the faces, segments or billboards in the geometry object.	Mesh
(^)	materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
(^)	objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
(^)	objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
(^)	ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
(^)	pivotZero : Boolean	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projectorType : String	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
(^)	renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	Object3D
(^)	rotationX : Number 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
(^)	scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
(^)	scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
(^)	scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePivotPoint : Number3D	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	segmentMaterial : ISegmentMaterial	Mesh
(^)	segments : Array Returns an array of the segments contained in the mesh object.	Mesh
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	Mesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	transitionValue : Number	Mesh
(^)	type : String = "mesh" String defining the type of class used to generate the mesh.	Mesh
(^)	url : String String defining the source of the mesh.	Mesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object.	Mesh
(^)	visible : Boolean Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number 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
(^)	addBillboard(billboard:Billboard):void Adds a billboard object to the mesh object.	Mesh
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	Mesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
(^)	addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
(^)	addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a sequenceDone event listener	Mesh
(^)	addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	addSegment(segment:Segment):void Adds a segment object to the mesh object.	Mesh
(^)	applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the geometry without altering the appearance of the mesh	Mesh
(^)	applyRotations():void Apply the local rotations to the geometry without altering the appearance of the mesh	Mesh
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
	buildPrimitive():void Builds the vertex, face and uv objects that make up the 3d primitive.	AbstractWirePrimitive
(^)	clone(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object	Mesh
(^)	cloneAll(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object, including geometry	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	Mesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	Mesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void 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 local point around which the object rotates.	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	Mesh
(^)	playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void Plays a sequence of frames.	Mesh
(^)	quarterFace(face:Face):void Divides a face object into 4 equal sized face objects.	Mesh
(^)	quarterFaces():void Divides all faces objects of a Mesh into 4 equal sized face objects.	Mesh
(^)	removeBillboard(billboard:Billboard):void Removes a billboard object from the mesh object.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	Mesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
(^)	removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
(^)	removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a sequenceDone event listener	Mesh
(^)	removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	removeSegment(segment:Segment):void Removes a segment object from the mesh object.	Mesh
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	Mesh
(^)	splitFace(face:Face, side:int = 0):void Divides a face object into 2 face objects.	Mesh
(^)	splitFaces(side:int = 0):void Divides all faces objects of a Mesh into 2 face objects.	Mesh
(^)	tick(time:int):void 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
(^)	triFace(face:Face):void Divides a face object into 3 face objects.	Mesh
(^)	triFaces():void Divides all faces objects of a Mesh into 3 face objects.	Mesh
(^)	updateMaterials(source:Object3D, view:View3D):void Updates the materials in the mesh object	Mesh
	updateObject():void	AbstractWirePrimitive
(^)	updateSession():void	Object3D
(^)	updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void update vertex information.	Mesh
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
	getDefaultMaterial():IMaterial	AbstractWirePrimitive
(^)	updateDimensions():void	Mesh
(^)	updateTransform():void	Object3D

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when a single animation in a sequence completes.	Mesh
(^)	dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
(^)	rollOver	Dispatched when a user rolls over the 3d object.	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 a sequence of animations completes.	Mesh
(^)	sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
(^)	sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
(^)	transformChanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

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.

getDefaultMaterial

()

method

protected override function getDefaultMaterial():IMaterial
Returns

IMaterial

updateObject

()

method

public override function updateObject():void

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

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
(^)	animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
(^)	center : Vertex	Object3D
	color : int Defines the color of the light object.	AmbientLight3D
	debug : Boolean Toggles debug mode: light object is visualised in the scene.	AmbientLight3D
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
(^)	debugBoundingBox : WireCube	Object3D
(^)	debugBoundingSphere : WireSphere	Object3D
(^)	debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
	debugPrimitive : Object3D [read-only]	AmbientLight3D
(^)	eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
(^)	inverseSceneTransform : Matrix3D Returns the inverse of sceneTransform.	Object3D
(^)	lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
(^)	materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
(^)	objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
(^)	objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
(^)	ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
(^)	ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
(^)	pivotZero : Boolean	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projectorType : String	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
(^)	renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	Object3D
(^)	rotationX : Number 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
(^)	scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
(^)	scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
(^)	scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePivotPoint : Number3D	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	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
(^)	visible : Boolean 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
(^)	addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
(^)	addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
(^)	addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the object without altering the apperance of child objects	Object3D
(^)	applyRotations():void Apply the local rotations to the object without altering the apperance of child objects	Object3D
	clone(object:Object3D = null):Object3D 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
(^)	movePivot(dx:Number, dy:Number, dz:Number):void Moves the local point around which the object rotates.	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
(^)	removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
(^)	removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
(^)	tick(time:int):void 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
(^)	updateObject():void	Object3D
(^)	updateSession():void	Object3D
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

	Method		Defined by
	(^)	updateDimensions():void	Object3D
	(^)	updateTransform():void	Object3D

Events

Event		Summary	Defined by
(^)	dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
(^)	rollOver	Dispatched when a user rolls over the 3d object.	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
(^)	sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
(^)	sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	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

debug:Boolean [read-write]

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

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

debugPrimitive

property

debugPrimitive:Object3D [read-only]
Implementation
public function get debugPrimitive():Object3D

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:Object3D = null):Object3D

Duplicates the light object's properties to another AmbientLight3D object

Parameters

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

Returns

Object3D — The new object instance with duplicated properties applied

light

()

method

public function light(consumer:ILightConsumer):void

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

Parameters

consumer:ILightConsumer

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
(^)	addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	AbstractShader
(^)	getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO	AbstractShader
(^)	removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	AbstractShader
(^)	renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face.	AbstractShader
	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	AmbientShader
	updateMaterial(source:Object3D, view:View3D):void Called once per render loop when material is visible.	AmbientShader

Protected Methods

Method		Defined by
	clearFaces(source:Object3D, view:View3D):void	AmbientShader
(^)	getLightingShape(layer:Sprite, light:LightPrimitive):Shape Returns a shape object for use by light shaders	AbstractShader
(^)	getShape(layer:Sprite):Shape Returns a shape object for use by environment shaders.	AbstractShader
	renderShader(tri:DrawTriangle):void Renders the shader to the specified face.	AmbientShader

Property detail

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

clearFaces

()

method

protected function clearFaces(source:Object3D, view:View3D):void
Parameters

	`source:Object3D`

	`view:View3D`

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(tri:DrawTriangle):void

Renders the shader to the specified face.

Parameters

tri:DrawTriangle — 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
(^)	colorTransform : ColorTransform Defines a colortransform for the texture bitmap.	BitmapMaterial
(^)	debug : Boolean Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
(^)	globalProjection : Boolean Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.	TransformBitmapMaterial
(^)	height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
	index : int returns the frame index of the animation.	AnimatedBitmapMaterial
	loop : Boolean Indicates whether the animation will loop.	AnimatedBitmapMaterial
(^)	offsetX : Number Offsets the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	offsetY : Number Offsets the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
(^)	projectionVector : Number3D Projects the texture in object space, ignoring the uv coordinates of the vertex objects.	TransformBitmapMaterial
(^)	repeat : Boolean Determines if texture bitmap will tile in uv-space	BitmapMaterial
(^)	rotation : Number Rotates the texture in uv-space	TransformBitmapMaterial
(^)	scaleX : Number Scales the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	scaleY : Number Scales the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	showNormals : Boolean Displays the normals per face in pink lines.	BitmapMaterial
(^)	smooth : Boolean Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
(^)	throughProjection : Boolean Determines whether a projected texture is visble on the faces pointing away from the projection.	TransformBitmapMaterial
(^)	transform : Matrix Transforms the texture in uv-space	TransformBitmapMaterial
(^)	visible : Boolean Indicates whether the material is visible	BitmapMaterial
(^)	width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

Method		Defined by
	AnimatedBitmapMaterial (movie:MovieClip, init:Object = null) Creates a new `AnimatedBitmapMaterial` object.	AnimatedBitmapMaterial
(^)	addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	BitmapMaterial
	clear():void Manually clears all frames of the animation.	AnimatedBitmapMaterial
(^)	clearFaces(source:Object3D = null, view:View3D = null):void Clears facematerial value objects when bitmap requires updating	BitmapMaterial
(^)	getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO	BitmapMaterial
(^)	getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	TransformBitmapMaterial
(^)	invalidateFaces(source:Object3D = null, view:View3D = null):void Invalidates facematerial value objects when texturemapping requires updating	BitmapMaterial
	play():void Resumes playback of the animation	AnimatedBitmapMaterial
(^)	removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	BitmapMaterial
(^)	renderBillboard(bill:DrawBillboard):void Sends data from the material coupled with data from the `DrawBillboard` primitive to the render session.	BitmapMaterial
(^)	renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face.	TransformBitmapMaterial
(^)	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
(^)	renderTriangle(tri:DrawTriangle):void 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
(^)	updateColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
(^)	updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterial

Property 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 [read-write]

returns the frame index of the animation.

Implementation
public function get index():int
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

clear

()

method

public function clear():void

Manually clears all frames of the animation. a new series of bitmapdatas will be required using the setFrames handler.

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
		geometry : Geometry The geometry on which the animation is occurring.	Animation
		isRunning : Boolean [read-only] Indicates whether the animation is currently running.	Animation
		latest : uint [read-only] Returns the number of the latest frame displayed.	Animation
		loop : Boolean = false Determines whether the animation will loop.	Animation
		mesh : Mesh The mesh on which the animation is occurring.	Animation
		sequence : Array Holds an array of animation frames.	Animation
		sequenceEvent : Boolean = false Determines whether the animation will fire sequence events.	Animation
		smooth : Boolean = false Determines whether the animation will smooth motion (interpolate) between frames.	Animation
		transitionValue : Number	Animation

Public Methods

	Method		Defined by
		Animation (geo:Geometry) Creates a new `Animation` object.	Animation
		createTransition():void Creates a new AnimationTransition object.	Animation
		interpolate():void Smooth interpolations between new AnimationSequence objects	Animation
		start():void Jumps to the beginning of the animation and start playing	Animation
		stop():void Stops the animation at it's current position.	Animation
		update():void Updates the positions of vertex objects in the geometry to the current frame values	Animation

Events

	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.

geometry

property

public var geometry:Geometry

The geometry on which the animation is occurring.

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.

mesh

property

public var mesh:Mesh

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.

transitionValue

property

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

Constructor detail

Animation

()

constructor

public function Animation(geo:Geometry)
Parameters

geo:Geometry — The geometry object that the animation acts on.

Method detail

createTransition

()

method

public function createTransition():void

Creates a new AnimationTransition object.

interpolate

()

method

public function interpolate():void

Smooth interpolations between new AnimationSequence objects

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():void

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

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

Orge 3d Animation based on V2.1

//------------------------------------------------------------------
import flash.display.*;
import flash.events.*;
import flash.geom.*;

import away3d.loaders.*;
import away3d.core.math.*;
import away3d.core.render.*;

import away3d.cameras.*;
import away3d.core.utils.*;
import away3d.core.base.*;
import away3d.containers.*;
import away3d.primitives.*;
import away3d.cameras.*;
import away3d.materials.*;
import away3d.materials.shaders.*;
//
import away3d.core.base.AnimationSequence;
//
var view:View3D = new View3D({x:300, y:200});
addChild(view);
var loaderMesh;
var loader = Md2.load("ogre.md2",{material:"dragon_tex", name:"ogre", scaling:0.05, y:0, x:10, z:10, loadersize:300});
view.scene.addChild(loader);
loader.addOnSuccess(onLoaderSuccess);
var fps = 6
//run, stand. attack, salute_alt
function onLoaderSuccess(event:Event):void
{
loaderMesh = (loader.handle as Mesh);

loaderMesh.play(new AnimationSequence("fly", true, true, fps));

//loader.handle.play({prefix:"run", smooth:true, loop:true, fps:12});
//(loader.handle as Mesh).play({prefix:"run", smooth:true, loop:true, fps:12});
//loaderMesh.play({prefix:"run", smooth:true, loop:true, fps:12});
//loader.children[0].play({prefix:"run", smooth:true, loop:true, fps:12});
//(loader.result as Mesh).play({prefix:"run", loop:true, smooth:true, fps:12});
addEventListener(Event.ENTER_FRAME, onEnterFrame);
}
stop_bt.addEventListener(MouseEvent.CLICK, onStop);
stepforward_bt.addEventListener(MouseEvent.CLICK, onStepForward);
plyPause_bt.addEventListener(MouseEvent.CLICK, onPlyPause);
run_bt.addEventListener(MouseEvent.CLICK, onRun);
stand_bt.addEventListener(MouseEvent.CLICK, onStand);
attack_bt.addEventListener(MouseEvent.CLICK, onAttack);
crab_bt.addEventListener(MouseEvent.CLICK, onCrab);
salute_bt.addEventListener(MouseEvent.CLICK, onSalute);
//
//loaderMesh.gotoAndPlay(4);
//
function onStop (event:Event) {
//loaderMesh.play(new AnimationSequence("", true, true, fps));
loaderMesh.gotoAndStop(1);

}
function onPlyPause (event:Event) {
//loaderMesh.play(new AnimationSequence("", true, true, fps));
loaderMesh.gotoAndPlay(loaderMesh.frame);

}
function onStepForward (event:Event) {
//loaderMesh.play(new AnimationSequence("", true, true, fps));
var num = loaderMesh.frame
num++;
trace(num)
loaderMesh.gotoAndStop(num);

}
function onRun (event:Event) {
loaderMesh.play(new AnimationSequence("run", true, true, fps));

}
function onStand (event:Event) {
//loaderMesh.gotoAndStop(4);
loaderMesh.play(new AnimationSequence("stand", true, true, fps));

}
function onAttack (event:Event) {
loaderMesh.play(new AnimationSequence("attack", true, true, fps));

}
function onSalute (event:Event) {
//loaderMesh.gotoAndStop(4);
loaderMesh.play(new AnimationSequence("salute_alt", true, true, fps));

}
function onCrab (event:Event) {
loaderMesh.play(new AnimationSequence("cwalk", true, true, fps));

}
function onEnterFrame(event:Event):void
{
view.scene.updateTime();
view.render();
}

AnimationData

Package	away3d.loaders.data
Class	public class AnimationData

Data class for the animation of a mesh.

See also

away3d.loaders.data.MeshData

Public Properties

	Property		Defined by
		animation : IMeshAnimation Reference to the animation object of the resulting animation.	AnimationData
		animationType : String = "skinAnimation" String representing the animation type.	AnimationData
		channels : Dictionary Dictonary of names representing the animation channels used in the animation.	AnimationData
		end : Number = 0 Reference to the number of seconds the animation ends.	AnimationData
		name : String The name of the animation used as a unique reference.	AnimationData
		start : Number = Infinity Reference to the time the animation starts.	AnimationData

Public Methods

	Method		Defined by
		clone(object:Object3D):AnimationData	AnimationData

Public Constants

	Constant		Defined by
		SKIN_ANIMATION : String = "skinAnimation" [static] String representing a skin animation.	AnimationData
		VERTEX_ANIMATION : String = "vertexAnimation" [static] String representing a vertex animation.	AnimationData

Property detail

animation

property

public var animation:IMeshAnimation

Reference to the animation object of the resulting animation.

animationType

property

public var animationType:String = "skinAnimation"

String representing the animation type.

channels

property

public var channels:Dictionary

Dictonary of names representing the animation channels used in the animation.

end

property

public var end:Number = 0

Reference to the number of seconds the animation ends.

name

property

public var name:String

The name of the animation used as a unique reference.

start

property

public var start:Number = Infinity

Reference to the time the animation starts.

Method detail

clone

()

method

public function clone(object:Object3D):AnimationData
Parameters

object:Object3D

Returns

AnimationData

Constant detail

SKIN_ANIMATION

constant

public static const SKIN_ANIMATION:String = "skinAnimation"

String representing a skin animation.

VERTEX_ANIMATION

constant

public static const VERTEX_ANIMATION:String = "vertexAnimation"

String representing a vertex animation.

Wiki link

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

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
		SEQUENCE_DONE : String = "sequenceDone" [static] Defines the value of the type property of a sequenceDone event object.	AnimationEvent
		SEQUENCE_UPDATE : String = "sequenceUpdate" [static] Defines the value of the type property of a sequenceUpdate event object.	AnimationEvent

Property detail

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.SEQUENCE_UPDATE` and `AnimationEvent.SEQUENCE_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.

SEQUENCE_DONE

constant

public static const SEQUENCE_DONE:String = "sequenceDone"

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

SEQUENCE_UPDATE

constant

public static const SEQUENCE_UPDATE:String = "sequenceUpdate"

Defines the value of the type property of a sequenceUpdate 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.animators.data
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.animators.data.AnimationFrame'

Code examples

There are currently no examples for this class

AnimationGroup

Package	away3d.animators.data
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.animators.data.AnimationGroup'

Code examples

There are currently no examples for this class

AnimationLibrary

Package	away3d.loaders.utils
Class	public dynamic class AnimationLibrary
Inheritance	AnimationLibrary -> flash.utils.Dictionary

Store for all animations associated with an externally loaded file.

Public Methods

	Method		Defined by
		addAnimation(name:String):AnimationData Adds an animation name reference to the library.	AnimationLibrary
		getAnimation(name:String):AnimationData Returns an animation data object for the given name reference in the library.	AnimationLibrary

Method detail

addAnimation

()

method

public function addAnimation(name:String):AnimationData

Adds an animation name reference to the library.

Parameters

name:String

Returns

AnimationData

getAnimation

()

method

public function getAnimation(name:String):AnimationData

Returns an animation data object for the given name reference in the library.

Parameters

name:String

Returns

AnimationData

Wiki link

Click to go to the wiki page for 'away3d.loaders.utils.AnimationLibrary'

Code examples

There are currently no examples for this class

AnimationSequence

Package	away3d.animators.data
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 = true, loop:Boolean = false, fps:Number = 3) 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 = true, loop:Boolean = false, fps:Number = 3)
Parameters

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

	`smooth:Boolean` (default = `true`) — [optional] Determines if the animation should be smoothed (interpolated) between frames. Default = true;

	`loop:Boolean` (default = `false`) — [optional] Determines whether the animation sequence should loop. Default = false;

	`fps:Number` (default = `3`) — [optional] Determines the speed of playback in keyframes of per second. Default = 3;

Wiki link

Click to go to the wiki page for 'away3d.animators.data.AnimationSequence'

Code examples

There are currently no examples for this class

AnimationTransition

Package	away3d.core.base
Class	public class AnimationTransition

Holds information about the current state of animation to transition into another animation.

Public Properties

	Property		Defined by
		interpolate : Number [read-only]	AnimationTransition
		transitionValue : Number	AnimationTransition

Public Methods

	Method		Defined by
		AnimationTransition (geo:Geometry)	AnimationTransition
		reset():void	AnimationTransition
		update():void	AnimationTransition

Property detail

interpolate

property

interpolate:Number [read-only]
Implementation
public function get interpolate():Number

transitionValue

property

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

Constructor detail

AnimationTransition

()

constructor

public function AnimationTransition(geo:Geometry)
Parameters

geo:Geometry

Method detail

reset

()

method

public function reset():void

update

()

method

public function update():void

Wiki link

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

Code examples

There are currently no examples for this class

Animator

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

Public Properties

Property		Defined by
(^)	activePrefix : String return the prefix of the animation actually started.	Mesh
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	billboardMaterial : IBillboardMaterial	Mesh
(^)	billboards : Array Returns an array of the billboards contained in the mesh object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
(^)	center : Vertex	Object3D
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
(^)	debugBoundingBox : WireCube	Object3D
(^)	debugBoundingSphere : WireSphere	Object3D
(^)	debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
(^)	elements : Array Returns an array of all elements contained in the mesh object.	Mesh
(^)	eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faceMaterial : ITriangleMaterial	Mesh
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	Mesh
(^)	frame : int Indicates the current frame of animation	Mesh
	framelist : Array [read-only]	Animator
(^)	geometry : Geometry Defines the geometry object used for the mesh.	Mesh
(^)	geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	Mesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	Mesh
(^)	indexes : Array Placeholder for md2 frame indexes	Mesh
(^)	inverseSceneTransform : Matrix3D Returns the inverse of sceneTransform.	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	Mesh
(^)	lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
(^)	loop : Boolean Determines whether the animation will loop.	Mesh
(^)	material : IMaterial Defines the material used to render the faces, segments or billboards in the geometry object.	Mesh
(^)	materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
(^)	objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
(^)	objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
(^)	ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
(^)	pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
(^)	pivotZero : Boolean	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projectorType : String	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
(^)	renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	Object3D
(^)	rotationX : Number 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
(^)	scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
(^)	scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
(^)	scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePivotPoint : Number3D	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	segmentMaterial : ISegmentMaterial	Mesh
(^)	segments : Array Returns an array of the segments contained in the mesh object.	Mesh
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	Mesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	transitionValue : Number	Mesh
(^)	type : String = "mesh" String defining the type of class used to generate the mesh.	Mesh
(^)	url : String String defining the source of the mesh.	Mesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object.	Mesh
(^)	visible : Boolean Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number 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) Creates a new `Animator` object.	Animator
(^)	addBillboard(billboard:Billboard):void Adds a billboard object to the mesh object.	Mesh
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
	addFrames(aFrames:Array):void Add new frames to the object at runtime	Animator
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	Mesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
(^)	addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
(^)	addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a sequenceDone event listener	Mesh
(^)	addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	addSegment(segment:Segment):void Adds a segment object to the mesh object.	Mesh
(^)	applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the geometry without altering the appearance of the mesh	Mesh
(^)	applyRotations():void Apply the local rotations to the geometry without altering the appearance of the mesh	Mesh
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
(^)	clone(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object	Mesh
(^)	cloneAll(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object, including geometry	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
	generate(baseObject:Mesh, aFrames:Array, doloop:Boolean):void	Animator
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	Mesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	Mesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void 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 local point around which the object rotates.	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	Mesh
(^)	playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void Plays a sequence of frames.	Mesh
(^)	quarterFace(face:Face):void Divides a face object into 4 equal sized face objects.	Mesh
(^)	quarterFaces():void Divides all faces objects of a Mesh into 4 equal sized face objects.	Mesh
(^)	removeBillboard(billboard:Billboard):void Removes a billboard object from the mesh object.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	Mesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
(^)	removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
(^)	removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a sequenceDone event listener	Mesh
(^)	removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	removeSegment(segment:Segment):void Removes a segment object from the mesh object.	Mesh
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
	scaleAnimation(scale:Number):void Scales the vertex positions contained within all animation frames	Animator
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	Mesh
(^)	splitFace(face:Face, side:int = 0):void Divides a face object into 2 face objects.	Mesh
(^)	splitFaces(side:int = 0):void Divides all faces objects of a Mesh into 2 face objects.	Mesh
(^)	tick(time:int):void 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
(^)	triFace(face:Face):void Divides a face object into 3 face objects.	Mesh
(^)	triFaces():void Divides all faces objects of a Mesh into 3 face objects.	Mesh
(^)	updateMaterials(source:Object3D, view:View3D):void Updates the materials in the mesh object	Mesh
(^)	updateObject():void	Object3D
(^)	updateSession():void	Object3D
(^)	updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void update vertex information.	Mesh
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	getDefaultMaterial():IMaterial	Mesh
(^)	updateDimensions():void	Mesh
(^)	updateTransform():void	Object3D

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when a single animation in a sequence completes.	Mesh
(^)	dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
(^)	rollOver	Dispatched when a user rolls over the 3d object.	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 a sequence of animations completes.	Mesh
(^)	sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
(^)	sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
(^)	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` — The Mesh to be used as reference

	`aFrames:Array` — [optional] An initialisation object for specifying default instance properties.

	`init:Object` (default = `null`) — [optional] If the geometry needs to be shown in a loop

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

Method detail

addFrames

()

method

public function addFrames(aFrames:Array):void

Add new frames to the object at runtime

Parameters

aFrames:Array

generate

()

method

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

	`baseObject:Mesh`

	`aFrames:Array`

	`doloop:Boolean`

scaleAnimation

()

method

public function scaleAnimation(scale:Number):void

Scales the vertex positions contained within all animation frames

Parameters

scale:Number — The scaling value

Wiki link

Click to go to the wiki page for 'away3d.animators.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(tree:QuadrantRenderer, scene:Scene3D, camera:Camera3D, clip:Clipping):void Applies the filter to the quadrant tree.	AnotherRivalFilter
		toString():String Used to trace the values of a filter.	AnotherRivalFilter

Constructor detail

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(tree:QuadrantRenderer, scene:Scene3D, camera:Camera3D, clip:Clipping):void

Applies the filter to the quadrant tree.

Parameters

	`tree:QuadrantRenderer` — The quadrant tree to be filtered.

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

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

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

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

AS3Exporter

Package	away3d.exporters
Class	public class AS3Exporter

Public Methods

	Method		Defined by
		AS3Exporter (object3d:Object3D, classname:String, packagename:String = "") Generates a string in the Actionscript3 format representing the object3D(s).	AS3Exporter

Constructor detail

AS3Exporter

()

constructor

public function AS3Exporter(object3d:Object3D, classname:String, packagename:String = "")
Parameters

	`object3d:Object3D` — Object3D. The Object3D to be exported to the AS3 format.

	`classname:String` — Defines the class name used in the output string.

	`packagename:String` (default = "") — [optional] Defines the package name used in the output string. Defaults to no package. The generated class will require one parameter: a Scene3D object already instanciated, and optional an init object with property scaling. Default being 1. Example: var myClass:ClassName = new ClassName(this.view.scene, {scaling:.5}); To access the objects stored into the class: - ClassName.containers, a getter returns the ObjectContainers3D Array. - ClassName.meshes, a getter returns the Mesh Array. Example to access to change a material (ClassName.meshes[0] as Mesh).material = myNewMat;

Wiki link

Click to go to the wiki page for 'away3d.exporters.AS3Exporter'

Code examples

There are currently no examples for this class

Ase

Package	away3d.loaders
Class	public class Ase
Inheritance	Ase -> AbstractParser -> flash.events.EventDispatcher

File loader for the ASE file format.

Public Properties

Property		Defined by
(^)	container : Object3D 3d container object used for storing the parsed 3ds object.	AbstractParser
(^)	parsedChunks : int Returns the total number of data chunks parsed	AbstractParser
(^)	totalChunks : int Returns the total number of data chunks available	AbstractParser

Public Methods

Method		Defined by
	Ase (data:*, 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):Mesh [static] Creates a 3d mesh object from the raw ascii data of the ase file.	Ase
(^)	parseNext():void Processes the next chunk in the parser	AbstractParser

Constructor detail

Ase

()

constructor

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

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

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

Init Parameters

scaling:Number (default = 1)

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):Mesh

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

Parameters

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

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

Returns

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

Wiki link

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

Code examples

There are currently no examples for this class

AWTweener

Package	away3d.animators.utils
Class	public class AWTweener

Public Methods

	Method		Defined by
		AWTweener () AWTweener, a simplified tweening system to allow native tweens.	AWTweener
		calculate(fps:Number = 30, startval:Number = 0, endval:Number = 1, duration:Number = 250, easeIn:Boolean = false, easeOut:Boolean = false):Array [static] precalculates the numerical tween, returns steps as array	AWTweener

Constructor detail

AWTweener

()

constructor

public function AWTweener()

Method detail

calculate

()

method

public static function calculate(fps:Number = 30, startval:Number = 0, endval:Number = 1, duration:Number = 250, easeIn:Boolean = false, easeOut:Boolean = false):Array

precalculates the numerical tween, returns steps as array

Parameters

	`fps:Number` (default = `30`) — fps Number. Frame rate per second. Default = 30.

	`startval:Number` (default = `0`) — startval Number. Start value. Default = 0.

	`endval:Number` (default = `1`) — endval Number. End value. Default = 1.

	`duration:Number` (default = `250`) — duration Number. Duration in millisec. Default = 250.

	`easeIn:Boolean` (default = `false`) — easeIn Boolean. If the values are tweened with an ease in. Default = false.

	`easeOut:Boolean` (default = `false`) — easeOut Boolean. If the values are tweened with an ease out. Default = false.

Returns

Array — Array Returns an array contatining the tweened values

Wiki link

Click to go to the wiki page for 'away3d.animators.utils.AWTweener'

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 based on V1.9.2

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

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

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

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

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

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

addEventListener(Event.ENTER_FRAME, onEnterFrame);
}

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

}

}

From HelloAway3D.as

BasicRenderer

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

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
		filters : Array Defines the array of filters to be used on the drawing primitives.	BasicRenderer

Public Methods

	Method		Defined by
		BasicRenderer (... filters) Creates a new `BasicRenderer` object.	BasicRenderer
		clear(view:View3D):void	BasicRenderer
		clone():IPrimitiveConsumer	BasicRenderer
		list():Array A list of primitives that have been clipped and blocked.	BasicRenderer
		primitive(pri:DrawPrimitive):Boolean Adds a drawing primitive to the primitive consumer	BasicRenderer
		render(view:View3D):void	BasicRenderer
		toString():String Used to trace the values of a renderer.	BasicRenderer

Property detail

filters

property

filters:Array [read-write]

Defines the array of filters to be used on the drawing primitives.

Implementation
public function get filters():Array
public function set filters(value:Array):void

Constructor detail

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

clear

()

method

public function clear(view:View3D):void
Parameters

view:View3D

clone

()

method

public function clone():IPrimitiveConsumer
Returns

IPrimitiveConsumer

list

()

method

public function list():Array

A list of primitives that have been clipped and blocked.

Returns

Array — An array containing the primitives to be rendered.

primitive

()

method

public function primitive(pri:DrawPrimitive):Boolean

Adds a drawing primitive to the primitive consumer

Parameters

pri:DrawPrimitive — The drawing primitive to add.

Returns

Boolean — Whether the primitive was added.

render

()

method

public function render(view:View3D):void
Parameters

view:View3D

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

BezierPatch

Package	away3d.primitives
Class	public class BezierPatch
Inheritance	BezierPatch -> Mesh -> Object3D -> flash.events.EventDispatcher

BezierPatch primitive creates a smooth mesh based on a 4x4 vertex patch using a cubic bezier curve.

Public Properties

Property		Defined by
(^)	activePrefix : String return the prefix of the animation actually started.	Mesh
(^)	alpha : Number An optional alpha value that can be applied to the 3d object.	Object3D
(^)	animationLibrary : AnimationLibrary Reference container for all animations used in the container.	Object3D
(^)	back : ITriangleMaterial Defines a triangle material to be used for the backface of all faces in the 3d object.	Mesh
(^)	billboardMaterial : IBillboardMaterial	Mesh
(^)	billboards : Array Returns an array of the billboards contained in the mesh object.	Mesh
(^)	blendMode : String An optional blend mode that can be applied to the 3d object.	Object3D
(^)	bothsides : Boolean Indicates whether both the front and reverse sides of a face should be rendered.	Mesh
(^)	boundingRadius : Number Returns the bounding radius of the 3d object	Object3D
(^)	center : Vertex	Object3D
	connectMirrors : Number	BezierPatch
(^)	debugbb : Boolean Indicates whether a debug bounding box should be rendered around the 3d object.	Object3D
(^)	debugBoundingBox : WireCube	Object3D
(^)	debugBoundingSphere : WireSphere	Object3D
(^)	debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
(^)	elements : Array Returns an array of all elements contained in the mesh object.	Mesh
(^)	eulers : Number3D Defines the rotation of the 3d object as a `Number3D` object containing euler angles for rotation around x, y and z axis.	Object3D
(^)	extra : Object An optional untyped object that can contain used-defined properties	Object3D
(^)	faceMaterial : ITriangleMaterial	Mesh
(^)	faces : Array Returns an array of the faces contained in the mesh object.	Mesh
(^)	filters : Array An optional array of filters that can be applied to the 3d object.	Object3D
(^)	fps : int Determines the frames per second at which the animation will run.	Mesh
(^)	frame : int Indicates the current frame of animation	Mesh
(^)	geometry : Geometry Defines the geometry object used for the mesh.	Mesh
(^)	geometryLibrary : GeometryLibrary Reference container for all geometries used in the container.	Object3D
(^)	hasCycleEvent : Boolean Indicates whether the animation has a cycle event listener	Mesh
(^)	hasSequenceEvent : Boolean Indicates whether the animation has a sequencedone event listener	Mesh
(^)	indexes : Array Placeholder for md2 frame indexes	Mesh
(^)	inverseSceneTransform : Matrix3D Returns the inverse of sceneTransform.	Object3D
(^)	isRunning : Boolean Indicates whether the animation is currently running.	Mesh
(^)	lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
(^)	loop : Boolean Determines whether the animation will loop.	Mesh
(^)	material : IMaterial Defines the material used to render the faces, segments or billboards in the geometry object.	Mesh
(^)	materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
(^)	maxX : Number Returns the maximum x value of the 3d object	Object3D
(^)	maxY : Number Returns the maximum y value of the 3d object	Object3D
(^)	maxZ : Number Returns the maximum z value of the 3d object	Object3D
(^)	minX : Number Returns the minimum x value of the 3d object	Object3D
(^)	minY : Number Returns the minimum y value of the 3d object	Object3D
(^)	minZ : Number Returns the minimum z value of the 3d object	Object3D
(^)	mouseEnabled : Boolean = true Defines whether mouse events are received on the 3d object	Object3D
(^)	name : String An optional name string for the 3d object.	Object3D
(^)	objectDepth : Number Boundary depth of the 3d object return The depth of the mesh	Object3D
(^)	objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
(^)	objectWidth : Number Boundary width of the 3d object return The width of the object	Object3D
(^)	outline : ISegmentMaterial Defines a segment material to be used for outlining the 3d object.	Mesh
(^)	ownCanvas : Boolean Defines whether the contents of the 3d object are rendered using it's own render session	Object3D
(^)	ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
(^)	ownSession : AbstractRenderSession Defines a unique render session for the 3d object.	Object3D
(^)	parent : ObjectContainer3D Defines the parent of the 3d object.	Object3D
	patchData : PatchData	BezierPatch
(^)	pivotPoint : Number3D Defines the local point around which the object rotates.	Object3D
(^)	pivotZero : Boolean	Object3D
(^)	position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	projectorType : String	Object3D
(^)	pushback : Boolean Elements use their furthest point from the camera when z-sorting	Object3D
(^)	pushfront : Boolean Elements use their nearest point to the camera when z-sorting	Object3D
(^)	renderer : IPrimitiveConsumer An optional renderer object that can be used to render the contents of the object.	Object3D
	renderMode : Number	BezierPatch
(^)	rotationX : Number 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
(^)	scaleX : Number Defines the scale of the 3d object along the x-axis, relative to local coordinates.	Object3D
(^)	scaleY : Number Defines the scale of the 3d object along the y-axis, relative to local coordinates.	Object3D
(^)	scaleZ : Number Defines the scale of the 3d object along the z-axis, relative to local coordinates.	Object3D
(^)	scene : Scene3D Returns the parent scene of the 3d object	Object3D
(^)	scenePivotPoint : Number3D	Object3D
(^)	scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	sceneTransform : Matrix3D Returns the transformation of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
(^)	segmentMaterial : ISegmentMaterial	Mesh
(^)	segments : Array Returns an array of the segments contained in the mesh object.	Mesh
(^)	session : AbstractRenderSession The render session used by the 3d object	Object3D
(^)	smooth : Boolean Determines whether the animation will smooth motion (interpolate) between frames.	Mesh
(^)	transform : Matrix3D Defines the transformation of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
(^)	transitionValue : Number	Mesh
(^)	type : String = "mesh" String defining the type of class used to generate the mesh.	Mesh
(^)	url : String String defining the source of the mesh.	Mesh
(^)	useHandCursor : Boolean = false Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.	Object3D
(^)	vertices : Array Returns an array of the vertices contained in the mesh object.	Mesh
(^)	visible : Boolean Defines whether the 3d object is visible in the scene	Object3D
(^)	x : Number Defines the x coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
	xOffset : Number	BezierPatch
(^)	y : Number Defines the y coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
	yOffset : Number	BezierPatch
(^)	z : Number Defines the z coordinate of the 3d object relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
	zOffset : Number	BezierPatch

Protected Properties

Method		Defined by
	BezierPatch (patchDataPrm:PatchData, init:Object = null) Creates a new `BezierPatch` object.	BezierPatch
(^)	addBillboard(billboard:Billboard):void Adds a billboard object to the mesh object.	Mesh
(^)	addFace(face:Face):void Adds a face object to the mesh object.	Mesh
(^)	addOnCycle(listener:Function):void Default method for adding a cycle event listener	Mesh
(^)	addOnDimensionsChange(listener:Function):void Default method for adding a dimensionschanged event listener	Object3D
(^)	addOnMouseDown(listener:Function):void Default method for adding a mouseDown3D event listener	Object3D
(^)	addOnMouseMove(listener:Function):void Default method for adding a mouseMove3D event listener	Object3D
(^)	addOnMouseOut(listener:Function):void Default method for adding a mouseOut3D event listener	Object3D
(^)	addOnMouseOver(listener:Function):void Default method for adding a mouseOver3D event listener	Object3D
(^)	addOnMouseUp(listener:Function):void Default method for adding a mouseUp3D event listener	Object3D
(^)	addOnParentUpdate(listener:Function):void Default method for adding a parentupdated event listener	Object3D
(^)	addOnRollOut(listener:Function):void Default method for adding a rollOut3D event listener	Object3D
(^)	addOnRollOver(listener:Function):void Default method for adding a rollOver3D event listener	Object3D
(^)	addOnSceneChange(listener:Function):void Default method for adding a scenechanged event listener	Object3D
(^)	addOnSceneTransformChange(listener:Function):void Default method for adding a scenetransformchanged event listener	Object3D
(^)	addOnSequenceDone(listener:Function):void Default method for adding a sequenceDone event listener	Mesh
(^)	addOnSessionChange(listener:Function):void Default method for adding a sessionchanged event listener	Object3D
(^)	addOnTransformChange(listener:Function):void Default method for adding a transformchanged event listener	Object3D
(^)	addSegment(segment:Segment):void Adds a segment object to the mesh object.	Mesh
(^)	applyPosition(dx:Number, dy:Number, dz:Number):void Apply the given position to the geometry without altering the appearance of the mesh	Mesh
(^)	applyRotations():void Apply the local rotations to the geometry without altering the appearance of the mesh	Mesh
(^)	asAS3Class(classname:String = null, packagename:String = "", round:Boolean = false, animated:Boolean = false):String Returns a formatted string containing a self contained AS3 class definition that can be used to re-create the mesh.	Mesh
(^)	asXML():XML Returns an xml representation of the mesh	Mesh
	buildPatch():void Generate the patch mesh based on the patch data and render modes.	BezierPatch
(^)	clone(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object	Mesh
(^)	cloneAll(object:Object3D = null):Object3D Duplicates the mesh properties to another 3d object, including geometry	Mesh
(^)	distanceTo(obj:Object3D):Number Calulates the absolute distance between the local 3d object position and the position of the given 3d object	Object3D
(^)	gotoAndPlay(value:int):void Starts playing the animation at the specified frame.	Mesh
(^)	gotoAndStop(value:int):void Brings the animation to the specifed frame and stops it there.	Mesh
(^)	invertFaces():void Inverts the geometry of all face objects.	Mesh
(^)	lookAt(target:Number3D, upAxis:Number3D = null):void 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 local point around which the object rotates.	Object3D
(^)	moveRight(distance:Number):void Moves the 3d object forwards along it's local x axis	Object3D
(^)	moveTo(dx:Number, dy:Number, dz:Number):void Moves the 3d object directly to a point in space	Object3D
(^)	moveUp(distance:Number):void Moves the 3d object forwards along it's local y axis	Object3D
(^)	pitch(angle:Number):void Rotates the 3d object around it's local x-axis	Object3D
(^)	play(sequence:AnimationSequence):void Plays a sequence of frames	Mesh
(^)	playFrames(prefixes:Array, fps:uint, smooth:Boolean = true, loop:Boolean = false):void Plays a sequence of frames.	Mesh
(^)	quarterFace(face:Face):void Divides a face object into 4 equal sized face objects.	Mesh
(^)	quarterFaces():void Divides all faces objects of a Mesh into 4 equal sized face objects.	Mesh
	refreshPatch():void Refresh the patch with updated patch data information - this is far quicker than re-building the patch	BezierPatch
(^)	removeBillboard(billboard:Billboard):void Removes a billboard object from the mesh object.	Mesh
(^)	removeFace(face:Face):void Removes a face object from the mesh object.	Mesh
(^)	removeOnCycle(listener:Function):void Default method for removing a cycle event listener	Mesh
(^)	removeOnDimensionsChange(listener:Function):void Default method for removing a dimensionschanged event listener	Object3D
(^)	removeOnMouseDown(listener:Function):void Default method for removing a mouseDown3D event listener	Object3D
(^)	removeOnMouseMove(listener:Function):void Default method for removing a mouseMove3D event listener	Object3D
(^)	removeOnMouseOut(listener:Function):void Default method for removing a mouseOut3D event listener	Object3D
(^)	removeOnMouseOver(listener:Function):void Default method for removing a mouseOver3D event listener	Object3D
(^)	removeOnMouseUp(listener:Function):void Default method for removing a mouseUp3D event listener	Object3D
(^)	removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated event listener	Object3D
(^)	removeOnRollOut(listener:Function):void Default method for removing a rollOut3D event listener	Object3D
(^)	removeOnRollOver(listener:Function):void Default method for removing a rollOver3D event listener	Object3D
(^)	removeOnSceneChange(listener:Function):void Default method for removing a scenechanged event listener	Object3D
(^)	removeOnSceneTransformChange(listener:Function):void Default method for removing a scenetransformchanged event listener	Object3D
(^)	removeOnSequenceDone(listener:Function):void Default method for removing a sequenceDone event listener	Mesh
(^)	removeOnSessionChange(listener:Function):void Default method for removing a sessionchanged event listener	Object3D
(^)	removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
(^)	removeSegment(segment:Segment):void Removes a segment object from the mesh object.	Mesh
(^)	roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
(^)	rotate(axis:Number3D, angle:Number):void Rotates the 3d object around an axis by a defined angle	Object3D
(^)	rotateTo(ax:Number, ay:Number, az:Number):void Rotates the 3d object directly to a euler angle	Object3D
(^)	scale(scale:Number):void Scales the contents of the 3d object.	Object3D
(^)	setPlaySequences(playlist:Array, loopLast:Boolean = false):void Passes an array of animationsequence objects to be added to the animation.	Mesh
(^)	splitFace(face:Face, side:int = 0):void Divides a face object into 2 face objects.	Mesh
(^)	splitFaces(side:int = 0):void Divides all faces objects of a Mesh into 2 face objects.	Mesh
(^)	tick(time:int):void 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
(^)	triFace(face:Face):void Divides a face object into 3 face objects.	Mesh
(^)	triFaces():void Divides all faces objects of a Mesh into 3 face objects.	Mesh
(^)	updateMaterials(source:Object3D, view:View3D):void Updates the materials in the mesh object	Mesh
(^)	updateObject():void	Object3D
(^)	updateSession():void	Object3D
(^)	updateVertex(v:Vertex, x:Number, y:Number, z:Number, refreshNormals:Boolean = false):void update vertex information.	Mesh
(^)	yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Method		Defined by
(^)	getDefaultMaterial():IMaterial	Mesh
(^)	updateDimensions():void	Mesh
(^)	updateTransform():void	Object3D

Events

Event		Summary	Defined by
(^)	cycle	Dispatched when a single animation in a sequence completes.	Mesh
(^)	dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
(^)	mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
(^)	mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
(^)	mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
(^)	mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
(^)	rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
(^)	rollOver	Dispatched when a user rolls over the 3d object.	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 a sequence of animations completes.	Mesh
(^)	sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
(^)	sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
(^)	transformChanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Public Constants

	Constant		Defined by
		B : int = 2048 [static]	BezierPatch
		BACK : Array [static]	BezierPatch
		BASEWIRE_ONLY : int = 2 [static]	BezierPatch
		BOTTOM : Array [static]	BezierPatch
		BOTTOMLEFT : int = 3 [static]	BezierPatch
		BOTTOMRIGHT : int = 4 [static]	BezierPatch
		BX : int [static]	BezierPatch
		BY : int [static]	BezierPatch
		BZ : int [static]	BezierPatch
		FRONT : Array [static]	BezierPatch
		L : int = 256 [static]	BezierPatch
		LEFT : Array [static]	BezierPatch
		LX : int [static]	BezierPatch
		LY : int [static]	BezierPatch
		LZ : int [static]	BezierPatch
		MIRRORWIRE_ONLY : int = 3 [static]	BezierPatch
		N : int = 1 [static]	BezierPatch
		NOTSET : int = 0 [static]	BezierPatch
		PATCH : int = 0 [static]	BezierPatch
		R : int = 512 [static]	BezierPatch
		RIGHT : Array [static]	BezierPatch
		RX : int [static]	BezierPatch
		RY : int [static]	BezierPatch
		RZ : int [static]	BezierPatch
		T : int = 1024 [static]	BezierPatch
		TOP : Array [static]	BezierPatch
		TOPLEFT : int = 1 [static]	BezierPatch
		TOPRIGHT : int = 2 [static]	BezierPatch
		TX : int [static]	BezierPatch
		TY : int [static]	BezierPatch
		TZ : int [static]	BezierPatch
		WIRE_ONLY : int = 1 [static]	BezierPatch
		X : int = 2 [static]	BezierPatch
		XY : int = 32 [static]	BezierPatch
		XYZ : int = 64 [static]	BezierPatch
		XZ : int = 4 [static]	BezierPatch
		Y : int = 16 [static]	BezierPatch
		YZ : int = 128 [static]	BezierPatch
		Z : int = 8 [static]	BezierPatch

Property detail

connectMirrors

property

public var connectMirrors:Number

patchData

property

public var patchData:PatchData

renderMode

property

public var renderMode:Number

xOffset

property

public var xOffset:Number

yOffset

property

public var yOffset:Number

zOffset

property

public var zOffset:Number

Constructor detail

BezierPatch

()

constructor

public function BezierPatch(patchDataPrm:PatchData, init:Object = null)
Parameters

	`patchDataPrm:PatchData` — Patch definition for this object.

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

Init Parameters

	`xoffset:Number` (default = 0)
	`yoffset:Number` (default = 0)
	`zoffset:Number` (default = 0)
	`renderMode:Int` (default = 0, min:0, max:3 } )

Method detail

buildPatch

()

method

public function buildPatch():void

Generate the patch mesh based on the patch data and render modes.

refreshPatch

()

method

public function refreshPatch():void

Refresh the patch with updated patch data information - this is far quicker than re-building the patch

Constant detail

constant

public static const B:int = 2048

BACK

constant

public static const BACK:Array

BASEWIRE_ONLY

constant

public static const BASEWIRE_ONLY:int = 2

BOTTOM

constant

public static const BOTTOM:Array

BOTTOMLEFT

constant

public static const BOTTOMLEFT:int = 3

BOTTOMRIGHT

constant

public static const BOTTOMRIGHT:int = 4

constant

public static const BX:int

constant

public static const BY:int

constant

public static const BZ:int

FRONT

constant

public static const FRONT:Array

constant

public static const L:int = 256

LEFT

constant

public static const LEFT:Array

constant

public static const LX:int

constant

public static const LY:int

constant

public static const LZ:int

MIRRORWIRE_ONLY

constant

public static const MIRRORWIRE_ONLY:int = 3

constant

public static const N:int = 1

NOTSET

constant

public static const NOTSET:int = 0

PATCH

constant

public static const PATCH:int = 0

constant

public static const R:int = 512

RIGHT

constant

public static const RIGHT:Array

constant

public static const RX:int

constant

public static const RY:int

constant

public static const RZ:int

constant

public static const T:int = 1024

TOP

constant

public static const TOP:Array

TOPLEFT

constant

public static const TOPLEFT:int = 1

TOPRIGHT

constant

public static const TOPRIGHT:int = 2

constant

public static const TX:int

constant

public static const TY:int

constant

public static const TZ:int

WIRE_ONLY

constant

public static const WIRE_ONLY:int = 1

constant

public static const X:int = 2

constant

public static const XY:int = 32

XYZ

constant

public static const XYZ:int = 64

constant

public static const XZ:int = 4

constant

public static const Y:int = 16

constant

public static const YZ:int = 128

constant

public static const Z:int = 8

Wiki link

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

Code examples

There are currently no examples for this class

Billboard

Package	away3d.core.base
Class	public class Billboard
Inheritance	Billboard -> Element -> flash.events.EventDispatcher

A graphics element used to represent objects that always face the camera

See also

away3d.core.base.Mesh

Public Properties

Property		Defined by
(^)	extra : Object An optional untyped object that can contain used-defined properties.	Element
	height : Number Defines the height of the billboard.	Billboard
	material : IBillboardMaterial Defines the material of the billboard.	Billboard
	maxX : Number [read-only] Returns the maximum x value of the segment	Billboard
	maxY : Number [read-only] Returns the maximum y value of the segment	Billboard
	maxZ : Number [read-only] Returns the maximum z value of the segment	Billboard
	minX : Number [read-only] Returns the minimum x value of the face	Billboard
	minY : Number [read-only] Returns the minimum y value of the face	Billboard
	minZ : Number [read-only] Returns the minimum y value of the face	Billboard
(^)	parent : Geometry Defines the parent 3d object of the segment.	Element
	radius2 : Number [read-only] Returns the squared bounding radius of the billboard.	Billboard
	rotation : Number Defines the rotation of the billboard.	Billboard
	scaling : Number Defines the scaling of the billboard when an `IUVMaterial` is used.	Billboard
	vertex : Vertex Defines the vertex of the billboard.	Billboard
(^)	vertexDirty : Boolean	Element
	vertices : Array [read-only] Returns an array of vertex objects that are used by the segment.	Billboard
(^)	visible : Boolean Determines whether the 3d element is visible in the scene.	Element
	width : Number Defines the width of the billboard.	Billboard
	x : Number Defines the x coordinate of the billboard relative to the local coordinates of the parent `Mesh`.	Billboard
	y : Number Defines the y coordinate of the billboard relative to the local coordinates of the parent `Mesh`.	Billboard
	z : Number Defines the z coordinate of the billboard relative to the local coordinates of the parent `Mesh`.	Billboard

Public Methods

Method		Defined by
	Billboard (vertex:Vertex, material:IBillboardMaterial = null, width:Number = 10, height:Number = 10) Creates a new `Billboard` object.	Billboard
	addOnMaterialChange(listener:Function):void Default method for adding a materialchanged event listener	Billboard
(^)	addOnVertexChange(listener:Function):void Default method for adding a vertexchanged event listener	Element
(^)	addOnVertexValueChange(listener:Function):void Default method for adding a vertexvaluechanged event listener	Element
(^)	addOnVisibleChange(listener:Function):void Default method for adding a visiblechanged event listener	Element
	removeOnMaterialChange(listener:Function):void Default method for removing a materialchanged event listener	Billboard
(^)	removeOnVertexChange(listener:Function):void Default method for removing a vertexchanged event listener	Element
(^)	removeOnVertexValueChange(listener:Function):void Default method for removing a vertexvaluechanged event listener	Element
(^)	removeOnVisibleChange(listener:Function):void Default method for removing a visiblechanged event listener	Element

Events

Event		Summary	Defined by
	materialchanged	Dispatched when the material of the billboard changes.	Billboard
(^)	vertexChanged	Dispatched when the vertex of a 3d element changes.	Element
(^)	vertexvalueChanged	Dispatched when the vertex value of a 3d element changes.	Element
(^)	visibleChanged	Dispatched when the visiblity of a 3d element changes.	Element

Property detail

height

property

height:Number [read-write]

Defines the height of the billboard.

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

material

property

material:IBillboardMaterial [read-write]

Defines the material of the billboard.

Implementation
public function get material():IBillboardMaterial
public function set material(value:IBillboardMaterial):void

maxX

property

maxX:Number [read-only]

Returns the maximum x value of the segment

Implementation
public function get maxX():Number

See also

maxY

property

maxY:Number [read-only]

Returns the maximum y value of the segment

Implementation
public function get maxY():Number

See also

maxZ

property

maxZ:Number [read-only]

Returns the maximum z value of the segment

Implementation
public function get maxZ():Number

See also

minX

property

minX:Number [read-only]

Returns the minimum x value of the face

Implementation
public function get minX():Number

See also

minY

property

minY:Number [read-only]

Returns the minimum y value of the face

Implementation
public function get minY():Number

See also

minZ

property

minZ:Number [read-only]

Returns the minimum y value of the face

Implementation
public function get minZ():Number

See also

radius2

property

radius2:Number [read-only]

Returns the squared bounding radius of the billboard.

Implementation
public function get radius2():Number

rotation

property

rotation:Number [read-write]

Defines the rotation of the billboard.

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

scaling

property

scaling:Number [read-write]

Defines the scaling of the billboard when an IUVMaterial is used.

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

vertex

property

vertex:Vertex [read-write]

Defines the vertex of the billboard.

Implementation
public function get vertex():Vertex
public function set vertex(value:Vertex):void

vertices

property

vertices:Array [read-only]

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

Implementation
public function get vertices():Array

width

property

width:Number [read-write]

Defines the width of the billboard.

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

property

x:Number [read-write]

Defines the x coordinate of the billboard relative to the local coordinates of the parent Mesh.

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

property

y:Number [read-write]

Defines the y coordinate of the billboard relative to the local coordinates of the parent Mesh.

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

property

z:Number [read-write]

Defines the z coordinate of the billboard relative to the local coordinates of the parent Mesh.

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

Constructor detail

Billboard

()

constructor

public function Billboard(vertex:Vertex, material:IBillboardMaterial = null, width:Number = 10, height:Number = 10)
Parameters

	`vertex:Vertex` — The vertex object of the billboard

	`material:IBillboardMaterial` (default = `null`) — [optional] The material used by the billboard to render

	`width:Number` (default = `10`)

	`height:Number` (default = `10`)

Method detail

addOnMaterialChange

()

method

public function addOnMaterialChange(listener:Function):void

Default method for adding a materialchanged event listener

Parameters

listener:Function — The listener function

removeOnMaterialChange

()

method

public function removeOnMaterialChange(listener:Function):void

Default method for removing a materialchanged event listener

Parameters

listener:Function — The listener function

Event detail

materialchanged

event

Event object type: away3d.events.BillboardEvent

Dispatched when the material of the billboard changes.

Wiki link

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

Code examples

There are currently no examples for this class

BillboardEvent

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

Passed as a parameter when a segment event occurs

Public Properties

	Property		Defined by
		billboard : Billboard A reference to the Billboard object that is relevant to the event.	BillboardEvent

Public Methods

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

Public Constants

	Constant		Defined by
		MATERIAL_CHANGED : String = "materialChanged" [static] Defines the value of the type property of a materialChanged event object.	BillboardEvent

Property detail

billboard

property

public var billboard:Billboard

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

Constructor detail

BillboardEvent

()

constructor

public function BillboardEvent(type:String, billboard:Billboard)
Parameters

	`type:String` — The type of the event. Possible values are: `BillboardEvent.MATERIAL_CHANGED`.

	`billboard:Billboard` — A reference to the Billboard object that is relevant to the event.

Method detail

clone

()

method

public override function clone():Event

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

Returns

Event

Constant detail

MATERIAL_CHANGED

constant

public static const MATERIAL_CHANGED:String = "materialChanged"

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

Wiki link

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

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
(^)	colorTransform : ColorTransform Defines a colortransform for the texture bitmap.	BitmapMaterial
(^)	debug : Boolean Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
(^)	globalProjection : Boolean Determines whether a projected texture uses offsetX, offsetY and projectionVector values relative to scene cordinates.	TransformBitmapMaterial
(^)	height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
(^)	offsetX : Number Offsets the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	offsetY : Number Offsets the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
(^)	projectionVector : Number3D Projects the texture in object space, ignoring the uv coordinates of the vertex objects.	TransformBitmapMaterial
(^)	repeat : Boolean Determines if texture bitmap will tile in uv-space	BitmapMaterial
(^)	rotation : Number Rotates the texture in uv-space	TransformBitmapMaterial
(^)	scaleX : Number Scales the x coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	scaleY : Number Scales the y coordinates of the texture in uv-space	TransformBitmapMaterial
(^)	showNormals : Boolean Displays the normals per face in pink lines.	BitmapMaterial
(^)	smooth : Boolean Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
(^)	throughProjection : Boolean Determines whether a projected texture is visble on the faces pointing away from the projection.	TransformBitmapMaterial
(^)	transform : Matrix Transforms the texture in uv-space	TransformBitmapMaterial
(^)	visible : Boolean Indicates whether the material is visible	BitmapMaterial
(^)	width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

Method		Defined by
	BitmapFileMaterial (url:String = "", init:Object = null) Creates a new `BitmapFileMaterial` object.	BitmapFileMaterial
	addOnLoadError(listener:Function):void Default method for adding a loadError event listener	BitmapFileMaterial
	addOnLoadProgress(listener:Function):void Default method for adding a loadProgress event listener	BitmapFileMaterial
	addOnLoadSuccess(listener:Function):void Default method for adding a loadSuccess event listener	BitmapFileMaterial
(^)	addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	BitmapMaterial
(^)	clearFaces(source:Object3D = null, view:View3D = null):void Clears facematerial value objects when bitmap requires updating	BitmapMaterial
(^)	getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO	BitmapMaterial
(^)	getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	TransformBitmapMaterial
(^)	invalidateFaces(source:Object3D = null, view:View3D = null):void Invalidates facematerial value objects when texturemapping requires updating	BitmapMaterial
	removeOnLoadError(listener:Function):void Default method for removing a loadError event listener	BitmapFileMaterial
	removeOnLoadProgress(listener:Function):void Default method for removing a loadProgress event listener	BitmapFileMaterial
	removeOnLoadSuccess(listener:Function):void Default method for removing a loadSuccess event listener	BitmapFileMaterial
(^)	removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	BitmapMaterial
(^)	renderBillboard(bill:DrawBillboard):void Sends data from the material coupled with data from the `DrawBillboard` primitive to the render session.	BitmapMaterial
(^)	renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face.	TransformBitmapMaterial
(^)	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
(^)	renderTriangle(tri:DrawTriangle):void 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
(^)	updateColorTransform():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

	Summary	Defined by
loadError	Dispatched when the material fails to load a file.	BitmapFileMaterial
loadProgress	Dispatched every frame the material is loading.	BitmapFileMaterial
loadSuccess	Dispatched when the material completes a file load successfully.	BitmapFileMaterial

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.

Method detail

addOnLoadError

()

method

public function addOnLoadError(listener:Function):void

Default method for adding a loadError event listener

Parameters

listener:Function — The listener function

addOnLoadProgress

()

method

public function addOnLoadProgress(listener:Function):void

Default method for adding a loadProgress event listener

Parameters

listener:Function — The listener function

addOnLoadSuccess

()

method

public function addOnLoadSuccess(listener:Function):void

Default method for adding a loadSuccess event listener

Parameters

listener:Function — The listener function

removeOnLoadError

()

method

public function removeOnLoadError(listener:Function):void

Default method for removing a loadError event listener

Parameters

listener:Function — The listener function

removeOnLoadProgress

()

method

public function removeOnLoadProgress(listener:Function):void

Default method for removing a loadProgress event listener

Parameters

listener:Function — The listener function

removeOnLoadSuccess

()

method

public function removeOnLoadSuccess(listener:Function):void

Default method for removing a loadSuccess event listener

Parameters

listener:Function — The listener function

Event detail

loadError

event

Event object type: away3d.events.LoaderEvent

Dispatched when the material fails to load a file.

loadProgress

event

Event object type: away3d.events.LoaderEvent

Dispatched every frame the material is loading.

loadSuccess

event

Event object type: away3d.events.LoaderEvent

Dispatched when the material completes a file load successfully.

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	IBillboardMaterial, ILayerMaterial, ITriangleMaterial, 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 Returns the bitmapData object being used as the material texture.	BitmapMaterial
		blendMode : String Defines a blendMode value for the texture bitmap.	BitmapMaterial
		color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
		colorTransform : ColorTransform Defines a colortransform for the texture bitmap.	BitmapMaterial
		debug : Boolean Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
		height : Number [read-only] Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
		precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
		repeat : Boolean Determines if texture bitmap will tile in uv-space	BitmapMaterial
		showNormals : Boolean Displays the normals per face in pink lines.	BitmapMaterial
		smooth : Boolean Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
		visible : Boolean [read-only] Indicates whether the material is visible	BitmapMaterial
		width : Number [read-only] Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

	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
		addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	BitmapMaterial
		clearFaces(source:Object3D = null, view:View3D = null):void Clears facematerial value objects when bitmap requires updating	BitmapMaterial
		getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO	BitmapMaterial
		getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	BitmapMaterial
		invalidateFaces(source:Object3D = null, view:View3D = null):void Invalidates facematerial value objects when texturemapping requires updating	BitmapMaterial
		removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	BitmapMaterial
		renderBillboard(bill:DrawBillboard):void Sends data from the material coupled with data from the `DrawBillboard` primitive to the render session.	BitmapMaterial
		renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face.	BitmapMaterial
		renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
		renderTriangle(tri:DrawTriangle):void 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
		updateColorTransform():void Updates the colortransform object applied to the texture from the `color` and `alpha` properties.	BitmapMaterial
		updateRenderBitmap():void Updates the texture bitmapData with the colortransform determined from the `color` and `alpha` properties.	BitmapMaterial

Property 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-write]

Returns the bitmapData object being used as the material texture.

Implementation
public function get bitmap():BitmapData
public function set bitmap(value:BitmapData):void

blendMode

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

colorTransform

property

colorTransform:ColorTransform [read-write]

Defines a colortransform for the texture bitmap.

Implementation
public function get colorTransform():ColorTransform
public function set colorTransform(value:ColorTransform):void

debug

property

debug:Boolean [read-write]

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

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

height

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

repeat:Boolean [read-write]

Determines if texture bitmap will tile in uv-space

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

showNormals

property

showNormals:Boolean [read-write]

Displays the normals per face in pink lines.

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

smooth

property

smooth:Boolean [read-write]

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

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

visible

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 = false)
	`debug:Boolean` (default = false)
	`repeat:Boolean` (default = false)
	`precision:Number` (default = 0)
	`blendMode:String` (default = BlendMode.NORMAL)
	`alpha:Number` (default = _alpha, min:0, max:1)
	`color:Color` (default = _color)
	`colorTransform:Object` (default = ColorTransform)
	`showNormals:Boolean` (default = false)

Method detail

addOnMaterialUpdate

()

method

public function addOnMaterialUpdate(listener:Function):void

Default method for adding a materialupdated event listener

Parameters

listener:Function — The listener function

clearFaces

()

method

public function clearFaces(source:Object3D = null, view:View3D = null):void

Clears facematerial value objects when bitmap requires updating

Parameters

	`source:Object3D` (default = `null`) — [optional] The parent 3d object of the face.

	`view:View3D` (default = `null`) — [optional] The view rendering the draw triangle.

getFaceMaterialVO

()

method

public function getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO
Parameters

	`faceVO:FaceVO`

	`source:Object3D` (default = `null`)

	`view:View3D` (default = `null`)

Returns

FaceMaterialVO

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.

invalidateFaces

()

method

public function invalidateFaces(source:Object3D = null, view:View3D = null):void

Invalidates facematerial value objects when texturemapping requires updating

Parameters

	`source:Object3D` (default = `null`) — [optional] The parent 3d object of the face.

	`view:View3D` (default = `null`) — [optional] The view rendering the draw triangle.

removeOnMaterialUpdate

()

method

public function removeOnMaterialUpdate(listener:Function):void

Default method for removing a materialupdated event listener

Parameters

listener:Function — The listener function

renderBillboard

()

method

public function renderBillboard(bill:DrawBillboard):void

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

Parameters

bill:DrawBillboard

renderBitmapLayer

()

method

public function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO

Renders a bitmapData surface object for the speficied face.

Parameters

	`tri:DrawTriangle` — The face object onto which the rendered sufrace is applied.

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

	`parentFaceMaterialVO:FaceMaterialVO` — The value object of the preceeding surface.

Returns

FaceMaterialVO

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

updateColorTransform

()

method

protected function updateColorTransform():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()

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
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
(^)	color : uint Defines a colored tint for the texture bitmap.	BitmapMaterial
(^)	colorTransform : ColorTransform Defines a colortransform for the texture bitmap.	BitmapMaterial
(^)	debug : Boolean Toggles debug mode: textured triangles are drawn with white outlines, precision correction triangles are drawn with blue outlines.	BitmapMaterial
(^)	height : Number Returns the height of the bitmapData being used as the material texture.	BitmapMaterial
(^)	precision : Number Corrects distortion caused by the affine transformation (non-perpective) of textures.	BitmapMaterial
(^)	repeat : Boolean Determines if texture bitmap will tile in uv-space	BitmapMaterial
(^)	showNormals : Boolean Displays the normals per face in pink lines.	BitmapMaterial
(^)	smooth : Boolean Determines if texture bitmap is smoothed (bilinearly filtered) when drawn to screen.	BitmapMaterial
	transparent : Boolean Defines whether the caching bitmapData objects are transparent	BitmapMaterialContainer
(^)	visible : Boolean Indicates whether the material is visible	BitmapMaterial
(^)	width : Number Returns the width of the bitmapData being used as the material texture.	BitmapMaterial

Protected Properties

Method		Defined by
	BitmapMaterialContainer (width:int, height:int, init:Object = null) Creates a new `BitmapMaterialContainer` object.	BitmapMaterialContainer
	addMaterial(material:ILayerMaterial):void	BitmapMaterialContainer
(^)	addOnMaterialUpdate(listener:Function):void Default method for adding a materialupdated event listener	BitmapMaterial
(^)	clearFaces(source:Object3D = null, view:View3D = null):void Clears facematerial value objects when bitmap requires updating	BitmapMaterial
	clearMaterials():void	BitmapMaterialContainer
(^)	getFaceMaterialVO(faceVO:FaceVO, source:Object3D = null, view:View3D = null):FaceMaterialVO	BitmapMaterial
(^)	getPixel32(u:Number, v:Number):uint Returns the argb value of the bitmapData pixel at the given u v coordinate.	BitmapMaterial
(^)	invalidateFaces(source:Object3D = null, view:View3D = null):void Invalidates facematerial value objects when texturemapping requires updating	BitmapMaterial
	removeMaterial(material:ILayerMaterial):void	BitmapMaterialContainer
(^)	removeOnMaterialUpdate(listener:Function):void Default method for removing a materialupdated event listener	BitmapMaterial
(^)	renderBillboard(bill:DrawBillboard):void Sends data from the material coupled with data from the `DrawBillboard` primitive to the render session.	BitmapMaterial
	renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO Renders a bitmapData surface object for the speficied face.	BitmapMaterialContainer
(^)	renderLayer(tri:DrawTriangle, layer:Sprite, level:int):void Renders a material layer for the specified triangle.	BitmapMaterial
(^)	renderTriangle(tri:DrawTriangle):void Sends data from the material coupled with data from the `DrawTriangle` primitive to the render session.	BitmapMaterial
	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
(^)	updateColorTransform():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

Property detail

materials

property

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

Method detail

addMaterial

()

method

public function addMaterial(material:ILayerMaterial):void
Parameters

material:ILayerMaterial

clearMaterials

()

method

public function clearMaterials():void

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.

removeMaterial

()

method

public function removeMaterial(material:ILayerMaterial):void
Parameters

material:ILayerMaterial

renderBitmapLayer

()

method

public override function renderBitmapLayer(tri:DrawTriangle, containerRect:Rectangle, parentFaceMaterialVO:FaceMaterialVO):FaceMaterialVO

Renders a bitmapData surface object for the speficied face.

Parameters

	`tri:DrawTriangle` — The face object onto which the rendered sufrace is applied.

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

	`parentFaceMaterialVO:FaceMaterialVO` — The value object of the preceeding surface.

Returns

FaceMaterialVO

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 -> flash.events.EventDispatcher

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

Public Properties

Property		Defined by
(^)	alpha : Number = 1 Placeholder for alpha property of containers	AbstractRenderSession
(^)	blendMode : String Placeholder for blendMode property of containers	AbstractRenderSession
(^)	children : Dictionary Dictionary of child displayobjects.	AbstractRenderSession
(^)	consumer : IPrimitiveConsumer	AbstractRenderSession
(^)	filters : Array Placeholder for filters property of containers	AbstractRenderSession
(^)	graphics : Graphics Reference to the current graphics object being used for drawing.	AbstractRenderSession
(^)	newLayer : Sprite Holds the last added layer sprite.	AbstractRenderSession
(^)	parent : AbstractRenderSession	AbstractRenderSession
(^)	priconsumers : Dictionary	AbstractRenderSession
(^)	primitives : Array	AbstractRenderSession
(^)	renderer : IPrimitiveConsumer	AbstractRenderSession
(^)	sessions : Array Array of child sessions.	AbstractRenderSession
(^)	spriteLayers : Array Dictionary of sprite layers for rendering composite materials.	AbstractRenderSession
(^)	updated : Boolean	AbstractRenderSession

Public Methods

Method		Defined by
	BitmapRenderSession (scale:Number = 2) Creates a new `BitmapRenderSession` object.	BitmapRenderSession
(^)	addChildSession(session:AbstractRenderSession):void Adds a session as a child of the session object.	AbstractRenderSession
	addDisplayObject(child:DisplayObject):void Adds a display object to the render session display list.	BitmapRenderSession
	addLayerObject(child:Sprite):void Adds a layer sprite to the render session display list.	BitmapRenderSession
(^)	addOnSessionUpdate(listener:Function):void Default method for adding a sessionUpdated event listener	AbstractRenderSession
	clear(view:View3D):void Clears the render session.	BitmapRenderSession
(^)	clearChildSessions():void	AbstractRenderSession
(^)	clearRenderers():void	AbstractRenderSession
	clone():AbstractRenderSession Duplicates the render session's properties to another render session.	BitmapRenderSession
	getBitmapContainer(view:View3D):Bitmap	BitmapRenderSession
	getBitmapData(view:View3D):BitmapData Returns a bitmapData object containing the rendered view.	BitmapRenderSession
(^)	getConsumer(view:View3D):IPrimitiveConsumer	AbstractRenderSession
	getContainer(view:View3D):DisplayObject Returns a display object representing the container for the specified view.	BitmapRenderSession
(^)	getTotalFaces(view:View3D):int	AbstractRenderSession
(^)	removeChildSession(session:AbstractRenderSession):void Removes a child session of the session object.	AbstractRenderSession
(^)	removeOnSessionUpdate(listener:Function):void Default method for removing a sessionUpdated event listener	AbstractRenderSession
	render(view:View3D):void	BitmapRenderSession
(^)	renderBillboardBitmap(bitmap:BitmapData, primitive:DrawBillboard, smooth:Boolean):void Draws a billboard element with a fill bitmap into the graphics object.	AbstractRenderSession
(^)	renderBillboardColor(color:int, alpha:Number, primitive:DrawBillboard):void Draws a billboard element with a fill color into the graphics object.	AbstractRenderSession
(^)	renderBitmap(bitmap:BitmapData, v0:ScreenVertex, smooth:Boolean = false):void Draws a non-scaled bitmap into the graphics object.	AbstractRenderSession
(^)	renderFogColor(clip:Clipping, color:int, alpha:Number):void Draws a fog element into the graphics object.	AbstractRenderSession
(^)	renderLine(v0:ScreenVertex, v1:ScreenVertex, width:Number, color:uint, alpha:Number):void Draws a segment element into the graphics object.	AbstractRenderSession
(^)	renderScaledBitmap(primitive:DrawScaledBitmap, bitmap:BitmapData, mapping:Matrix, smooth:Boolean = false):void Draws a bitmap with a precalculated matrix into the graphics object.	AbstractRenderSession
(^)	renderTriangleBitmap(bitmap:BitmapData, map:Matrix, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, smooth:Boolean, repeat:Boolean, layerGraphics:Graphics = null):void Draws a triangle element with a bitmap texture into the graphics object.	AbstractRenderSession
(^)	renderTriangleColor(color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex, layerGraphics:Graphics = null):void Draws a triangle element with a fill color into the graphics object.	AbstractRenderSession
(^)	renderTriangleLine(width:Number, color:int, alpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element into the graphics object.	AbstractRenderSession
(^)	renderTriangleLineFill(width:Number, color:int, alpha:Number, wirecolor:int, wirealpha:Number, v0:ScreenVertex, v1:ScreenVertex, v2:ScreenVertex):void Draws a wire triangle element with a fill color into the graphics object.	AbstractRenderSession

Protected Methods

	Method		Defined by
		createLayer():void Creates a new render layer for rendering composite materials.	BitmapRenderSession
	(^)	onSessionUpdate(event:SessionEvent):void	AbstractRenderSession

Events

	Event		Summary	Defined by
	(^)	sessionUpdated	Dispatched when the render contents of the session require updating.	AbstractRenderSession

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(view:View3D):void

Clears the render session.

Parameters

view:View3D

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.

getBitmapContainer

()

method

public function getBitmapContainer(view:View3D):Bitmap
Parameters

view:View3D

Returns

Bitmap

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.

render

()

method

public override function render(view:View3D):void
Parameters

view:View3D

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
(^)	generated : Boolean Indicator of whether primitive is the produce of a generator algorithm	DrawPrimitive
(^)	maxX : Number Indicates the maximum x value of the drawing primitive.	DrawPrimitive
(^)	maxY : Number Indicates the maximum y value of the draw