CullTraverser

class CullTraverser

Bases: TypedReferenceCount

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.

Inheritance diagram

CullTraverser(void)

CullTraverser(CullTraverser const &copy)

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

Draws an appropriate visualization of the indicated bounding volume.

virtual void end_traverse(void)

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

void flush_level(void)

Flushes the PStatCollectors used during traversal.

DrawMask const &get_camera_mask(void) const

Returns the visibility mask from the camera viewing the scene.

TransformState const *get_camera_transform(void) const

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

static TypeHandle get_class_type(void)

CullHandler *get_cull_handler(void) const

Returns the object that will receive the culled Geoms.

Thread *get_current_thread(void) const

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

bool get_depth_offset_decals(void) const

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

bool get_effective_incomplete_render(void) 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. This returns the flag during the cull traversal; see GSG::get_effective_incomplete_render() for this same flag during the draw traversal.

GraphicsStateGuardianBase *get_gsg(void) const

Returns the GraphicsStateGuardian in effect.

RenderState const *get_initial_state(void) 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.

PortalClipper *get_portal_clipper(void) const

Returns the _portal_clipper pointer

SceneSetup *get_scene(void) const

Returns the SceneSetup object.

std::string const &get_tag_state_key(void) const

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

GeometricBoundingVolume *get_view_frustum(void) 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.

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.

TransformState const *get_world_transform(void) const

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

bool has_tag_state_key(void) const

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

void set_camera_mask(DrawMask const &camera_mask)

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.

void set_cull_handler(CullHandler *cull_handler)

Specifies the object that will receive the culled Geoms. This must be set before calling traverse().

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. This must be called before traversal begins.

void set_view_frustum(GeometricBoundingVolume *view_frustum)

Specifies the bounding volume that corresponds to the view frustum. Any primitives that fall entirely outside of this volume are not drawn.

void traverse(NodePath const &root)

void traverse(CullTraverserData &data)

Begins the traversal from the indicated node.

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.