EggTexture

Inheritance:

Methods of EggTexture:

Methods of EggFilenameNode:

Methods of EggNode:

Methods of EggNamedObject:

Methods of EggObject:

Methods of TypedReferenceCount:

Methods of TypedObject:

Methods of ReferenceCount:

Methods of Namable:

Methods of EggRenderMode:

Methods of EggTransform:

Constants in EggTexture:

Constants in EggRenderMode:

Constants in EggTransform:

affectsPolygonAlpha
bool EggTexture::affects_polygon_alpha(void) const;

Description: Returns true if this texture's environment type or combine mode allows the texture to have an affect on the polygon's alpha values, false otherwise.

clearAlphaFileChannel
void EggTexture::clear_alpha_file_channel(void);

Description: Removes the specification of a particular channel to use from the alpha-file image.

clearAlphaFilename
void EggTexture::clear_alpha_filename(void);

Description:

clearAlphaScale
void EggTexture::clear_alpha_scale(void);

Description: Removes the alpha_scale from the texture and restores it to the default value of 1.

clearAnisotropicDegree
void EggTexture::clear_anisotropic_degree(void);

Description: Removes the specification of anisotropic filtering from the texture.

clearBorderColor
void EggTexture::clear_border_color(void);

Description:

clearColor
void EggTexture::clear_color(void);

Description:

clearMultitexture
void EggTexture::clear_multitexture(void);

Description: Resets the multitexture flags set by multitexture_over(). After this call, get_multitexture() will return false, and get_multitexture_sort() will return 0.

clearPriority
void EggTexture::clear_priority(void);

Description: Removes the specification of multitexture priority from the texture. The default priority value is 0.

clearRgbScale
void EggTexture::clear_rgb_scale(void);

Description: Removes the rgb_scale from the texture and restores it to the default value of 1.

clearStageName
void EggTexture::clear_stage_name(void);

Description: Removes the named TextureStage specification.

clearUvName
void EggTexture::clear_uv_name(void);

Description: Removes the restriction to a particular named set of texture coordinates and restores the texture to using the default texture coordinates.

determineWrapU
EggTexture::WrapMode EggTexture::determine_wrap_u(void) const;

Description: Determines the appropriate wrap in the U direction. This is different from get_wrap_u() in that if the U wrap is unspecified, it returns the overall wrap value.

determineWrapV
EggTexture::WrapMode EggTexture::determine_wrap_v(void) const;

Description: Determines the appropriate wrap in the V direction. This is different from get_wrap_v() in that if the V wrap is unspecified, it returns the overall wrap value.

determineWrapW
EggTexture::WrapMode EggTexture::determine_wrap_w(void) const;

Description: Determines the appropriate wrap in the W direction. This is different from get_wrap_w() in that if the W wrap is unspecified, it returns the overall wrap value.

getAlphaFileChannel
int EggTexture::get_alpha_file_channel(void) const;

Description: Returns the particular channel that has been specified for the alpha-file image, or 0 if no channel has been specified. See set_alpha_file_channel().

getAlphaFilename
Filename const &EggTexture::get_alpha_filename(void) const;

Description: Returns the separate file assigned for the alpha channel. It is an error to call this unless has_alpha_filename() returns true. See set_alpha_filename().

getAlphaFullpath
Filename const &EggTexture::get_alpha_fullpath(void) const;

Description: Returns the full pathname to the alpha file, if it is known; otherwise, returns the same thing as get_alpha_filename().
This function simply returns whatever was set by the last call to set_alpha_fullpath(). This string is not written to the egg file; its main purpose is to record the full path to the alpha filename if it is known, for egg structures that are generated in-memory and then immediately converted to a scene graph.

getAlphaScale
int EggTexture::get_alpha_scale(void) const;

Description: Returns the alpha_scale value that has been specified for the texture, or 1 if no alpha_scale value has been specified.

getAnisotropicDegree
int EggTexture::get_anisotropic_degree(void) const;

Description: Returns the anisotropic filtering degree that has been specified for this texture, or 0 if nothing has been specified.

getBorderColor
LVecBase4f const &EggTexture::get_border_color(void) const;

Description: Returns the border color if one has been specified, or (0, 0, 0, 1) otherwise.

getClassType
static TypeHandle EggTexture::get_class_type(void);

Undocumented function.

getColor
LVecBase4f const &EggTexture::get_color(void) const;

Description: Returns the blend color if one has been specified, or (0, 0, 0, 1) otherwise.

getCombineMode
EggTexture::CombineMode EggTexture::get_combine_mode(EggTexture::CombineChannel channel) const;

Description:

getCombineOperand
EggTexture::CombineOperand EggTexture::get_combine_operand(EggTexture::CombineChannel channel, int n) const;

Description:

getCombineSource
EggTexture::CombineSource EggTexture::get_combine_source(EggTexture::CombineChannel channel, int n) const;

Description:

getCompressionMode
EggTexture::CompressionMode EggTexture::get_compression_mode(void) const;

Description:

getEnvType
EggTexture::EnvType EggTexture::get_env_type(void) const;

Description:

getFormat
EggTexture::Format EggTexture::get_format(void) const;

Description:

getMagfilter
EggTexture::FilterType EggTexture::get_magfilter(void) const;

Description:

getMinfilter
EggTexture::FilterType EggTexture::get_minfilter(void) const;

Description:

getMultitextureSort
int EggTexture::get_multitexture_sort(void) const;

Description: Returns an integer that represents the depth to which this texture is layered on all other textures in the egg file. In general, if texture A is layered over texture B, then sort(A) > sort(B). If texture A is never layered over any other texture, then sort(A) == 0. More than that is difficult to guarantee.

getPriority
int EggTexture::get_priority(void) const;

Description: Returns the multitexture importance value that has been specified for the texture, or 0 if no priority value has been specified.

getReadMipmaps
bool EggTexture::get_read_mipmaps(void) const;

Description: Returns the current setting of the read_mipmaps flag. See set_read_mipmaps().

getRgbScale
int EggTexture::get_rgb_scale(void) const;

Description: Returns the rgb_scale value that has been specified for the texture, or 1 if no rgb_scale value has been specified.

getSavedResult
bool EggTexture::get_saved_result(void) const;

Description: Returns the current setting of the saved_result flag. See set_saved_result().

getStageName
string const &EggTexture::get_stage_name(void) const;

Description: Returns the stage name that has been specified for this texture, or the tref name if no texture stage has explicitly been specified.

getTexGen
EggTexture::TexGen EggTexture::get_tex_gen(void) const;

Description:

getTextureType
EggTexture::TextureType EggTexture::get_texture_type(void) const;

Description:

getUvName
string const &EggTexture::get_uv_name(void) const;

Description: Returns the texcoord name that has been specified for this texture, or the empty string if no texcoord name has explicitly been specified.

getWrapMode
EggTexture::WrapMode EggTexture::get_wrap_mode(void) const;

Description:

getWrapU
EggTexture::WrapMode EggTexture::get_wrap_u(void) const;

Description: Returns the amount specified for U wrap. This may be unspecified, even if there is an overall wrap value.

getWrapV
EggTexture::WrapMode EggTexture::get_wrap_v(void) const;

Description: Returns the amount specified for V wrap. This may be unspecified, even if there is an overall wrap value.

getWrapW
EggTexture::WrapMode EggTexture::get_wrap_w(void) const;

Description: Returns the amount specified for W wrap. This may be unspecified, even if there is an overall wrap value.

hasAlphaChannel
bool EggTexture::has_alpha_channel(int num_components) const;

Description: Given the number of color components (channels) in the image file as actually read from the disk, return true if this texture seems to have an alpha channel or not. This depends on the EggTexture's format as well as the number of channels.

hasAlphaFileChannel
bool EggTexture::has_alpha_file_channel(void) const;

Description: Returns true if a particular channel has been specified for the alpha-file image, false otherwise.

hasAlphaFilename
bool EggTexture::has_alpha_filename(void) const;

Description: Returns true if a separate file for the alpha component has been applied, false otherwise. See set_alpha_filename().

hasAlphaScale
bool EggTexture::has_alpha_scale(void) const;

Description: Returns true if an alpha_scale has been specified for the texture, false otherwise.

hasAnisotropicDegree
bool EggTexture::has_anisotropic_degree(void) const;

Description: Returns true if a value for the anisotropic filtering degree has been specified for this texture, false otherwise.

hasBorderColor
bool EggTexture::has_border_color(void) const;

Description: Returns true if a border color has been specified for the texture.

hasColor
bool EggTexture::has_color(void) const;

Description: Returns true if a blend color has been specified for the texture.

hasPriority
bool EggTexture::has_priority(void) const;

Description: Returns true if a priority value for multitexture importance has been specified for the texture, false otherwise.

hasRgbScale
bool EggTexture::has_rgb_scale(void) const;

Description: Returns true if an rgb_scale has been specified for the texture, false otherwise.

hasStageName
bool EggTexture::has_stage_name(void) const;

Description: Returns true if a stage name has been explicitly specified for this texture, false otherwise.

hasUvName
bool EggTexture::has_uv_name(void) const;

Description: Returns true if a texcoord name has been explicitly specified for this texture, false otherwise.

isEquivalentTo
bool EggTexture::is_equivalent_to(EggTexture const &other, int eq) const;

Description: Returns true if the two textures are equivalent in all relevant properties (according to eq), false otherwise.
The Equivalence parameter, eq, should be set to the bitwise OR of the following properties, according to what you consider relevant:
EggTexture::E_basename: The basename part of the texture filename, without the directory prefix *or* the filename extension.
EggTexture::E_extension: The extension part of the texture filename.
EggTexture::E_dirname: The directory prefix of the texture filename.
EggTexture::E_complete_filename: The union of the above three; that is, the complete filename, with directory, basename, and extension.
EggTexture::E_transform: The texture matrix.
EggTexture::E_attributes: All remaining texture attributes (mode, mipmap, etc.) except TRef name.
EggTexture::E_tref_name: The TRef name.

multitextureOver
bool EggTexture::multitexture_over(EggTexture *other);

Description: Indicates that this texture should be layered on top of the other texture. This will guarantee that this->get_multitexture_sort() > other->get_multitexture_sort(), at least until clear_multitexture() is called on either one.
The return value is true if successful, or false if there is a failure because the other texture was already layered on top of this one (or there is a three- or more-way cycle).

operator =
EggTexture &EggTexture::operator =(EggTexture const &copy);

Description:

setAlphaFileChannel
void EggTexture::set_alpha_file_channel(int alpha_file_channel);

Description: If a separate alpha-file is specified, this indicates which channel number should be extracted from this file to derive the alpha channel for the final image. The default is 0, which means the grayscale combination of r, g, b. Otherwise, this should be the 1-based channel number, for instance 1, 2, or 3 for r, g, or b, respectively, or 4 for the alpha channel of a four-component image.

setAlphaFilename
void EggTexture::set_alpha_filename(Filename const &filename);

Description: Specifies a separate file that will be loaded in with the 1- or 3-component texture and applied as the alpha channel. This is useful when loading textures from file formats that do not support alpha, for instance jpg.

setAlphaFullpath
void EggTexture::set_alpha_fullpath(Filename const &fullpath);

Description: Records the full pathname to the file, for the benefit of get_alpha_fullpath().

setAlphaScale
void EggTexture::set_alpha_scale(int alpha_scale);

Description: Sets an additional factor that will scale the alpha component after the texture has been applied. This is used only when a combine mode is in effect.
The only legal values are 1, 2, or 4.

setAnisotropicDegree
void EggTexture::set_anisotropic_degree(int anisotropic_degree);

Description: Sets the degree of anisotropic filtering for this texture. 1 is off; higher levels indicate filtering in effect.

setBorderColor
void EggTexture::set_border_color(LVecBase4f const &border_color);

Description:

setColor
void EggTexture::set_color(LVecBase4f const &color);

Description:

setCombineMode
void EggTexture::set_combine_mode(EggTexture::CombineChannel channel, EggTexture::CombineMode cm);

Description:

setCombineOperand
void EggTexture::set_combine_operand(EggTexture::CombineChannel channel, int n, EggTexture::CombineOperand co);

Description:

setCombineSource
void EggTexture::set_combine_source(EggTexture::CombineChannel channel, int n, EggTexture::CombineSource cs);

Description:

setCompressionMode
void EggTexture::set_compression_mode(EggTexture::CompressionMode mode);

Description:

setEnvType
void EggTexture::set_env_type(EggTexture::EnvType type);

Description:

setFormat
void EggTexture::set_format(EggTexture::Format format);

Description:

setMagfilter
void EggTexture::set_magfilter(EggTexture::FilterType type);

Description:

setMinfilter
void EggTexture::set_minfilter(EggTexture::FilterType type);

Description:

setPriority
void EggTexture::set_priority(int priority);

Description: Sets the importance of this texture with respect to other textures also applied on the same geometry. This is only meaningful in the presence of multitexturing.

setReadMipmaps
void EggTexture::set_read_mipmaps(bool read_mipmaps);

Description: Sets the read_mipmaps flag.
If read_mipmaps is true, the filename should contain a hash mark ('#'), which will be filled in with the mipmap level number; and the texture will be defined with a series of images, one for each mipmap level.
If the filename is of a time that already requires a hash mark, such as a cube map or a 3-d texture, then the filename should now require two hash marks, and the first one indicates the mipmap level number, while the second indicates the face number or 3-d level number.

setRgbScale
void EggTexture::set_rgb_scale(int rgb_scale);

Description: Sets an additional factor that will scale all three r, g, b components after the texture has been applied. This is used only when a combine mode is in effect.
The only legal values are 1, 2, or 4.

setSavedResult
void EggTexture::set_saved_result(bool saved_result);

Description: Sets the saved_result flag. When this is true, the output of this stage is not part of the normal pipeline--that is, it will not be supplied as the "previous" source for the next texture stage--but it will instead be supplied as the "last_saved_result" source for any future stages, until the next TextureStage with a saved_result set true is encountered.
This can be used to reuse the results of this texture stage as input to more than one stage later in the pipeline.
The last texture in the pipeline (the one with the highest sort value) should not have this flag set.

setStageName
void EggTexture::set_stage_name(string const &stage_name);

Description: Specifies the particular TextureStage this texture will be rendered on by name. If this is omitted, the texture will be rendered on the default TextureStage, unless some other stage-specific property is specificied, in which case the texture will be rendered on a TextureStage with the same name as the tref. This is in support of multitexturing.
Each different TextureStage in the world must be uniquely named.

setTexGen
void EggTexture::set_tex_gen(EggTexture::TexGen tex_gen);

Description:

setTextureType
void EggTexture::set_texture_type(EggTexture::TextureType texture_type);

Filename: eggTexture.I Created by: drose (18Jan99)
PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ .
To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net .
Description:

setUvName
void EggTexture::set_uv_name(string const &uv_name);

Description: Specifies the named set of texture coordinates that this texture will use when it is applied to geometry. Geometry may have multiple sets of texture coordinates defined, by name.
If this is not specified for a particular texture, the default set of texture coordinates will be used.

setWrapMode
void EggTexture::set_wrap_mode(EggTexture::WrapMode mode);

Description:

setWrapU
void EggTexture::set_wrap_u(EggTexture::WrapMode mode);

Description:

setWrapV
void EggTexture::set_wrap_v(EggTexture::WrapMode mode);

Description:

setWrapW
void EggTexture::set_wrap_w(EggTexture::WrapMode mode);

Description:

sortsLessThan
bool EggTexture::sorts_less_than(EggTexture const &other, int eq) const;

Description: An ordering operator to compare two textures for sorting order. This imposes an arbitrary ordering useful to identify unique textures, according to the indicated Equivalence factor. See is_equivalent_to().

stringCombineMode
static EggTexture::CombineMode EggTexture::string_combine_mode(string const &string);

Description: Returns the CombineMode value associated with the given string representation, or CM_unspecified if the string does not match any known CombineMode value.

stringCombineOperand
static EggTexture::CombineOperand EggTexture::string_combine_operand(string const &string);

Description: Returns the CombineOperand value associated with the given string representation, or CO_unspecified if the string does not match any known CombineOperand value.

stringCombineSource
static EggTexture::CombineSource EggTexture::string_combine_source(string const &string);

Description: Returns the CombineSource value associated with the given string representation, or CS_unspecified if the string does not match any known CombineSource value.

stringCompressionMode
static EggTexture::CompressionMode EggTexture::string_compression_mode(string const &string);

Description: Returns the CompressionMode value associated with the given string representation, or CM_default if the string does not match any known CompressionMode value.

stringEnvType
static EggTexture::EnvType EggTexture::string_env_type(string const &string);

Description: Returns the EnvType value associated with the given string representation, or ET_unspecified if the string does not match any known EnvType value.

stringFilterType
static EggTexture::FilterType EggTexture::string_filter_type(string const &string);

Description: Returns the FilterType value associated with the given string representation, or FT_unspecified if the string does not match any known FilterType value.

stringFormat
static EggTexture::Format EggTexture::string_format(string const &string);

Description: Returns the Format value associated with the given string representation, or F_unspecified if the string does not match any known Format value.

stringTexGen
static EggTexture::TexGen EggTexture::string_tex_gen(string const &string);

Description: Returns the TexGen value associated with the given string representation, or ET_unspecified if the string does not match any known TexGen value.

stringTextureType
static EggTexture::TextureType EggTexture::string_texture_type(string const &string);

Description: Returns the Texture_ype value associated with the given string representation, or TT_unspecified if the string does not match any known TextureType value.

stringWrapMode
static EggTexture::WrapMode EggTexture::string_wrap_mode(string const &string);

Description: Returns the WrapMode value associated with the given string representation, or WM_unspecified if the string does not match any known WrapMode value.

write
virtual void EggTexture::write(ostream &out, int indent_level) const;

Description: Writes the texture definition to the indicated output stream in Egg format.

getClassType
static TypeHandle EggFilenameNode::get_class_type(void);

Undocumented function.

getDefaultExtension
virtual string EggFilenameNode::get_default_extension(void) const;

Description: Returns the default extension for this filename type.

getFilename
Filename const &EggFilenameNode::get_filename(void) const;

Description: Returns a nonmodifiable reference to the filename.

getFullpath
Filename const &EggFilenameNode::get_fullpath(void) const;

Description: Returns the full pathname to the file, if it is known; otherwise, returns the same thing as get_filename().
This function simply returns whatever was set by the last call to set_fullpath(). This string is not written to the egg file; its main purpose is to record the full path to a filename (for instance, a texture filename) if it is known, for egg structures that are generated in-memory and then immediately converted to a scene graph.

operator =
EggFilenameNode &EggFilenameNode::operator =(EggFilenameNode const &copy);

Description:

setFilename
void EggFilenameNode::set_filename(Filename const &filename);

Description:

setFullpath
void EggFilenameNode::set_fullpath(Filename const &fullpath);

Description: Records the full pathname to the file, for the benefit of get_fullpath().

applyTexmats
void EggNode::apply_texmats(void);

Description: 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
virtual EggRenderMode *EggNode::determine_alpha_mode(void);

Description: 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
virtual EggRenderMode *EggNode::determine_bin(void);

Description: 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
virtual bool EggNode::determine_decal(void);

Description: 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.

determineDepthTestMode
virtual EggRenderMode *EggNode::determine_depth_test_mode(void);

Description: 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
virtual EggRenderMode *EggNode::determine_depth_write_mode(void);

Description: 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
virtual EggRenderMode *EggNode::determine_draw_order(void);

Description: 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
virtual bool EggNode::determine_indexed(void);

Description: 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
virtual EggRenderMode *EggNode::determine_visibility_mode(void);

Description: 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
void EggNode::flatten_transforms(void);

Description: 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 EggNode::get_class_type(void);

Undocumented function.

getDepth
int EggNode::get_depth(void) const;

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

getNodeFrame
LMatrix4d const &EggNode::get_node_frame(void) const;

Description: Returns the coordinate frame of the node itself. This is simply the net product of all transformations up to the root.

getNodeFrameInv
LMatrix4d const &EggNode::get_node_frame_inv(void) const;

Description: Returns the inverse of the matrix returned by get_node_frame(). See get_node_frame().

getNodeFrameInvPtr
LMatrix4d const *EggNode::get_node_frame_inv_ptr(void) const;

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

getNodeFramePtr
LMatrix4d const *EggNode::get_node_frame_ptr(void) const;

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

getNodeToVertex
LMatrix4d const &EggNode::get_node_to_vertex(void) const;

Description: 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
LMatrix4d const *EggNode::get_node_to_vertex_ptr(void) const;

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

getParent
EggGroupNode *EggNode::get_parent(void) const;

Description:

getVertexFrame
LMatrix4d const &EggNode::get_vertex_frame(void) const;

Description: 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
LMatrix4d const &EggNode::get_vertex_frame_inv(void) const;

Description: Returns the inverse of the matrix returned by get_vertex_frame(). See get_vertex_frame().

getVertexFrameInvPtr
LMatrix4d const *EggNode::get_vertex_frame_inv_ptr(void) const;

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

getVertexFramePtr
LMatrix4d const *EggNode::get_vertex_frame_ptr(void) const;

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

getVertexToNode
LMatrix4d const &EggNode::get_vertex_to_node(void) const;

Description: 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
LMatrix4d const *EggNode::get_vertex_to_node_ptr(void) const;

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

isAnimMatrix
virtual bool EggNode::is_anim_matrix(void) const;

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

isJoint
virtual bool EggNode::is_joint(void) const;

Description: 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 EggNode::is_local_coord(void) const;

Description: 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 EggNode::is_under_instance(void) const;

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

isUnderTransform
bool EggNode::is_under_transform(void) const;

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

operator =
EggNode &EggNode::operator =(EggNode const &copy);

Description:

parseEgg
bool EggNode::parse_egg(string const &egg_syntax);

Description: 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 EggNode::rename_node(vector< string > strip_prefix);

Description: Rename by stripping out the prefix

testUnderIntegrity
void EggNode::test_under_integrity(void) const;

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

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

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

transformVerticesOnly
void EggNode::transform_vertices_only(LMatrix4d const &mat);

Description: 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
virtual void EggNode::write(ostream &out, int indent_level) const = 0;

Undocumented function.

getClassType
static TypeHandle EggNamedObject::get_class_type(void);

Undocumented function.

operator =
EggNamedObject &EggNamedObject::operator =(EggNamedObject const &copy);

Description:

output
void EggNamedObject::output(ostream &out) const;

Description:

clearUserData
void EggObject::clear_user_data(void);

Description: Removes *all* user data pointers from the node.
Description: Removes the user data pointer of the indicated type.

getClassType
static TypeHandle EggObject::get_class_type(void);

Undocumented function.

getUserData
EggUserData *EggObject::get_user_data(void) const;

Description: Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored.
Description: Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.

hasUserData
bool EggObject::has_user_data(void) const;

Description: Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise.
Description: Returns true if the user data pointer of the indicated type has been set, false otherwise.

operator =
EggObject &EggObject::operator =(EggObject const &copy);

Description:

setUserData
void EggObject::set_user_data(EggUserData *user_data);

Description: Sets the user data associated with this object. This may be any EggUserData-derived object. The egg library will do nothing with this pointer, except to hold its reference count and return the pointer on request.
The EggObject maintains multiple different EggUserData pointers, one for each unique type (as reported by get_type()). If you know that only one type of EggUserData object will be added in your application, you may use the query functions that accept no parameters, but it is recommended that in general you pass in the type of your particular user data, to allow multiple applications to coexist in the same egg data.
This pointer is also copied by the copy assignment operator and copy constructor.

getClassType
static TypeHandle TypedReferenceCount::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

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

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

Description: Returns true if the current object is or derives from the indicated type.

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
void ReferenceCount::ref(void) const;

Description: 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.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero
bool ReferenceCount::test_ref_count_nonzero(void) const;

Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref
bool ReferenceCount::unref(void) const;

Description: 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; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
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.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.

clearName
void Namable::clear_name(void);

Description: Resets the Namable's name to empty.

getClassType
static TypeHandle Namable::get_class_type(void);

Undocumented function.

getName
string const &Namable::get_name(void) const;

Description:

hasName
bool Namable::has_name(void) const;

Description: Returns true if the Namable has a nonempty name set, false if the name is empty.

operator =
Namable &Namable::operator =(Namable const &other);

Description:

output
void Namable::output(ostream &out) const;

In the absence of any definition to the contrary, outputting a Namable will write out its name.
Description: Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

setName
void Namable::set_name(string const &name);

Description:

clearBin
void EggRenderMode::clear_bin(void);

Description: Removes the bin name that was set for this particular object. See set_bin().

clearDrawOrder
void EggRenderMode::clear_draw_order(void);

Description: Removes the draw-order flag from this particular object. See set_draw_order().

getAlphaMode
EggRenderMode::AlphaMode EggRenderMode::get_alpha_mode(void) const;

Description: Returns the alpha mode that was set, or AM_unspecified if nothing was set. See set_alpha_mode().

getBin
string EggRenderMode::get_bin(void) const;

Description: Returns the bin name that has been set for this particular object, if any. See set_bin().

getClassType
static TypeHandle EggRenderMode::get_class_type(void);

Undocumented function.

getDepthTestMode
EggRenderMode::DepthTestMode EggRenderMode::get_depth_test_mode(void) const;

Description: Returns the depth_test mode that was set, or DTM_unspecified if nothing was set. See set_depth_test_mode().

getDepthWriteMode
EggRenderMode::DepthWriteMode EggRenderMode::get_depth_write_mode(void) const;

Description: Returns the depth_write mode that was set, or DWM_unspecified if nothing was set. See set_depth_write_mode().

getDrawOrder
int EggRenderMode::get_draw_order(void) const;

Description: Returns the "draw-order" flag as set for this particular object. See set_draw_order().

getVisibilityMode
EggRenderMode::VisibilityMode EggRenderMode::get_visibility_mode(void) const;

Description: Returns the visibility mode that was set, or VM_unspecified if nothing was set. See set_visibility_mode().

hasBin
bool EggRenderMode::has_bin(void) const;

Description: Returns true if a bin name has been set for this particular object. See set_bin().

hasDrawOrder
bool EggRenderMode::has_draw_order(void) const;

Description: Returns true if the draw-order flag has been set for this particular object. See set_draw_order().

operator !=
bool EggRenderMode::operator !=(EggRenderMode const &other) const;

Comparison operators are handy.
Description:

operator <
bool EggRenderMode::operator <(EggRenderMode const &other) const;

Description:

operator =
EggRenderMode &EggRenderMode::operator =(EggRenderMode const &copy);

Description:

operator ==
bool EggRenderMode::operator ==(EggRenderMode const &other) const;

Comparison operators are handy.
Description:

setAlphaMode
void EggRenderMode::set_alpha_mode(EggRenderMode::AlphaMode mode);

Description: 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.

setBin
void EggRenderMode::set_bin(string const &bin);

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

setDepthTestMode
void EggRenderMode::set_depth_test_mode(EggRenderMode::DepthTestMode mode);

Description: 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.

setDepthWriteMode
void EggRenderMode::set_depth_write_mode(EggRenderMode::DepthWriteMode mode);

Description: Specifies whether writes should be made to the depth buffer (assuming the rendering backend provides a depth buffer) when rendering this geometry.

setDrawOrder
void EggRenderMode::set_draw_order(int order);

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

setVisibilityMode
void EggRenderMode::set_visibility_mode(EggRenderMode::VisibilityMode mode);

Description: 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.

stringAlphaMode
static EggRenderMode::AlphaMode EggRenderMode::string_alpha_mode(string const &string);

Description: Returns the AlphaMode value associated with the given string representation, or AM_unspecified if the string does not match any known AlphaMode value.

stringDepthTestMode
static EggRenderMode::DepthTestMode EggRenderMode::string_depth_test_mode(string const &string);

Description: Returns the DepthTestMode value associated with the given string representation, or DTM_unspecified if the string does not match any known DepthTestMode value.

stringDepthWriteMode
static EggRenderMode::DepthWriteMode EggRenderMode::string_depth_write_mode(string const &string);

Description: Returns the DepthWriteMode value associated with the given string representation, or DWM_unspecified if the string does not match any known DepthWriteMode value.

stringVisibilityMode
static EggRenderMode::VisibilityMode EggRenderMode::string_visibility_mode(string const &string);

Description: Returns the HiddenMode value associated with the given string representation, or VM_unspecified if the string does not match any known HiddenMode value.

write
void EggRenderMode::write(ostream &out, int indent_level) const;

Description: Writes the attributes to the indicated output stream in Egg format.

addMatrix3
void EggTransform::add_matrix3(LMatrix3d const &mat);

Description: Appends an arbitrary 3x3 matrix to the current transform.

addMatrix4
void EggTransform::add_matrix4(LMatrix4d const &mat);

Description: Appends an arbitrary 4x4 matrix to the current transform.

addRotate2d
void EggTransform::add_rotate2d(double angle);

Description: Appends a 2-d rotation to the current transform. The rotation angle is specified in degrees counterclockwise about the origin.

addRotate3d
void EggTransform::add_rotate3d(double angle, LVector3d const &axis);

Description: Appends a 3-d rotation about an arbitrary axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.
Description: Appends an arbitrary 3-d rotation to the current transform, expressed as a quaternion. This is converted to axis-angle notation for the egg file.

addRotx
void EggTransform::add_rotx(double angle);

Description: Appends a rotation about the X axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.

addRoty
void EggTransform::add_roty(double angle);

Description: Appends a rotation about the Y axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.

addRotz
void EggTransform::add_rotz(double angle);

Description: Appends a rotation about the Z axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.

addScale2d
void EggTransform::add_scale2d(LVecBase2d const &scale);

Description: Appends a possibly non-uniform scale to the current transform.

addScale3d
void EggTransform::add_scale3d(LVecBase3d const &scale);

Description: Appends a possibly non-uniform scale to the current transform.

addTranslate2d
void EggTransform::add_translate2d(LVector2d const &translate);

Description: Appends a 2-d translation operation to the current transform.

addTranslate3d
void EggTransform::add_translate3d(LVector3d const &translate);

Description: Appends a 3-d translation operation to the current transform.

addUniformScale
void EggTransform::add_uniform_scale(double scale);

Description: Appends a uniform scale to the current transform.

clearTransform
void EggTransform::clear_transform(void);

Description: Resets the transform to empty, identity.

getComponentMat3
LMatrix3d const &EggTransform::get_component_mat3(int n) const;

Description: Returns the 3x3 matrix associated with the nth component. It is an error to call this if the component type is not CT_matrix3.

getComponentMat4
LMatrix4d const &EggTransform::get_component_mat4(int n) const;

Description: Returns the 4x4 matrix associated with the nth component. It is an error to call this if the component type is not CT_matrix4.

getComponentNumber
double EggTransform::get_component_number(int n) const;

Description: Returns the solitary number associated with the nth component. In the case of a rotation, this is the angle in degrees to rotate; in the case of uniform scale, this is the amount of the scale. Other types do not use this property.

getComponentType
EggTransform::ComponentType EggTransform::get_component_type(int n) const;

Description: Returns the type of the nth component.

getComponentVec2
LVecBase2d const &EggTransform::get_component_vec2(int n) const;

Description: Returns the 2-component vector associated with the nth component. This may be the translate vector, rotate axis, or non-uniform scale. It is an error to call this if the component type does not use a 2-d vector property.

getComponentVec3
LVecBase3d const &EggTransform::get_component_vec3(int n) const;

Description: Returns the 3-component vector associated with the nth component. This may be the translate vector, rotate axis, or non-uniform scale. It is an error to call this if the component type does not use a 3-d vector property.

getNumComponents
int EggTransform::get_num_components(void) const;

Description: Returns the number of components that make up the transform.

getTransform2d
LMatrix3d EggTransform::get_transform2d(void) const;

Description: Returns the overall transform as a 3x3 matrix. It is an error to call this if has_transform3d() is true.

getTransform3d
LMatrix4d const &EggTransform::get_transform3d(void) const;

Description: Returns the overall transform as a 4x4 matrix. It is valid to call this even if has_transform2d() is true; in this case, the 3x3 transform will be expanded to a 4x4 matrix.

hasTransform
bool EggTransform::has_transform(void) const;

Description: Returns true if the transform is nonempty, false if it is empty (no transform components have been added). This is true for either a 2-d or a 3-d transform.

hasTransform2d
bool EggTransform::has_transform2d(void) const;

Description: Returns true if the transform is specified as a 2-d transform, e.g. with a 3x3 matrix, or false if it is specified as a 3-d transform (with a 4x4 matrix), or not specified at all.
Normally, EggTextures have a 2-d matrix (but occasionally they use a 3-d matrix), and EggGroups always have a 3-d matrix.

hasTransform3d
bool EggTransform::has_transform3d(void) const;

Description: Returns true if the transform is specified as a 3-d transform, e.g. with a 4x4 matrix, or false if it is specified as a 2-d transform (with a 2x2 matrix), or not specified at all.
Normally, EggTextures have a 3-d matrix (but occasionally they use a 3-d matrix), and EggGroups always have a 3-d matrix.

operator =
EggTransform &EggTransform::operator =(EggTransform const &copy);

Description:

setTransform2d
void EggTransform::set_transform2d(LMatrix3d const &mat);

Description: Sets the overall transform as a 3x3 matrix. This completely replaces whatever componentwise transform may have been defined.

setTransform3d
void EggTransform::set_transform3d(LMatrix4d const &mat);

Description: Sets the overall transform as a 4x4 matrix. This completely replaces whatever componentwise transform may have been defined.

transformIsIdentity
bool EggTransform::transform_is_identity(void) const;

Description: Returns true if the described transform is identity, false otherwise.

write
void EggTransform::write(ostream &out, int indent_level) const;

Description: Writes the transform to the indicated stream in Egg format.