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

A base class for things that may be directly added into the egg hierarchy. More...

Inheritance diagram for EggNode:
EggNamedObject EggObject Namable TypedReferenceCount TypedObject ReferenceCount EggAnimData EggAnimPreload EggComment EggCoordinateSystem EggFilenameNode EggGroupNode EggMaterial EggPrimitive EggVertexPool

Public Member Functions

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

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 things that may be directly added into the egg hierarchy.

This includes groups, joints, polygons, vertex pools, etc., but does not include things like vertices.

Member Function Documentation

◆ applyTexmats()

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.

◆ determineAlphaMode()

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.

◆ determineBin()

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.

◆ determineDecal()

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.

In other words, returns true if the "decal" flag is in effect for the indicated node, false 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 node 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 node that has a draw_order specified.

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

◆ determineIndexed()

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.

In other words, returns true if the "indexed" flag is in effect for the indicated node, false 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.

◆ flattenTransforms()

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.

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

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDepth()

int getDepth ( )

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

◆ getNodeFrame()

const LMatrix4d getNodeFrame ( )

Returns the coordinate frame of the node itself.

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

◆ getNodeFrameInv()

const LMatrix4d getNodeFrameInv ( )

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

See get_node_frame().

◆ getNodeFrameInvPtr()

const LMatrix4d getNodeFrameInvPtr ( )

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

◆ getNodeFramePtr()

const LMatrix4d getNodeFramePtr ( )

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

◆ getNodeToVertex()

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:

get_node_frame() * get_vertex_frame_inv()

◆ getNodeToVertexPtr()

const LMatrix4d getNodeToVertexPtr ( )

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

◆ getParent()

EggGroupNode getParent ( )

◆ getVertexFrame()

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

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.

◆ getVertexFrameInv()

const LMatrix4d getVertexFrameInv ( )

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

See get_vertex_frame().

◆ getVertexFrameInvPtr()

const LMatrix4d getVertexFrameInvPtr ( )

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

◆ getVertexFramePtr()

const LMatrix4d getVertexFramePtr ( )

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

◆ getVertexToNode()

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:

get_vertex_frame() * get_node_frame_inv()

◆ getVertexToNodePtr()

const LMatrix4d getVertexToNodePtr ( )

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

◆ isAnimMatrix()

bool isAnimMatrix ( )

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

◆ isJoint()

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

◆ isLocalCoord()

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.

◆ isUnderInstance()

bool isUnderInstance ( )

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

◆ isUnderTransform()

bool isUnderTransform ( )

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

◆ operator=()

EggNode operator= ( const EggNode  copy)

◆ parseEgg()

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.

◆ renameNode()

int renameNode ( VectorString  strip_prefix)

Rename by stripping out the prefix.

◆ testUnderIntegrity()

testUnderIntegrity ( )

◆ transform()

transform ( const LMatrix4d  mat)

Applies the indicated transformation to the node and all of its descendants.

◆ transformVerticesOnly()

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.

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ depth

int depth

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

◆ parent

EggGroupNode parent