away3d.entities.Sprite3D

Public Properties

	Property		Defined by
		animation : AnimationBase [read-only]	Sprite3D
		animationState : AnimationStateBase [read-only]	Sprite3D
		bounds : BoundingVolumeBase The bounding volume approximating the volume occupied by the Entity.	Entity
		castsShadows : Boolean [read-only]	Sprite3D
		eulers : Vector3D Defines the rotation of the 3d object as a `Vector3D` object containing euler angles for rotation around x, y and z axis.	Object3D
		extra : Object An object that can contain any extra data.	Object3D
		height : Number	Sprite3D
		inverseSceneTransform : Matrix3D The inverse scene transform object that transforms from world to model space.	ObjectContainer3D
		material : MaterialBase	Sprite3D
		maxX : Number The maximum extremum of the object along the X-axis.	Entity
		maxY : Number The maximum extremum of the object along the Y-axis.	Entity
		maxZ : Number The maximum extremum of the object along the Z-axis.	Entity
		minX : Number The minimum extremum of the object along the X-axis.	Entity
		minY : Number The minimum extremum of the object along the Y-axis.	Entity
		minZ : Number The minimum extremum of the object along the Z-axis.	Entity
		modelViewProjection : Matrix3D The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from model to homogeneous projection space.	Entity
		mouseDetails : Boolean	Sprite3D
		mouseEnabled : Boolean Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.	Entity
		name : String The name of the object.	Object3D
		numChildren : uint The amount of child objects of the ObjectContainer3D.	ObjectContainer3D
		numTriangles : uint [read-only]	Sprite3D
		parent : ObjectContainer3D The parent ObjectContainer3D to which this object's transformation is relative.	ObjectContainer3D
		partition : Partition3D The space partition to be used by the object container and all its recursive children, unless it has its own space partition assigned.	ObjectContainer3D
		pivotPoint : Vector3D Defines the local point around which the object rotates.	Object3D
		position : Vector3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	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
		scenePosition : Vector3D The global position of the ObjectContainer3D in the scene.	ObjectContainer3D
		sceneTransform : Matrix3D The transformation matrix that transforms from model to world space.	ObjectContainer3D
		sourceEntity : Entity [read-only]	Sprite3D
		transform : Matrix3D The local transformation matrix that transforms to the parent object's space.	ObjectContainer3D
		width : Number	Sprite3D
		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
		zIndex : Number The distance of the IRenderable object to the view, used to sort per object.	Entity

	Property	Defined by
		_bounds : BoundingVolumeBase	Entity
		_boundsInvalid : Boolean = true	Entity
		_explicitPartition : Partition3D	ObjectContainer3D
		_implicitPartition : Partition3D	ObjectContainer3D
		_mvpIndex : int = -1	Entity
		_mvpTransformStack : Vector	Entity
		_parent : ObjectContainer3D	ObjectContainer3D
		_pivotPoint : Vector3D	Object3D
		_pivotZero : Boolean = true	Object3D
		_pos : Vector3D A calculation placeholder.	Object3D
		_scaleX : Number = 1	Object3D
		_scaleY : Number = 1	Object3D
		_scaleZ : Number = 1	Object3D
		_scene : Scene3D	ObjectContainer3D
		_sceneTransform : Matrix3D	ObjectContainer3D
		_sceneTransformDirty : Boolean = true	ObjectContainer3D
		_stackLen : uint	Entity
		_transform : Matrix3D	Object3D
		_x : Number = 0	Object3D
		_y : Number = 0	Object3D
		_z : Number = 0	Object3D
		_zIndices : Vector	Entity

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Sprite3D (material:MaterialBase, width:Number, height:Number)	Sprite3D
		addChild(child:ObjectContainer3D):ObjectContainer3D Adds a child ObjectContainer3D to the current object.	ObjectContainer3D
		addChildren(... childarray):void Adds an array of 3d objects to the scene as children of the container	ObjectContainer3D
		clone():Object3D	Object3D
		dispose(deep:Boolean):void Cleans up any resources used by the current object.	ObjectContainer3D
		getChildAt(index:uint):ObjectContainer3D Retrieves the child object at the given index.	ObjectContainer3D
		getEntityPartitionNode():EntityNode Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance	Entity
		getIndexBuffer(context:Context3D, contextIndex:uint):IndexBuffer3D	Sprite3D
		getUVBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D	Sprite3D
		getVertexBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D	Sprite3D
		getVertexNormalBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D	Sprite3D
		getVertexTangentBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D	Sprite3D
		lookAt(target:Vector3D, upAxis:Vector3D = null):void Rotates the 3d object around to face a point defined relative to the local coordinates of the parent `ObjectContainer3D`.	ObjectContainer3D
		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
		popModelViewProjection():void Removes a model view projection matrix from the stack, used when leaving a render.	Entity
		pushModelViewProjection(camera:Camera3D):void	Sprite3D
		removeChild(child:ObjectContainer3D):void Removes a 3d object from the child array of the container	ObjectContainer3D
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Vector3D, 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(value:Number):void Appends a uniform scale to the current transformation.	Object3D
		translate(axis:Vector3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		translateLocal(axis:Vector3D, distance:Number):void	ObjectContainer3D
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

	Method	Defined by
		createEntityPartitionNode():EntityNode	Sprite3D
		getDefaultBoundingVolume():BoundingVolumeBase	Sprite3D
		invalidateBounds():void Invalidates the bounding volume, causing to be updated when requested.	Entity
		invalidateSceneTransform():void Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.	Entity
		invalidateTransform():void Invalidates the transformation matrix, causing it to be updated upon the next request	ObjectContainer3D
		updateBounds():void	Sprite3D
		updateSceneTransform():void Updates the scene transformation matrix.	ObjectContainer3D
		updateTransform():void	Sprite3D

Property detail

animation

property

animation:AnimationBase [read-only]Implementation
public function get animation():AnimationBase

animationState

property

animationState:AnimationStateBase [read-only]Implementation
public function get animationState():AnimationStateBase

castsShadows

property

castsShadows:Boolean [read-only]Implementation
public function get castsShadows():Boolean

height

property

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

material

property

material:MaterialBase  [read-write]Implementation
    public function get material():MaterialBase
    public function set material(value:MaterialBase):void

mouseDetails

property

mouseDetails:Boolean  [read-write]Implementation
    public function get mouseDetails():Boolean
    public function set mouseDetails(value:Boolean):void

numTriangles

property

numTriangles:uint [read-only]Implementation
public function get numTriangles():uint

sourceEntity

property

sourceEntity:Entity [read-only]Implementation
public function get sourceEntity():Entity

width

property

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

Constructor detail

Sprite3D

()

constructor

public function Sprite3D(material:MaterialBase, width:Number, height:Number)Parameters

	`material:MaterialBase`

	`width:Number`

	`height:Number`

Init Parameters

Method detail

createEntityPartitionNode

()

method

protected override function createEntityPartitionNode():EntityNode

Returns

EntityNode

getDefaultBoundingVolume

()

method

protected override function getDefaultBoundingVolume():BoundingVolumeBase

Returns

BoundingVolumeBase

getIndexBuffer

()

method

public function getIndexBuffer(context:Context3D, contextIndex:uint):IndexBuffer3D Parameters

	`context:Context3D`

	`contextIndex:uint`

Returns

IndexBuffer3D

getUVBuffer

()

method

public function getUVBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D Parameters

	`context:Context3D`

	`contextIndex:uint`

Returns

VertexBuffer3D

getVertexBuffer

()

method

public function getVertexBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D Parameters

	`context:Context3D`

	`contextIndex:uint`

Returns

VertexBuffer3D

getVertexNormalBuffer

()

method

public function getVertexNormalBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D Parameters

	`context:Context3D`

	`contextIndex:uint`

Returns

VertexBuffer3D

getVertexTangentBuffer

()

method

public function getVertexTangentBuffer(context:Context3D, contextIndex:uint):VertexBuffer3D Parameters

	`context:Context3D`

	`contextIndex:uint`

Returns

VertexBuffer3D

pushModelViewProjection

()

method

public override function pushModelViewProjection(camera:Camera3D):void Parameters

camera:Camera3D

updateBounds

()

method

protected override function updateBounds():void

updateTransform

()

method

protected override function updateTransform():void

Wiki link

Click to go to the wiki page for 'away3d.entities.Sprite3D'

Code examples

Comments

Broomstick FP11 Trunk (as on 30-Mar-2011)	All Packages \| All Classes \| Index \| Frames No Frames
Class Sprite3D		Properties \| Methods

Package	away3d.entities
Class	public class Sprite3D
Inheritance	Sprite3D Entity ObjectContainer3D Object3D flash.events.EventDispatcher
Implements	IRenderable