---

CullBin Class Reference

A collection of Geoms and their associated state, for a particular scene. More...

#include <cullBin.h>

Inheritance diagram for CullBin:

List of all members.

Public Member Functions
	CullBin (GraphicsStateGuardianBase *gsg)
virtual	~CullBin ()
virtual PointerTo< CullBin >	make_next () const
	Returns a newly-allocated CullBin object that contains a copy of just the subset of the data from this CullBin object that is worth keeping around for next frame.
virtual void	add_object (CullableObject *object)=0
	Adds a geom, along with its associated state, to the bin for rendering.
virtual void	finish_cull ()
	Called after all the geoms have been added, this indicates that the cull process is finished for this frame and gives the bins a chance to do any post-processing (like sorting) before moving on to draw.
virtual void	draw ()=0
	Draws all the geoms in the bin, in the appropriate order.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Protected Attributes
GraphicsStateGuardianBase *	_gsg
Static Private Attributes
TypeHandle	_type_handle

---

Detailed Description

A collection of Geoms and their associated state, for a particular scene.

The cull traversal (and the BinCullHandler) assigns Geoms to bins as it comes across them.

This is an abstract base class; derived classes like CullBinStateSorted and CullBinBackToFront provide the actual implementation.

Definition at line 54 of file cullBin.h.

---

Constructor & Destructor Documentation

CullBin::CullBin (  GraphicsStateGuardianBase *  gsg  )  [inline]

Definition at line 32 of file cullBin.I.

CullBin::~CullBin (   )  [virtual]

Definition at line 36 of file cullBin.cxx. References NULL.

---

Member Function Documentation

void CullBin::add_object (  CullableObject *  object  )  [pure virtual]

Adds a geom, along with its associated state, to the bin for rendering. Implemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 79 of file cullBin.cxx. Referenced by CullResult::add_object().

void CullBin::draw (   )  [pure virtual]

Draws all the geoms in the bin, in the appropriate order. Implemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 113 of file cullBin.cxx.

void CullBin::finish_cull (   )  [virtual]

Called after all the geoms have been added, this indicates that the cull process is finished for this frame and gives the bins a chance to do any post-processing (like sorting) before moving on to draw. Reimplemented in CullBinBackToFront, CullBinFixed, and CullBinFrontToBack. Definition at line 99 of file cullBin.cxx.

virtual TypeHandle CullBin::force_init_type (  void   )  [inline, virtual]

Reimplemented from TypedReferenceCount. Reimplemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 81 of file cullBin.h.

TypeHandle CullBin::get_class_type (  void   )  [inline, static]

Reimplemented from TypedReferenceCount. Reimplemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 70 of file cullBin.h. Referenced by CullBinFrontToBack::get_class_type().

int ReferenceCount::get_ref_count (   )  const [inline, inherited]

Returns the current reference count. Definition at line 183 of file referenceCount.I. Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle CullBin::get_type (  void   )  const [inline, virtual]

Reimplemented from TypedReferenceCount. Reimplemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 78 of file cullBin.h.

int TypedObject::get_type_index (   )  const [inline, 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(). Definition at line 71 of file typedObject.I. References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

void CullBin::init_type (  void   )  [inline, static]

Reimplemented from TypedReferenceCount. Reimplemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 73 of file cullBin.h. Referenced by CullBinFrontToBack::get_class_type().

bool TypedObject::is_exact_type (  TypeHandle  handle  )  const [inline, inherited]

Returns true if the current object is the indicated type exactly. Definition at line 101 of file typedObject.I. Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type (  TypeHandle  handle  )  const [inline, inherited]

Returns true if the current object is or derives from the indicated type. Definition at line 86 of file typedObject.I. Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

PointerTo< CullBin > CullBin::make_next (   )  const [virtual]

Returns a newly-allocated CullBin object that contains a copy of just the subset of the data from this CullBin object that is worth keeping around for next frame. If a particular CullBin object has no data worth preserving till next frame, it is acceptable to return NULL (which is the default behavior of this method). Definition at line 64 of file cullBin.cxx.

int ReferenceCount::ref (   )  const [inline, 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. The return value is the new reference count. Definition at line 225 of file referenceCount.I. Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

void ReferenceCount::test_ref_count_integrity (   )  const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus. Definition at line 328 of file referenceCount.I. References INLINE. Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref (   )  const [inline, 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; plus, we don't have a virtual destructor anyway.) 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 the new reference count. Definition at line 293 of file referenceCount.I. References INLINE. Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

---

Member Data Documentation

GraphicsStateGuardianBase* CullBin::_gsg [protected]

Definition at line 67 of file cullBin.h. Referenced by CullBinUnsorted::add_object(), CullBinFrontToBack::add_object(), and CullBinBackToFront::add_object().

TypeHandle CullBin::_type_handle [static, private]

Reimplemented from TypedReferenceCount. Reimplemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, and CullBinUnsorted. Definition at line 25 of file cullBin.cxx.

---

The documentation for this class was generated from the following files:

• panda/src/pgraph/cullBin.h
• panda/src/pgraph/cullBin.cxx
• panda/src/pgraph/cullBin.I

---