Panda3D
Public Member Functions | Static Public Member Functions

EggVertexPool Class Reference

A collection of vertices. More...

Inheritance diagram for EggVertexPool:
EggNode EggNamedObject EggObject

List of all members.

Public Member Functions

 EggVertexPool (EggVertexPool const copy)
 Copying a vertex pool is of questionable value, since it will copy all of the vertices and assign new pointers to them all.
 EggVertexPool (string name)
EggVertex addVertex (EggVertex vertex, int index)
 Adds the indicated vertex to the pool.
EggVertex addVertex (EggVertex vertex)
 Adds the indicated vertex to the pool.
 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.
 clearUserData ()
 Removes *all* user data pointers from the node.
 clearUserData (TypeHandle type)
 Removes the user data pointer of the indicated type.
EggVertex createUniqueVertex (EggVertex const copy)
 Creates a new vertex in the pool that is a copy of the indicated one and returns it.
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.
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.
bool determineDecal ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set.
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.
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.
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.
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.
bool determineIndexed ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set.
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.
EggVertex findMatchingVertex (EggVertex const copy)
 If the EggVertexPool already has a vertex matching the indicated vertex, returns it; otherwise, returns NULL.
 flattenTransforms ()
 Removes any transform and instance records from this node in the scene graph and below.
int getDepth ()
 Returns the number of nodes above this node in the egg hierarchy.
EggVertex getForwardVertex (int index)
 Returns the vertex in the pool with the indicated index number.
int getHighestIndex ()
 Returns the highest index number used by any vertex in the pool (except forward references).
Mat4D const getNodeFrame ()
 Returns the coordinate frame of the node itself.
Mat4D const getNodeFrameInv ()
 Returns the inverse of the matrix returned by get_node_frame().
Mat4D const getNodeFrameInvPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix.
Mat4D const getNodeFramePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix.
Mat4D const 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.
Mat4D const getNodeToVertexPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix.
int getNumDimensions ()
 Returns the maximum number of dimensions used by any vertex in the pool.
EggGroupNode getParent ()
EggUserData getUserData ()
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored.
EggUserData getUserData (TypeHandle type)
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.
 getUvNames (vectorbasic_stringchar uv_names, vectorbasic_stringchar uvw_names, vectorbasic_stringchar tbn_names)
 Returns the list of UV names that are defined by any vertices in the pool, as well as the subset of UV names that actually define 3-d texture coordinates ("uvw_names").
EggVertex getVertex (int index)
 Returns the vertex in the pool with the indicated index number, or NULL if no vertices have that index number.
Mat4D const getVertexFrame ()
 Returns the coordinate frame of the vertices referenced by primitives at or under this node.
Mat4D const getVertexFrameInv ()
 Returns the inverse of the matrix returned by get_vertex_frame().
Mat4D const getVertexFrameInvPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix.
Mat4D const getVertexFramePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix.
Mat4D const getVertexToNode ()
 Returns the transformation matrix suitable for converting the vertices as read from the egg file into the coordinate space of the node.
Mat4D const getVertexToNodePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix.
bool hasColors ()
 Returns true if any vertex in the pool has a color defined, false if none of them do.
bool hasDefinedVertices ()
 Returns true if any vertices in the pool are fully defined vertices, false if all vertices are forward references.
bool hasForwardVertices ()
 Returns true if any vertices in the pool are undefined forward-reference vertices, false if all vertices are defined.
bool hasNonwhiteColors ()
 Returns true if any vertex in the pool has a color defined other than white, false if no vertices have colors, or if all colors are white.
bool hasNormals ()
 Returns true if any vertex in the pool has a normal defined, false if none of them do.
bool hasUserData (TypeHandle type)
 Returns true if the user data pointer of the indicated type has been set, false otherwise.
bool hasUserData ()
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise.
bool hasUvs ()
 Returns true if any vertex in the pool has a uv defined, false if none of them do.
bool hasVertex (int index)
 Returns true if the indicated vertex has been defined in the vertex pool, false otherwise.
bool isAnimMatrix ()
 Returns true if this node represents a table of animation transformation data, false otherwise.
bool isJoint ()
 Returns true if this particular node represents a <Joint> entry or not.
bool isLocalCoord ()
 Returns true if this node's vertices are not in the global coordinate space.
bool isUnderInstance ()
 Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise.
bool isUnderTransform ()
 Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise.
EggVertex makeNewVertex ()
 Allocates and returns a new vertex from the pool.
EggVertex makeNewVertex (Point2D const pos)
 Allocates and returns a new vertex from the pool.
EggVertex makeNewVertex (Point4D const pos)
 Allocates and returns a new vertex from the pool.
EggVertex makeNewVertex (Point3D const pos)
 Allocates and returns a new vertex from the pool.
EggVertex makeNewVertex (double pos)
 Allocates and returns a new vertex from the pool.
EggVertex operator[] (int index)
 Returns the vertex in the pool with the indicated index number, or NULL if no vertices have that index number.
 output (ostream out)
bool parseEgg (string 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.
int removeUnusedVertices ()
 Removes all vertices from the pool that are not referenced by at least one primitive.
 removeVertex (EggVertex vertex)
 Removes the vertex from the pool.
int renameNode (vectorbasic_stringchar strip_prefix)
 Rename by stripping out the prefix.
 setHighestIndex (int highest_index)
 Artificially changes the "highest index number", so that a newly created vertex will begin at this number plus 1.
 setUserData (EggUserData user_data)
 Sets the user data associated with this object.
unsigned int size ()
 Returns the number of vertices in the pool.
 testUnderIntegrity ()
 Recursively checks the integrity of the _under_flags, _parent, and _depth members of this node and all of its ancestors.
 transform (Mat4D const mat)
 Applies the indicated transformation matrix to all the vertices.
 transformVerticesOnly (Mat4D const mat)
 Applies the indicated transformation only to vertices that appear in global space within vertex pools at this node and below.
 write (ostream out, int indent_level)

Static Public Member Functions

static TypeHandle getClassType ()

Detailed Description

A collection of vertices.

There may be any number of vertex pools in a single egg structure. The vertices in a single pool need not necessarily have any connection to each other, but it is necessary that any one primitive (e.g. a polygon) must pull all its vertices from the same pool.

An EggVertexPool is an STL-style container of pointers to EggVertex's. Functions add_vertex() and remove_vertex() are provided to manipulate the list. The list may also be operated on (read-only) via iterators and begin()/end().


Constructor & Destructor Documentation

EggVertexPool ( EggVertexPool const  copy)

Copying a vertex pool is of questionable value, since it will copy all of the vertices and assign new pointers to them all.

There will be no polygons referring to the new vertices.

EggVertexPool ( string  name)

Member Function Documentation

EggVertex addVertex ( EggVertex  vertex,
int  index 
)

Adds the indicated vertex to the pool.

It is an error if the vertex is already a member of this or any other pool. The vertex must have been allocated from the free store; its pointer will now be owned by the vertex pool. If the index number is supplied, tries to assign that index number; it is an error if the index number is already in use.

It is possible that a forward reference to this vertex was requested in the past; if so, the data from the supplied vertex is copied onto the forward reference, which becomes the actual vertex. In this case, a different pointer is saved (and returned) than the one actually passed in. In the usual case, however, the vertex pointer passed in is the one that is saved in the vertex pool and returned from this method.

EggVertex addVertex ( EggVertex  vertex)

Adds the indicated vertex to the pool.

It is an error if the vertex is already a member of this or any other pool. The vertex must have been allocated from the free store; its pointer will now be owned by the vertex pool. If the index number is supplied, tries to assign that index number; it is an error if the index number is already in use.

It is possible that a forward reference to this vertex was requested in the past; if so, the data from the supplied vertex is copied onto the forward reference, which becomes the actual vertex. In this case, a different pointer is saved (and returned) than the one actually passed in. In the usual case, however, the vertex pointer passed in is the one that is saved in the vertex pool and returned from this method.

applyTexmats ( ) [inherited]

Applies the texture matrices to the UV's of the vertices that reference them, and then removes the texture matrices from the textures themselves.

clearUserData ( ) [inherited]

Removes *all* user data pointers from the node.

clearUserData ( TypeHandle  type) [inherited]

Removes the user data pointer of the indicated type.

EggVertex createUniqueVertex ( EggVertex const  copy)

Creates a new vertex in the pool that is a copy of the indicated one and returns it.

If there is already a vertex in the pool like the indicated one, simply returns that one.

EggRenderMode determineAlphaMode ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

EggRenderMode determineBin ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

bool determineDecal ( ) [inherited]

Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set.

Returns the value of the decal flag if it is found, or false if it is not.

In other words, returns true if the "decal" flag is in effect for the indicated node, false otherwise.

Reimplemented in EggGroup.

EggRenderMode determineDepthOffset ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

EggRenderMode determineDepthTestMode ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

EggRenderMode determineDepthWriteMode ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

EggRenderMode determineDrawOrder ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

bool determineIndexed ( ) [inherited]

Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set.

Returns the value of the indexed scalar if it is found, or false if it is not.

In other words, returns true if the "indexed" flag is in effect for the indicated node, false otherwise.

Reimplemented in EggGroup.

EggRenderMode determineVisibilityMode ( ) [inherited]

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.

Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

Reimplemented in EggGroup, and EggPrimitive.

EggVertex findMatchingVertex ( EggVertex const  copy)

If the EggVertexPool already has a vertex matching the indicated vertex, returns it; otherwise, returns NULL.

This is similar to create_unique_vertex() except that a new vertex is never created.

flattenTransforms ( ) [inherited]

Removes any transform and instance records from this node in the scene graph and below.

If an instance node is encountered, removes the instance and applies the transform to its vertices, duplicating vertices if necessary.

Since this function may result in duplicated vertices, it may be a good idea to call remove_unused_vertices() after calling this.

static TypeHandle getClassType ( ) [static]

Reimplemented from EggNode.

int getDepth ( ) [inherited]

Returns the number of nodes above this node in the egg hierarchy.

EggVertex getForwardVertex ( int  index)

Returns the vertex in the pool with the indicated index number.

If there is not a vertex in the pool with the indicated index number, creates a special forward-reference EggVertex that has no data, on the assumption that the vertex pool has not yet been fully read and more data will be available later.

int getHighestIndex ( )

Returns the highest index number used by any vertex in the pool (except forward references).

Returns -1 if the pool is empty.

Mat4D const getNodeFrame ( ) [inherited]

Returns the coordinate frame of the node itself.

This is simply the net product of all transformations up to the root.

Mat4D const getNodeFrameInv ( ) [inherited]

Returns the inverse of the matrix returned by get_node_frame().

See get_node_frame().

Mat4D const getNodeFrameInvPtr ( ) [inherited]

Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix.

Mat4D const getNodeFramePtr ( ) [inherited]

Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix.

Mat4D const getNodeToVertex ( ) [inherited]

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.

This is the same thing as:

get_node_frame() * get_vertex_frame_inv()

Mat4D const getNodeToVertexPtr ( ) [inherited]

Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix.

int getNumDimensions ( )

Returns the maximum number of dimensions used by any vertex in the pool.

EggGroupNode getParent ( ) [inherited]
EggUserData getUserData ( ) [inherited]

Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored.

EggUserData getUserData ( TypeHandle  type) [inherited]

Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.

getUvNames ( vectorbasic_stringchar  uv_names,
vectorbasic_stringchar  uvw_names,
vectorbasic_stringchar  tbn_names 
)

Returns the list of UV names that are defined by any vertices in the pool, as well as the subset of UV names that actually define 3-d texture coordinates ("uvw_names").

Also returns the subset of UV/UVW names that define a tangent and binormal. It is the user's responsibility to clear both vectors before calling this method.

EggVertex getVertex ( int  index)

Returns the vertex in the pool with the indicated index number, or NULL if no vertices have that index number.

Mat4D const getVertexFrame ( ) [inherited]

Returns the coordinate frame of the vertices referenced by primitives at or under this node.

This is not the same as get_node_frame().

Generally, vertices in an egg file are stored in the global coordinate space, regardless of the transforms defined at each node. Thus, get_vertex_frame() will usually return the identity transform (global coordinate space). However, primitives under an <Instance> entry reference their vertices in the coordinate system under effect at the time of the <Instance>. Thus, nodes under an <Instance> entry may return this non-identity matrix.

Specifically, this may return a non-identity matrix only if is_local_coord() is true.

Mat4D const getVertexFrameInv ( ) [inherited]

Returns the inverse of the matrix returned by get_vertex_frame().

See get_vertex_frame().

Mat4D const getVertexFrameInvPtr ( ) [inherited]

Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix.

Mat4D const getVertexFramePtr ( ) [inherited]

Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix.

Mat4D const getVertexToNode ( ) [inherited]

Returns the transformation matrix suitable for converting the vertices as read from the egg file into the coordinate space of the node.

This is the same thing as:

get_vertex_frame() * get_node_frame_inv()

Mat4D const getVertexToNodePtr ( ) [inherited]

Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix.

bool hasColors ( )

Returns true if any vertex in the pool has a color defined, false if none of them do.

bool hasDefinedVertices ( )

Returns true if any vertices in the pool are fully defined vertices, false if all vertices are forward references.

bool hasForwardVertices ( )

Returns true if any vertices in the pool are undefined forward-reference vertices, false if all vertices are defined.

bool hasNonwhiteColors ( )

Returns true if any vertex in the pool has a color defined other than white, false if no vertices have colors, or if all colors are white.

bool hasNormals ( )

Returns true if any vertex in the pool has a normal defined, false if none of them do.

bool hasUserData ( TypeHandle  type) [inherited]

Returns true if the user data pointer of the indicated type has been set, false otherwise.

bool hasUserData ( ) [inherited]

Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise.

bool hasUvs ( )

Returns true if any vertex in the pool has a uv defined, false if none of them do.

bool hasVertex ( int  index)

Returns true if the indicated vertex has been defined in the vertex pool, false otherwise.

This does not include forward references.

bool isAnimMatrix ( ) [inherited]

Returns true if this node represents a table of animation transformation data, false otherwise.

bool isJoint ( ) [inherited]

Returns true if this particular node represents a <Joint> entry or not.

This is a handy thing to know since Joints are sorted to the end of their sibling list when writing an egg file. See EggGroupNode.write().

Reimplemented in EggGroup.

bool isLocalCoord ( ) [inherited]

Returns true if this node's vertices are not in the global coordinate space.

This will be the case if there was an <Instance> node under a transform at or above this node.

bool isUnderInstance ( ) [inherited]

Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise.

bool isUnderTransform ( ) [inherited]

Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise.

EggVertex makeNewVertex ( )

Allocates and returns a new vertex from the pool.

This is one of three ways to add new vertices to a vertex pool.

EggVertex makeNewVertex ( Point2D const  pos)

Allocates and returns a new vertex from the pool.

This is one of three ways to add new vertices to a vertex pool.

This flavor of make_new_vertex() explicitly sets the vertex position as it is allocated. It does not attempt to share vertices.

EggVertex makeNewVertex ( Point4D const  pos)

Allocates and returns a new vertex from the pool.

This is one of three ways to add new vertices to a vertex pool.

This flavor of make_new_vertex() explicitly sets the vertex position as it is allocated. It does not attempt to share vertices.

EggVertex makeNewVertex ( Point3D const  pos)

Allocates and returns a new vertex from the pool.

This is one of three ways to add new vertices to a vertex pool.

This flavor of make_new_vertex() explicitly sets the vertex position as it is allocated. It does not attempt to share vertices.

EggVertex makeNewVertex ( double  pos)

Allocates and returns a new vertex from the pool.

This is one of three ways to add new vertices to a vertex pool.

This flavor of make_new_vertex() explicitly sets the vertex position as it is allocated. It does not attempt to share vertices.

EggVertex operator[] ( int  index)

Returns the vertex in the pool with the indicated index number, or NULL if no vertices have that index number.

output ( ostream  out) [inherited]
bool parseEgg ( string  egg_syntax) [inherited]

Parses the egg syntax given in the indicate string as if it had been read from the egg file within this object's definition.

Updates the object accordingly. Returns true if successful, false if there was some parse error or if the object does not support this functionality.

int removeUnusedVertices ( )

Removes all vertices from the pool 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 number of vertices removed.

removeVertex ( EggVertex  vertex)

Removes the vertex from the pool.

It is an error if the vertex is not already a member of the pool.

int renameNode ( vectorbasic_stringchar  strip_prefix) [inherited]

Rename by stripping out the prefix.

setHighestIndex ( int  highest_index)

Artificially changes the "highest index number", so that a newly created vertex will begin at this number plus 1.

This can be used to default a vertex pool to start counting at 1 (or any other index number), instead of the default of 0. Use with caution.

setUserData ( EggUserData  user_data) [inherited]

Sets the user data associated with this object.

This may be any EggUserData-derived object. The egg library will do nothing with this pointer, except to hold its reference count and return the pointer on request.

The EggObject maintains multiple different EggUserData pointers, one for each unique type (as reported by get_type()). If you know that only one type of EggUserData object will be added in your application, you may use the query functions that accept no parameters, but it is recommended that in general you pass in the type of your particular user data, to allow multiple applications to coexist in the same egg data.

This pointer is also copied by the copy assignment operator and copy constructor.

unsigned int size ( )

Returns the number of vertices in the pool.

testUnderIntegrity ( ) [inherited]

Recursively checks the integrity of the _under_flags, _parent, and _depth members of this node and all of its ancestors.

transform ( Mat4D const  mat)

Applies the indicated transformation matrix to all the vertices.

However, vertices that are attached to primitives that believe their vertices are in a local coordinate system are transformed only by the scale and rotation component. If a vertex happens to be attached both to a local and a global primitive, and the transformation includes a translation component, the vertex will be split.

Reimplemented from EggNode.

transformVerticesOnly ( Mat4D const  mat) [inherited]

Applies the indicated transformation only to vertices that appear in global space within vertex pools at this node and below.

Joints and other transforms are not affected, nor are local vertices.

write ( ostream  out,
int  indent_level 
) [inherited]

Reimplemented in EggGroup, EggTexture, and EggPrimitive.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties