The EntityCollector object is a traverser for scene partitions that collects all scene graph entities that are considered potientially visible.


Inherited from PartitionTraverser.


Can be created using method new:

Lib.Away3D.Core.Traverse.EntityCollector.new()

Creates a new EntityCollector object.



Created EntityCollector object has properties:

blendedRenderableHead

The list of IRenderable objects that require blending and are considered potentially visible. (RenderableListItem)

camera

The camera that provides the visible frustum. (Camera3D)

cullPlanes

Vector array of (Plane3D)

directionalLights

[read-only] Vector array of (DirectionalLight)

entityHead

[read-only] (EntityListItem)

lightProbes

[read-only] Vector array of (LightProbe)

lights

[read-only] The lights of which the affecting area intersects the camera's frustum. Vector array of (LightBase)

numMouseEnableds

[read-only] The amount of IRenderable objects that are mouse-enabled.

numTriangles

[read-only] The total number of triangles collected, and which will be pushed to the render engine.

opaqueRenderableHead

The list of opaque IRenderable objects that are considered potentially visible. (RenderableListItem)

pointLights

[read-only] Vector array of (PointLight)

skyBox

[read-only] The sky box object if encountered. IRenderable: SegmentSet, SkyBox, Sprite3D, SubMesh


methods:

applyDirectionalLight(light)

[override]

light - (DirectionalLight)

applyEntity(entity)

[override] Registers an entity for use.

entity - (Entity)

applyLightProbe(light)

[override]

light - (LightProbe)

applyPointLight(light)

[override]

light - (PointLight)

applyRenderable(renderable)

[override] Passes an IRenderable object to be processed by the traverser.

renderable - IRenderable (SegmentSet, SkyBox, Sprite3D, SubMesh)

applySkyBox(renderable)

[override] Passes a skybox to be processed by the traverser.

renderable - IRenderable (SegmentSet, SkyBox, Sprite3D, SubMesh)

applyUnknownLight(light)

[override] Passes a light to be processed by the traverser.

light - (LightBase)

cleanUp()

Cleans up any data at the end of a frame.


clear()

Clears all objects in the entity collector.


enterNode(node)

[override] Called when the traversers enters a node. Return Boolean

node - The currently entered node. (NodeBase)

Created with the Personal Edition of HelpNDoc: Easily create iPhone documentation