Panda3D
Public Types | Public Member Functions | Static Public Member Functions | List of all members
EggMaterial Class Reference
Inheritance diagram for EggMaterial:
EggNode EggNamedObject EggObject Namable TypedReferenceCount MemoryBase TypedObject ReferenceCount MemoryBase MemoryBase

Public Types

enum  Equivalence { E_attributes = 0x001, E_mref_name = 0x002 }
 

Public Member Functions

 EggMaterial (const string &mref_name)
 
 EggMaterial (const EggMaterial &copy)
 
void clear_amb ()
 
void clear_diff ()
 
void clear_emit ()
 
void clear_local ()
 
void clear_shininess ()
 
void clear_spec ()
 
virtual TypeHandle force_init_type ()
 
LColor get_amb () const
 It is legal to call this even if has_amb() returns false. More...
 
LColor get_diff () const
 It is legal to call this even if has_diff() returns false. More...
 
LColor get_emit () const
 It is legal to call this even if has_emit() returns false. More...
 
bool get_local () const
 
double get_shininess () const
 
LColor get_spec () const
 It is legal to call this even if has_spec() returns false. More...
 
virtual TypeHandle get_type () const
 
bool has_amb () const
 
bool has_diff () const
 
bool has_emit () const
 
bool has_local () const
 
bool has_shininess () const
 
bool has_spec () const
 
bool is_equivalent_to (const EggMaterial &other, int eq) const
 Returns true if the two materials are equivalent in all relevant properties (according to eq), false otherwise. More...
 
void set_amb (const LColor &amb)
 
void set_diff (const LColor &diff)
 
void set_emit (const LColor &emit)
 
void set_local (bool local)
 
void set_shininess (double shininess)
 
void set_spec (const LColor &spec)
 
bool sorts_less_than (const EggMaterial &other, int eq) const
 An ordering operator to compare two materials for sorting order. More...
 
virtual void write (ostream &out, int indent_level) const
 Writes the material definition to the indicated output stream in Egg format. More...
 
- Public Member Functions inherited from EggNode
 EggNode (const 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...
 
int get_depth () const
 Returns the number of nodes above this node in the egg hierarchy. More...
 
const LMatrix4dget_node_frame () const
 Returns the coordinate frame of the node itself. More...
 
const LMatrix4dget_node_frame_inv () const
 Returns the inverse of the matrix returned by get_node_frame(). More...
 
const LMatrix4dget_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 LMatrix4dget_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 LMatrix4dget_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 LMatrix4dget_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
 
const LMatrix4dget_vertex_frame () const
 Returns the coordinate frame of the vertices referenced by primitives at or under this node. More...
 
const LMatrix4dget_vertex_frame_inv () const
 Returns the inverse of the matrix returned by get_vertex_frame(). More...
 
const LMatrix4dget_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 LMatrix4dget_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 LMatrix4dget_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 LMatrix4dget_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 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...
 
- Public Member Functions inherited from EggNamedObject
 EggNamedObject (const string &name="")
 
 EggNamedObject (const EggNamedObject &copy)
 
EggNamedObjectoperator= (const EggNamedObject &copy)
 
void output (ostream &out) const
 
void write_header (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)
 
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...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
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 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...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const string &initial_name="")
 
 Namable (const Namable &copy)
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const 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...
 
Namableoperator= (const Namable &other)
 
void output (ostream &out) const
 Outputs the Namable. More...
 
void set_name (const string &name)
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from EggNode
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 ()
 

Detailed Description

Definition at line 28 of file eggMaterial.h.

Member Function Documentation

◆ get_amb()

LColor EggMaterial::get_amb ( ) const
inline

It is legal to call this even if has_amb() returns false.

If so, it simply returns the default amb color.

Definition at line 102 of file eggMaterial.I.

References get_emit().

Referenced by EggRenderState::compare_to(), get_diff(), is_equivalent_to(), and sorts_less_than().

◆ get_diff()

LColor EggMaterial::get_diff ( ) const
inline

It is legal to call this even if has_diff() returns false.

If so, it simply returns the default diff color.

Definition at line 55 of file eggMaterial.I.

References get_amb().

Referenced by EggRenderState::compare_to(), is_equivalent_to(), XFileMaterial::set_from_egg(), and sorts_less_than().

◆ get_emit()

LColor EggMaterial::get_emit ( ) const
inline

It is legal to call this even if has_emit() returns false.

If so, it simply returns the default emit color.

Definition at line 149 of file eggMaterial.I.

References get_spec().

Referenced by EggRenderState::compare_to(), get_amb(), is_equivalent_to(), XFileMaterial::set_from_egg(), and sorts_less_than().

◆ get_spec()

LColor EggMaterial::get_spec ( ) const
inline

It is legal to call this even if has_spec() returns false.

If so, it simply returns the default spec color.

Definition at line 196 of file eggMaterial.I.

References sorts_less_than().

Referenced by EggRenderState::compare_to(), get_emit(), is_equivalent_to(), XFileMaterial::set_from_egg(), and sorts_less_than().

◆ is_equivalent_to()

bool EggMaterial::is_equivalent_to ( const EggMaterial other,
int  eq 
) const

Returns true if the two materials 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:

EggMaterial::E_attributes: All material attributes (diff, spec, etc.) except MRef name.

EggMaterial::E_mref_name: The MRef name.

Definition at line 147 of file eggMaterial.cxx.

References get_amb(), get_diff(), get_emit(), get_spec(), and sorts_less_than().

Referenced by EggMaterialCollection::create_unique_material(), and write().

◆ sorts_less_than()

bool EggMaterial::sorts_less_than ( const EggMaterial other,
int  eq 
) const

An ordering operator to compare two materials for sorting order.

This imposes an arbitrary ordering useful to identify unique materials, according to the indicated Equivalence factor. See is_equivalent_to().

Definition at line 179 of file eggMaterial.cxx.

References get_amb(), get_diff(), get_emit(), and get_spec().

Referenced by get_spec(), is_equivalent_to(), and EggPolysetMaker::sorts_less().

◆ write()

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

Writes the material definition to the indicated output stream in Egg format.

Implements EggNode.

Definition at line 60 of file eggMaterial.cxx.

References is_equivalent_to(), and EggNamedObject::write_header().


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