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

EggNameUniquifier Class Reference

This is a handy class for guaranteeing unique node names in an egg hierarchy. More...

#include <eggNameUniquifier.h>

Inheritance diagram for EggNameUniquifier:


Public Member Functions
	EggNameUniquifier ()
	~EggNameUniquifier ()
void	clear ()
	Empties the table of used named and prepares the Uniquifier for a new tree.
void	uniquify (EggNode *node)
	Begins the traversal from the indicated node.
EggNode *	get_node (const string &category, const string &name) const
	Returns the node associated with the given category and name, or NULL if the name has not been used.
bool	has_name (const string &category, const string &name) const
	Returns true if the name has been used for the indicated category already, false otherwise.
bool	add_name (const string &category, const string &name, EggNode *node=NULL)
	Adds the name to the indicated category.
virtual string	get_category (EggNode *node)=0
virtual string	filter_name (EggNode *node)
	Returns the name of the given node, or at least the name it should be.
virtual string	generate_name (EggNode *node, const string &category, int index)
	Generates a new name for the given node when its existing name clashes with some other node.
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 pmap< string, EggNode * >	UsedNames
typedef pmap< string, UsedNames >	Categories
Private Attributes
Categories	_categories
int	_index
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

This is a handy class for guaranteeing unique node names in an egg hierarchy.

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

Definition at line 103 of file eggNameUniquifier.h.

Member Typedef Documentation

typedef pmap<string, UsedNames> EggNameUniquifier::Categories [private]

Definition at line 124 of file eggNameUniquifier.h.

typedef pmap<string, EggNode *> EggNameUniquifier::UsedNames [private]

Definition at line 123 of file eggNameUniquifier.h.

Constructor & Destructor Documentation

EggNameUniquifier::EggNameUniquifier ( )

Definition at line 39 of file eggNameUniquifier.cxx.

EggNameUniquifier::~EggNameUniquifier ( )

Definition at line 51 of file eggNameUniquifier.cxx.
References _categories, and _index.

Member Function Documentation

bool EggNameUniquifier::add_name ( const string & category,

const string & name,

EggNode * node = NULL

)

Adds the name to the indicated category.
This name will not be used for any other egg node within this category. Returns true if the name was added, or false if it was already in use for the category.
Definition at line 184 of file eggNameUniquifier.cxx.
References filter_name(), and ostringstream::str().

void EggNameUniquifier::clear ( )

Empties the table of used named and prepares the Uniquifier for a new tree.

Definition at line 65 of file eggNameUniquifier.cxx.
References _categories, _index, filter_name(), and get_category().

string EggNameUniquifier::filter_name ( EggNode * node ) [virtual]

Returns the name of the given node, or at least the name it should be.
This provides a hook to adjust the name before attempting to uniquify it, if desired, for instance to remove invalid characters.
Reimplemented in EggGroupUniquifier.
Definition at line 205 of file eggNameUniquifier.cxx.
Referenced by add_name(), and clear().

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

Reimplemented from EggObject.
Reimplemented in EggGroupUniquifier, and EggPoolUniquifier.
Definition at line 142 of file eggNameUniquifier.h.

string EggNameUniquifier::generate_name ( EggNode * node,

const string & category,

int index

) [virtual]

Generates a new name for the given node when its existing name clashes with some other node.
This function will be called repeatedly, if necessary, until it returns a name that actually is unique.
The category is the string returned by get_category(), and index is a uniquely-generated number that may be useful for synthesizing the name.
Reimplemented in EggGroupUniquifier.
Definition at line 232 of file eggNameUniquifier.cxx.

virtual string EggNameUniquifier::get_category ( EggNode * node ) [pure virtual]

Implemented in EggGroupUniquifier, and EggPoolUniquifier.
Referenced by clear().

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

Reimplemented from EggObject.
Reimplemented in EggGroupUniquifier, and EggPoolUniquifier.
Definition at line 131 of file eggNameUniquifier.h.
References EggObject::get_class_type(), and EggObject::init_type().

EggNode * EggNameUniquifier::get_node ( const string & category,

const string & name

) const

Returns the node associated with the given category and name, or NULL if the name has not been used.

Definition at line 124 of file eggNameUniquifier.cxx.

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

Reimplemented from EggObject.
Reimplemented in EggGroupUniquifier, and EggPoolUniquifier.
Definition at line 139 of file eggNameUniquifier.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.

bool EggNameUniquifier::has_name ( const string & category,

const string & name

) const

Returns true if the name has been used for the indicated category already, false otherwise.

Definition at line 152 of file eggNameUniquifier.cxx.

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

Reimplemented from EggObject.
Reimplemented in EggGroupUniquifier, and EggPoolUniquifier.
Definition at line 134 of file eggNameUniquifier.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 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().

void EggNameUniquifier::uniquify ( EggNode * node )

Begins the traversal from the indicated node.

Definition at line 79 of file eggNameUniquifier.cxx.

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

Categories EggNameUniquifier::_categories [private]

Definition at line 126 of file eggNameUniquifier.h.
Referenced by clear(), and ~EggNameUniquifier().

int EggNameUniquifier::_index [private]

Definition at line 127 of file eggNameUniquifier.h.
Referenced by clear(), and ~EggNameUniquifier().

TypeHandle EggNameUniquifier::_type_handle [static, private]

Reimplemented from EggObject.
Reimplemented in EggGroupUniquifier, and EggPoolUniquifier.
Definition at line 28 of file eggNameUniquifier.cxx.

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

panda/src/egg/eggNameUniquifier.h
panda/src/egg/eggNameUniquifier.cxx

Generated on Fri May 2 00:50:08 2003 for Panda by

1.3

EggNameUniquifier Class Reference

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation