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

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

#include "eggNameUniquifier.h"

Inheritance diagram for EggNameUniquifier:
EggObject TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase EggGroupUniquifier EggPoolUniquifier

Public Member Functions

bool add_name (const std::string &category, const std::string &name, EggNode *node=nullptr)
 Adds the name to the indicated category. More...
 
void clear ()
 Empties the table of used named and prepares the Uniquifier for a new tree. More...
 
virtual std::string filter_name (EggNode *node)
 Returns the name of the given node, or at least the name it should be. More...
 
virtual TypeHandle force_init_type ()
 
virtual std::string generate_name (EggNode *node, const std::string &category, int index)
 Generates a new name for the given node when its existing name clashes with some other node. More...
 
virtual std::string get_category (EggNode *node)=0
 
EggNodeget_node (const std::string &category, const std::string &name) const
 Returns the node associated with the given category and name, or NULL if the name has not been used. More...
 
virtual TypeHandle get_type () const
 
bool has_name (const std::string &category, const std::string &name) const
 Returns true if the name has been used for the indicated category already, false otherwise. More...
 
void uniquify (EggNode *node)
 Begins the traversal from the indicated node. More...
 
- Public Member Functions inherited from EggObject
 EggObject (const EggObject &copy)
 
virtual EggTransformas_transform ()
 Returns this object cross-cast to an EggTransform pointer, if it inherits from EggTransform, or NULL if it does not. More...
 
void clear_user_data ()
 Removes *all* user data pointers from the node. More...
 
void clear_user_data (TypeHandle type)
 Removes the user data pointer of the indicated type. More...
 
EggUserDataget_user_data () const
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. More...
 
EggUserDataget_user_data (TypeHandle type) const
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not. More...
 
bool has_user_data () const
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. More...
 
bool has_user_data (TypeHandle type) const
 Returns true if the user data pointer of the indicated type has been set, false otherwise. More...
 
EggObjectoperator= (const EggObject &copy)
 
void set_user_data (EggUserData *user_data)
 Sets the user data associated with this object. More...
 
- 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
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
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. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from EggObject
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. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns 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.

Definition at line 59 of file eggNameUniquifier.h.

Member Function Documentation

◆ add_name()

bool EggNameUniquifier::add_name ( const std::string &  category,
const std::string &  name,
EggNode node = nullptr 
)

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 150 of file eggNameUniquifier.cxx.

◆ clear()

void EggNameUniquifier::clear ( )

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

Definition at line 46 of file eggNameUniquifier.cxx.

◆ filter_name()

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 162 of file eggNameUniquifier.cxx.

Referenced by generate_name(), and uniquify().

◆ generate_name()

string EggNameUniquifier::generate_name ( EggNode node,
const std::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 175 of file eggNameUniquifier.cxx.

References filter_name().

Referenced by uniquify().

◆ get_node()

EggNode * EggNameUniquifier::get_node ( const std::string &  category,
const std::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 105 of file eggNameUniquifier.cxx.

◆ has_name()

bool EggNameUniquifier::has_name ( const std::string &  category,
const std::string &  name 
) const

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

Definition at line 127 of file eggNameUniquifier.cxx.

◆ uniquify()

void EggNameUniquifier::uniquify ( EggNode node)

Begins the traversal from the indicated node.

Definition at line 55 of file eggNameUniquifier.cxx.

References filter_name(), generate_name(), and TypedObject::is_of_type().


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