This object performs a depth-first traversal of the scene graph, with optional view-frustum culling, collecting CullState and searching for GeomNodes. More...

#include "cullTraverser.h"

Inheritance diagram for CullTraverser:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase PGCullTraverser PipeOcclusionCullTraverser

List of all members.

Public Member Functions

 CullTraverser (const CullTraverser &copy)
void draw_bounding_volume (const BoundingVolume *vol, const TransformState *net_transform, const TransformState *modelview_transform)
 Draws an appropriate visualization of the indicated bounding volume.
virtual void end_traverse ()
 Should be called when the traverser has finished traversing its scene, this gives it a chance to do any necessary finalization.
virtual TypeHandle force_init_type ()
const DrawMaskget_camera_mask () const
 Returns the visibility mask from the camera viewing the scene.
const TransformStateget_camera_transform () const
 Returns the position of the camera relative to the starting node.
CullHandlerget_cull_handler () const
 Returns the object that will receive the culled Geoms.
Threadget_current_thread () const
 Returns the currently-executing thread object, as passed to the CullTraverser constructor.
bool get_depth_offset_decals () const
 Returns the depth_offset_decals flag.
bool get_effective_incomplete_render () const
 Returns true if the cull traversal is effectively in incomplete_render state, considering both the GSG's incomplete_render and the current DisplayRegion's incomplete_render flags.
GraphicsStateGuardianBaseget_gsg () const
 Returns the GraphicsStateGuardian in effect.
const RenderStateget_initial_state () const
 Returns the initial RenderState at the top of the scene graph we are traversing, or the empty state if the initial state was never set.
PortalClipperget_portal_clipper () const
 Returns the _portal_clipper pointer.
SceneSetupget_scene () const
 Returns the SceneSetup object.
const string & get_tag_state_key () const
 Returns the tag state key that has been specified for the scene's camera, if any.
virtual TypeHandle get_type () const
GeometricBoundingVolumeget_view_frustum () const
 Returns the bounding volume that corresponds to the view frustum, or NULL if the view frustum is not in use or has not been set.
const TransformStateget_world_transform () const
 Returns the position of the starting node relative to the camera.
bool has_tag_state_key () const
 Returns true if a nonempty tag state key has been specified for the scene's camera, false otherwise.
void set_camera_mask (const DrawMask &camera_mask)
 Changes the visibility mask for the camera viewing the scene.
void set_cull_handler (CullHandler *cull_handler)
 Specifies the object that will receive the culled Geoms.
void set_portal_clipper (PortalClipper *portal_clipper)
 Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below may use.
virtual void set_scene (SceneSetup *scene_setup, GraphicsStateGuardianBase *gsg, bool dr_incomplete_render)
 Sets the SceneSetup object that indicates the initial camera position, etc.
void set_view_frustum (GeometricBoundingVolume *view_frustum)
 Specifies the bounding volume that corresponds to the view frustum.
void traverse (const NodePath &root)
 Begins the traversal from the indicated node.
void traverse (CullTraverserData &data)
 Traverses from the next node with the given data, which has been constructed with the node but has not yet been converted into the node's space.
virtual void traverse_below (CullTraverserData &data)
 Traverses all the children of the indicated node, with the given data, which has been converted into the node's space.

Static Public Member Functions

static void flush_level ()
 Flushes the PStatCollectors used during traversal.
static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Static Public Attributes

static PStatCollector _geom_nodes_pcollector
static PStatCollector _geoms_occluded_pcollector
static PStatCollector _geoms_pcollector
static PStatCollector _nodes_pcollector

Protected Member Functions

virtual bool is_in_view (CullTraverserData &data)
 Returns true if the current node is fully or partially within the viewing area and should be drawn, or false if it (and all of its children) should be pruned.

Detailed Description

This object performs a depth-first traversal of the scene graph, with optional view-frustum culling, collecting CullState and searching for GeomNodes.

Each renderable Geom encountered is passed along with its associated RenderState to the CullHandler object.

Definition at line 47 of file cullTraverser.h.


Member Function Documentation

void CullTraverser::draw_bounding_volume ( const BoundingVolume vol,
const TransformState net_transform,
const TransformState modelview_transform 
)

Draws an appropriate visualization of the indicated bounding volume.

Definition at line 314 of file cullTraverser.cxx.

References get_gsg(), and CullHandler::record_object().

void CullTraverser::end_traverse ( ) [virtual]

Should be called when the traverser has finished traversing its scene, this gives it a chance to do any necessary finalization.

Reimplemented in PipeOcclusionCullTraverser.

Definition at line 303 of file cullTraverser.cxx.

References CullHandler::end_traverse().

Referenced by PGTop::cull_callback().

void CullTraverser::flush_level ( ) [inline, static]

Flushes the PStatCollectors used during traversal.

Definition at line 242 of file cullTraverser.I.

Referenced by GraphicsEngine::render_frame().

const DrawMask & CullTraverser::get_camera_mask ( ) const [inline]

Returns the visibility mask from the camera viewing the scene.

Definition at line 143 of file cullTraverser.I.

Referenced by CullTraverserData::is_this_node_hidden().

const TransformState * CullTraverser::get_camera_transform ( ) const [inline]

Returns the position of the camera relative to the starting node.

Definition at line 76 of file cullTraverser.I.

Referenced by BillboardEffect::cull_callback(), and traverse().

CullHandler * CullTraverser::get_cull_handler ( ) const [inline]

Returns the object that will receive the culled Geoms.

Definition at line 196 of file cullTraverser.I.

Referenced by CallbackNode::add_for_draw(), GeomNode::add_for_draw(), PlaneNode::cull_callback(), PipeOcclusionCullTraverser::set_scene(), and NodeCullCallbackData::upcall().

bool CullTraverser::get_depth_offset_decals ( ) const [inline]

Returns the depth_offset_decals flag.

See set_depth_offset_decals().

Definition at line 117 of file cullTraverser.I.

bool CullTraverser::get_effective_incomplete_render ( ) const [inline]

Returns true if the cull traversal is effectively in incomplete_render state, considering both the GSG's incomplete_render and the current DisplayRegion's incomplete_render flags.

This returns the flag during the cull traversal; see GSG::get_effective_incomplete_render() for this same flag during the draw traversal.

Definition at line 232 of file cullTraverser.I.

Referenced by CullResult::add_object().

const RenderState * CullTraverser::get_initial_state ( ) const [inline]

Returns the initial RenderState at the top of the scene graph we are traversing, or the empty state if the initial state was never set.

Definition at line 106 of file cullTraverser.I.

PortalClipper * CullTraverser::get_portal_clipper ( ) const [inline]

Returns the _portal_clipper pointer.

Definition at line 216 of file cullTraverser.I.

Referenced by PortalNode::cull_callback().

SceneSetup * CullTraverser::get_scene ( ) const [inline]
const string & CullTraverser::get_tag_state_key ( ) const [inline]

Returns the tag state key that has been specified for the scene's camera, if any.

Definition at line 65 of file cullTraverser.I.

Referenced by CullTraverserData::apply_transform_and_state().

GeometricBoundingVolume * CullTraverser::get_view_frustum ( ) const [inline]

Returns the bounding volume that corresponds to the view frustum, or NULL if the view frustum is not in use or has not been set.

Note that the view frustum returned here is always in the coordinate space of the starting node, not the current node, even if it is sampled during a traversal. To get the view frustum in the current node's coordinate space, check in the current CullTraverserData.

Definition at line 174 of file cullTraverser.I.

Referenced by PortalNode::cull_callback(), and PipeOcclusionCullTraverser::set_scene().

const TransformState * CullTraverser::get_world_transform ( ) const [inline]

Returns the position of the starting node relative to the camera.

This is the inverse of the camera transform.

Note that this value is always the position of the starting node, not the current node, even if it is sampled during a traversal. To get the transform of the current node use CullTraverserData::get_modelview_transform().

Definition at line 94 of file cullTraverser.I.

bool CullTraverser::has_tag_state_key ( ) const [inline]

Returns true if a nonempty tag state key has been specified for the scene's camera, false otherwise.

Definition at line 54 of file cullTraverser.I.

Referenced by CullTraverserData::apply_transform_and_state().

static void CullTraverser::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedReferenceCount.

Reimplemented in PipeOcclusionCullTraverser, and PGCullTraverser.

Definition at line 134 of file cullTraverser.h.

References TypedReferenceCount::init_type().

Referenced by PGCullTraverser::init_type(), and PipeOcclusionCullTraverser::init_type().

bool CullTraverser::is_in_view ( CullTraverserData data) [protected, virtual]

Returns true if the current node is fully or partially within the viewing area and should be drawn, or false if it (and all of its children) should be pruned.

Reimplemented in PipeOcclusionCullTraverser.

Definition at line 342 of file cullTraverser.cxx.

References CullTraverserData::is_in_view().

Referenced by PipeOcclusionCullTraverser::is_in_view(), and traverse().

void CullTraverser::set_camera_mask ( const DrawMask camera_mask) [inline]

Changes the visibility mask for the camera viewing the scene.

This is normally set automatically at the time setup_scene() is called; you should change this only if you want to render some set of objects different from what the camera normally would draw.

Definition at line 132 of file cullTraverser.I.

void CullTraverser::set_cull_handler ( CullHandler cull_handler) [inline]

Specifies the object that will receive the culled Geoms.

This must be set before calling traverse().

Definition at line 185 of file cullTraverser.I.

Referenced by GraphicsEngine::do_cull(), and PipeOcclusionCullTraverser::set_scene().

void CullTraverser::set_portal_clipper ( PortalClipper portal_clipper) [inline]

Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below may use.

Definition at line 206 of file cullTraverser.I.

Referenced by traverse().

void CullTraverser::set_scene ( SceneSetup scene_setup,
GraphicsStateGuardianBase gsg,
bool  dr_incomplete_render 
) [virtual]

Sets the SceneSetup object that indicates the initial camera position, etc.

This must be called before traversal begins.

Reimplemented in PipeOcclusionCullTraverser.

Definition at line 94 of file cullTraverser.cxx.

References Camera::get_camera_mask(), SceneSetup::get_camera_node(), get_current_thread(), SceneSetup::get_initial_state(), and Camera::get_tag_state_key().

void CullTraverser::set_view_frustum ( GeometricBoundingVolume view_frustum) [inline]

Specifies the bounding volume that corresponds to the view frustum.

Any primitives that fall entirely outside of this volume are not drawn.

Definition at line 155 of file cullTraverser.I.


The documentation for this class was generated from the following files: