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

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

#include "eggNode.h"

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

Public Member Functions

 EggNode (const std::string &name="")
 
 EggNode (const EggNode &copy)
 
void apply_texmats ()
 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...
 
virtual EggRenderModedetermine_alpha_mode ()
 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...
 
virtual EggRenderModedetermine_bin ()
 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...
 
virtual bool determine_decal ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set. More...
 
virtual EggRenderModedetermine_depth_offset ()
 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...
 
virtual EggRenderModedetermine_depth_test_mode ()
 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...
 
virtual EggRenderModedetermine_depth_write_mode ()
 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...
 
virtual EggRenderModedetermine_draw_order ()
 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...
 
virtual bool determine_indexed ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set. More...
 
virtual EggRenderModedetermine_visibility_mode ()
 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...
 
void flatten_transforms ()
 Removes any transform and instance records from this node in the scene graph and below. More...
 
virtual TypeHandle force_init_type ()
 
int get_depth () const
 
const LMatrix4d & get_node_frame () const
 Returns the coordinate frame of the node itself. More...
 
const LMatrix4d & get_node_frame_inv () const
 Returns the inverse of the matrix returned by get_node_frame(). More...
 
const LMatrix4d * get_node_frame_inv_ptr () const
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix. More...
 
const LMatrix4d * get_node_frame_ptr () const
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix. More...
 
const LMatrix4d & get_node_to_vertex () const
 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 * get_node_to_vertex_ptr () const
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix. More...
 
EggGroupNodeget_parent () const
 
virtual TypeHandle get_type () const
 
const LMatrix4d & get_vertex_frame () const
 Returns the coordinate frame of the vertices referenced by primitives at or under this node. More...
 
const LMatrix4d & get_vertex_frame_inv () const
 Returns the inverse of the matrix returned by get_vertex_frame(). More...
 
const LMatrix4d * get_vertex_frame_inv_ptr () const
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix. More...
 
const LMatrix4d * get_vertex_frame_ptr () const
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix. More...
 
const LMatrix4d & get_vertex_to_node () const
 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 * get_vertex_to_node_ptr () const
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix. More...
 
virtual bool is_anim_matrix () const
 Returns true if this node represents a table of animation transformation data, false otherwise. More...
 
virtual bool is_joint () const
 Returns true if this particular node represents a <Joint> entry or not. More...
 
bool is_local_coord () const
 Returns true if this node's vertices are not in the global coordinate space. More...
 
bool is_under_instance () const
 Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise. More...
 
bool is_under_transform () const
 Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise. More...
 
EggNodeoperator= (const EggNode &copy)
 
bool parse_egg (const std::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. More...
 
int rename_node (vector_string strip_prefix)
 Rename by stripping out the prefix. More...
 
void test_under_integrity () const
 
void transform (const LMatrix4d &mat)
 Applies the indicated transformation to the node and all of its descendants. More...
 
void transform_vertices_only (const LMatrix4d &mat)
 Applies the indicated transformation only to vertices that appear in global space within vertex pools at this node and below. More...
 
virtual void write (std::ostream &out, int indent_level) const =0
 
- Public Member Functions inherited from EggNamedObject
 EggNamedObject (const std::string &name="")
 
 EggNamedObject (const EggNamedObject &copy)
 
EggNamedObjectoperator= (const EggNamedObject &copy)
 
void output (std::ostream &out) const
 
void write_header (std::ostream &out, int indent_level, const char *egg_keyword) const
 Writes the first line of the egg object, e.g. More...
 
- Public Member Functions inherited from EggObject
 EggObject (const EggObject &copy)
 
virtual EggTransformas_transform ()
 Returns this object cross-cast to an EggTransform pointer, if it inherits from EggTransform, or NULL if it does not. More...
 
void clear_user_data ()
 Removes *all* user data pointers from the node. More...
 
void clear_user_data (TypeHandle type)
 Removes the user data pointer of the indicated type. More...
 
EggUserDataget_user_data () const
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. More...
 
EggUserDataget_user_data (TypeHandle type) const
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not. More...
 
bool has_user_data () const
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. More...
 
bool has_user_data (TypeHandle type) const
 Returns true if the user data pointer of the indicated type has been set, false otherwise. More...
 
EggObjectoperator= (const EggObject &copy)
 
void set_user_data (EggUserData *user_data)
 Sets the user data associated with this object. More...
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const std::string &initial_name="")
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const std::string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
void output (std::ostream &out) const
 Outputs the Namable. More...
 
void set_name (const std::string &name)
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from EggNamedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from EggObject
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_depth
 Returns the number of nodes above this node in the egg hierarchy. More...
 
 get_parent
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from Namable
 get_name
 
 set_name
 

Friends

class EggGroupNode
 
class EggTable
 

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.

Definition at line 35 of file eggNode.h.

Member Function Documentation

◆ apply_texmats()

void EggNode::apply_texmats ( )

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

Definition at line 53 of file eggNode.cxx.

References EggTextureCollection::find_used_textures().

◆ determine_alpha_mode()

EggRenderMode * EggNode::determine_alpha_mode ( )
virtual

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.

Definition at line 85 of file eggNode.cxx.

References determine_alpha_mode().

Referenced by determine_alpha_mode(), EggPrimitive::determine_alpha_mode(), and EggGroup::determine_alpha_mode().

◆ determine_bin()

EggRenderMode * EggNode::determine_bin ( )
virtual

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.

Definition at line 174 of file eggNode.cxx.

References determine_bin().

Referenced by determine_bin(), EggPrimitive::determine_bin(), and EggGroup::determine_bin().

◆ determine_decal()

bool EggNode::determine_decal ( )
virtual

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.

Definition at line 208 of file eggNode.cxx.

References determine_decal().

Referenced by determine_decal(), and EggGroup::determine_decal().

◆ determine_depth_offset()

EggRenderMode * EggNode::determine_depth_offset ( )
virtual

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.

Definition at line 145 of file eggNode.cxx.

References determine_depth_offset().

Referenced by determine_depth_offset(), EggPrimitive::determine_depth_offset(), and EggGroup::determine_depth_offset().

◆ determine_depth_test_mode()

EggRenderMode * EggNode::determine_depth_test_mode ( )
virtual

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.

Definition at line 115 of file eggNode.cxx.

References determine_depth_test_mode().

Referenced by determine_depth_test_mode(), EggPrimitive::determine_depth_test_mode(), and EggGroup::determine_depth_test_mode().

◆ determine_depth_write_mode()

EggRenderMode * EggNode::determine_depth_write_mode ( )
virtual

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.

Definition at line 100 of file eggNode.cxx.

References determine_depth_write_mode().

Referenced by determine_depth_write_mode(), EggPrimitive::determine_depth_write_mode(), and EggGroup::determine_depth_write_mode().

◆ determine_draw_order()

EggRenderMode * EggNode::determine_draw_order ( )
virtual

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.

Definition at line 160 of file eggNode.cxx.

References determine_draw_order().

Referenced by determine_draw_order(), EggPrimitive::determine_draw_order(), and EggGroup::determine_draw_order().

◆ determine_indexed()

bool EggNode::determine_indexed ( )
virtual

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.

Definition at line 191 of file eggNode.cxx.

References determine_indexed().

Referenced by determine_indexed(), and EggGroup::determine_indexed().

◆ determine_visibility_mode()

EggRenderMode * EggNode::determine_visibility_mode ( )
virtual

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.

Definition at line 130 of file eggNode.cxx.

References determine_visibility_mode().

Referenced by determine_visibility_mode(), EggPrimitive::determine_visibility_mode(), and EggGroup::determine_visibility_mode().

◆ flatten_transforms()

void EggNode::flatten_transforms ( )
inline

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.

Definition at line 284 of file eggNode.I.

◆ get_node_frame()

const LMatrix4d & EggNode::get_node_frame ( ) const
inline

Returns the coordinate frame of the node itself.

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

Definition at line 122 of file eggNode.I.

◆ get_node_frame_inv()

const LMatrix4d & EggNode::get_node_frame_inv ( ) const
inline

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

See get_node_frame().

Definition at line 149 of file eggNode.I.

◆ get_node_frame_inv_ptr()

const LMatrix4d * EggNode::get_node_frame_inv_ptr ( ) const
inline

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

Definition at line 225 of file eggNode.I.

◆ get_node_frame_ptr()

const LMatrix4d * EggNode::get_node_frame_ptr ( ) const
inline

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

Definition at line 206 of file eggNode.I.

◆ get_node_to_vertex()

const LMatrix4d & EggNode::get_node_to_vertex ( ) const
inline

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

Definition at line 183 of file eggNode.I.

◆ get_node_to_vertex_ptr()

const LMatrix4d * EggNode::get_node_to_vertex_ptr ( ) const
inline

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

Definition at line 243 of file eggNode.I.

◆ get_vertex_frame()

const LMatrix4d & EggNode::get_vertex_frame ( ) const
inline

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.

Definition at line 108 of file eggNode.I.

◆ get_vertex_frame_inv()

const LMatrix4d & EggNode::get_vertex_frame_inv ( ) const
inline

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

See get_vertex_frame().

Definition at line 135 of file eggNode.I.

◆ get_vertex_frame_inv_ptr()

const LMatrix4d * EggNode::get_vertex_frame_inv_ptr ( ) const
inline

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

Definition at line 215 of file eggNode.I.

◆ get_vertex_frame_ptr()

const LMatrix4d * EggNode::get_vertex_frame_ptr ( ) const
inline

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

Definition at line 196 of file eggNode.I.

◆ get_vertex_to_node()

const LMatrix4d & EggNode::get_vertex_to_node ( ) const
inline

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

Definition at line 166 of file eggNode.I.

◆ get_vertex_to_node_ptr()

const LMatrix4d * EggNode::get_vertex_to_node_ptr ( ) const
inline

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

Definition at line 234 of file eggNode.I.

◆ is_anim_matrix()

bool EggNode::is_anim_matrix ( ) const
virtual

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

Reimplemented in EggXfmSAnim, and EggXfmAnimData.

Definition at line 74 of file eggNode.cxx.

Referenced by EggTable::has_transform().

◆ is_joint()

bool EggNode::is_joint ( ) const
virtual

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.

Definition at line 65 of file eggNode.cxx.

Referenced by EggGroupNode::joint_has_primitives().

◆ is_local_coord()

bool EggNode::is_local_coord ( ) const
inline

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.

Definition at line 87 of file eggNode.I.

Referenced by EggVertex::get_num_global_coord(), and EggVertex::get_num_local_coord().

◆ is_under_instance()

bool EggNode::is_under_instance ( ) const
inline

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

Definition at line 68 of file eggNode.I.

◆ is_under_transform()

bool EggNode::is_under_transform ( ) const
inline

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

Definition at line 77 of file eggNode.I.

◆ parse_egg()

bool EggNode::parse_egg ( const std::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.

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

Definition at line 224 of file eggNode.cxx.

References TypedObject::is_of_type().

◆ rename_node()

int EggNode::rename_node ( vector_string  strip_prefix)

Rename by stripping out the prefix.

Definition at line 34 of file eggNode.cxx.

◆ transform()

void EggNode::transform ( const LMatrix4d &  mat)
inline

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

Definition at line 253 of file eggNode.I.

◆ transform_vertices_only()

void EggNode::transform_vertices_only ( const LMatrix4d &  mat)
inline

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.

Definition at line 270 of file eggNode.I.

Member Data Documentation

◆ get_depth

int EggNode::get_depth
inline

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

Definition at line 48 of file eggNode.h.


The documentation for this class was generated from the following files: