Panda3D
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions

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

List of all members.

Public Member Functions

 CullTraverser (const CullTraverser &copy)
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.
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 ()
int get_best_parent_from_Set (const std::set< int > &) const
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.
int get_ref_count () const
 Returns the current reference count.
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
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
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.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
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.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
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.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
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)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void ref () const
 Explicitly increments the reference count.
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.
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.
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.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 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 ()
 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

bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
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

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

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

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

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

Definition at line 110 of file typedObject.I.

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

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().

Thread * CullTraverser::get_current_thread ( ) const [inline]
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().

GraphicsStateGuardianBase * CullTraverser::get_gsg ( ) const [inline]
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().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
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().

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 52 of file typedObject.I.

References TypeHandle::get_index().

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().

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

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().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

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 TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
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().

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 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

void ReferenceCount::local_object ( ) [inline, inherited]

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

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

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.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

void CullTraverser::traverse ( CullTraverserData data)
void CullTraverser::traverse ( const NodePath root)
void CullTraverser::traverse_below ( CullTraverserData data) [virtual]
bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations