Panda3D
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
CullTraverser Class Reference

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

Public Member Functions

 CullTraverser (const CullTraverser &copy)
 
void draw_bounding_volume (const BoundingVolume *vol, const TransformState *internal_transform) const
 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 true, as depth offsets are the only way that we implement decals nowadays.
 
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 std::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.
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from MemoryBase
void operator delete (void *, void *)
 
void operator delete (void *ptr)
 
void operator delete[] (void *, void *)
 
void operator delete[] (void *ptr)
 
void * operator new (size_t size)
 
void * operator new (size_t size, void *ptr)
 
void * operator new[] (size_t size)
 
void * operator new[] (size_t size, void *ptr)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
 
void ref () const
 Explicitly increments the reference count.
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero.
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
 
virtual bool unref () const
 Explicitly decrements the reference count.
 
bool unref_if_one () const
 Atomically decreases the reference count of this object if it is one.
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object.
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object.
 

Static Public Member Functions

static void flush_level ()
 Flushes the PStatCollectors used during traversal.
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
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 Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Static Public Attributes

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

Additional Inherited Members

- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count.
 

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 45 of file cullTraverser.h.

Constructor & Destructor Documentation

◆ CullTraverser() [1/2]

CullTraverser::CullTraverser ( )

Definition at line 48 of file cullTraverser.cxx.

◆ CullTraverser() [2/2]

CullTraverser::CullTraverser ( const CullTraverser & copy)

Definition at line 64 of file cullTraverser.cxx.

Member Function Documentation

◆ draw_bounding_volume()

void CullTraverser::draw_bounding_volume ( const BoundingVolume * vol,
const TransformState * internal_transform ) const

Draws an appropriate visualization of the indicated bounding volume.

Definition at line 227 of file cullTraverser.cxx.

References CullHandler::record_object().

◆ end_traverse()

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 219 of file cullTraverser.cxx.

References CullHandler::end_traverse().

Referenced by PGTop::cull_callback(), GraphicsEngine::do_cull(), and PipeOcclusionCullTraverser::end_traverse().

◆ flush_level()

void CullTraverser::flush_level ( )
inlinestatic

Flushes the PStatCollectors used during traversal.

Definition at line 187 of file cullTraverser.I.

Referenced by GraphicsEngine::render_frame().

◆ force_init_type()

virtual TypeHandle CullTraverser::force_init_type ( )
inlinevirtual

Reimplemented from TypedReferenceCount.

Definition at line 137 of file cullTraverser.h.

◆ get_camera_mask()

const DrawMask & CullTraverser::get_camera_mask ( ) const
inline

Returns the visibility mask from the camera viewing the scene.

Definition at line 111 of file cullTraverser.I.

◆ get_camera_transform()

const TransformState * CullTraverser::get_camera_transform ( ) const
inline

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

Definition at line 60 of file cullTraverser.I.

◆ get_class_type()

static TypeHandle CullTraverser::get_class_type ( )
inlinestatic

Definition at line 126 of file cullTraverser.h.

◆ get_cull_handler()

CullHandler * CullTraverser::get_cull_handler ( ) const
inline

◆ get_current_thread()

Thread * CullTraverser::get_current_thread ( ) const
inline

Returns the currently-executing thread object, as passed to the CullTraverser constructor.

Definition at line 26 of file cullTraverser.I.

Referenced by PortalNode::cull_callback(), PipeOcclusionCullTraverser::end_traverse(), CullableObject::munge_geom(), DrawCullHandler::record_object(), and PipeOcclusionCullTraverser::set_scene().

◆ get_depth_offset_decals()

bool CullTraverser::get_depth_offset_decals ( ) const
inline

Returns true, as depth offsets are the only way that we implement decals nowadays.

Definition at line 92 of file cullTraverser.I.

◆ get_effective_incomplete_render()

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 179 of file cullTraverser.I.

◆ get_gsg()

GraphicsStateGuardianBase * CullTraverser::get_gsg ( ) const
inline

Returns the GraphicsStateGuardian in effect.

Definition at line 17 of file cullTraverser.I.

Referenced by SpeedTreeNode::cull_callback(), and CullableObject::munge_geom().

◆ get_initial_state()

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 83 of file cullTraverser.I.

◆ get_portal_clipper()

PortalClipper * CullTraverser::get_portal_clipper ( ) const
inline

Returns the _portal_clipper pointer.

Definition at line 167 of file cullTraverser.I.

Referenced by PortalNode::cull_callback().

◆ get_scene()

SceneSetup * CullTraverser::get_scene ( ) const
inline

◆ get_tag_state_key()

const std::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 52 of file cullTraverser.I.

Referenced by CullTraverserData::apply_transform_and_state().

◆ get_type()

virtual TypeHandle CullTraverser::get_type ( ) const
inlinevirtual

Reimplemented from TypedReferenceCount.

Definition at line 134 of file cullTraverser.h.

◆ get_view_frustum()

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 134 of file cullTraverser.I.

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

◆ get_world_transform()

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 74 of file cullTraverser.I.

Referenced by CPT(), and RocketRenderInterface::render().

◆ has_tag_state_key()

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 43 of file cullTraverser.I.

Referenced by CullTraverserData::apply_transform_and_state().

◆ init_type()

static void CullTraverser::init_type ( )
inlinestatic

Definition at line 129 of file cullTraverser.h.

◆ set_camera_mask()

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 103 of file cullTraverser.I.

◆ set_cull_handler()

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 143 of file cullTraverser.I.

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

◆ set_portal_clipper()

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 159 of file cullTraverser.I.

Referenced by traverse().

◆ set_scene()

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 84 of file cullTraverser.cxx.

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

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

◆ set_view_frustum()

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 120 of file cullTraverser.I.

Referenced by GraphicsEngine::do_cull().

◆ traverse() [1/2]

void CullTraverser::traverse ( const NodePath & root)

◆ traverse() [2/2]

void CullTraverser::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.

Definition at line 162 of file cullTraverser.cxx.

◆ traverse_below()

void CullTraverser::traverse_below ( CullTraverserData & data)
virtual

Member Data Documentation

◆ _geom_nodes_pcollector

PStatCollector CullTraverser::_geom_nodes_pcollector
static

Definition at line 99 of file cullTraverser.h.

◆ _geoms_occluded_pcollector

PStatCollector CullTraverser::_geoms_occluded_pcollector
static

Definition at line 101 of file cullTraverser.h.

◆ _geoms_pcollector

PStatCollector CullTraverser::_geoms_pcollector
static

Definition at line 100 of file cullTraverser.h.

◆ _nodes_pcollector

PStatCollector CullTraverser::_nodes_pcollector
static

Definition at line 98 of file cullTraverser.h.


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