This is a collection of materials by MRef name. More...
#include "eggMaterialCollection.h"
Public Types | |
| typedef iterator | const_iterator |
| typedef OrderedMaterials::const_iterator | iterator |
| typedef pmap< PT_EggMaterial, PT_EggMaterial > | MaterialReplacement |
| typedef OrderedMaterials::size_type | size_type |
Public Member Functions | |
| EggMaterialCollection (const EggMaterialCollection ©) | |
| bool | add_material (EggMaterial *material) |
| Explicitly adds a new material to the collection. More... | |
| iterator | begin () const |
| void | clear () |
| Removes all materials from the collection. More... | |
| int | collapse_equivalent_materials (int eq, EggGroupNode *node) |
| Walks through the collection and collapses together any separate materials that are equivalent according to the indicated equivalence factor, eq (see EggMaterial::is_equivalent_to()). More... | |
| int | collapse_equivalent_materials (int eq, MaterialReplacement &removed) |
| Walks through the collection and collapses together any separate materials that are equivalent according to the indicated equivalence factor, eq (see EggMaterial::is_equivalent_to()). More... | |
| EggMaterial * | create_unique_material (const EggMaterial ©, int eq) |
| Creates a new material if there is not already one equivalent (according to eq, see EggMaterial::is_equivalent_to()) to the indicated material, or returns the existing one if there is. More... | |
| bool | empty () const |
| iterator | end () const |
| int | extract_materials (EggGroupNode *node) |
| Walks the egg hierarchy beginning at the indicated node, and removes any EggMaterials encountered in the hierarchy, adding them to the collection. More... | |
| EggMaterial * | find_mref (const std::string &mref_name) const |
| Returns the material with the indicated MRef name, or NULL if no material matches. More... | |
| int | find_used_materials (EggNode *node) |
| Walks the egg hierarchy beginning at the indicated node, looking for materials that are referenced by primitives but are not already members of the collection, adding them to the collection. More... | |
| EggGroupNode::iterator | insert_materials (EggGroupNode *node) |
| Adds a series of EggMaterial nodes to the beginning of the indicated node to reflect each of the materials in the collection. More... | |
| EggGroupNode::iterator | insert_materials (EggGroupNode *node, EggGroupNode::iterator position) |
| Adds a series of EggMaterial nodes to the beginning of the indicated node to reflect each of the materials in the collection. More... | |
| EggMaterialCollection & | operator= (const EggMaterialCollection ©) |
| bool | remove_material (EggMaterial *material) |
| Explicitly removes a material from the collection. More... | |
| void | remove_unused_materials (EggNode *node) |
| Removes any materials from the collection that aren't referenced by any primitives in the indicated egg hierarchy. More... | |
| size_type | size () const |
| void | sort_by_mref () |
| Sorts all the materials into alphabetical order by MRef name. More... | |
| void | uniquify_mrefs () |
| Guarantees that each material in the collection has a unique MRef name. More... | |
Static Public Member Functions | |
| static void | replace_materials (EggGroupNode *node, const MaterialReplacement &replace) |
| Walks the egg hierarchy, changing out any reference to a material appearing on the left side of the map with its corresponding material on the right side. More... | |
This is a collection of materials by MRef name.
It can extract the materials from an egg file and sort them all together; it can also manage the creation of unique materials and the assignment of unique MRef names.
Definition at line 30 of file eggMaterialCollection.h.
| bool EggMaterialCollection::add_material | ( | EggMaterial * | material | ) |
Explicitly adds a new material to the collection.
Returns true if the material was added, false if it was already there or if there was some error.
Definition at line 311 of file eggMaterialCollection.cxx.
Referenced by create_unique_material().
| void EggMaterialCollection::clear | ( | ) |
Removes all materials from the collection.
Definition at line 62 of file eggMaterialCollection.cxx.
Referenced by remove_unused_materials().
| int EggMaterialCollection::collapse_equivalent_materials | ( | int | eq, |
| EggGroupNode * | node | ||
| ) |
Walks through the collection and collapses together any separate materials that are equivalent according to the indicated equivalence factor, eq (see EggMaterial::is_equivalent_to()).
The return value is the number of materials removed.
This flavor of collapse_equivalent_materials() automatically adjusts all the primitives in the egg hierarchy to refer to the new material pointers.
Definition at line 185 of file eggMaterialCollection.cxx.
References replace_materials().
Referenced by EggData::collapse_equivalent_materials().
| int EggMaterialCollection::collapse_equivalent_materials | ( | int | eq, |
| EggMaterialCollection::MaterialReplacement & | removed | ||
| ) |
Walks through the collection and collapses together any separate materials that are equivalent according to the indicated equivalence factor, eq (see EggMaterial::is_equivalent_to()).
The return value is the number of materials removed.
This flavor of collapse_equivalent_materials() does not adjust any primitives in the egg hierarchy; instead, it fills up the 'removed' map with an entry for each removed material, mapping it back to the equivalent retained material. It's up to the user to then call replace_materials() with this map, if desired, to apply these changes to the egg hierarchy.
Definition at line 209 of file eggMaterialCollection.cxx.
| EggMaterial * EggMaterialCollection::create_unique_material | ( | const EggMaterial & | copy, |
| int | eq | ||
| ) |
Creates a new material if there is not already one equivalent (according to eq, see EggMaterial::is_equivalent_to()) to the indicated material, or returns the existing one if there is.
Definition at line 364 of file eggMaterialCollection.cxx.
References add_material(), and EggMaterial::is_equivalent_to().
Referenced by XFileToEggConverter::create_unique_material().
| int EggMaterialCollection::extract_materials | ( | EggGroupNode * | node | ) |
Walks the egg hierarchy beginning at the indicated node, and removes any EggMaterials encountered in the hierarchy, adding them to the collection.
Returns the number of EggMaterials encountered.
Definition at line 73 of file eggMaterialCollection.cxx.
| EggMaterial * EggMaterialCollection::find_mref | ( | const std::string & | mref_name | ) | const |
Returns the material with the indicated MRef name, or NULL if no material matches.
Definition at line 386 of file eggMaterialCollection.cxx.
| int EggMaterialCollection::find_used_materials | ( | EggNode * | node | ) |
Walks the egg hierarchy beginning at the indicated node, looking for materials that are referenced by primitives but are not already members of the collection, adding them to the collection.
If this is called following extract_materials(), it can be used to pick up any additional material references that appeared in the egg hierarchy (but whose EggMaterial node was not actually part of the hierarchy).
If this is called in lieu of extract_materials(), it will fill up the collection with all of the referenced materials (and only the referenced materials), without destructively removing the EggMaterials from the hierarchy.
This also has the side effect of incrementing the internal usage count for a material in the collection each time a material reference is encountered. This side effect is taken advantage of by remove_unused_materials().
Definition at line 126 of file eggMaterialCollection.cxx.
References TypedObject::is_of_type().
Referenced by EggData::collapse_equivalent_materials(), and remove_unused_materials().
| EggGroupNode::iterator EggMaterialCollection::insert_materials | ( | EggGroupNode * | node | ) |
Adds a series of EggMaterial nodes to the beginning of the indicated node to reflect each of the materials in the collection.
Returns an iterator representing the first position after the newly inserted materials.
Definition at line 85 of file eggMaterialCollection.cxx.
| EggGroupNode::iterator EggMaterialCollection::insert_materials | ( | EggGroupNode * | node, |
| EggGroupNode::iterator | position | ||
| ) |
Adds a series of EggMaterial nodes to the beginning of the indicated node to reflect each of the materials in the collection.
Returns an iterator representing the first position after the newly inserted materials.
Definition at line 95 of file eggMaterialCollection.cxx.
| bool EggMaterialCollection::remove_material | ( | EggMaterial * | material | ) |
Explicitly removes a material from the collection.
Returns true if the material was removed, false if it wasn't there or if there was some error.
Definition at line 335 of file eggMaterialCollection.cxx.
| void EggMaterialCollection::remove_unused_materials | ( | EggNode * | node | ) |
Removes any materials from the collection that aren't referenced by any primitives in the indicated egg hierarchy.
This also, incidentally, adds materials to the collection that had been referenced by primitives but had not previously appeared in the collection.
Definition at line 167 of file eggMaterialCollection.cxx.
References clear(), and find_used_materials().
|
static |
Walks the egg hierarchy, changing out any reference to a material appearing on the left side of the map with its corresponding material on the right side.
This is most often done following a call to collapse_equivalent_materials(). It does not directly affect the Collection.
Definition at line 251 of file eggMaterialCollection.cxx.
References TypedObject::is_of_type().
Referenced by collapse_equivalent_materials().
| void EggMaterialCollection::sort_by_mref | ( | ) |
Sorts all the materials into alphabetical order by MRef name.
Subsequent operations using begin()/end() will traverse in this sorted order.
Definition at line 300 of file eggMaterialCollection.cxx.
| void EggMaterialCollection::uniquify_mrefs | ( | ) |
Guarantees that each material in the collection has a unique MRef name.
This is essential before writing an egg file.
Definition at line 282 of file eggMaterialCollection.cxx.
References NameUniquifier::add_name().
1.8.15