| Package | away3d.core.traverse |
| Class | public class EntityCollector |
| Inheritance | EntityCollector  PartitionTraverser Object |
| Subclasses | ShadowCasterCollector |
See also
| Property | Defined By | ||
|---|---|---|---|
| blendedRenderableHead : RenderableListItem
The list of IRenderable objects that require blending and are considered potentially visible. | EntityCollector | ||
| camera : Camera3D
The camera that provides the visible frustum. | EntityCollector | ||
| directionalLights : Vector.<DirectionalLight> [read-only] | EntityCollector | ||
| entityHead : EntityListItem [read-only] | EntityCollector | ||
 | entryPoint : Vector3D [read-only]
The entry point for scene graph traversal, ie the point that will be used for traversing the graph
position-dependently. | PartitionTraverser | |
| lightProbes : Vector.<LightProbe> [read-only] | EntityCollector | ||
| lights : Vector.<LightBase> [read-only]
The lights of which the affecting area intersects the camera's frustum. | EntityCollector | ||
| numBlended : uint [read-only] | EntityCollector | ||
| numMouseEnableds : uint [read-only]
The amount of IRenderable objects that are mouse-enabled. | EntityCollector | ||
| numOpaques : uint [read-only] | EntityCollector | ||
| numTriangles : uint [read-only]
The total number of triangles collected, and which will be pushed to the render engine. | EntityCollector | ||
| opaqueRenderableHead : RenderableListItem
The list of opaque IRenderable objects that are considered potentially visible. | EntityCollector | ||
| pointLights : Vector.<PointLight> [read-only] | EntityCollector | ||
| scene : Scene3D
The scene being traversed. | PartitionTraverser | |
| skyBox : IRenderable [read-only]
The sky box object if encountered. | EntityCollector | ||
| Property | Defined By | ||
|---|---|---|---|
| _blendedRenderableHead : RenderableListItem | EntityCollector | ||
| _camera : Camera3D | EntityCollector | ||
| _entityListItemPool : EntityListItemPool | EntityCollector | ||
| _lights : Vector.<LightBase> | EntityCollector | ||
| _numBlended : uint | EntityCollector | ||
| _numEntities : uint | EntityCollector | ||
| _numLights : uint | EntityCollector | ||
| _numMouseEnableds : uint | EntityCollector | ||
| _numOpaques : uint | EntityCollector | ||
| _numTriangles : uint | EntityCollector | ||
| _opaqueRenderableHead : RenderableListItem | EntityCollector | ||
| _renderableListItemPool : RenderableListItemPool | EntityCollector | ||
| _skyBox : IRenderable | EntityCollector | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new EntityCollector object. | EntityCollector | ||
applyDirectionalLight(light:DirectionalLight):void [override] | EntityCollector | ||
applyEntity(entity:Entity):void [override]
Registers an entity for use. | EntityCollector | ||
applyLightProbe(light:LightProbe):void [override] | EntityCollector | ||
applyPointLight(light:PointLight):void [override] | EntityCollector | ||
applyRenderable(renderable:IRenderable):void [override]
Adds an IRenderable object to the potentially visible objects. | EntityCollector | ||
applySkyBox(renderable:IRenderable):void [override]
Adds a skybox to the potentially visible objects. | EntityCollector | ||
applyUnknownLight(light:LightBase):void [override]
Adds a light to the potentially visible objects. | EntityCollector | ||
cleanUp():void
Cleans up any data at the end of a frame. | EntityCollector | ||
clear():void
Clears all objects in the entity collector. | EntityCollector | ||
[override]
Returns true if the current node is at least partly in the frustum. | EntityCollector | ||
|
Called when the traverser leaves a node. | PartitionTraverser | |
| _blendedRenderableHead | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _blendedRenderableHead:RenderableListItem| _camera | property |
protected var _camera:Camera3D| _entityListItemPool | property |
protected var _entityListItemPool:EntityListItemPool| _lights | property |
protected var _lights:Vector.<LightBase>| _numBlended | property |
protected var _numBlended:uint| _numEntities | property |
protected var _numEntities:uint| _numLights | property |
protected var _numLights:uint| _numMouseEnableds | property |
protected var _numMouseEnableds:uint| _numOpaques | property |
protected var _numOpaques:uint| _numTriangles | property |
protected var _numTriangles:uint| _opaqueRenderableHead | property |
protected var _opaqueRenderableHead:RenderableListItem| _renderableListItemPool | property |
protected var _renderableListItemPool:RenderableListItemPool| _skyBox | property |
protected var _skyBox:IRenderable| blendedRenderableHead | property |
blendedRenderableHead:RenderableListItemThe list of IRenderable objects that require blending and are considered potentially visible.
public function get blendedRenderableHead():RenderableListItem public function set blendedRenderableHead(value:RenderableListItem):void| camera | property |
camera:Camera3DThe camera that provides the visible frustum.
public function get camera():Camera3D public function set camera(value:Camera3D):void| directionalLights | property |
directionalLights:Vector.<DirectionalLight> [read-only] public function get directionalLights():Vector.<DirectionalLight>| entityHead | property |
entityHead:EntityListItem [read-only] public function get entityHead():EntityListItem| lightProbes | property |
lightProbes:Vector.<LightProbe> [read-only] public function get lightProbes():Vector.<LightProbe>| lights | property |
lights:Vector.<LightBase> [read-only] The lights of which the affecting area intersects the camera's frustum.
public function get lights():Vector.<LightBase>| numBlended | property |
numBlended:uint [read-only] public function get numBlended():uint| numMouseEnableds | property |
numMouseEnableds:uint [read-only] The amount of IRenderable objects that are mouse-enabled.
public function get numMouseEnableds():uint| numOpaques | property |
numOpaques:uint [read-only] public function get numOpaques():uint| numTriangles | property |
numTriangles:uint [read-only] The total number of triangles collected, and which will be pushed to the render engine.
public function get numTriangles():uint| opaqueRenderableHead | property |
opaqueRenderableHead:RenderableListItemThe list of opaque IRenderable objects that are considered potentially visible.
public function get opaqueRenderableHead():RenderableListItem public function set opaqueRenderableHead(value:RenderableListItem):void| pointLights | property |
pointLights:Vector.<PointLight> [read-only] public function get pointLights():Vector.<PointLight>| skyBox | property |
skyBox:IRenderable [read-only] The sky box object if encountered.
public function get skyBox():IRenderable| EntityCollector | () | Constructor |
public function EntityCollector()Creates a new EntityCollector object.
| applyDirectionalLight | () | method |
override public function applyDirectionalLight(light:DirectionalLight):voidParameters
light:DirectionalLight |
| applyEntity | () | method |
override public function applyEntity(entity:Entity):voidRegisters an entity for use.
Parameters
entity:Entity |
| applyLightProbe | () | method |
| applyPointLight | () | method |
| applyRenderable | () | method |
override public function applyRenderable(renderable:IRenderable):voidAdds an IRenderable object to the potentially visible objects.
Parameters
renderable:IRenderable — The IRenderable object to add.
|
| applySkyBox | () | method |
override public function applySkyBox(renderable:IRenderable):voidAdds a skybox to the potentially visible objects.
Parameters
renderable:IRenderable — The skybox to add.
|
| applyUnknownLight | () | method |
override public function applyUnknownLight(light:LightBase):voidAdds a light to the potentially visible objects.
Parameters
light:LightBase — The light to add.
|
| cleanUp | () | method |
public function cleanUp():voidCleans up any data at the end of a frame.
| clear | () | method |
public function clear():voidClears all objects in the entity collector.
| enterNode | () | method |
override public function enterNode(node:NodeBase):BooleanReturns true if the current node is at least partly in the frustum. If so, the partition node knows to pass on the traverser to its children.
Parameters
node:NodeBase — The Partition3DNode object to frustum-test.
|
Boolean |