|
|
|
A base class for nodes in the hierarchy that are not leaf nodes.
More...
#include "eggGroupNode.h"
List of all members.
Classes |
| class | NVertexReference |
| class | TBNVertexReference |
| class | TBNVertexValue |
Public Types |
|
typedef Children::const_iterator | const_iterator |
|
typedef Children::const_pointer | const_pointer |
|
typedef Children::const_reference | const_reference |
typedef
Children::const_reverse_iterator | const_reverse_iterator |
|
typedef Children::difference_type | difference_type |
|
typedef Children::const_iterator | iterator |
|
typedef Children::const_pointer | pointer |
|
typedef Children::const_reference | reference |
typedef
Children::const_reverse_iterator | reverse_iterator |
|
typedef Children::size_type | size_type |
| enum | TriangulateFlags {
T_polygon = 0x001,
T_convex = 0x002,
T_composite = 0x004,
T_recurse = 0x008,
T_flat_shaded = 0x010
} |
Public Member Functions |
|
| EggGroupNode (const string &name="") |
|
| EggGroupNode (const EggGroupNode ©) |
| EggNode * | add_child (EggNode *node) |
| | Adds the indicated child to the group and returns it.
|
| void | apply_first_attribute (bool recurse) |
| | Sets the first vertex of the triangle (or each component) to the primitive normal and/or color, if the primitive is flat-shaded.
|
| void | apply_last_attribute (bool recurse) |
| | Sets the last vertex of the triangle (or each component) to the primitive normal and/or color, if the primitive is flat-shaded.
|
|
iterator | begin () const |
|
void | clear () |
| void | clear_connected_shading () |
| | Resets the connected_shading information on all primitives at this node and below, so that it may be accurately rederived by the next call to get_connected_shading().
|
|
bool | empty () const |
|
iterator | end () const |
|
iterator | erase (iterator position) |
|
iterator | erase (iterator first, iterator last) |
| EggNode * | find_child (const string &name) const |
| | Returns the child of this node whose name is the indicated string, or NULL if there is no child of this node by that name.
|
| void | force_filenames (const Filename &directory) |
| | Similar to resolve_filenames, but each non-absolute filename encountered is arbitrarily taken to be in the indicated directory, whether or not the so-named filename exists.
|
|
virtual TypeHandle | force_init_type () |
| void | get_connected_shading () |
| | Queries the connected_shading information on all primitives at this node and below, to ensure that it has been completely filled in before we start mucking around with vertices.
|
| EggNode * | get_first_child () |
| | Returns the first child in the group's list of children, or NULL if the list of children is empty.
|
| EggNode * | get_next_child () |
| | Returns the next child in the group's list of children since the last call to get_first_child() or get_next_child(), or NULL if the last child has been returned.
|
|
virtual TypeHandle | get_type () const |
| bool | has_absolute_pathnames () const |
| | Returns true if any nodes at this level and below include a reference to a file via an absolute pathname, or false if all references are relative.
|
| virtual bool | has_normals () const |
| | Returns true if any of the primitives (e.g.
|
| virtual bool | has_primitives () const |
| | Returns true if there are any primitives (e.g.
|
|
iterator | insert (iterator position, PT(EggNode) x) |
| virtual bool | joint_has_primitives () const |
| | Returns true if there are any primitives (e.g.
|
| void | mesh_triangles (int flags) |
| | Combine triangles together into triangle strips, at this group and below.
|
|
EggGroupNode & | operator= (const EggGroupNode ©) |
| void | post_apply_flat_attribute (bool recurse) |
| | Intended as a followup to apply_last_attribute(), this also sets an attribute on the first vertices of the primitive, if they don't already have an attribute set, just so they end up with *something*.
|
|
| PT (EggNode) remove_child(EggNode *node) |
|
reverse_iterator | rbegin () const |
| void | rebuild_vertex_pools (EggVertexPools &vertex_pools, unsigned int max_vertices, bool recurse) |
| | Copies vertices used by the primitives at this group node (and below, if recurse is true) into one or more new vertex pools, and updates the primitives to reference these pools.
|
| void | recompute_polygon_normals (CoordinateSystem cs=CS_default) |
| | Recomputes all the polygon normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions.
|
| bool | recompute_tangent_binormal (const vector_string &names) |
| | This function recomputes the tangent and binormal for the named texture coordinate sets.
|
| bool | recompute_tangent_binormal (const GlobPattern &uv_name) |
| | This function recomputes the tangent and binormal for the named texture coordinate set for all vertices at this level and below.
|
| bool | recompute_tangent_binormal_auto () |
| | This function recomputes the tangent and binormal for any texture coordinate set that affects a normal map.
|
| void | recompute_vertex_normals (double threshold, CoordinateSystem cs=CS_default) |
| | Recomputes all the vertex normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions.
|
| int | remove_invalid_primitives (bool recurse) |
| | Removes primitives at this level and below which appear to be degenerate; e.g.
|
| int | remove_unused_vertices (bool recurse) |
| | Removes all vertices from VertexPools within this group or below that are not referenced by at least one primitive.
|
| int | rename_nodes (vector_string strip_prefix, bool recurse) |
| | Rename by stripping out the prefix.
|
|
reverse_iterator | rend () const |
| void | replace (iterator position, PT(EggNode) x) |
| | Replaces the node at the indicated position with the indicated node.
|
| void | resolve_filenames (const DSearchPath &searchpath) |
| | Walks the tree and attempts to resolve any filenames encountered.
|
| void | reverse_vertex_ordering () |
| | Reverses the vertex ordering of all polygons defined at this node and below.
|
|
size_type | size () const |
| void | steal_children (EggGroupNode &other) |
| | Moves all the children from the other node to this one.
|
| void | strip_normals () |
| | Removes all normals from primitives, and the vertices they reference, at this node and below.
|
| int | triangulate_polygons (int flags) |
| | Replace all higher-order polygons at this point in the scene graph and below with triangles.
|
| void | unify_attributes (bool use_connected_shading, bool allow_per_primitive, bool recurse) |
| | Applies per-vertex normal and color to all vertices, if they are in fact per-vertex (and different for each vertex), or moves them to the primitive if they are all the same.
|
| virtual void | write (ostream &out, int indent_level) const |
| | Writes the group and all of its children to the indicated output stream in Egg format.
|
Static Public Member Functions |
|
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.
|
| static bool | is_right (const LVector2d &v1, const LVector2d &v2) |
| | Returns true if the 2-d v1 is to the right of v2.
|
Protected Member Functions |
| CoordinateSystem | find_coordsys_entry () |
| | Walks the tree, looking for an EggCoordinateSystem entry.
|
| int | find_materials (EggMaterialCollection *collection) |
| | Walks the tree, looking for EggMaterials.
|
| int | find_textures (EggTextureCollection *collection) |
| | Walks the tree, looking for EggTextures.
|
| virtual void | r_apply_texmats (EggTextureCollection &textures) |
| | The recursive implementation of apply_texmats().
|
| virtual void | r_flatten_transforms () |
| | The recursive implementation of flatten_transforms().
|
| bool | r_load_externals (const DSearchPath &searchpath, CoordinateSystem coordsys, BamCacheRecord *record) |
| | Walks the tree and locates unloaded external reference nodes, which it attempts to locate and load in.
|
| virtual void | r_mark_coordsys (CoordinateSystem cs) |
| | This is only called immediately after loading an egg file from disk, to propagate the value found in the CoordinateSystem entry (or the default Y-up coordinate system) to all nodes that care about what the coordinate system is.
|
| virtual void | r_transform (const LMatrix4d &mat, const LMatrix4d &inv, CoordinateSystem to_cs) |
| | This is called from within the egg code by transform().
|
| virtual void | r_transform_vertices (const LMatrix4d &mat) |
| | This is called from within the egg code by transform_vertices_only()().
|
| virtual void | update_under (int depth_offset) |
| | This function is called from within EggGroupNode whenever the parentage of the node has changed.
|
Friends |
|
class | EggMaterialCollection |
|
class | EggTextureCollection |
Detailed Description
A base class for nodes in the hierarchy that are not leaf nodes.
(See also EggGroup, which is specifically the "<Group>" node in egg.)
An EggGroupNode is an STL-style container of pointers to EggNodes, like a vector. Functions push_back()/pop_back() and insert()/erase() are provided to manipulate the list. The list may also be operated on (read-only) via iterators and begin()/end().
Definition at line 51 of file eggGroupNode.h.
Member Function Documentation
Adds the indicated child to the group and returns it.
If the child node is already a child of some other node, removes it first.
Definition at line 282 of file eggGroupNode.cxx.
References ReferenceCount::test_ref_count_integrity().
Referenced by EggXfmSAnim::add_component_data(), EggXfmSAnim::add_data(), CLwoLayer::connect_egg(), XFileAnimationSet::create_hierarchy(), XFileMesh::create_polygons(), EggTriangleStrip::do_triangulate(), EggTriangleFan::do_triangulate(), EggCompositePrimitive::do_triangulate(), EggXfmSAnim::EggXfmSAnim(), SoftToEggConverter::find_morph_table(), SoftNodeTree::get_egg_group(), MayaNodeTree::get_egg_group(), MaxNodeTree::get_egg_group(), MayaNodeTree::get_egg_slider(), SoftNodeTree::get_egg_table(), MayaNodeTree::get_egg_table(), MaxNodeTree::get_egg_table(), FltToEggLevelState::get_synthetic_group(), SomethingToEggConverter::handle_external_reference(), EggMatrixTablePointer::make_new_joint(), DaeCharacter::process_joint(), XFileMesh::set_egg_parent(), QtessSurface::tesselate(), and EggMesherFanMaker::unroll().
| void EggGroupNode::apply_first_attribute |
( |
bool |
recurse | ) |
|
| void EggGroupNode::apply_last_attribute |
( |
bool |
recurse | ) |
|
| void EggGroupNode::clear_connected_shading |
( |
| ) |
|
| EggNode * EggGroupNode::find_child |
( |
const string & |
name | ) |
const |
| CoordinateSystem EggGroupNode::find_coordsys_entry |
( |
| ) |
[protected] |
| void EggGroupNode::force_filenames |
( |
const Filename & |
directory | ) |
|
| void EggGroupNode::get_connected_shading |
( |
| ) |
|
| EggNode * EggGroupNode::get_first_child |
( |
| ) |
|
Returns the first child in the group's list of children, or NULL if the list of children is empty.
Can be used with get_next_child() to return the complete list of children without using the iterator class; however, this is non-thread-safe, and so is not recommended except for languages other than C++ which cannot use the iterators.
Definition at line 246 of file eggGroupNode.cxx.
References get_next_child().
| EggNode * EggGroupNode::get_next_child |
( |
| ) |
|
Returns the next child in the group's list of children since the last call to get_first_child() or get_next_child(), or NULL if the last child has been returned.
Can be used with get_first_child() to return the complete list of children without using the iterator class; however, this is non-thread-safe, and so is not recommended except for languages other than C++ which cannot use the iterators.
It is an error to call this without previously calling get_first_child().
Definition at line 267 of file eggGroupNode.cxx.
Referenced by get_first_child().
| bool EggGroupNode::has_absolute_pathnames |
( |
| ) |
const |
| bool EggGroupNode::has_normals |
( |
| ) |
const [virtual] |
Returns true if any of the primitives (e.g.
polygons) defined within this group or below have either face or vertex normals defined, false otherwise.
Reimplemented from EggNode.
Definition at line 1234 of file eggGroupNode.cxx.
| bool EggGroupNode::has_primitives |
( |
| ) |
const [virtual] |
Returns true if there are any primitives (e.g.
polygons) defined within this group or below, false otherwise.
Reimplemented from EggNode.
Definition at line 1188 of file eggGroupNode.cxx.
| static void EggGroupNode::init_type |
( |
| ) |
[inline, static] |
| bool EggGroupNode::is_right |
( |
const LVector2d & |
v1, |
|
|
const LVector2d & |
v2 |
|
) |
| [inline, static] |
Returns true if the 2-d v1 is to the right of v2.
Definition at line 22 of file eggGroupNode.I.
| bool EggGroupNode::joint_has_primitives |
( |
| ) |
const [virtual] |
| void EggGroupNode::mesh_triangles |
( |
int |
flags | ) |
|
| void EggGroupNode::post_apply_flat_attribute |
( |
bool |
recurse | ) |
|
| void EggGroupNode::r_flatten_transforms |
( |
| ) |
[protected, virtual] |
| bool EggGroupNode::r_load_externals |
( |
const DSearchPath & |
searchpath, |
|
|
CoordinateSystem |
coordsys, |
|
|
BamCacheRecord * |
record |
|
) |
| [protected] |
Walks the tree and locates unloaded external reference nodes, which it attempts to locate and load in.
The reference node is replaced with the entire subtree loaded. This is intended to be called from EggData::load_externals().
Definition at line 1668 of file eggGroupNode.cxx.
References BamCacheRecord::add_dependent_file(), Filename::get_basename_wo_extension(), TypedObject::is_of_type(), EggData::load_externals(), r_load_externals(), EggData::read(), replace(), EggData::resolve_egg_filename(), EggData::set_auto_resolve_externals(), EggData::set_coordinate_system(), and steal_children().
Referenced by EggData::load_externals(), and r_load_externals().
| void EggGroupNode::r_mark_coordsys |
( |
CoordinateSystem |
cs | ) |
[protected, virtual] |
This is only called immediately after loading an egg file from disk, to propagate the value found in the CoordinateSystem entry (or the default Y-up coordinate system) to all nodes that care about what the coordinate system is.
Reimplemented from EggNode.
Reimplemented in EggXfmSAnim.
Definition at line 1469 of file eggGroupNode.cxx.
| void EggGroupNode::r_transform |
( |
const LMatrix4d & |
mat, |
|
|
const LMatrix4d & |
inv, |
|
|
CoordinateSystem |
to_cs |
|
) |
| [protected, virtual] |
This is called from within the egg code by transform().
It applies a transformation matrix to the current node in some sensible way, then continues down the tree.
The first matrix is the transformation to apply; the second is its inverse. The third parameter is the coordinate system we are changing to, or CS_default if we are not changing coordinate systems.
Reimplemented from EggNode.
Reimplemented in EggGroup, EggTable, and EggXfmSAnim.
Definition at line 1430 of file eggGroupNode.cxx.
Referenced by EggData::set_coordinate_system().
| void EggGroupNode::r_transform_vertices |
( |
const LMatrix4d & |
mat | ) |
[protected, virtual] |
| void EggGroupNode::rebuild_vertex_pools |
( |
EggVertexPools & |
vertex_pools, |
|
|
unsigned int |
max_vertices, |
|
|
bool |
recurse |
|
) |
| |
Copies vertices used by the primitives at this group node (and below, if recurse is true) into one or more new vertex pools, and updates the primitives to reference these pools.
It is up to the caller to parent the newly-created vertex pools somewhere appropriate in the egg hierarchy.
No more than max_vertices will be placed into any one vertex pool. This is the sole criteria for splitting vertex pools.
Definition at line 1262 of file eggGroupNode.cxx.
References EggPrimitive::add_vertex(), EggPrimitive::clear(), EggVertex::copy_grefs_from(), EggVertexPool::create_unique_vertex(), EggVertexPool::find_matching_vertex(), EggCompositePrimitive::get_component(), EggCompositePrimitive::get_num_components(), TypedObject::is_of_type(), EggCompositePrimitive::set_component(), and EggVertexPool::size().
Referenced by EggLoader::make_polyset().
| void EggGroupNode::recompute_polygon_normals |
( |
CoordinateSystem |
cs = CS_default | ) |
|
| bool EggGroupNode::recompute_tangent_binormal |
( |
const GlobPattern & |
uv_name | ) |
|
This function recomputes the tangent and binormal for the named texture coordinate set for all vertices at this level and below.
Use the empty string for the default texture coordinate set.
It is necessary for each vertex to already have a normal (or at least a polygon normal), as well as a texture coordinate in the named texture coordinate set, before calling this function. You might precede this with recompute_vertex_normals() to ensure that the normals exist.
Like recompute_vertex_normals(), this function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the new tangents and binormals computed. Thus, it is a good idea to call remove_unused_vertices() after calling this.
Definition at line 719 of file eggGroupNode.cxx.
Referenced by recompute_tangent_binormal(), and recompute_tangent_binormal_auto().
| bool EggGroupNode::recompute_tangent_binormal |
( |
const vector_string & |
names | ) |
|
| bool EggGroupNode::recompute_tangent_binormal_auto |
( |
| ) |
|
| void EggGroupNode::recompute_vertex_normals |
( |
double |
threshold, |
|
|
CoordinateSystem |
cs = CS_default |
|
) |
| |
Recomputes all the vertex normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions.
A shared edge between two polygons (even in different groups) is considered smooth if the angle between the two edges is less than threshold degrees.
This function also removes degenerate polygons that do not have enough vertices to define a normal. It does not affect normals for other kinds of primitives like Nurbs or Points.
This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the correct normals. Thus, it is a good idea to call remove_unused_vertices() after calling this.
Definition at line 539 of file eggGroupNode.cxx.
Referenced by XFileMesh::create_polygons().
| int EggGroupNode::remove_invalid_primitives |
( |
bool |
recurse | ) |
|
| int EggGroupNode::remove_unused_vertices |
( |
bool |
recurse | ) |
|
Removes all vertices from VertexPools within this group or below that are not referenced by at least one primitive.
Also collapses together equivalent vertices, and renumbers all vertices after the operation so their indices are consecutive, beginning at zero. Returns the total number of vertices removed.
Note that this operates on the VertexPools within this group level, without respect to primitives that reference these vertices (unlike other functions like strip_normals()). It is therefore most useful to call this on the EggData root, rather than on a subgroup within the hierarchy, since a VertexPool may appear anywhere in the hierarchy.
Definition at line 912 of file eggGroupNode.cxx.
References EggVertexPool::empty(), TypedObject::is_of_type(), and EggVertexPool::remove_unused_vertices().
| int EggGroupNode::rename_nodes |
( |
vector_string |
strip_prefix, |
|
|
bool |
recurse |
|
) |
| |
| void EggGroupNode::replace |
( |
iterator |
position, |
|
|
PT(EggNode) |
x |
|
) |
| |
Replaces the node at the indicated position with the indicated node.
It is an error to call this with an invalid position iterator (e.g. end()).
Definition at line 196 of file eggGroupNode.cxx.
Referenced by r_load_externals().
| void EggGroupNode::resolve_filenames |
( |
const DSearchPath & |
searchpath | ) |
|
| void EggGroupNode::reverse_vertex_ordering |
( |
| ) |
|
| void EggGroupNode::strip_normals |
( |
| ) |
|
| int EggGroupNode::triangulate_polygons |
( |
int |
flags | ) |
|
Replace all higher-order polygons at this point in the scene graph and below with triangles.
Returns the total number of new triangles produced, less degenerate polygons removed.
If flags contains T_polygon and T_convex, both concave and convex polygons will be subdivided into triangles; with only T_polygon, only concave polygons will be subdivided, and convex polygons will be largely unchanged.
Definition at line 803 of file eggGroupNode.cxx.
References TypedObject::is_of_type().
Referenced by EggLoader::make_polyset().
| void EggGroupNode::unify_attributes |
( |
bool |
use_connected_shading, |
|
|
bool |
allow_per_primitive, |
|
|
bool |
recurse |
|
) |
| |
Applies per-vertex normal and color to all vertices, if they are in fact per-vertex (and different for each vertex), or moves them to the primitive if they are all the same.
After this call, either the primitive will have normals or its vertices will, but not both. Ditto for colors.
If use_connected_shading is true, each polygon is considered in conjunction with all connected polygons; otherwise, each polygon is considered individually.
If allow_per_primitive is false, S_per_face or S_overall will treated like S_per_vertex: normals and colors will always be assigned to the vertices. In this case, there will never be per-primitive colors or normals after this call returns. On the other hand, if allow_per_primitive is true, then S_per_face means that normals and colors should be assigned to the primitives, and removed from the vertices, as described above.
This may create redundant vertices in the vertex pool, so it may be a good idea to follow this up with remove_unused_vertices().
Definition at line 1064 of file eggGroupNode.cxx.
References EggPrimitive::get_connected_shading(), EggPrimitive::get_shading(), TypedObject::is_of_type(), and EggPrimitive::unify_attributes().
| void EggGroupNode::update_under |
( |
int |
depth_offset | ) |
[protected, virtual] |
| void EggGroupNode::write |
( |
ostream & |
out, |
|
|
int |
indent_level |
|
) |
| const [virtual] |
The documentation for this class was generated from the following files:
| | |