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

PipeOcclusionCullTraverser Class Reference

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

Inheritance diagram for PipeOcclusionCullTraverser:
CullTraverser CullHandler TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

List of all members.

Public Member Functions

 PipeOcclusionCullTraverser (GraphicsOutput host)
 PipeOcclusionCullTraverser (PipeOcclusionCullTraverser const copy)
 drawBoundingVolume (BoundingVolume const vol, TransformState const net_transform, TransformState const modelview_transform)
 Draws an appropriate visualization of the indicated bounding volume.
 endTraverse ()
 Should be called when the traverser has finished traversing its scene, this gives it a chance to do any necessary finalization.
GraphicsOutput getBuffer ()
BitMaskunsigned const getCameraMask ()
TransformState const getCameraTransform ()
 Returns the position of the camera relative to the starting node.
CullHandler getCullHandler ()
 Returns the object that will receive the culled Geoms.
Thread getCurrentThread ()
 Returns the currently-executing thread object, as passed to the CullTraverser constructor.
bool getDepthOffsetDecals ()
 Returns the depth_offset_decals flag.
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.
GraphicsStateGuardianBase getGsg ()
 Returns the GraphicsStateGuardian in effect.
RenderState const 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.
BitMaskunsigned const getOcclusionMask ()
PortalClipper getPortalClipper ()
 Returns the _portal_clipper pointer.
int getRefCount ()
 Returns the current reference count.
SceneSetup getScene ()
 Returns the SceneSetup object.
string getTagStateKey ()
 Returns the tag state key that has been specified for the scene's camera, if any.
Texture getTexture ()
 Returns a Texture that can be used to visualize the efforts of the occlusion cull.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
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.
TransformState const getWorldTransform ()
 Returns the position of the starting node relative to the camera.
bool hasTagStateKey ()
 Returns true if a nonempty tag state key has been specified for the scene's camera, false otherwise.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
 ref ()
 Explicitly increments the reference count.
 setCameraMask (BitMaskunsigned int, 32 const camera_mask)
 Changes the visibility mask for the camera viewing the scene.
 setCullHandler (CullHandler cull_handler)
 Specifies the object that will receive the culled Geoms.
 setOcclusionMask (BitMaskunsigned int, 32 const occlusion_mask)
 Specifies the DrawMask that should be set on occlusion polygons for this scene.
 setPortalClipper (PortalClipper portal_clipper)
 Specifies _portal_clipper object pointer that subsequent traverse() or traverse_below may use.
 setScene (SceneSetup scene_setup, GraphicsStateGuardianBase gsg, bool dr_incomplete_render)
 Sets the SceneSetup object that indicates the initial camera position, etc.
 setViewFrustum (GeometricBoundingVolume view_frustum)
 Specifies the bounding volume that corresponds to the view frustum.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
 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 (NodePath const root)
 Begins the traversal from the indicated node.
 traverseBelow (CullTraverserData data)
 Traverses all the children of the indicated node, with the given data, which has been converted into the node's space.
bool unref ()
 Explicitly decrements the reference count.

Static Public Member Functions

static flushLevel ()
 Flushes the PStatCollectors used during traversal.
static TypeHandle getClassType ()

Public Attributes

BitMaskunsigned int
 Returns the DrawMask for occlusion polygons.

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.


Constructor & Destructor Documentation


Member Function Documentation

drawBoundingVolume ( BoundingVolume const  vol,
TransformState const  net_transform,
TransformState const  modelview_transform 
) [inherited]

Draws an appropriate visualization of the indicated bounding volume.

endTraverse ( )

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

Reimplemented from CullTraverser.

static flushLevel ( ) [static, inherited]

Flushes the PStatCollectors used during traversal.

GraphicsOutput getBuffer ( )
BitMaskunsigned const getCameraMask ( ) [inherited]
TransformState const getCameraTransform ( ) [inherited]

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

static TypeHandle getClassType ( ) [static]

Reimplemented from CullTraverser.

CullHandler getCullHandler ( ) [inherited]

Returns the object that will receive the culled Geoms.

Thread getCurrentThread ( ) [inherited]

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

bool getDepthOffsetDecals ( ) [inherited]

Returns the depth_offset_decals flag.

See set_depth_offset_decals().

bool getEffectiveIncompleteRender ( ) [inherited]

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 getGsg ( ) [inherited]

Returns the GraphicsStateGuardian in effect.

RenderState const getInitialState ( ) [inherited]

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.

BitMaskunsigned const getOcclusionMask ( )
PortalClipper getPortalClipper ( ) [inherited]

Returns the _portal_clipper pointer.

int getRefCount ( ) [inherited]

Returns the current reference count.

SceneSetup getScene ( ) [inherited]

Returns the SceneSetup object.

string getTagStateKey ( ) [inherited]

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

Texture getTexture ( )

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

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [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().

GeometricBoundingVolume getViewFrustum ( ) [inherited]

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 getWorldTransform ( ) [inherited]

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 hasTagStateKey ( ) [inherited]

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

bool isExactType ( TypeHandle  handle) [inherited]

Returns true if the current object is the indicated type exactly.

bool isOfType ( TypeHandle  handle) [inherited]

Returns true if the current object is or derives from the indicated type.

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

setCameraMask ( BitMaskunsigned  int,
32 const  camera_mask 
) [inherited]

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 ( CullHandler  cull_handler) [inherited]

Specifies the object that will receive the culled Geoms.

This must be set before calling traverse().

setOcclusionMask ( BitMaskunsigned  int,
32 const  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.

setPortalClipper ( PortalClipper  portal_clipper) [inherited]

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

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.

Reimplemented from CullTraverser.

setViewFrustum ( GeometricBoundingVolume  view_frustum) [inherited]

Specifies the bounding volume that corresponds to the view frustum.

Any primitives that fall entirely outside of this volume are not drawn.

bool testRefCountIntegrity ( ) [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.

bool testRefCountNonzero ( ) [inherited]

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

Returns true if ok, false otherwise.

traverse ( CullTraverserData  data) [inherited]

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 ( NodePath const  root) [inherited]

Begins the traversal from the indicated node.

traverseBelow ( CullTraverserData  data) [inherited]

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

bool unref ( ) [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, and GeomVertexFormat.


Member Data Documentation

BitMaskunsigned int

Returns the DrawMask for occlusion polygons.

See set_occlusion_mask().

Reimplemented from CullTraverser.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties