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:

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

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

virtual TypeHandle	force_init_type ()

const DrawMask &	get_camera_mask () const
	Returns the visibility mask from the camera viewing the scene. More...

const TransformState *	get_camera_transform () const
	Returns the position of the camera relative to the starting node. More...

CullHandler *	get_cull_handler () const
	Returns the object that will receive the culled Geoms. More...

Thread *	get_current_thread () const
	Returns the currently-executing thread object, as passed to the CullTraverser constructor. More...

bool	get_depth_offset_decals () const
	Returns true, as depth offsets are the only way that we implement decals nowadays. More...

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

GraphicsStateGuardianBase *	get_gsg () const
	Returns the GraphicsStateGuardian in effect. More...

const RenderState *	get_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. More...

PortalClipper *	get_portal_clipper () const
	Returns the _portal_clipper pointer. More...

SceneSetup *	get_scene () const
	Returns the SceneSetup object. More...

const std::string &	get_tag_state_key () const
	Returns the tag state key that has been specified for the scene's camera, if any. More...

virtual TypeHandle	get_type () const

GeometricBoundingVolume *	get_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. More...

const TransformState *	get_world_transform () const
	Returns the position of the starting node relative to the camera. More...

bool	has_tag_state_key () const
	Returns true if a nonempty tag state key has been specified for the scene's camera, false otherwise. More...

void	set_camera_mask (const DrawMask &camera_mask)
	Changes the visibility mask for the camera viewing the scene. More...

void	set_cull_handler (CullHandler *cull_handler)
	Specifies the object that will receive the culled Geoms. More...

void	set_portal_clipper (PortalClipper *portal_clipper)
	Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below may use. More...

virtual void	set_scene (SceneSetup scene_setup, GraphicsStateGuardianBase gsg, bool dr_incomplete_render)
	Sets the SceneSetup object that indicates the initial camera position, etc. More...

void	set_view_frustum (GeometricBoundingVolume *view_frustum)
	Specifies the bounding volume that corresponds to the view frustum. More...

void	traverse (const NodePath &root)
	Begins the traversal from the indicated node. More...

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

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

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

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

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

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly. More...

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type. More...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus. More...

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

virtual bool	unref () const
	Explicitly decrements the reference count. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Static Public Member Functions
static void	flush_level ()
	Flushes the PStatCollectors used during traversal. More...

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

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

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.

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

References CullHandler::end_traverse().

Referenced by PipeOcclusionCullTraverser::end_traverse().

◆ flush_level()

void CullTraverser::flush_level ( )

inlinestatic

Flushes the PStatCollectors used during traversal.

Definition at line 188 of file cullTraverser.I.

◆ get_camera_mask()

const DrawMask & CullTraverser::get_camera_mask ( ) const

inline

Returns the visibility mask from the camera viewing the scene.

Definition at line 112 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 61 of file cullTraverser.I.

◆ get_cull_handler()

CullHandler * CullTraverser::get_cull_handler ( ) const

inline

Returns the object that will receive the culled Geoms.

Definition at line 152 of file cullTraverser.I.

Referenced by NodeCullCallbackData::upcall().

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

Referenced by PipeOcclusionCullTraverser::end_traverse(), and DrawCullHandler::record_object().

◆ 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 93 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 180 of file cullTraverser.I.

◆ get_gsg()

GraphicsStateGuardianBase * CullTraverser::get_gsg ( ) const

inline

Returns the GraphicsStateGuardian in effect.

Definition at line 18 of file cullTraverser.I.

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

◆ get_portal_clipper()

PortalClipper * CullTraverser::get_portal_clipper ( ) const

inline

Returns the _portal_clipper pointer.

Definition at line 168 of file cullTraverser.I.

◆ get_scene()

SceneSetup * CullTraverser::get_scene ( ) const

inline

Returns the SceneSetup object.

Definition at line 35 of file cullTraverser.I.

Referenced by CullTraverserData::apply_transform_and_state().

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

Referenced by CullTraverserData::apply_transform_and_state().

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

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

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

Referenced by CullTraverserData::apply_transform_and_state().

◆ 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 104 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 144 of file cullTraverser.I.

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

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

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

Referenced by 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 121 of file cullTraverser.I.

◆ traverse() [1/2]

void CullTraverser::traverse ( const NodePath & root )

Begins the traversal from the indicated node.

Definition at line 106 of file cullTraverser.cxx.

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

◆ traverse_below()

void CullTraverser::traverse_below ( CullTraverserData & data )

virtual

Traverses all the children of the indicated node, with the given data, which has been converted into the node's space.

Definition at line 172 of file cullTraverser.cxx.

Referenced by NodeCullCallbackData::upcall().

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

panda/src/pgraph/cullTraverser.h
panda/src/pgraph/cullTraverser.cxx
panda/src/pgraph/cullTraverser.I

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ draw_bounding_volume()

◆ end_traverse()

◆ flush_level()

◆ get_camera_mask()

◆ get_camera_transform()

◆ get_cull_handler()

◆ get_current_thread()

◆ get_depth_offset_decals()

◆ get_effective_incomplete_render()

◆ get_gsg()

◆ get_initial_state()

◆ get_portal_clipper()

◆ get_scene()

◆ get_tag_state_key()

◆ get_view_frustum()

◆ get_world_transform()

◆ has_tag_state_key()

◆ set_camera_mask()

◆ set_cull_handler()

◆ set_portal_clipper()

◆ set_scene()

◆ set_view_frustum()

◆ traverse() [1/2]

◆ traverse() [2/2]

◆ traverse_below()