Panda3D
Public Member Functions | Static Public Member Functions | List of all members
EggNameUniquifier Class Reference

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

Inheritance diagram for EggNameUniquifier:
EggObject TypedReferenceCount TypedObject ReferenceCount EggGroupUniquifier EggPoolUniquifier

Public Member Functions

bool addName (str category, str name, EggNode node)
 Adds the name to the indicated category. More...
 
 clear ()
 Empties the table of used named and prepares the Uniquifier for a new tree. More...
 
str filterName (EggNode node)
 Returns the name of the given node, or at least the name it should be. More...
 
str generateName (EggNode node, str category, int index)
 Generates a new name for the given node when its existing name clashes with some other node. More...
 
str getCategory (EggNode node)
 
EggNode getNode (str category, str name)
 Returns the node associated with the given category and name, or NULL if the name has not been used. More...
 
bool hasName (str category, str name)
 Returns true if the name has been used for the indicated category already, false otherwise. More...
 
 uniquify (EggNode node)
 Begins the traversal from the indicated node. More...
 
- Public Member Functions inherited from EggObject
 __init__ ()
 
 __init__ (const EggObject copy)
 
 clearUserData ()
 Removes all user data pointers from the node. More...
 
 clearUserData (TypeHandle type)
 Removes the user data pointer of the indicated type. More...
 
EggUserData getUserData ()
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. More...
 
EggUserData getUserData (TypeHandle type)
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not. More...
 
bool hasUserData ()
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. More...
 
bool hasUserData (TypeHandle type)
 Returns true if the user data pointer of the indicated type has been set, false otherwise. More...
 
EggObject operator= (const EggObject copy)
 
 setUserData (EggUserData user_data)
 Sets the user data associated with this object. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

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.

Member Function Documentation

◆ addName()

bool addName ( str  category,
str  name,
EggNode  node 
)

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

clear ( )

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

◆ filterName()

str filterName ( EggNode  node)

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

str generateName ( EggNode  node,
str  category,
int  index 
)

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

str getCategory ( EggNode  node)

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getNode()

EggNode getNode ( str  category,
str  name 
)

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

◆ hasName()

bool hasName ( str  category,
str  name 
)

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

◆ uniquify()

uniquify ( EggNode  node)

Begins the traversal from the indicated node.