EggNode

class EggNode

Bases: EggNamedObject

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.

Inheritance diagram

void apply_texmats(void): Applies the texture matrices to the UV’s of the vertices that reference them, and then removes the texture matrices from the textures themselves.

virtual EggRenderMode *determine_alpha_mode(void): 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.

virtual EggRenderMode *determine_bin(void): 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.

virtual bool determine_decal(void)

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.

virtual EggRenderMode *determine_depth_offset(void): 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.

virtual EggRenderMode *determine_depth_test_mode(void): 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.

virtual EggRenderMode *determine_depth_write_mode(void): 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.

virtual EggRenderMode *determine_draw_order(void): 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.

virtual bool determine_indexed(void)

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.

virtual EggRenderMode *determine_visibility_mode(void): 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.

void flatten_transforms(void)

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 get_class_type(void)

int get_depth(void) const: Returns the number of nodes above this node in the egg hierarchy.

LMatrix4d const &get_node_frame(void) const: Returns the coordinate frame of the node itself. This is simply the net product of all transformations up to the root.

LMatrix4d const &get_node_frame_inv(void) const: Returns the inverse of the matrix returned by get_node_frame(). See get_node_frame().

LMatrix4d const *get_node_frame_inv_ptr(void) const: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix.

LMatrix4d const *get_node_frame_ptr(void) const: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix.

LMatrix4d const &get_node_to_vertex(void) 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. This is the same thing as:

get_node_frame() * get_vertex_frame_inv()

LMatrix4d const *get_node_to_vertex_ptr(void) const: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix.

EggGroupNode *get_parent(void) const

LMatrix4d const &get_vertex_frame(void) const

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.

LMatrix4d const &get_vertex_frame_inv(void) const: Returns the inverse of the matrix returned by get_vertex_frame(). See get_vertex_frame().

LMatrix4d const *get_vertex_frame_inv_ptr(void) const: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix.

LMatrix4d const *get_vertex_frame_ptr(void) const: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix.

LMatrix4d const &get_vertex_to_node(void) const

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

LMatrix4d const *get_vertex_to_node_ptr(void) const: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix.

virtual bool is_anim_matrix(void) const: Returns true if this node represents a table of animation transformation data, false otherwise.

virtual bool is_joint(void) const: 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().

bool is_local_coord(void) const: 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 is_under_instance(void) const: Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise.

bool is_under_transform(void) const: Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise.

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

int rename_node(vector_string strip_prefix): Rename by stripping out the prefix

void test_under_integrity(void) const

void transform(LMatrix4d const &mat): Applies the indicated transformation to the node and all of its descendants.

void transform_vertices_only(LMatrix4d const &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.

virtual void write(std::ostream &out, int indent_level) const = 0