Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
EggGroupNode Class Reference

A base class for nodes in the hierarchy that are not leaf nodes. More...

Inheritance diagram for EggGroupNode:
EggNode EggNamedObject EggObject Namable TypedReferenceCount TypedObject ReferenceCount EggData EggGroup EggTable EggXfmSAnim EggBin

Public Types

enum  TriangulateFlags {
  T_polygon = 1, T_convex = 2, T_composite = 4, T_recurse = 8,
  T_flat_shaded = 16
}
 

Public Member Functions

 __init__ (const EggGroupNode copy)
 
 __init__ (str name)
 
EggNode addChild (EggNode node)
 Adds the indicated child to the group and returns it. More...
 
 applyFirstAttribute (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. More...
 
 applyLastAttribute (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. More...
 
 clear ()
 
 clearConnectedShading ()
 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(). More...
 
bool empty ()
 
EggNode findChild (str name)
 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. More...
 
 forceFilenames (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. More...
 
object getChildren ()
 
 getConnectedShading ()
 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. More...
 
EggNode getFirstChild ()
 Returns the first child in the group's list of children, or NULL if the list of children is empty. More...
 
EggNode getNextChild ()
 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. More...
 
bool hasAbsolutePathnames ()
 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. More...
 
bool hasNormals ()
 Returns true if any of the primitives (e.g. More...
 
bool hasPrimitives ()
 Returns true if there are any primitives (e.g. More...
 
bool jointHasPrimitives ()
 Returns true if there are any primitives (e.g. More...
 
 makePointPrimitives ()
 Creates PointLight primitives to reference any otherwise unreferences vertices discovered in this group or below. More...
 
 meshTriangles (int flags)
 Combine triangles together into triangle strips, at this group and below. More...
 
EggGroupNode operator= (const EggGroupNode copy)
 
 postApplyFlatAttribute (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. More...
 
 recomputePolygonNormals (CoordinateSystem cs)
 Recomputes all the polygon normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. More...
 
bool recomputeTangentBinormal (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. More...
 
bool recomputeTangentBinormal (const VectorString names)
 This function recomputes the tangent and binormal for the named texture coordinate sets. More...
 
bool recomputeTangentBinormalAuto ()
 This function recomputes the tangent and binormal for any texture coordinate set that affects a normal map. More...
 
 recomputeVertexNormals (double threshold, CoordinateSystem cs)
 Recomputes all the vertex normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. More...
 
EggNode removeChild (EggNode node)
 Removes the indicated child node from the group and returns it. More...
 
int removeInvalidPrimitives (bool recurse)
 Removes primitives at this level and below which appear to be degenerate; e.g. More...
 
int removeUnusedVertices (bool recurse)
 Removes all vertices from VertexPools within this group or below that are not referenced by at least one primitive. More...
 
int renameNodes (VectorString strip_prefix, bool recurse)
 Rename by stripping out the prefix. More...
 
 resolveFilenames (const DSearchPath searchpath)
 Walks the tree and attempts to resolve any filenames encountered. More...
 
 reverseVertexOrdering ()
 Reverses the vertex ordering of all polygons defined at this node and below. More...
 
EggGroupNode::SizeType size ()
 
 stealChildren (EggGroupNode other)
 Moves all the children from the other node to this one. More...
 
 stripNormals ()
 Removes all normals from primitives, and the vertices they reference, at this node and below. More...
 
int triangulatePolygons (int flags)
 Replace all higher-order polygons at this point in the scene graph and below with triangles. More...
 
 unifyAttributes (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. More...
 
- Public Member Functions inherited from EggNode
 applyTexmats ()
 Applies the texture matrices to the UV's of the vertices that reference them, and then removes the texture matrices from the textures themselves. More...
 
EggRenderMode determineAlphaMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has an alpha_mode other than AM_unspecified. More...
 
EggRenderMode determineBin ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a bin specified. More...
 
bool determineDecal ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set. More...
 
EggRenderMode determineDepthOffset ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a depth_offset specified. More...
 
EggRenderMode determineDepthTestMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a depth_test_mode other than DTM_unspecified. More...
 
EggRenderMode determineDepthWriteMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a depth_write_mode other than DWM_unspecified. More...
 
EggRenderMode determineDrawOrder ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a draw_order specified. More...
 
bool determineIndexed ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set. More...
 
EggRenderMode determineVisibilityMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a visibility_mode other than VM_unspecified. More...
 
 flattenTransforms ()
 Removes any transform and instance records from this node in the scene graph and below. More...
 
int getDepth ()
 Returns the number of nodes above this node in the egg hierarchy. More...
 
const LMatrix4d getNodeFrame ()
 Returns the coordinate frame of the node itself. More...
 
const LMatrix4d getNodeFrameInv ()
 Returns the inverse of the matrix returned by get_node_frame(). More...
 
const LMatrix4d getNodeFrameInvPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix. More...
 
const LMatrix4d getNodeFramePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix. More...
 
const LMatrix4d getNodeToVertex ()
 Returns the transformation matrix suitable for converting vertices in the coordinate space of the node to the appropriate coordinate space for storing in the egg file. More...
 
const LMatrix4d getNodeToVertexPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix. More...
 
EggGroupNode getParent ()
 
const LMatrix4d getVertexFrame ()
 Returns the coordinate frame of the vertices referenced by primitives at or under this node. More...
 
const LMatrix4d getVertexFrameInv ()
 Returns the inverse of the matrix returned by get_vertex_frame(). More...
 
const LMatrix4d getVertexFrameInvPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix. More...
 
const LMatrix4d getVertexFramePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix. More...
 
const LMatrix4d getVertexToNode ()
 Returns the transformation matrix suitable for converting the vertices as read from the egg file into the coordinate space of the node. More...
 
const LMatrix4d getVertexToNodePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix. More...
 
bool isAnimMatrix ()
 Returns true if this node represents a table of animation transformation data, false otherwise. More...
 
bool isJoint ()
 Returns true if this particular node represents a <Joint> entry or not. More...
 
bool isLocalCoord ()
 Returns true if this node's vertices are not in the global coordinate space. More...
 
bool isUnderInstance ()
 Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise. More...
 
bool isUnderTransform ()
 Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise. More...
 
EggNode operator= (const EggNode copy)
 
bool parseEgg (str egg_syntax)
 Parses the egg syntax given in the indicate string as if it had been read from the egg file within this object's definition. More...
 
int renameNode (VectorString strip_prefix)
 Rename by stripping out the prefix. More...
 
 testUnderIntegrity ()
 
 transform (const LMatrix4d mat)
 Applies the indicated transformation to the node and all of its descendants. More...
 
 transformVerticesOnly (const LMatrix4d mat)
 Applies the indicated transformation only to vertices that appear in global space within vertex pools at this node and below. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from EggNamedObject
 __init__ (const EggNamedObject copy)
 
 __init__ (str name)
 
EggNamedObject operator= (const EggNamedObject copy)
 
 output (Ostream out)
 
- 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...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
static bool isRight (const LVector2d v1, const LVector2d v2)
 Returns true if the 2-d v1 is to the right of v2. More...
 
- Static Public Member Functions inherited from EggNode
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggNamedObject
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 ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Public Attributes

object children
 
- Public Attributes inherited from EggNode
int depth
 Returns the number of nodes above this node in the egg hierarchy. More...
 
EggGroupNode parent
 
- 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...
 
- Public Attributes inherited from Namable
const String name
 

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

Member Enumeration Documentation

◆ TriangulateFlags

Enumerator
T_polygon 
T_convex 
T_composite 
T_recurse 
T_flat_shaded 

Member Function Documentation

◆ __init__() [1/2]

__init__ ( const EggGroupNode  copy)

◆ __init__() [2/2]

__init__ ( str  name)

◆ addChild()

EggNode addChild ( EggNode  node)

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.

◆ applyFirstAttribute()

applyFirstAttribute ( 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.

This reflects the DirectX convention of storing flat-shaded properties on the first vertex, although it is not usually a convention in Egg.

This may create redundant vertices in the vertex pool, so it may be a good idea to follow this up with remove_unused_vertices().

◆ applyLastAttribute()

applyLastAttribute ( 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.

This reflects the OpenGL convention of storing flat-shaded properties on the last vertex, although it is not usually a convention in Egg.

This may create redundant vertices in the vertex pool, so it may be a good idea to follow this up with remove_unused_vertices().

◆ clear()

clear ( )

◆ clearConnectedShading()

clearConnectedShading ( )

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

It may be a good idea to call remove_unused_vertices() as well, to establish the correct connectivity between common vertices.

◆ empty()

bool empty ( )

◆ findChild()

EggNode findChild ( str  name)

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.

Does not search recursively.

◆ forceFilenames()

forceFilenames ( 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.

◆ getChildren()

object getChildren ( )

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getConnectedShading()

getConnectedShading ( )

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.

◆ getFirstChild()

EggNode getFirstChild ( )

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.

◆ getNextChild()

EggNode getNextChild ( )

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

◆ hasAbsolutePathnames()

bool hasAbsolutePathnames ( )

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.

◆ hasNormals()

bool hasNormals ( )

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.

◆ hasPrimitives()

bool hasPrimitives ( )

Returns true if there are any primitives (e.g.

polygons) defined within this group or below, false otherwise.

◆ isRight()

static bool isRight ( const LVector2d  v1,
const LVector2d  v2 
)
static

Returns true if the 2-d v1 is to the right of v2.

◆ jointHasPrimitives()

bool jointHasPrimitives ( )

Returns true if there are any primitives (e.g.

polygons) defined within this group or below, but the search does not include nested joints.

◆ makePointPrimitives()

makePointPrimitives ( )

Creates PointLight primitives to reference any otherwise unreferences vertices discovered in this group or below.

◆ meshTriangles()

meshTriangles ( int  flags)

Combine triangles together into triangle strips, at this group and below.

◆ operator=()

EggGroupNode operator= ( const EggGroupNode  copy)

◆ postApplyFlatAttribute()

postApplyFlatAttribute ( 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.

◆ recomputePolygonNormals()

recomputePolygonNormals ( CoordinateSystem  cs)

Recomputes all the polygon normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions.

Normals are removed from the vertices and defined only on polygons, giving the geometry a faceted appearance.

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 normals removed. Thus, it is a good idea to call remove_unused_vertices() after calling this.

◆ recomputeTangentBinormal() [1/2]

bool recomputeTangentBinormal ( 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.

◆ recomputeTangentBinormal() [2/2]

bool recomputeTangentBinormal ( const VectorString  names)

This function recomputes the tangent and binormal for the named texture coordinate sets.

Returns true if anything was done.

◆ recomputeTangentBinormalAuto()

bool recomputeTangentBinormalAuto ( )

This function recomputes the tangent and binormal for any texture coordinate set that affects a normal map.

Returns true if anything was done.

◆ recomputeVertexNormals()

recomputeVertexNormals ( double  threshold,
CoordinateSystem  cs 
)

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.

◆ removeChild()

EggNode removeChild ( EggNode  node)

Removes the indicated child node from the group and returns it.

If the child was not already in the group, does nothing and returns NULL.

◆ removeInvalidPrimitives()

int removeInvalidPrimitives ( bool  recurse)

Removes primitives at this level and below which appear to be degenerate; e.g.

polygons with fewer than 3 vertices, etc. Returns the number of primitives removed.

◆ removeUnusedVertices()

int removeUnusedVertices ( 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.

◆ renameNodes()

int renameNodes ( VectorString  strip_prefix,
bool  recurse 
)

Rename by stripping out the prefix.

◆ resolveFilenames()

resolveFilenames ( const DSearchPath  searchpath)

Walks the tree and attempts to resolve any filenames encountered.

This looks up filenames along the specified search path; it does not automatically search the model_path for missing files.

◆ reverseVertexOrdering()

reverseVertexOrdering ( )

Reverses the vertex ordering of all polygons defined at this node and below.

Does not change the surface normals, if any.

◆ size()

EggGroupNode::SizeType size ( )

◆ stealChildren()

stealChildren ( EggGroupNode  other)

Moves all the children from the other node to this one.

This is especially useful because the group node copy assignment operator does not copy children.

◆ stripNormals()

stripNormals ( )

Removes all normals from primitives, and the vertices they reference, at this node and below.

This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the normal removed. Thus, it is a good idea to call remove_unused_vertices() after calling this.

◆ triangulatePolygons()

int triangulatePolygons ( 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.

◆ unifyAttributes()

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

Member Data Documentation

◆ children

object children