# EggNameUniquifier

from pandac.PandaModules import EggNameUniquifier

Class : EggNameUniquifier
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.

## Inheritance:

EggNameUniquifier: EggObject
EggObject: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase

## Methods of EggNameUniquifier:

addName
clear
filterName
generateName
getCategory
getClassType
getNode
hasName
uniquify

## Methods of EggObject:

EggObject (Constructor)
clearUserData
getClassType
getUserData
hasUserData
operator =
setUserData

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

addName bool EggNameUniquifier::add_name(string const &category, string const &name, EggNode *node = ((void *)(0))); Description: 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.

clear void EggNameUniquifier::clear(void); Description: Empties the table of used named and prepares the Uniquifier for a new tree.

filterName virtual string EggNameUniquifier::filter_name(EggNode *node); Description: 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.

generateName virtual string EggNameUniquifier::generate_name(EggNode *node, string const &category, int index); Description: 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.

getCategory virtual string EggNameUniquifier::get_category(EggNode *node) = 0; Undocumented function.

getClassType static TypeHandle EggNameUniquifier::get_class_type(void); Undocumented function.

getNode EggNode *EggNameUniquifier::get_node(string const &category, string const &name) const; Description: Returns the node associated with the given category and name, or NULL if the name has not been used.

hasName bool EggNameUniquifier::has_name(string const &category, string const &name) const; Description: Returns true if the name has been used for the indicated category already, false otherwise.

uniquify void EggNameUniquifier::uniquify(EggNode *node); Description: Begins the traversal from the indicated node.

EggObject EggObject::EggObject(void); Description:

clearUserData void EggObject::clear_user_data(void); Description: Removes *all* user data pointers from the node. Description: Removes the user data pointer of the indicated type.

getClassType static TypeHandle EggObject::get_class_type(void); Undocumented function.

getUserData EggUserData *EggObject::get_user_data(void) const; Description: Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. Description: Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.

hasUserData bool EggObject::has_user_data(void) const; Description: Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. Description: Returns true if the user data pointer of the indicated type has been set, false otherwise.

operator = EggObject &EggObject::operator =(EggObject const &copy); Description:

setUserData void EggObject::set_user_data(EggUserData *user_data); Description: Sets the user data associated with this object. This may be any EggUserData-derived object. The egg library will do nothing with this pointer, except to hold its reference count and return the pointer on request. The EggObject maintains multiple different EggUserData pointers, one for each unique type (as reported by get_type()). If you know that only one type of EggUserData object will be added in your application, you may use the query functions that accept no parameters, but it is recommended that in general you pass in the type of your particular user data, to allow multiple applications to coexist in the same egg data. This pointer is also copied by the copy assignment operator and copy constructor.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: 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().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

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

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: 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.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: 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 true if the new reference count is nonzero, false if it is zero.