Panda3D
Public Member Functions | Static Public Member Functions | List of all members
PipeOcclusionCullTraverser Class Reference

This specialization of CullTraverser uses the graphics pipe itself to perform occlusion culling. More...

Inheritance diagram for PipeOcclusionCullTraverser:
CullTraverser TypedReferenceCount TypedObject ReferenceCount

Public Member Functions

 __init__ (GraphicsOutput host)
 
 endTraverse ()
 Should be called when the traverser has finished traversing its scene, this gives it a chance to do any necessary finalization. More...
 
GraphicsOutput getBuffer ()
 
const DrawMask getOcclusionMask ()
 Returns the DrawMask for occlusion polygons. More...
 
Texture getTexture ()
 Returns a Texture that can be used to visualize the efforts of the occlusion cull. More...
 
 setOcclusionMask (const DrawMask occlusion_mask)
 Specifies the DrawMask that should be set on occlusion polygons for this scene. More...
 
 setScene (SceneSetup scene_setup, GraphicsStateGuardianBase gsg, bool dr_incomplete_render)
 
- Public Member Functions inherited from CullTraverser
 __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 TypeHandle getClassType ()
 
- Static Public Member Functions inherited from CullTraverser
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 specialization of CullTraverser uses the graphics pipe itself to perform occlusion culling.

As such, it's likely to be inefficient (since it interferes with the pipe's normal mode of rendering), and is mainly useful to test other, CPU-based occlusion algorithms.

This cannot be used in a multithreaded pipeline environment where cull and draw are operating simultaneously.

It can't be defined in the cull subdirectory, because it needs access to GraphicsPipe and DisplayRegion and other classes in display. So we put it in grutil instead, for lack of any better ideas.

Member Function Documentation

◆ __init__()

__init__ ( GraphicsOutput  host)

◆ endTraverse()

endTraverse ( )

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

◆ getBuffer()

GraphicsOutput getBuffer ( )

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getOcclusionMask()

const DrawMask getOcclusionMask ( )

Returns the DrawMask for occlusion polygons.

See set_occlusion_mask().

◆ getTexture()

Texture getTexture ( )

Returns a Texture that can be used to visualize the efforts of the occlusion cull.

◆ setOcclusionMask()

setOcclusionMask ( const DrawMask  occlusion_mask)

Specifies the DrawMask that should be set on occlusion polygons for this scene.

This identifies the polygons that are to be treated as occluders. Polygons that do not have this draw mask set will not be considered occluders.

◆ setScene()

setScene ( SceneSetup  scene_setup,
GraphicsStateGuardianBase  gsg,
bool  dr_incomplete_render 
)