Packageaway3d.core.traverse
Classpublic class RaycastCollector
InheritanceRaycastCollector Inheritance EntityCollector Inheritance PartitionTraverser Inheritance Object

The RaycastCollector class is a traverser for scene partitions that collects all scene graph entities that are considered intersecting with the defined ray.

See also

away3d.partition.Partition3D
away3d.partition.Entity


Public Properties
 PropertyDefined By
 InheritedblendedRenderableHead : RenderableListItem
The list of IRenderable objects that require blending and are considered potentially visible.
EntityCollector
 Inheritedcamera : Camera3D
The camera that provides the visible frustum.
EntityCollector
 InheritedcullPlanes : Vector.<Plane3D>
EntityCollector
 InheriteddirectionalLights : Vector.<DirectionalLight>
[read-only]
EntityCollector
 InheritedentityHead : EntityListItem
[read-only]
EntityCollector
 InheritedentryPoint : Vector3D
[read-only] The entry point for scene graph traversal, ie the point that will be used for traversing the graph position-dependently.
PartitionTraverser
 InheritedlightProbes : Vector.<LightProbe>
[read-only]
EntityCollector
 Inheritedlights : Vector.<LightBase>
[read-only] The lights of which the affecting area intersects the camera's frustum.
EntityCollector
 InheritednumMouseEnableds : uint
[read-only] The amount of IRenderable objects that are mouse-enabled.
EntityCollector
 InheritednumTriangles : uint
[read-only] The total number of triangles collected, and which will be pushed to the render engine.
EntityCollector
 InheritedopaqueRenderableHead : RenderableListItem
The list of opaque IRenderable objects that are considered potentially visible.
EntityCollector
 InheritedpointLights : Vector.<PointLight>
[read-only]
EntityCollector
  rayDirection : Vector3D
Provides the direction vector of the ray.
RaycastCollector
  rayPosition : Vector3D
Provides the starting position of the ray.
RaycastCollector
 Inheritedscene : Scene3D
The scene being traversed.
PartitionTraverser
 InheritedskyBox : IRenderable
[read-only] The sky box object if encountered.
EntityCollector
Protected Properties
 PropertyDefined By
 Inherited_blendedRenderableHead : RenderableListItem
EntityCollector
 Inherited_camera : Camera3D
EntityCollector
 Inherited_cameraForward : Vector3D
EntityCollector
 Inherited_entityListItemPool : EntityListItemPool
EntityCollector
 Inherited_lights : Vector.<LightBase>
EntityCollector
 Inherited_numEntities : uint
EntityCollector
 Inherited_numLights : uint
EntityCollector
 Inherited_numMouseEnableds : uint
EntityCollector
 Inherited_numTriangles : uint
EntityCollector
 Inherited_opaqueRenderableHead : RenderableListItem
EntityCollector
 Inherited_renderableListItemPool : RenderableListItemPool
EntityCollector
 Inherited_skyBox : IRenderable
EntityCollector
Public Methods
 MethodDefined By
  
Creates a new RaycastCollector object.
RaycastCollector
 Inherited
[override]
EntityCollector
 Inherited
applyEntity(entity:Entity):void
[override] Registers an entity for use.
EntityCollector
 Inherited
[override]
EntityCollector
 Inherited
[override]
EntityCollector
  
applyRenderable(renderable:IRenderable):void
[override] Adds an IRenderable object to the potentially visible objects.
RaycastCollector
  
applySkyBox(renderable:IRenderable):void
[override] Adds a skybox to the potentially visible objects.
RaycastCollector
  
[override] Adds a light to the potentially visible objects.
RaycastCollector
 Inherited
cleanUp():void
Cleans up any data at the end of a frame.
EntityCollector
 Inherited
clear():void
Clears all objects in the entity collector.
EntityCollector
  
enterNode(node:NodeBase):Boolean
[override] Returns true if the current node is at least partly in the frustum.
RaycastCollector
Property Detail
rayDirectionproperty
rayDirection:Vector3D

Provides the direction vector of the ray.


Implementation
    public function get rayDirection():Vector3D
    public function set rayDirection(value:Vector3D):void
rayPositionproperty 
rayPosition:Vector3D

Provides the starting position of the ray.


Implementation
    public function get rayPosition():Vector3D
    public function set rayPosition(value:Vector3D):void
Constructor Detail
RaycastCollector()Constructor
public function RaycastCollector()

Creates a new RaycastCollector object.

Method Detail
applyRenderable()method
override public function applyRenderable(renderable:IRenderable):void

Adds an IRenderable object to the potentially visible objects.

Parameters

renderable:IRenderable — The IRenderable object to add.

applySkyBox()method 
override public function applySkyBox(renderable:IRenderable):void

Adds a skybox to the potentially visible objects.

Parameters

renderable:IRenderable — The skybox to add.

applyUnknownLight()method 
override public function applyUnknownLight(light:LightBase):void

Adds a light to the potentially visible objects.

Parameters

light:LightBase — The light to add.

enterNode()method 
override public function enterNode(node:NodeBase):Boolean

Returns 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.

Returns
Boolean