EggTextureCollection

class EggTextureCollection

This is a collection of textures by TRef name. It can extract the textures from an egg file and sort them all together; it can also manage the creation of unique textures and the assignment of unique TRef names.

Inheritance diagram

EggTextureCollection(void)

EggTextureCollection(EggTextureCollection const &copy)

bool add_texture(EggTexture *texture)

Explicitly adds a new texture to the collection. Returns true if the texture was added, false if it was already there or if there was some error.

void clear(void)

Removes all textures from the collection.

int collapse_equivalent_textures(int eq, EggGroupNode *node)

int collapse_equivalent_textures(int eq, TextureReplacement &removed)

Walks through the collection and collapses together any separate textures that are equivalent according to the indicated equivalence factor, eq (see EggTexture::is_equivalent_to()). The return value is the number of textures removed.

This flavor of collapse_equivalent_textures() automatically adjusts all the primitives in the egg hierarchy to refer to the new texture pointers.

Walks through the collection and collapses together any separate textures that are equivalent according to the indicated equivalence factor, eq (see EggTexture::is_equivalent_to()). The return value is the number of textures removed.

This flavor of collapse_equivalent_textures() does not adjust any primitives in the egg hierarchy; instead, it fills up the ‘removed’ map with an entry for each removed texture, mapping it back to the equivalent retained texture. It’s up to the user to then call replace_textures() with this map, if desired, to apply these changes to the egg hierarchy.

EggTexture *create_unique_texture(EggTexture const &copy, int eq)

create_unique_texture() creates a new texture if there is not already one equivalent (according to eq, see EggTexture::is_equivalent_to()) to the indicated texture, or returns the existing one if there is.

Creates a new texture if there is not already one equivalent (according to eq, see EggTexture::is_equivalent_to()) to the indicated texture, or returns the existing one if there is.

int extract_textures(EggGroupNode *node)

Walks the egg hierarchy beginning at the indicated node, and removes any EggTextures encountered in the hierarchy, adding them to the collection. Returns the number of EggTextures encountered.

EggTexture *find_filename(Filename const &filename) const

Find a texture with a particular filename.

Returns the texture with the indicated filename, or NULL if no texture matches.

EggTexture *find_tref(std::string const &tref_name) const

Find a texture with a particular TRef name.

Returns the texture with the indicated TRef name, or NULL if no texture matches.

int find_used_textures(EggNode *node)

Walks the egg hierarchy beginning at the indicated node, looking for textures that are referenced by primitives but are not already members of the collection, adding them to the collection.

If this is called following extract_textures(), it can be used to pick up any additional texture references that appeared in the egg hierarchy (but whose EggTexture node was not actually part of the hierarchy).

If this is called in lieu of extract_textures(), it will fill up the collection with all of the referenced textures (and only the referenced textures), without destructively removing the EggTextures from the hierarchy.

This also has the side effect of incrementing the internal usage count for a texture in the collection each time a texture reference is encountered. This side effect is taken advantage of by remove_unused_textures().

And one more side effect: this function identifies the presence of multitexturing in the egg file, and calls multitexture_over() on each texture appropriately so that, after this call, you may expect get_multitexture_sort() to return a reasonable value for each texture.

int get_num_textures(void) const

Returns the number of EggTextures in the collection.

EggTexture *get_texture(int index) const

Returns the nth EggTexture in the collection.

bool is_empty(void) const

Returns true if there are no EggTexures in the collection, false otherwise.

bool remove_texture(EggTexture *texture)

Explicitly removes a texture from the collection. Returns true if the texture was removed, false if it wasn’t there or if there was some error.

void remove_unused_textures(EggNode *node)

Removes any textures from the collection that aren’t referenced by any primitives in the indicated egg hierarchy. This also, incidentally, adds textures to the collection that had been referenced by primitives but had not previously appeared in the collection.

static void replace_textures(EggGroupNode *node, TextureReplacement const &replace)

Walks the egg hierarchy, changing out any reference to a texture appearing on the left side of the map with its corresponding texture on the right side. This is most often done following a call to collapse_equivalent_textures(). It does not directly affect the Collection.

size_type size(void) const

Returns the number of EggTextures in the collection.

void sort_by_basename(void)

Sorts all the textures into alphabetical order by the basename part (including extension) of the filename. Subsequent operations using begin()/end() will traverse in this sorted order.

void sort_by_tref(void)

Sorts all the textures into alphabetical order by TRef name. Subsequent operations using begin()/end() will traverse in this sorted order.

void uniquify_trefs(void)

Guarantees that each texture in the collection has a unique TRef name. This is essential before writing an egg file.