Panda3D
Public Member Functions | Static Public Member Functions | List of all 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...

Inheritance diagram for CullTraverser:
TypedReferenceCount TypedObject ReferenceCount PipeOcclusionCullTraverser

Public Member Functions

 __init__ ()
 
 __init__ (const CullTraverser copy)
 
 drawBoundingVolume (const BoundingVolume vol, const TransformState internal_transform)
 Draws an appropriate visualization of the indicated bounding volume. More...
 
 endTraverse ()
 Should be called when the traverser has finished traversing its scene, this gives it a chance to do any necessary finalization. More...
 
const DrawMask getCameraMask ()
 Returns the visibility mask from the camera viewing the scene. More...
 
const TransformState getCameraTransform ()
 Returns the position of the camera relative to the starting node. More...
 
CullHandler getCullHandler ()
 Returns the object that will receive the culled Geoms. More...
 
Thread getCurrentThread ()
 Returns the currently-executing thread object, as passed to the CullTraverser constructor. More...
 
bool getDepthOffsetDecals ()
 Returns true, as depth offsets are the only way that we implement decals nowadays. More...
 
bool getEffectiveIncompleteRender ()
 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 getGsg ()
 Returns the GraphicsStateGuardian in effect. More...
 
const RenderState getInitialState ()
 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 getPortalClipper ()
 Returns the _portal_clipper pointer. More...
 
SceneSetup getScene ()
 Returns the SceneSetup object. More...
 
str getTagStateKey ()
 Returns the tag state key that has been specified for the scene's camera, if any. More...
 
GeometricBoundingVolume getViewFrustum ()
 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 getWorldTransform ()
 Returns the position of the starting node relative to the camera. More...
 
bool hasTagStateKey ()
 Returns true if a nonempty tag state key has been specified for the scene's camera, false otherwise. More...
 
 setCameraMask (const DrawMask camera_mask)
 Changes the visibility mask for the camera viewing the scene. More...
 
 setCullHandler (CullHandler cull_handler)
 Specifies the object that will receive the culled Geoms. More...
 
 setPortalClipper (PortalClipper portal_clipper)
 Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below may use. More...
 
 setScene (SceneSetup scene_setup, GraphicsStateGuardianBase gsg, bool dr_incomplete_render)
 Sets the SceneSetup object that indicates the initial camera position, etc. More...
 
 setViewFrustum (GeometricBoundingVolume view_frustum)
 Specifies the bounding volume that corresponds to the view frustum. More...
 
 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...
 
 traverse (const NodePath root)
 Begins the traversal from the indicated node. More...
 
 traverseBelow (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 TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static flushLevel ()
 Flushes the PStatCollectors used during traversal. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 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.

Member Function Documentation

◆ __init__() [1/2]

__init__ ( )

◆ __init__() [2/2]

__init__ ( const CullTraverser  copy)

◆ drawBoundingVolume()

drawBoundingVolume ( const BoundingVolume  vol,
const TransformState  internal_transform 
)

Draws an appropriate visualization of the indicated bounding volume.

◆ endTraverse()

endTraverse ( )

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

◆ flushLevel()

static flushLevel ( )
static

Flushes the PStatCollectors used during traversal.

◆ getCameraMask()

const DrawMask getCameraMask ( )

Returns the visibility mask from the camera viewing the scene.

◆ getCameraTransform()

const TransformState getCameraTransform ( )

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

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getCullHandler()

CullHandler getCullHandler ( )

Returns the object that will receive the culled Geoms.

◆ getCurrentThread()

Thread getCurrentThread ( )

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

◆ getDepthOffsetDecals()

bool getDepthOffsetDecals ( )

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

◆ getEffectiveIncompleteRender()

bool getEffectiveIncompleteRender ( )

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.

◆ getGsg()

Returns the GraphicsStateGuardian in effect.

◆ getInitialState()

const RenderState getInitialState ( )

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.

◆ getPortalClipper()

PortalClipper getPortalClipper ( )

Returns the _portal_clipper pointer.

◆ getScene()

SceneSetup getScene ( )

Returns the SceneSetup object.

◆ getTagStateKey()

str getTagStateKey ( )

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

◆ getViewFrustum()

GeometricBoundingVolume getViewFrustum ( )

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.

◆ getWorldTransform()

const TransformState getWorldTransform ( )

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

◆ hasTagStateKey()

bool hasTagStateKey ( )

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

◆ setCameraMask()

setCameraMask ( const DrawMask  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.

◆ setCullHandler()

setCullHandler ( CullHandler  cull_handler)

Specifies the object that will receive the culled Geoms.

This must be set before calling traverse().

◆ setPortalClipper()

setPortalClipper ( PortalClipper  portal_clipper)

Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below may use.

◆ setScene()

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

◆ setViewFrustum()

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

◆ traverse() [1/2]

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.

◆ traverse() [2/2]

traverse ( const NodePath  root)

Begins the traversal from the indicated node.

◆ traverseBelow()

traverseBelow ( CullTraverserData  data)

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