Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

MaterialAttrib Class Reference

Indicates which, if any, material should be applied to geometry. More...

#include <materialAttrib.h>

Inheritance diagram for MaterialAttrib:

RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject List of all members.

Public Types

enum  PandaCompareFunc {
  M_none = 0, M_never, M_less, M_equal,
  M_less_equal, M_greater, M_not_equal, M_greater_equal,
  M_always
}

Public Member Functions

bool is_off () const
 Returns true if the MaterialAttrib is an 'off' MaterialAttrib, indicating that it should disable the use of materials.

const Material * get_material () const
 If the MaterialAttrib is not an 'off' MaterialAttrib, returns the material that is associated.

virtual void issue (GraphicsStateGuardianBase *gsg) const
 Calls the appropriate method on the indicated GSG to issue the graphics commands appropriate to the given attribute.

virtual void output (ostream &out) const
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file.

virtual int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
ConstPointerTo< RenderAttrib > compose (const RenderAttrib *other) const
ConstPointerTo< RenderAttrib > invert_compose (const RenderAttrib *other) const
ConstPointerTo< RenderAttrib > make_default () const
int compare_to (const RenderAttrib &other) const
 Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest.

virtual void write (ostream &out, int indent_level) const
virtual void finalize ()
 Method to ensure that any necessary clean up tasks that have to be performed by this object are performed.

int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.

bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.

int get_ref_count () const
 Returns the current reference count.

int ref () const
 Explicitly increments the reference count.

int unref () const
 Explicitly decrements the reference count.

void test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.


Static Public Member Functions

ConstPointerTo< RenderAttrib > make (const Material *material)
 Constructs a new MaterialAttrib object suitable for rendering the indicated material onto geometry.

ConstPointerTo< RenderAttrib > make_off ()
 Constructs a new MaterialAttrib object suitable for rendering unmateriald geometry.

void register_with_read_factory ()
 Tells the BamReader how to create objects of type MaterialAttrib.

TypeHandle get_class_type ()
void init_type ()
TypedWritable * change_this (TypedWritable *old_ptr, BamReader *manager)
 Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired.


Static Public Attributes

TypedWritable *const Null = (TypedWritable*)0L

Protected Member Functions

virtual int compare_to_impl (const RenderAttrib *other) const
 Intended to be overridden by derived MaterialAttrib types to return a unique number indicating whether this MaterialAttrib is equivalent to the other one.

virtual RenderAttrib * make_default_impl () const
 Intended to be overridden by derived MaterialAttrib types to specify what the default property for a MaterialAttrib of this type should be.

void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new MaterialAttrib.

virtual ConstPointerTo< RenderAttrib > compose_impl (const RenderAttrib *other) const
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.

virtual ConstPointerTo< RenderAttrib > invert_compose_impl (const RenderAttrib *other) const
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.

void output_comparefunc (ostream &out, PandaCompareFunc fn) const

Static Protected Member Functions

TypedWritable * make_from_bam (const FactoryParams &params)
 This function is called by the BamReader's factory when a new object of type MaterialAttrib is encountered in the Bam file.

ConstPointerTo< RenderAttrib > return_new (RenderAttrib *attrib)
 This function is used by derived RenderAttrib types to share a common RenderAttrib pointer for all equivalent RenderAttrib objects.

TypedWritable * new_from_bam (RenderAttrib *attrib, BamReader *manager)

Private Member Functions

 MaterialAttrib ()
 Use MaterialAttrib::make() to construct a new MaterialAttrib object.


Private Attributes

ConstPointerTo< Material > _material

Static Private Attributes

TypeHandle _type_handle

Detailed Description

Indicates which, if any, material should be applied to geometry.

The material is used primarily to control lighting effects, and isn't necessarily (or useful) in the absence of lighting.

Definition at line 43 of file materialAttrib.h.

Member Enumeration Documentation

enum RenderAttrib::PandaCompareFunc [inherited]
 

Enumeration values:
M_none 
M_never 
M_less 
M_equal 
M_less_equal 
M_greater 
M_not_equal 
M_greater_equal 
M_always 

Definition at line 107 of file renderAttrib.h.

Referenced by AlphaTestAttrib::AlphaTestAttrib(), DepthTestAttrib::DepthTestAttrib(), DXGraphicsStateGuardian8::enable_texturing(), GLGraphicsStateGuardian::issue_tex_matrix(), and GLGraphicsStateGuardian::issue_transform().

Constructor & Destructor Documentation

MaterialAttrib::MaterialAttrib (   )  [inline, private]
 

Use MaterialAttrib::make() to construct a new MaterialAttrib object.

Definition at line 34 of file materialAttrib.I.

References _material, INLINE, and NULL.

Member Function Documentation

TypedWritable * RenderAttrib::change_this (  TypedWritable *  old_ptr,
BamReader *  manager
)  [static, inherited]
 

Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired.

Most objects don't change pointers after completion, but some need to.

Once this function has been called, the old pointer will no longer be accessed.

Definition at line 362 of file renderAttrib.cxx.

int RenderAttrib::compare_to (  const RenderAttrib &  other  )  const [inline, inherited]
 

Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest.

This method is not needed outside of the RenderAttrib class because all equivalent RenderAttrib objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

Definition at line 125 of file renderAttrib.I.

int MaterialAttrib::compare_to_impl (  const RenderAttrib *  other  )  const [protected, virtual]
 

Intended to be overridden by derived MaterialAttrib types to return a unique number indicating whether this MaterialAttrib is equivalent to the other one.

This should return 0 if the two MaterialAttrib objects are equivalent, a number less than zero if this one should be sorted before the other one, and a number greater than zero otherwise.

This will only be called with two MaterialAttrib objects whose get_type() functions return the same.

Reimplemented from RenderAttrib.

Definition at line 132 of file materialAttrib.cxx.

References get_class_type(), BamReader::get_factory(), make_from_bam(), and Factory< TypedWritable >::register_factory().

int MaterialAttrib::complete_pointers (  TypedWritable **  plist,
BamReader *  manager
)  [virtual]
 

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

Reimplemented from TypedWritable.

Definition at line 215 of file materialAttrib.cxx.

ConstPointerTo< RenderAttrib > RenderAttrib::compose (  const RenderAttrib *  other  )  const [inline, inherited]
 

Referenced by LightAttrib::get_light(), LightAttrib::get_num_lights(), ClipPlaneAttrib::get_num_planes(), and ClipPlaneAttrib::get_plane().

ConstPointerTo< RenderAttrib > RenderAttrib::compose_impl (  const RenderAttrib *  other  )  const [protected, virtual, inherited]
 

Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.

This should return the result of applying the other RenderAttrib to a node in the scene graph below this RenderAttrib, which was already applied. In most cases, the result is the same as the other RenderAttrib (that is, a subsequent RenderAttrib completely replaces the preceding one). On the other hand, some kinds of RenderAttrib (for instance, ColorTransformAttrib) might combine in meaningful ways.

Reimplemented in ClipPlaneAttrib, ColorScaleAttrib, CullFaceAttrib, DepthOffsetAttrib, LightAttrib, and TexMatrixAttrib.

Definition at line 276 of file renderAttrib.cxx.

void MaterialAttrib::fillin (  DatagramIterator &  scan,
BamReader *  manager
)  [protected]
 

This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new MaterialAttrib.

Reimplemented from RenderAttrib.

Definition at line 265 of file materialAttrib.cxx.

void RenderAttrib::finalize (  void   )  [virtual, inherited]
 

Method to ensure that any necessary clean up tasks that have to be performed by this object are performed.

Reimplemented from TypedWritable.

Definition at line 393 of file renderAttrib.cxx.

virtual TypeHandle MaterialAttrib::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from RenderAttrib.

Definition at line 86 of file materialAttrib.h.

TypeHandle MaterialAttrib::get_class_type (  void   )  [inline, static]
 

Reimplemented from RenderAttrib.

Definition at line 75 of file materialAttrib.h.

Referenced by compare_to_impl(), and NodePath::get_color().

const Material * MaterialAttrib::get_material (   )  const [inline]
 

If the MaterialAttrib is not an 'off' MaterialAttrib, returns the material that is associated.

Otherwise, return NULL.

Definition at line 67 of file materialAttrib.I.

int ReferenceCount::get_ref_count (   )  const [inline, inherited]
 

Returns the current reference count.

Definition at line 183 of file referenceCount.I.

Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle MaterialAttrib::get_type (  void   )  const [inline, virtual]
 

Reimplemented from RenderAttrib.

Definition at line 83 of file materialAttrib.h.

int TypedObject::get_type_index (   )  const [inline, inherited]
 

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

Definition at line 71 of file typedObject.I.

References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

void MaterialAttrib::init_type (  void   )  [inline, static]
 

Reimplemented from RenderAttrib.

Definition at line 78 of file materialAttrib.h.

ConstPointerTo< RenderAttrib > RenderAttrib::invert_compose (  const RenderAttrib *  other  )  const [inline, inherited]
 

ConstPointerTo< RenderAttrib > RenderAttrib::invert_compose_impl (  const RenderAttrib *  other  )  const [protected, virtual, inherited]
 

Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.

See invert_compose() and compose_impl().

Reimplemented in ClipPlaneAttrib, ColorScaleAttrib, CullFaceAttrib, DepthOffsetAttrib, LightAttrib, and TexMatrixAttrib.

Definition at line 297 of file renderAttrib.cxx.

bool TypedObject::is_exact_type (  TypeHandle  handle  )  const [inline, inherited]
 

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

Definition at line 101 of file typedObject.I.

Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type (  TypeHandle  handle  )  const [inline, inherited]
 

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

Definition at line 86 of file typedObject.I.

Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

bool MaterialAttrib::is_off (   )  const [inline]
 

Returns true if the MaterialAttrib is an 'off' MaterialAttrib, indicating that it should disable the use of materials.

Definition at line 50 of file materialAttrib.I.

References _material.

Referenced by NodePath::get_color().

void MaterialAttrib::issue (  GraphicsStateGuardianBase *  gsg  )  const [virtual]
 

Calls the appropriate method on the indicated GSG to issue the graphics commands appropriate to the given attribute.

This is normally called (indirectly) only from GraphicsStateGuardian::set_state() or modify_state().

Reimplemented from RenderAttrib.

Definition at line 81 of file materialAttrib.cxx.

ConstPointerTo< RenderAttrib > MaterialAttrib::make (  const Material *  material  )  [static]
 

Constructs a new MaterialAttrib object suitable for rendering the indicated material onto geometry.

Definition at line 42 of file materialAttrib.cxx.

References RenderAttrib::return_new().

Referenced by NodePath::set_color_off().

ConstPointerTo< RenderAttrib > RenderAttrib::make_default (   )  const [inline, inherited]
 

RenderAttrib * MaterialAttrib::make_default_impl (   )  const [protected, virtual]
 

Intended to be overridden by derived MaterialAttrib types to specify what the default property for a MaterialAttrib of this type should be.

This should return a newly-allocated MaterialAttrib of the same type that corresponds to whatever the standard default for this kind of MaterialAttrib is.

Implements RenderAttrib.

Definition at line 166 of file materialAttrib.cxx.

TypedWritable * MaterialAttrib::make_from_bam (  const FactoryParams &  params  )  [static, protected]
 

This function is called by the BamReader's factory when a new object of type MaterialAttrib is encountered in the Bam file.

It should create the MaterialAttrib and extract its information from the file.

Definition at line 241 of file materialAttrib.cxx.

Referenced by compare_to_impl().

ConstPointerTo< RenderAttrib > MaterialAttrib::make_off (   )  [static]
 

Constructs a new MaterialAttrib object suitable for rendering unmateriald geometry.

Definition at line 59 of file materialAttrib.cxx.

References GraphicsStateGuardianBase::issue_material().

TypedWritable* RenderAttrib::new_from_bam (  RenderAttrib *  attrib,
BamReader *  manager
)  [static, protected, inherited]
 

void MaterialAttrib::output (  ostream &  out  )  const [virtual]
 

Reimplemented from RenderAttrib.

Definition at line 94 of file materialAttrib.cxx.

References _material, and DCAST_INTO_R.

void RenderAttrib::output_comparefunc (  ostream &  out,
PandaCompareFunc  fn
)  const [protected, inherited]
 

Definition at line 141 of file renderAttrib.cxx.

References RenderAttrib::_attribs, RenderAttrib::_saved_entry, nassertr, and NULL.

int ReferenceCount::ref (   )  const [inline, inherited]
 

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.

The return value is the new reference count.

Definition at line 225 of file referenceCount.I.

Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

void MaterialAttrib::register_with_read_factory (  void   )  [static]
 

Tells the BamReader how to create objects of type MaterialAttrib.

Definition at line 181 of file materialAttrib.cxx.

ConstPointerTo< RenderAttrib > RenderAttrib::return_new (  RenderAttrib *  attrib  )  [static, protected, inherited]
 

This function is used by derived RenderAttrib types to share a common RenderAttrib pointer for all equivalent RenderAttrib objects.

The make() function of the derived type should create a new RenderAttrib and pass it through return_new(), which will either save the pointer and return it unchanged (if this is the first similar such object) or delete it and return an equivalent pointer (if there was already a similar object saved).

Definition at line 186 of file renderAttrib.cxx.

Referenced by CullFaceAttrib::compare_to_impl(), TextureAttrib::make(), make(), LightAttrib::make(), FogAttrib::make(), CullFaceAttrib::make(), ClipPlaneAttrib::make(), LightAttrib::make_all_off(), ClipPlaneAttrib::make_all_off(), ColorAttrib::make_flat(), and ColorAttrib::make_vertex().

void ReferenceCount::test_ref_count_integrity (   )  const [inline, inherited]
 

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.

References INLINE.

Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref (   )  const [inline, inherited]
 

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 the new reference count.

Definition at line 293 of file referenceCount.I.

References INLINE.

Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

void RenderAttrib::write (  ostream &  out,
int  indent_level
)  const [virtual, inherited]
 

Definition at line 155 of file renderAttrib.cxx.

References RenderAttrib::_attribs.

void MaterialAttrib::write_datagram (  BamWriter *  manager,
Datagram &  dg
)  [virtual]
 

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from RenderAttrib.

Definition at line 196 of file materialAttrib.cxx.

References RenderAttrib::fillin(), and BamReader::read_pointer().

Member Data Documentation

ConstPointerTo< Material > MaterialAttrib::_material [private]
 

Definition at line 63 of file materialAttrib.h.

Referenced by is_off(), MaterialAttrib(), and output().

TypeHandle MaterialAttrib::_type_handle [static, private]
 

Reimplemented from RenderAttrib.

Definition at line 29 of file materialAttrib.cxx.

TypedWritable *const TypedWritable::Null = (TypedWritable*)0L [static, inherited]
 

Definition at line 25 of file typedWritable.cxx.

Referenced by Child::complete_pointers(), Parent::complete_pointers(), Person::complete_pointers(), LoaderFileTypeBam::get_extension(), PartGroup::pick_channel_index(), BamReader::read_pointer(), and AnimGroup::write_datagram().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:52:07 2003 for Panda by doxygen1.3