Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File 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:

List of all members.


Public Member Functions
	CullTraverser ()
	CullTraverser (const CullTraverser &copy)
void	set_scene (SceneSetup *scene_setup)
	Sets the SceneSetup object that indicates the initial camera position, etc.
SceneSetup *	get_scene () const
	Returns the SceneSetup object.
void	set_camera_mask (const DrawMask &camera_mask)
	Specifies the visibility mask from the camera viewing the scene.
const DrawMask &	get_camera_mask () const
	Returns the visibility mask from the camera viewing the scene.
const TransformState *	get_camera_transform () const
	Returns the position of the camera relative to the starting node, without any compensating coordinate-system transforms that might have been introduced for the purposes of rendering.
const TransformState *	get_render_transform () const
	Returns the position of the starting node relative to the camera, pretransformed as appropriate for rendering.
void	set_initial_state (const RenderState *initial_state)
	Sets the initial RenderState at the top of the scene graph we are traversing.
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.
void	set_depth_offset_decals (bool flag)
	Sets the depth_offset_decals flag.
bool	get_depth_offset_decals () const
	Returns the depth_offset_decals flag.
void	set_view_frustum (GeometricBoundingVolume *view_frustum)
	Specifies the bounding volume that corresponds to the view frustum.
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.
void	set_guard_band (GeometricBoundingVolume *guard_band)
	Specifies the bounding volume to use for detecting guard band clipping.
GeometricBoundingVolume *	get_guard_band () const
	Returns the bounding volume that corresponds to the guard band, or NULL if the guard band is not in use or has not been set.
void	set_cull_handler (CullHandler *cull_handler)
	Specifies the object that will receive the culled Geoms.
CullHandler *	get_cull_handler () const
	Returns the object that will receive the culled Geoms.
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.
void	traverse_below (CullTraverserData &data)
	Traverses all the children of the indicated node, with the given data, which been converted into the node's space.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
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_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96.
Private Member Functions
void	show_bounds (CullTraverserData &data)
	Draws an appropriate visualization of the node's external bounding volume.
PointerTo< Geom >	make_bounds_viz (const BoundingVolume &vol)
	Returns an appropriate visualization of the indicated bounding volume.
ConstPointerTo< RenderState >	get_bounds_outer_viz_state ()
	Returns a RenderState for rendering the outside surfaces of the bounding volume visualizations.
ConstPointerTo< RenderState >	get_bounds_inner_viz_state ()
	Returns a RenderState for rendering the inside surfaces of the bounding volume visualizations.
ConstPointerTo< RenderState >	get_depth_offset_state ()
	Returns a RenderState for increasing the DepthOffset by one.
void	start_decal (const CullTraverserData &data)
	Collects a base node and all of the decals applied to it.
CullableObject *	r_get_decals (CullTraverserData &data, CullableObject *decals)
	Recursively gets all the decals applied to a particular GeomNode.
Private Attributes
PointerTo< SceneSetup >	_scene_setup
DrawMask	_camera_mask
ConstPointerTo< RenderState >	_initial_state
bool	_depth_offset_decals
PointerTo< GeometricBoundingVolume >	_view_frustum
PointerTo< GeometricBoundingVolume >	_guard_band
CullHandler *	_cull_handler
Static Private Attributes
TypeHandle	_type_handle

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

Constructor & Destructor Documentation

CullTraverser::CullTraverser ( )

Definition at line 50 of file cullTraverser.cxx.

CullTraverser::CullTraverser ( const CullTraverser & copy )

Definition at line 66 of file cullTraverser.cxx.

Member Function Documentation

virtual TypeHandle CullTraverser::force_init_type ( void ) [inline, virtual]

Implements TypedObject.
Reimplemented in PGCullTraverser.
Definition at line 120 of file cullTraverser.h.

ConstPointerTo< RenderState > CullTraverser::get_bounds_inner_viz_state ( ) [private]

Returns a RenderState for rendering the inside surfaces of the bounding volume visualizations.

Definition at line 316 of file cullTraverser.cxx.
References PandaNode::get_children(), PandaNode::get_first_visible_child(), PandaNode::has_selective_visibility(), PandaNode::is_geom_node(), CullTraverserData::node(), and NULL.

ConstPointerTo< RenderState > CullTraverser::get_bounds_outer_viz_state ( ) [private]

Returns a RenderState for rendering the outside surfaces of the bounding volume visualizations.

Definition at line 292 of file cullTraverser.cxx.
References CPT, DepthOffsetAttrib::make(), RenderState::make(), and NULL.

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

Returns the visibility mask from the camera viewing the scene.

Definition at line 199 of file cullTraverser.I.
References _guard_band, and INLINE.

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

Returns the position of the camera relative to the starting node, without any compensating coordinate-system transforms that might have been introduced for the purposes of rendering.

Definition at line 68 of file cullTraverser.I.
References _scene_setup, and INLINE.
Referenced by LODNode::xform().

TypeHandle CullTraverser::get_class_type ( void ) [inline, static]

Reimplemented from TypedObject.
Reimplemented in PGCullTraverser.
Definition at line 109 of file cullTraverser.h.
Referenced by PGCullTraverser::get_class_type().

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

Returns the object that will receive the culled Geoms.

Definition at line 343 of file cullTraverser.I.

bool CullTraverser::get_depth_offset_decals ( ) const [inline]

Returns the depth_offset_decals flag.
See set_depth_offset_decals().
Definition at line 167 of file cullTraverser.I.
References _view_frustum, and INLINE.

ConstPointerTo< RenderState > CullTraverser::get_depth_offset_state ( ) [private]

Returns a RenderState for increasing the DepthOffset by one.

Definition at line 340 of file cullTraverser.cxx.

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

Returns the bounding volume that corresponds to the guard band, or NULL if the guard band is not in use or has not been set.
Note that the guard band 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 guard band in the current node's coordinate space, check in the current CullTraverserData.
Definition at line 313 of file cullTraverser.I.

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 131 of file cullTraverser.I.
References _camera_mask.

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

Returns the position of the starting node relative to the camera, pretransformed as appropriate for rendering.
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 render transform of the current node check in the current CullTraverserData.
Definition at line 97 of file cullTraverser.I.
References _depth_offset_decals, and INLINE.

SceneSetup * CullTraverser::get_scene ( ) const [inline]

Returns the SceneSetup object.

Definition at line 49 of file cullTraverser.I.
References _scene_setup, and INLINE.

virtual TypeHandle CullTraverser::get_type ( void ) const [inline, virtual]

Implements TypedObject.
Reimplemented in PGCullTraverser.
Definition at line 117 of file cullTraverser.h.

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

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

void CullTraverser::init_type ( void ) [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 TypedObject.
Reimplemented in PGCullTraverser.
Definition at line 112 of file cullTraverser.h.
Referenced by PGCullTraverser::get_class_type().

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

PointerTo< Geom > CullTraverser::make_bounds_viz ( const BoundingVolume & vol ) [private]

Returns an appropriate visualization of the indicated bounding volume.

Definition at line 255 of file cullTraverser.cxx.
References Colorf, CPT, CullFaceAttrib::M_cull_clockwise, RenderModeAttrib::M_wireframe, CullFaceAttrib::make(), RenderModeAttrib::make(), RenderState::make(), ColorAttrib::make_flat(), and NULL.

CullableObject * CullTraverser::r_get_decals ( CullTraverserData & data,

CullableObject * decals

) [private]

Recursively gets all the decals applied to a particular GeomNode.
These are built into a CullableObject list in LIFO order (so that the traversing the list will extract them in the order they were encountered in the scene graph).
Definition at line 435 of file cullTraverser.cxx.

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

Specifies the visibility mask from the camera viewing the scene.
Any nodes that do not have at least some bits in common with this mask will not be drawn.
Definition at line 184 of file cullTraverser.I.
References _guard_band, and INLINE.

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

void CullTraverser::set_depth_offset_decals ( bool flag ) [inline]

Sets the depth_offset_decals flag.
If this is true, decals will be rendered using DepthOffsetAttribs; otherwise, decals will be rendered with a more expensive three-pass system. This is normally set from the corresponding flag in the GSG.
Definition at line 152 of file cullTraverser.I.
References _view_frustum, and INLINE.

void CullTraverser::set_guard_band ( GeometricBoundingVolume * guard_band ) [inline]

Specifies the bounding volume to use for detecting guard band clipping.
This is a render optimization for certain cards that support this feature; the guard band is a 2-d area than the frame buffer. If a primitive will appear entirely within the guard band after perspective transform, it may be drawn correctly with clipping disabled, for a small performance gain.
This is the bounding volume that corresponds to the 2-d guard band. If a primitive is entirely within this area, clipping will be disabled on the GSG.
Definition at line 282 of file cullTraverser.I.

void CullTraverser::set_initial_state ( const RenderState * initial_state ) [inline]

Sets the initial RenderState at the top of the scene graph we are traversing.
If this is not set, the default is the empty state.
Definition at line 114 of file cullTraverser.I.
References _depth_offset_decals, and INLINE.

void CullTraverser::set_scene ( SceneSetup * scene_setup ) [inline]

Sets the SceneSetup object that indicates the initial camera position, etc.
This must be called before traversal begins.
Definition at line 36 of file cullTraverser.I.
References _scene_setup, and INLINE.

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 216 of file cullTraverser.I.
References _cull_handler, and INLINE.

void CullTraverser::show_bounds ( CullTraverserData & data ) [private]

Draws an appropriate visualization of the node's external bounding volume.

Definition at line 227 of file cullTraverser.cxx.
Referenced by traverse().

void CullTraverser::start_decal ( const CullTraverserData & data ) [private]

Collects a base node and all of the decals applied to it.
This involves recursing below the base GeomNode to find all the decal geoms.
Definition at line 365 of file cullTraverser.cxx.
References _cull_handler.

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 109 of file cullTraverser.cxx.
References NULL.

void CullTraverser::traverse ( const NodePath & root )

Begins the traversal from the indicated node.

Definition at line 86 of file cullTraverser.cxx.
References _camera_mask, CullTraverserData::apply_transform_and_state(), PandaNode::get_effects(), RenderEffects::has_show_bounds(), CullTraverserData::is_in_view(), CullTraverserData::node(), and show_bounds().
Referenced by CollisionNode::combine_with().

void CullTraverser::traverse_below ( CullTraverserData & data )

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

Definition at line 159 of file cullTraverser.cxx.
Referenced by PGTop::has_cull_callback().

Member Data Documentation

DrawMask CullTraverser::_camera_mask [private]

Definition at line 101 of file cullTraverser.h.
Referenced by get_initial_state(), and traverse().

CullHandler* CullTraverser::_cull_handler [private]

Definition at line 106 of file cullTraverser.h.
Referenced by set_view_frustum(), and start_decal().

bool CullTraverser::_depth_offset_decals [private]

Definition at line 103 of file cullTraverser.h.
Referenced by get_render_transform(), and set_initial_state().

PointerTo< GeometricBoundingVolume > CullTraverser::_guard_band [private]

Definition at line 105 of file cullTraverser.h.
Referenced by get_camera_mask(), and set_camera_mask().

ConstPointerTo< RenderState > CullTraverser::_initial_state [private]

Definition at line 102 of file cullTraverser.h.

PointerTo< SceneSetup > CullTraverser::_scene_setup [private]

Definition at line 100 of file cullTraverser.h.
Referenced by get_camera_transform(), get_scene(), and set_scene().

TypeHandle CullTraverser::_type_handle [static, private]

Reimplemented from TypedObject.
Reimplemented in PGCullTraverser.
Definition at line 39 of file cullTraverser.cxx.

PointerTo< GeometricBoundingVolume > CullTraverser::_view_frustum [private]

Definition at line 104 of file cullTraverser.h.
Referenced by get_depth_offset_decals(), and set_depth_offset_decals().

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

Generated on Fri May 2 00:49:06 2003 for Panda by

1.3

CullTraverser Class Reference

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation