Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

EggBinMaker Class Reference

This is a handy class for collecting related nodes together. More...

#include <eggBinMaker.h>

Inheritance diagram for EggBinMaker:


Public Member Functions
	EggBinMaker ()
	~EggBinMaker ()
int	make_bins (EggGroupNode *root_group)
	The main entry point to EggBinMaker.
virtual int	get_bin_number (const EggNode *node)=0
virtual bool	sorts_less (int bin_number, const EggNode a, const EggNode b)
	May be overridden in derived classes to create additional bins within a particular bin number, based on some arbitrary property of nodes.
virtual bool	collapse_group (const EggGroup *group, int bin_number)
	May be overridden in derived classes to specify whether a particular group node, apparently redundant, may be safely collapsed out.
virtual string	get_bin_name (int bin_number)
	May be overridden in derived classes to define a name for each new bin, based on its bin number.
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 ()
Private Types
typedef pmultiset< PointerTo< EggNode >, EggBinMakerCompareNodes >	SortedNodes
typedef pmap< EggGroupNode *, SortedNodes >	GroupNodes
typedef pvector< PointerTo< EggNode > >	Nodes
typedef pvector< Nodes >	Bins
Private Member Functions
void	collect_nodes (EggGroupNode *group)
	Walks the egg scene graph, identifying nodes to be binned and moving them from the scene graph into the internal bin structure.
int	get_bins_for_group (GroupNodes::const_iterator gi)
	Breaks the set of nodes for a given group up into individual bins.
void	make_bins_for_group (EggGroupNode *group, const Bins &bins)
	Creates the EggBin nodes indicated by the internal bin structure for each group.
void	setup_bin (EggBin *bin, const Nodes &nodes)
	Sets up a recently-created EggBin structure with all of its children.
Private Attributes
GroupNodes	_group_nodes
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

This is a handy class for collecting related nodes together.

It is an abstract class; to use it you must subclass off of it. See the somewhat lengthy comment above.

Definition at line 266 of file eggBinMaker.h.

Member Typedef Documentation

typedef pvector<Nodes> EggBinMaker::Bins [private]

Definition at line 297 of file eggBinMaker.h.

typedef pmap<EggGroupNode *, SortedNodes> EggBinMaker::GroupNodes [private]

Definition at line 291 of file eggBinMaker.h.

typedef pvector< PointerTo< EggNode > > EggBinMaker::Nodes [private]

Definition at line 296 of file eggBinMaker.h.

typedef pmultiset<PointerTo< EggNode >, EggBinMakerCompareNodes> EggBinMaker::SortedNodes [private]

Definition at line 290 of file eggBinMaker.h.
Referenced by collapse_group().

Constructor & Destructor Documentation

EggBinMaker::EggBinMaker ( )

Definition at line 70 of file eggBinMaker.cxx.

EggBinMaker::~EggBinMaker ( )

Definition at line 82 of file eggBinMaker.cxx.
References _group_nodes.

Member Function Documentation

bool EggBinMaker::collapse_group ( const EggGroup * group,

int bin_number

) [virtual]

May be overridden in derived classes to specify whether a particular group node, apparently redundant, may be safely collapsed out.

Reimplemented in EggBinner.
Definition at line 153 of file eggBinMaker.cxx.
References _group_nodes, and SortedNodes.
Referenced by get_bins_for_group().

void EggBinMaker::collect_nodes ( EggGroupNode * group ) [private]

Walks the egg scene graph, identifying nodes to be binned and moving them from the scene graph into the internal bin structure.

Definition at line 185 of file eggBinMaker.cxx.

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

Reimplemented from EggObject.
Definition at line 320 of file eggBinMaker.h.

string EggBinMaker::get_bin_name ( int bin_number ) [virtual]

May be overridden in derived classes to define a name for each new bin, based on its bin number.

Definition at line 168 of file eggBinMaker.cxx.

virtual int EggBinMaker::get_bin_number ( const EggNode * node ) [pure virtual]

Implemented in EggPolysetMaker, and EggBinner.
Referenced by get_bins_for_group().

int EggBinMaker::get_bins_for_group ( GroupNodes::const_iterator gi ) [private]

Breaks the set of nodes for a given group up into individual bins.

Definition at line 245 of file eggBinMaker.cxx.
References collapse_group(), DCAST, get_bin_number(), nassertv, and NULL.

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

Reimplemented from EggObject.
Definition at line 309 of file eggBinMaker.h.

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 EggBinMaker::get_type ( void ) const [inline, virtual]

Reimplemented from EggObject.
Definition at line 317 of file eggBinMaker.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 EggBinMaker::init_type ( void ) [inline, static]

Reimplemented from EggObject.
Definition at line 312 of file eggBinMaker.h.

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

int EggBinMaker::make_bins ( EggGroupNode * root_group )

The main entry point to EggBinMaker.
Walks the egg scene graph beginning at the indicated root node, and moves all binnable nodes into EggBin objects. Returns the number of EggBins created.
Definition at line 101 of file eggBinMaker.cxx.
Referenced by EggLoader::EggLoader().

void EggBinMaker::make_bins_for_group ( EggGroupNode * group,

const Bins & bins

) [private]

Creates the EggBin nodes indicated by the internal bin structure for each group.

Definition at line 287 of file eggBinMaker.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 EggBinMaker::setup_bin ( EggBin * bin,

const Nodes & nodes

) [private]

Sets up a recently-created EggBin structure with all of its children.

Definition at line 339 of file eggBinMaker.cxx.

bool EggBinMaker::sorts_less ( int bin_number,

const EggNode * a,

const EggNode * b

) [virtual]

May be overridden in derived classes to create additional bins within a particular bin number, based on some arbitrary property of nodes.
This function establishes an arbitrary but fixed ordering between nodes; if two nodes do not sort to the same position, different bins are created for each one (with the same bin number on each bin).
Reimplemented in EggPolysetMaker, and EggBinner.
Definition at line 136 of file eggBinMaker.cxx.
References _group_nodes, EggGroupNode::begin(), EggGroupNode::end(), and EggGroupNode::iterator.

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

GroupNodes EggBinMaker::_group_nodes [private]

Definition at line 304 of file eggBinMaker.h.
Referenced by collapse_group(), sorts_less(), and ~EggBinMaker().

TypeHandle EggBinMaker::_type_handle [static, private]

Reimplemented from EggObject.
Definition at line 30 of file eggBinMaker.cxx.

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

panda/src/egg/eggBinMaker.h
panda/src/egg/eggBinMaker.cxx

Generated on Fri May 2 00:49:51 2003 for Panda by

1.3

EggBinMaker Class Reference

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation