CullTraverser

from panda3d.core import CullTraverser

class CullTraverser

Bases:

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

__init__()

__init__(copy: CullTraverser)

do_traverse(data: CullTraverserData): Internal method called by traverse() and traverse_down(). Traverses the given node, assuming it has already been checked with is_in_view().

draw_bounding_volume(vol: BoundingVolume, internal_transform: TransformState): Draws an appropriate visualization of the indicated bounding volume.

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

static flush_level(): Flushes the PStatCollectors used during traversal.

get_camera_mask() → DrawMask: Returns the visibility mask from the camera viewing the scene.

get_camera_transform() → TransformState: Returns the position of the camera relative to the starting node.

static get_class_type() → TypeHandle

get_cull_handler() → CullHandler: Returns the object that will receive the culled Geoms.

get_current_thread() → Thread: Returns the currently-executing thread object, as passed to the CullTraverser constructor.

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

get_effective_incomplete_render() → bool: 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.

get_fake_view_frustum_cull() → bool: Returns true if fake view frustum culling is active.

get_gsg() → GraphicsStateGuardianBase: Returns the GraphicsStateGuardian in effect.

get_initial_state() → RenderState: 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.

get_portal_clipper() → PortalClipper: Returns the _portal_clipper pointer

get_scene() → SceneSetup: Returns the SceneSetup object.

get_tag_state_key() → str: Returns the tag state key that has been specified for the scene’s camera, if any.

get_view_frustum() → GeometricBoundingVolume

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.

get_world_transform() → TransformState

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

has_tag_state_key() → bool: Returns true if a nonempty tag state key has been specified for the scene’s camera, false otherwise.

set_camera_mask(camera_mask: DrawMask): 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.

set_cull_handler(cull_handler: CullHandler): Specifies the object that will receive the culled Geoms. This must be set before calling traverse().

set_portal_clipper(portal_clipper: PortalClipper): Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below() may use.

set_scene(scene_setup: SceneSetup, gsg: GraphicsStateGuardianBase, dr_incomplete_render: bool): Sets the SceneSetup object that indicates the initial camera position, etc. This must be called before traversal begins.

set_view_frustum(view_frustum: GeometricBoundingVolume)

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

Nowadays, this gets set automatically by set_scene().

traverse(root: NodePath): Begins the traversal from the indicated node.

traverse_below(data: CullTraverserData): Calls traverse_down on each child.