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

LightAttrib Class Reference

Indicates which set of lights should be considered "on" to illuminate geometry at this level and below. More...

#include <lightAttrib.h>

Inheritance diagram for LightAttrib:

RenderAttrib TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject List of all members.

Public Types

enum  Operation { O_set, O_add, O_remove }
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

Operation get_operation () const
 Returns the basic operation type of the LightAttrib.

int get_num_lights () const
 Returns the number of lights listed in the attribute.

Light * get_light (int n) const
 Returns the nth lights listed in the attribute.

bool has_light (Light *light) const
 Returns true if the indicated light is listed in the attrib, false otherwise.

ConstPointerTo< RenderAttrib > add_light (Light *light) const
ConstPointerTo< RenderAttrib > remove_light (Light *light) const
bool is_identity () const
 Returns true if this is an identity attrib: it does not change the set of lights in use.

bool is_all_off () const
 Returns true if this attrib turns off all lights and turns none on.

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_all_off ()
 Constructs a new LightAttrib object that turns off all lights (and hence disables lighting).

ConstPointerTo< RenderAttrib > make (Operation op, Light *light)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

ConstPointerTo< RenderAttrib > make (Operation op, Light *light1, Light *light2)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

ConstPointerTo< RenderAttrib > make (Operation op, Light *light1, Light *light2, Light *light3)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

ConstPointerTo< RenderAttrib > make (Operation op, Light *light1, Light *light2, Light *light3, Light *light4)
 Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

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

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 LightAttrib types to return a unique number indicating whether this LightAttrib is equivalent to the other one.

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.

virtual RenderAttrib * make_default_impl () const
 Intended to be overridden by derived LightAttrib types to specify what the default property for a LightAttrib 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 LightAttrib.

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 LightAttrib 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 Types

typedef ov_set< PointerTo<
Light > > 		Lights

Private Member Functions

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

ConstPointerTo< RenderAttrib > do_add (const LightAttrib *other, Operation op) const
 Returns a new LightAttrib that represents all the lights of this attrib, with those of the other one added in.

ConstPointerTo< RenderAttrib > do_remove (const LightAttrib *other, Operation op) const
 Returns a new LightAttrib that represents all the lights of this attrib, with those of the other one removed.


Private Attributes

Operation _operation
Lights _lights

Static Private Attributes

TypeHandle _type_handle

Detailed Description

Indicates which set of lights should be considered "on" to illuminate geometry at this level and below.

A LightAttrib can either add lights or remove lights from the total set of "on" lights.

Definition at line 44 of file lightAttrib.h.

Member Typedef Documentation

typedef ov_set< PointerTo< Light > > LightAttrib::Lights [private]
 

Definition at line 95 of file lightAttrib.h.

Member Enumeration Documentation

enum LightAttrib::Operation
 

Enumeration values:
O_set 
O_add 
O_remove 

Definition at line 49 of file lightAttrib.h.

Referenced by LightAttrib().

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

LightAttrib::LightAttrib (   )  [inline, private]
 

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

Definition at line 34 of file lightAttrib.I.

References _operation, INLINE, and Operation.

Member Function Documentation

ConstPointerTo< RenderAttrib > LightAttrib::add_light (  Light *  light  )  const [inline]
 

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 LightAttrib::compare_to_impl (  const RenderAttrib *  other  )  const [protected, virtual]
 

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

This should return 0 if the two LightAttrib 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 LightAttrib objects whose get_type() functions return the same.

Reimplemented from RenderAttrib.

Definition at line 234 of file lightAttrib.cxx.

References _operation, DCAST_INTO_R, do_add(), do_remove(), O_remove, and O_set.

int LightAttrib::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 542 of file lightAttrib.cxx.

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

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

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

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 from RenderAttrib.

Definition at line 300 of file lightAttrib.cxx.

References _lights, and _operation.

ConstPointerTo< RenderAttrib > LightAttrib::do_add (  const LightAttrib *  other,
LightAttrib::Operation  op
)  const [private]
 

Returns a new LightAttrib that represents all the lights of this attrib, with those of the other one added in.

Definition at line 391 of file lightAttrib.cxx.

Referenced by compare_to_impl().

ConstPointerTo< RenderAttrib > LightAttrib::do_remove (  const LightAttrib *  other,
LightAttrib::Operation  op
)  const [private]
 

Returns a new LightAttrib that represents all the lights of this attrib, with those of the other one removed.

Definition at line 451 of file lightAttrib.cxx.

References fillin(), and parse_params().

Referenced by compare_to_impl().

void LightAttrib::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 LightAttrib.

Reimplemented from RenderAttrib.

Definition at line 594 of file lightAttrib.cxx.

Referenced by do_remove().

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 LightAttrib::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from RenderAttrib.

Definition at line 119 of file lightAttrib.h.

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

Reimplemented from RenderAttrib.

Definition at line 108 of file lightAttrib.h.

Light * LightAttrib::get_light (  int  n  )  const [inline]
 

Returns the nth lights listed in the attribute.

Definition at line 85 of file lightAttrib.I.

References _operation, RenderAttrib::compose(), INLINE, make(), O_add, and O_remove.

Referenced by GraphicsStateGuardian::begin_decal_nested().

int LightAttrib::get_num_lights (   )  const [inline]
 

Returns the number of lights listed in the attribute.

Definition at line 72 of file lightAttrib.I.

References _operation, RenderAttrib::compose(), INLINE, make(), O_add, and O_remove.

Referenced by GraphicsStateGuardian::begin_decal_nested().

LightAttrib::Operation LightAttrib::get_operation (   )  const [inline]
 

Returns the basic operation type of the LightAttrib.

If this is O_set, the lights listed here completely replace any lights that were already on. If this is O_add, the lights here are added to the set of of lights that were already on, and if O_remove, the lights here are removed from the set of lights that were on.

Definition at line 59 of file lightAttrib.I.

References _lights, INLINE, nassertr, and NULL.

Referenced by GraphicsStateGuardian::begin_decal_nested().

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 LightAttrib::get_type (  void   )  const [inline, virtual]
 

Reimplemented from RenderAttrib.

Definition at line 116 of file lightAttrib.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.

bool LightAttrib::has_light (  Light *  light  )  const
 

Returns true if the indicated light is listed in the attrib, false otherwise.

Definition at line 146 of file lightAttrib.cxx.

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

Reimplemented from RenderAttrib.

Definition at line 111 of file lightAttrib.h.

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

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

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 from RenderAttrib.

Definition at line 346 of file lightAttrib.cxx.

bool LightAttrib::is_all_off (   )  const [inline]
 

Returns true if this attrib turns off all lights and turns none on.

Definition at line 156 of file lightAttrib.I.

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 LightAttrib::is_identity (   )  const [inline]
 

Returns true if this is an identity attrib: it does not change the set of lights in use.

Definition at line 141 of file lightAttrib.I.

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

void LightAttrib::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 167 of file lightAttrib.cxx.

ConstPointerTo< RenderAttrib > LightAttrib::make (  LightAttrib::Operation  op,
Light *  light1,
Light *  light2,
Light *  light3,
Light *  light4
)  [static]
 

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

Definition at line 122 of file lightAttrib.cxx.

References GraphicsStateGuardianBase::issue_light().

ConstPointerTo< RenderAttrib > LightAttrib::make (  LightAttrib::Operation  op,
Light *  light1,
Light *  light2,
Light *  light3
)  [static]
 

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

Definition at line 99 of file lightAttrib.cxx.

References _lights, _operation, RenderAttrib::return_new(), and ov_set< PointerTo< Light > >::sort().

ConstPointerTo< RenderAttrib > LightAttrib::make (  LightAttrib::Operation  op,
Light *  light1,
Light *  light2
)  [static]
 

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

Definition at line 78 of file lightAttrib.cxx.

References _lights, _operation, RenderAttrib::return_new(), and ov_set< PointerTo< Light > >::sort().

ConstPointerTo< RenderAttrib > LightAttrib::make (  LightAttrib::Operation  op,
Light *  light
)  [static]
 

Constructs a new LightAttrib object that turns on (or off, according to op) the indicate light(s).

Definition at line 60 of file lightAttrib.cxx.

References _lights, _operation, RenderAttrib::return_new(), and ov_set< PointerTo< Light > >::sort().

Referenced by get_light(), and get_num_lights().

ConstPointerTo< RenderAttrib > LightAttrib::make_all_off (   )  [static]
 

Constructs a new LightAttrib object that turns off all lights (and hence disables lighting).

Definition at line 43 of file lightAttrib.cxx.

References _lights, _operation, and RenderAttrib::return_new().

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

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

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

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

Implements RenderAttrib.

Definition at line 374 of file lightAttrib.cxx.

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

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

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

Definition at line 570 of file lightAttrib.cxx.

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

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

Reimplemented from RenderAttrib.

Definition at line 180 of file lightAttrib.cxx.

References _lights, _operation, 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 LightAttrib::register_with_read_factory (  void   )  [static]
 

Tells the BamReader how to create objects of type LightAttrib.

Definition at line 499 of file lightAttrib.cxx.

ConstPointerTo< RenderAttrib > LightAttrib::remove_light (  Light *  light  )  const [inline]
 

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(), MaterialAttrib::make(), make(), FogAttrib::make(), CullFaceAttrib::make(), ClipPlaneAttrib::make(), 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 LightAttrib::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 514 of file lightAttrib.cxx.

Member Data Documentation

Lights LightAttrib::_lights [private]
 

Definition at line 96 of file lightAttrib.h.

Referenced by compose_impl(), get_operation(), make(), make_all_off(), and output().

Operation LightAttrib::_operation [private]
 

Definition at line 94 of file lightAttrib.h.

Referenced by compare_to_impl(), compose_impl(), get_light(), get_num_lights(), LightAttrib(), make(), make_all_off(), and output().

TypeHandle LightAttrib::_type_handle [static, private]
 

Reimplemented from RenderAttrib.

Definition at line 30 of file lightAttrib.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:51:43 2003 for Panda by doxygen1.3