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

#include "cullBin.h"

Inheritance diagram for CullBin:

Public Member Functions
	CullBin (const std::string &name, BinType bin_type, GraphicsStateGuardianBase *gsg, const PStatCollector &draw_region_pcollector)

virtual void	add_object (CullableObject object, Thread current_thread)=0

virtual void	draw (bool force, Thread *current_thread)=0

virtual void	finish_cull (SceneSetup scene_setup, Thread current_thread)
	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 TypeHandle	force_init_type ()

BinType	get_bin_type () const

const LColor &	get_flash_color () const

const std::string &	get_name () const

virtual TypeHandle	get_type () const

bool	has_flash_color () const

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.

PointerTo< PandaNode >	make_result_graph ()
	Returns a special scene graph constructed to represent the results of the cull.

Public Member Functions inherited from TypedReferenceCount
	TypedReferenceCount (const TypedReferenceCount &copy)

void	operator= (const TypedReferenceCount &copy)

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer.

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer.

int	get_best_parent_from_Set (const std::set< int > &) const

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_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from MemoryBase
void	operator delete (void , void )

void	operator delete (void *ptr)

void	operator delete[] (void , void )

void	operator delete[] (void *ptr)

void *	operator new (size_t size)

void *	operator new (size_t size, void *ptr)

void *	operator new[] (size_t size)

void *	operator new[] (size_t size, void *ptr)

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object.

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

void	ref () const
	Explicitly increments the reference count.

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero.

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.

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

virtual bool	unref () const
	Explicitly decrements the reference count.

bool	unref_if_one () const
	Atomically decreases the reference count of this object if it is one.

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object.

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object.

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

static void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96.

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Additional Inherited Members
Public Types inherited from CullBinEnums
enum	BinType { BT_invalid , BT_unsorted , BT_state_sorted , BT_back_to_front , BT_front_to_back , BT_fixed }

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count.

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 40 of file cullBin.h.

Constructor & Destructor Documentation

◆ CullBin()

CullBin::CullBin	(	const std::string &	name,
		CullBin::BinType	bin_type,
		GraphicsStateGuardianBase *	gsg,
		const PStatCollector &	draw_region_pcollector )

inline

Definition at line 30 of file cullBin.I.

◆ ~CullBin()

CullBin::~CullBin ( )

virtual

Definition at line 29 of file cullBin.cxx.

Member Function Documentation

◆ add_object()

virtual void CullBin::add_object	(	CullableObject *	object,
		Thread *	current_thread )

pure virtual

Implemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, CullBinStateSorted, and CullBinUnsorted.

◆ draw()

virtual void CullBin::draw	(	bool	force,
		Thread *	current_thread )

pure virtual

Implemented in CullBinBackToFront, CullBinFixed, CullBinFrontToBack, CullBinStateSorted, and CullBinUnsorted.

◆ finish_cull()

void CullBin::finish_cull	(	SceneSetup *	scene_setup,
		Thread *	current_thread )

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, CullBinFrontToBack, and CullBinStateSorted.

Definition at line 52 of file cullBin.cxx.

Referenced by CullResult::finish_cull().

◆ force_init_type()

virtual TypeHandle CullBin::force_init_type ( )

inlinevirtual

Reimplemented from TypedReferenceCount.

Definition at line 109 of file cullBin.h.

◆ get_bin_type()

CullBin::BinType CullBin::get_bin_type ( ) const

inline

Definition at line 53 of file cullBin.I.

◆ get_class_type()

static TypeHandle CullBin::get_class_type ( )

inlinestatic

Definition at line 98 of file cullBin.h.

◆ get_name()

const std::string & CullBin::get_name ( ) const

inline

Definition at line 45 of file cullBin.I.

◆ get_type()

virtual TypeHandle CullBin::get_type ( ) const

inlinevirtual

Reimplemented from TypedReferenceCount.

Definition at line 106 of file cullBin.h.

◆ init_type()

static void CullBin::init_type ( )

inlinestatic

Definition at line 101 of file cullBin.h.

◆ make_next()

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 42 of file cullBin.cxx.

Referenced by CullResult::make_next().

◆ make_result_graph()

PointerTo< PandaNode > CullBin::make_result_graph ( )

Returns a special scene graph constructed to represent the results of the cull.

This will be a single node with a list of GeomNode children, which represent the various geom objects discovered by the cull.

This is useful mainly for high-level debugging and abstraction tools; it should not be mistaken for the low-level cull result itself. For the low- level cull result, use draw() to efficiently draw the culled scene.

Definition at line 65 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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CullBin()

◆ ~CullBin()

Member Function Documentation

◆ add_object()

◆ draw()

◆ finish_cull()

◆ force_init_type()

◆ get_bin_type()

◆ get_class_type()

◆ get_name()

◆ get_type()

◆ init_type()

◆ make_next()

◆ make_result_graph()