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

A base class for any of a number of kinds of geometry primitives: polygons, point lights, nurbs patches, parametrics curves, etc. Things with a set of vertices and some rendering properties like color. More...

Inheritance diagram for EggPrimitive:
EggNode EggAttributes EggRenderMode EggNamedObject MemoryBase EggObject Namable TypedReferenceCount MemoryBase TypedObject ReferenceCount MemoryBase MemoryBase EggCompositePrimitive EggCurve EggPatch EggPoint EggPolygon EggSurface EggLine EggTriangleFan EggTriangleStrip EggNurbsCurve EggNurbsSurface

Public Types

enum  Shading { S_unknown = 0, S_overall = 1, S_per_face = 2, S_per_vertex = 3 }
 
- Public Types inherited from EggRenderMode
enum  AlphaMode {
  AM_unspecified = 0, AM_off = 1, AM_on = 2, AM_blend = 3,
  AM_blend_no_occlude = 4, AM_ms = 5, AM_ms_mask = 6, AM_binary = 7,
  AM_dual = 8
}
 Specifies implementation of transparency. More...
 
enum  DepthTestMode { DTM_unspecified = 0, DTM_off = 1, DTM_on = 2 }
 
enum  DepthWriteMode { DWM_unspecified = 0, DWM_off = 1, DWM_on = 2 }
 
enum  VisibilityMode { VM_unspecified = 0, VM_hidden = 1, VM_normal = 2 }
 

Public Member Functions

 addTexture (EggTexture texture)
 Applies the indicated texture to the primitive. More...
 
EggVertex addVertex (EggVertex vertex)
 Adds the indicated vertex to the end of the primitive's list of vertices, and returns it. More...
 
 applyFirstAttribute ()
 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. More...
 
 applyLastAttribute ()
 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. More...
 
bool cleanup ()
 Cleans up modeling errors in whatever context this makes sense. For instance, for a polygon, this calls remove_doubled_verts(true). For a point, it calls remove_nonunique_verts(). Returns true if the primitive is valid, or false if it is degenerate. More...
 
 clear ()
 Removes all of the vertices from the primitive. More...
 
 clearConnectedShading ()
 Resets the connected_shading member in this primitive, so that get_connected_shading() will recompute a new value. More...
 
 clearMaterial ()
 Removes any material from the primitive. More...
 
 clearTexture ()
 Removes any texturing from the primitive. More...
 
 copyAttributes (const EggAttributes other)
 Copies the rendering attributes from the indicated primitive. More...
 
 copyAttributes (const EggPrimitive other)
 Copies the rendering attributes from the indicated primitive. More...
 
 copyVertices (const EggPrimitive other)
 Replaces the current primitive's list of vertices with a copy of the list of vertices on the other primitive. More...
 
EggRenderMode determineAlphaMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has an alpha_mode other than AM_unspecified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
EggRenderMode determineBin ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has a bin specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
EggRenderMode determineDepthOffset ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has a depth_offset specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
EggRenderMode determineDrawOrder ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has a draw_order specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
bool getBfaceFlag ()
 Retrieves the backfacing flag of the polygon. See set_bface_flag(). More...
 
EggPrimitive::Shading getConnectedShading ()
 Determines what sort of shading properties this primitive's connected neighbors have. More...
 
EggMaterial getMaterial ()
 Returns a pointer to the applied material, or NULL if there is no material applied. More...
 
int getNumTextures ()
 Returns the number of textures applied to the primitive. More...
 
int getNumVertices ()
 
EggVertexPool getPool ()
 Returns the vertex pool associated with the vertices of the primitive, or NULL if the primitive has no vertices. More...
 
EggPrimitive::Shading getShading ()
 Returns the shading properties apparent on this particular primitive. This returns S_per_vertex if the vertices have colors or normals (and they are not all the same values), or for a simple primitive, S_overall otherwise. A composite primitive may also return S_per_face if the individual component primitives have colors or normals that are not all the same values. More...
 
str getSortName ()
 Returns the name of the primitive for the purposes of sorting primitives into different groups, if there is one. More...
 
EggTexture getTexture ()
 Returns the first texture on the primitive, if any, or NULL if there are no textures on the primitive. More...
 
EggTexture getTexture (int n)
 Returns the nth texture that has been applied to the primitive. More...
 
list getTextures ()
 
EggVertex getVertex (int index)
 Returns a particular index based on its index number. More...
 
list getVertices ()
 
bool hasMaterial ()
 Returns true if the primitive is materiald (and get_material() will return a real pointer), false otherwise (and get_material() will return NULL). More...
 
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. More...
 
bool hasPrimitives ()
 Returns true if there are any primitives (e.g. polygons) defined within this group or below, false otherwise. More...
 
bool hasTexture ()
 Returns true if the primitive has any textures specified, false otherwise. More...
 
bool hasTexture (EggTexture texture)
 Returns true if the primitive has the particular indicated texture, false otherwise. More...
 
bool hasVertexColor ()
 Returns true if any vertex on the primitive has a specific color set, false otherwise. More...
 
bool hasVertexNormal ()
 Returns true if any vertex on the primitive has a specific normal set, false otherwise. More...
 
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. More...
 
EggPrimitive operator= (const EggPrimitive copy)
 
 postApplyFlatAttribute ()
 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...
 
 removeDoubledVerts (bool closed)
 Certain kinds of primitives, particularly polygons, don't like to have the same vertex repeated consecutively. Unfortunately, some modeling programs (like MultiGen) make this an easy mistake to make. More...
 
 removeNonuniqueVerts ()
 Removes any multiple appearances of the same vertex from the primitive. This primarily makes sense for a point primitive, which is really a collection of points and which doesn't make sense to include the same point twice, in any order. More...
 
EggVertex removeVertex (EggVertex vertex)
 Removes the indicated vertex from the primitive and returns it. If the vertex was not already in the primitive, does nothing and returns NULL. More...
 
 reverseVertexOrdering ()
 Reverses the ordering of the vertices in this primitive, if appropriate, in order to change the direction the polygon appears to be facing. Does not adjust the surface normal, if any. More...
 
 setBfaceFlag (bool flag)
 Sets the backfacing flag of the polygon. If this is true, the polygon will be rendered so that both faces are visible; if it is false, only the front face of the polygon will be visible. More...
 
 setMaterial (EggMaterial material)
 Applies the indicated material to the primitive. More...
 
 setTexture (EggTexture texture)
 Replaces the current list of textures with the indicated texture. More...
 
 setVertex (int index, EggVertex vertex)
 Replaces a particular vertex based on its index number in the list of vertices. This is just a convenience function for people who don't want to mess with the iterators. More...
 
 testVrefIntegrity ()
 
 unifyAttributes (EggPrimitive::Shading shading)
 If the shading property is S_per_vertex, ensures that all vertices have a normal and a color, and the overall primitive does not. More...
 
 write (Ostream out, int indent_level)
 
- 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
bool determineDecal ()
 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. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
bool determineIndexed ()
 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. 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise. More...
 
 flattenTransforms ()
 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. 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. This is simply the net product of all transformations up to the root. More...
 
const LMatrix4d getNodeFrameInv ()
 Returns the inverse of the matrix returned by get_node_frame(). See 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. This is the same thing as: 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. This is not the same as get_node_frame(). More...
 
const LMatrix4d getVertexFrameInv ()
 Returns the inverse of the matrix returned by get_vertex_frame(). See 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. This is the same thing as: 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. 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(). More...
 
bool isLocalCoord ()
 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. 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. Updates the object accordingly. Returns true if successful, false if there was some parse error or if the object does not support this functionality. 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. Joints and other transforms are not affected, nor are local vertices. 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. 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. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). 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. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable copy)
 
 __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...
 
Namable operator= (const Namable other)
 
 output (Ostream out)
 Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More...
 
 setName (str name)
 
- Public Member Functions inherited from EggAttributes
 __init__ ()
 
 __init__ (const EggAttributes copy)
 
 clearColor ()
 
 clearNormal ()
 
int compareTo (const EggAttributes other)
 An ordering operator to compare two vertices for sorting order. This imposes an arbitrary ordering useful to identify unique vertices. More...
 
 copyColor (const EggAttributes other)
 Sets this color to be the same as the other's, include morphs. If the other has no color, this clears the color. More...
 
 copyNormal (const EggAttributes other)
 Sets this normal to be the same as the other's, include morphs. If the other has no normal, this clears the normal. More...
 
LColor getColor ()
 Returns the color set on this particular attribute. If there is no color set, returns white. More...
 
const LNormald getNormal ()
 
bool hasColor ()
 
bool hasNormal ()
 
bool matchesColor (const EggAttributes other)
 Returns true if this color matches that of the other EggAttributes object, include the morph list. More...
 
bool matchesNormal (const EggAttributes other)
 Returns true if this normal matches that of the other EggAttributes object, include the morph list. More...
 
EggAttributes operator= (const EggAttributes copy)
 
 setColor (const LColor Color)
 
 setNormal (const LNormald normal)
 
bool sortsLessThan (const EggAttributes other)
 An ordering operator to compare two vertices for sorting order. This imposes an arbitrary ordering useful to identify unique vertices. More...
 
 transform (const LMatrix4d mat)
 Applies the indicated transformation matrix to the attributes. More...
 
 write (Ostream out, int indent_level)
 Writes the attributes to the indicated output stream in Egg format. More...
 
- Public Member Functions inherited from EggRenderMode
 __init__ ()
 
 __init__ (const EggRenderMode copy)
 
 clearBin ()
 Removes the bin name that was set for this particular object. See set_bin(). More...
 
 clearDepthOffset ()
 Removes the depth-offset flag from this particular object. See set_depth_offset(). More...
 
 clearDrawOrder ()
 Removes the draw-order flag from this particular object. See set_draw_order(). More...
 
EggRenderMode::AlphaMode getAlphaMode ()
 Returns the alpha mode that was set, or AM_unspecified if nothing was set. See set_alpha_mode(). More...
 
str getBin ()
 Returns the bin name that has been set for this particular object, if any. See set_bin(). More...
 
int getDepthOffset ()
 Returns the "depth-offset" flag as set for this particular object. See set_depth_offset(). More...
 
EggRenderMode::DepthTestMode getDepthTestMode ()
 Returns the depth_test mode that was set, or DTM_unspecified if nothing was set. See set_depth_test_mode(). More...
 
EggRenderMode::DepthWriteMode getDepthWriteMode ()
 Returns the depth_write mode that was set, or DWM_unspecified if nothing was set. See set_depth_write_mode(). More...
 
int getDrawOrder ()
 Returns the "draw-order" flag as set for this particular object. See set_draw_order(). More...
 
EggRenderMode::VisibilityMode getVisibilityMode ()
 Returns the visibility mode that was set, or VM_unspecified if nothing was set. See set_visibility_mode(). More...
 
bool hasBin ()
 Returns true if a bin name has been set for this particular object. See set_bin(). More...
 
bool hasDepthOffset ()
 Returns true if the depth-offset flag has been set for this particular object. See set_depth_offset(). More...
 
bool hasDrawOrder ()
 Returns true if the draw-order flag has been set for this particular object. See set_draw_order(). More...
 
bool operator!= (const EggRenderMode other)
 
bool operator< (const EggRenderMode other)
 
EggRenderMode operator= (const EggRenderMode copy)
 
bool operator== (const EggRenderMode other)
 Comparison operators are handy. More...
 
 setAlphaMode (EggRenderMode::AlphaMode mode)
 Specifies precisely how the transparency for this geometry should be achieved, or if it should be used. The default, AM_unspecified, is to use transparency if the geometry has a color whose alpha value is non-1, or if it has a four-channel texture applied; otherwise, AM_on forces transparency on, and AM_off forces it off. The other flavors of transparency are specific ways to turn on transparency, which may or may not be supported by a particular rendering backend. More...
 
 setBin (str bin)
 Sets the "bin" string for this particular object. This names a particular bin in which the object should be rendered. The exact meaning of a bin is implementation defined, but generally a GeomBin matching each bin name must also be specifically added to the rendering engine (e.g. the CullTraverser) in use for this to work. See also set_draw_order(). More...
 
 setDepthOffset (int bias)
 Sets the "depth-offset" flag associated with this object. This adds or subtracts an offset bias into the depth buffer. See also DepthOffsetAttrib and NodePath::set_depth_offset(). More...
 
 setDepthTestMode (EggRenderMode::DepthTestMode mode)
 Specifies whether this geometry should be tested against the depth buffer when it is drawn (assuming the rendering backend provides a depth buffer). Note that this is different, and independent from, the depth_write mode. More...
 
 setDepthWriteMode (EggRenderMode::DepthWriteMode mode)
 Specifies whether writes should be made to the depth buffer (assuming the rendering backend provides a depth buffer) when rendering this geometry. More...
 
 setDrawOrder (int order)
 Sets the "draw-order" flag associated with this object. This specifies a particular order in which objects of this type should be drawn, within the specified bin. If a bin is not explicitly specified, "fixed" is used. See also set_bin(). More...
 
 setVisibilityMode (EggRenderMode::VisibilityMode mode)
 Specifies whether this geometry is to be considered normally visible, or hidden. If it is hidden, it is either not loaded into the scene graph at all, or loaded as a "stashed" node, according to the setting of egg-suppress-hidden. More...
 
 write (Ostream out, int indent_level)
 Writes the attributes to the indicated output stream in Egg format. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- 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 ()
 
- Static Public Member Functions inherited from EggAttributes
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggRenderMode
static TypeHandle getClassType ()
 
static EggRenderMode::AlphaMode stringAlphaMode (str string)
 Returns the AlphaMode value associated with the given string representation, or AM_unspecified if the string does not match any known AlphaMode value. More...
 
static EggRenderMode::DepthTestMode stringDepthTestMode (str string)
 Returns the DepthTestMode value associated with the given string representation, or DTM_unspecified if the string does not match any known DepthTestMode value. More...
 
static EggRenderMode::DepthWriteMode stringDepthWriteMode (str string)
 Returns the DepthWriteMode value associated with the given string representation, or DWM_unspecified if the string does not match any known DepthWriteMode value. More...
 
static EggRenderMode::VisibilityMode stringVisibilityMode (str string)
 Returns the HiddenMode value associated with the given string representation, or VM_unspecified if the string does not match any known HiddenMode value. More...
 

Additional Inherited Members

- Public Attributes inherited from EggAttributes
EggMorphNormalList _dnormals
 
EggMorphColorList _drgbas
 

Detailed Description

A base class for any of a number of kinds of geometry primitives: polygons, point lights, nurbs patches, parametrics curves, etc. Things with a set of vertices and some rendering properties like color.

An EggPrimitive is an STL-style container of pointers to EggVertex's. In fact, it IS a vector, and can be manipulated in all the ways that vectors can. However, it is necessary that all vertices belong to the same vertex pool.

Member Enumeration Documentation

◆ Shading

enum Shading
Enumerator
S_unknown 

The order here is important. The later choices are more specific than the earlier ones.

S_overall 
S_per_face 
S_per_vertex 

Member Function Documentation

◆ addTexture()

addTexture ( EggTexture  texture)

Applies the indicated texture to the primitive.

Note that, in the case of multiple textures being applied to a single primitive, the order in which the textures are applied does not affect the rendering order; use EggTexture::set_sort() to specify that.

◆ addVertex()

EggVertex addVertex ( EggVertex  vertex)

Adds the indicated vertex to the end of the primitive's list of vertices, and returns it.

◆ applyFirstAttribute()

applyFirstAttribute ( )

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 introduce redundant vertices to the vertex pool.

◆ applyLastAttribute()

applyLastAttribute ( )

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 introduce redundant vertices to the vertex pool.

◆ cleanup()

bool cleanup ( )

Cleans up modeling errors in whatever context this makes sense. For instance, for a polygon, this calls remove_doubled_verts(true). For a point, it calls remove_nonunique_verts(). Returns true if the primitive is valid, or false if it is degenerate.

◆ clear()

clear ( )

Removes all of the vertices from the primitive.

◆ clearConnectedShading()

clearConnectedShading ( )

Resets the connected_shading member in this primitive, so that get_connected_shading() will recompute a new value.

◆ clearMaterial()

clearMaterial ( )

Removes any material from the primitive.

◆ clearTexture()

clearTexture ( )

Removes any texturing from the primitive.

◆ copyAttributes() [1/2]

copyAttributes ( const EggAttributes  other)

Copies the rendering attributes from the indicated primitive.

◆ copyAttributes() [2/2]

copyAttributes ( const EggPrimitive  other)

Copies the rendering attributes from the indicated primitive.

◆ copyVertices()

copyVertices ( const EggPrimitive  other)

Replaces the current primitive's list of vertices with a copy of the list of vertices on the other primitive.

◆ determineAlphaMode()

EggRenderMode determineAlphaMode ( )

Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has an alpha_mode other than AM_unspecified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ determineBin()

EggRenderMode determineBin ( )

Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has a bin specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ determineDepthOffset()

EggRenderMode determineDepthOffset ( )

Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has a depth_offset specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ determineDepthTestMode()

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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ determineDepthWriteMode()

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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ determineDrawOrder()

EggRenderMode determineDrawOrder ( )

Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this primitive that has a draw_order specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ determineVisibilityMode()

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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

◆ getBfaceFlag()

bool getBfaceFlag ( )

Retrieves the backfacing flag of the polygon. See set_bface_flag().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getConnectedShading()

EggPrimitive::Shading getConnectedShading ( )

Determines what sort of shading properties this primitive's connected neighbors have.

To get the most accurate results, you should first call clear_connected_shading() on all connected primitives (or on all primitives in the egg file). It might also be a good idea to call remove_unused_vertices() to ensure proper connectivity.

You may find it easiest to call these other methods on the EggData root node (they are defined on EggGroupNode).

◆ getMaterial()

EggMaterial getMaterial ( )

Returns a pointer to the applied material, or NULL if there is no material applied.

◆ getNumTextures()

int getNumTextures ( )

Returns the number of textures applied to the primitive.

◆ getNumVertices()

int getNumVertices ( )

◆ getPool()

EggVertexPool getPool ( )

Returns the vertex pool associated with the vertices of the primitive, or NULL if the primitive has no vertices.

◆ getShading()

EggPrimitive::Shading getShading ( )

Returns the shading properties apparent on this particular primitive. This returns S_per_vertex if the vertices have colors or normals (and they are not all the same values), or for a simple primitive, S_overall otherwise. A composite primitive may also return S_per_face if the individual component primitives have colors or normals that are not all the same values.

To get the most accurate results, you should call clear_shading() on all connected primitives (or on all primitives in the egg file), followed by get_shading() on each primitive. You may find it easiest to call these methods on the EggData root node (they are defined on EggGroupNode).

◆ getSortName()

str getSortName ( )

Returns the name of the primitive for the purposes of sorting primitives into different groups, if there is one.

Presently, this is defined as the primitive name itself, unless it begins with a digit.

◆ getTexture() [1/2]

EggTexture getTexture ( )

Returns the first texture on the primitive, if any, or NULL if there are no textures on the primitive.

This method is deprecated and is used in support of single-texturing only. New code should be written to use the multitexture variants instead.

◆ getTexture() [2/2]

EggTexture getTexture ( int  n)

Returns the nth texture that has been applied to the primitive.

◆ getTextures()

list getTextures ( )

◆ getVertex()

EggVertex getVertex ( int  index)

Returns a particular index based on its index number.

◆ getVertices()

list getVertices ( )

◆ hasMaterial()

bool hasMaterial ( )

Returns true if the primitive is materiald (and get_material() will return a real pointer), false otherwise (and get_material() will return NULL).

◆ 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.

◆ hasTexture() [1/2]

bool hasTexture ( )

Returns true if the primitive has any textures specified, false otherwise.

This method is deprecated and is used in support of single-texturing only. New code should be written to use the multitexture variants instead.

◆ hasTexture() [2/2]

bool hasTexture ( EggTexture  texture)

Returns true if the primitive has the particular indicated texture, false otherwise.

◆ hasVertexColor()

bool hasVertexColor ( )

Returns true if any vertex on the primitive has a specific color set, false otherwise.

If you call unify_attributes() first, this will also return false even if all the vertices were set to the same value (since unify_attributes() removes redundant vertex properties).

◆ hasVertexNormal()

bool hasVertexNormal ( )

Returns true if any vertex on the primitive has a specific normal set, false otherwise.

If you call unify_attributes() first, this will also return false even if all the vertices were set to the same value (since unify_attributes() removes redundant vertex properties).

◆ 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.

◆ operator=()

EggPrimitive operator= ( const EggPrimitive  copy)

◆ postApplyFlatAttribute()

postApplyFlatAttribute ( )

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.

◆ removeDoubledVerts()

removeDoubledVerts ( bool  closed)

Certain kinds of primitives, particularly polygons, don't like to have the same vertex repeated consecutively. Unfortunately, some modeling programs (like MultiGen) make this an easy mistake to make.

It's handy to have a function to remove these redundant vertices. If closed is true, it also checks that the first and last vertices are not the same.

This function identifies repeated vertices by position only; it does not consider any other properties, such as color or UV, significant in differentiating vertices.

◆ removeNonuniqueVerts()

removeNonuniqueVerts ( )

Removes any multiple appearances of the same vertex from the primitive. This primarily makes sense for a point primitive, which is really a collection of points and which doesn't make sense to include the same point twice, in any order.

◆ removeVertex()

EggVertex removeVertex ( EggVertex  vertex)

Removes the indicated vertex from the primitive and returns it. If the vertex was not already in the primitive, does nothing and returns NULL.

◆ reverseVertexOrdering()

reverseVertexOrdering ( )

Reverses the ordering of the vertices in this primitive, if appropriate, in order to change the direction the polygon appears to be facing. Does not adjust the surface normal, if any.

◆ setBfaceFlag()

setBfaceFlag ( bool  flag)

Sets the backfacing flag of the polygon. If this is true, the polygon will be rendered so that both faces are visible; if it is false, only the front face of the polygon will be visible.

◆ setMaterial()

setMaterial ( EggMaterial  material)

Applies the indicated material to the primitive.

◆ setTexture()

setTexture ( EggTexture  texture)

Replaces the current list of textures with the indicated texture.

This method is deprecated and is used in support of single-texturing only. Please use the multitexture variant add_texture instead.

◆ setVertex()

setVertex ( int  index,
EggVertex  vertex 
)

Replaces a particular vertex based on its index number in the list of vertices. This is just a convenience function for people who don't want to mess with the iterators.

◆ testVrefIntegrity()

testVrefIntegrity ( )

◆ unifyAttributes()

unifyAttributes ( EggPrimitive::Shading  shading)

If the shading property is S_per_vertex, ensures that all vertices have a normal and a color, and the overall primitive does not.

If the shading property is S_per_face, and this is a composite primitive, ensures that all components have a normal and a color, and the vertices and overall primitive do not. (If this is a simple primitive, S_per_face works the same as S_overall, below).

If the shading property is S_overall, ensures that no vertices or components have a normal or a color, and the overall primitive does (if any exists at all).

After this call, either the primitive will have normals or its vertices will, but not both. Ditto for colors.

This may create redundant vertices in the vertex pool.

◆ write()

write ( Ostream  out,
int  indent_level 
)