away3d.entities.Entity

Public Properties

	Property		Defined by
		bounds : BoundingVolumeBase The bounding volume approximating the volume occupied by the Entity.	Entity
		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
		inverseSceneTransform : Matrix3D The inverse scene transform object that transforms from world to model space.	ObjectContainer3D
		maxX : Number [read-only] The maximum extremum of the object along the X-axis.	Entity
		maxY : Number [read-only] The maximum extremum of the object along the Y-axis.	Entity
		maxZ : Number [read-only] The maximum extremum of the object along the Z-axis.	Entity
		minX : Number [read-only] The minimum extremum of the object along the X-axis.	Entity
		minY : Number [read-only] The minimum extremum of the object along the Y-axis.	Entity
		minZ : Number [read-only] The minimum extremum of the object along the Z-axis.	Entity
		modelViewProjection : Matrix3D [read-only] 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
		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
		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
		transform : Matrix3D The local transformation matrix that transforms to the parent object's space.	ObjectContainer3D
		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 [read-only] 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
		Entity () Creates a new Entity object.	Entity
		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
		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 Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space and places it on the stack.	Entity
		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 Factory method that returns the current partition node.	Entity
		getDefaultBoundingVolume():BoundingVolumeBase Creates the default bounding box to be used by this type of Entity.	Entity
		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 Updates the bounding volume for the object.	Entity
		updateSceneTransform():void Updates the scene transformation matrix.	ObjectContainer3D
		updateTransform():void	Object3D

Property detail

_bounds

property

protected var _bounds:BoundingVolumeBase

bounds

property

bounds:BoundingVolumeBase [read-write]

The bounding volume approximating the volume occupied by the Entity.

Implementation
public function get bounds():BoundingVolumeBase
public function set bounds(value:BoundingVolumeBase):void

_boundsInvalid

property

protected var _boundsInvalid:Boolean = true

implicitPartition

property

implicitPartition:Partition3D [write-only]

Implementation
arcane function set implicitPartition(value:Partition3D):void

maxX

property

maxX:Number [read-only]

The maximum extremum of the object along the X-axis.

Implementation
public function get maxX():Number

maxY

property

maxY:Number [read-only]

The maximum extremum of the object along the Y-axis.

Implementation
public function get maxY():Number

maxZ

property

maxZ:Number [read-only]

The maximum extremum of the object along the Z-axis.

Implementation
public function get maxZ():Number

minX

property

minX:Number [read-only]

The minimum extremum of the object along the X-axis.

Implementation
public function get minX():Number

minY

property

minY:Number [read-only]

The minimum extremum of the object along the Y-axis.

Implementation
public function get minY():Number

minZ

property

minZ:Number [read-only]

The minimum extremum of the object along the Z-axis.

Implementation
public function get minZ():Number

modelViewProjection

property

modelViewProjection:Matrix3D [read-only]

The current model-view-projection (MVP) matrix - the one on the top of the stack - used to transform from model to homogeneous projection space.

Implementation
public function get modelViewProjection():Matrix3D

mouseEnabled

property

mouseEnabled:Boolean [read-write]

Indicates whether the IRenderable should trigger mouse events, and hence should be rendered for hit testing.

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

_mvpIndex

property

protected var _mvpIndex:int = -1

_mvpTransformStack

property

protected var _mvpTransformStack:Vector

scene

property

scene:Scene3D [write-only]

Implementation
arcane function set scene(value:Scene3D):void

_stackLen

property

protected var _stackLen:uint

zIndex

property

zIndex:Number [read-only]

The distance of the IRenderable object to the view, used to sort per object.

Implementation
public function get zIndex():Number

_zIndices

property

protected var _zIndices:Vector

Constructor detail

Entity

()

constructor

public function Entity() Init Parameters

Method detail

createEntityPartitionNode

()

method

protected function createEntityPartitionNode():EntityNode

Factory method that returns the current partition node. Needs to be overridden by concrete subclasses such as Mesh to return the correct concrete subtype of EntityPartition3DNode (for Mesh = MeshPartition3DNode, most IRenderables (particles fe) would return RenderablePartition3DNode, I suppose)

Returns

EntityNode

getDefaultBoundingVolume

()

method

protected function getDefaultBoundingVolume():BoundingVolumeBase

Creates the default bounding box to be used by this type of Entity.

Returns

BoundingVolumeBase

getEntityPartitionNode

()

method

public function getEntityPartitionNode():EntityNode

Gets a concrete EntityPartition3DNode subclass that is associated with this Entity instance

Returns

EntityNode

invalidateBounds

()

method

protected function invalidateBounds():void

Invalidates the bounding volume, causing to be updated when requested.

invalidateSceneTransform

()

method

protected override function invalidateSceneTransform():void

Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.

popModelViewProjection

()

method

public function popModelViewProjection():void

Removes a model view projection matrix from the stack, used when leaving a render.

pushModelViewProjection

()

method

public function pushModelViewProjection(camera:Camera3D):void

Updates the model-view-projection (MVP) matrix used to transform from model to homogeneous projection space and places it on the stack. The stack allows nested rendering while keeping the MVP intact.

Parameters

camera:Camera3D — The camera which will perform the view transformation and projection.

updateBounds

()

method

protected function updateBounds():void

Updates the bounding volume for the object. Overriding methods need to set invalid flag to false!

Wiki link

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

Code examples

Comments

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

Package	away3d.entities
Class	public class Entity
Inheritance	Entity ObjectContainer3D Object3D flash.events.EventDispatcher
Subclasses	Camera3D, LightBase, Mesh, SegmentsBase, SkyBox, Sprite3D