Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes

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 MemoryBase MemoryBase

List of all members.

Classes

class  BamAuxData

Public Types

typedef pvector< PT(PandaNode) > NodeList
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
}
enum  TexGenMode {
  M_off, M_eye_sphere_map, M_world_cube_map, M_eye_cube_map,
  M_world_normal, M_eye_normal, M_world_position, M_unused,
  M_eye_position, M_point_sprite, M_light_vector, M_constant
}

Public Member Functions

bool always_reissue () const
 Returns true if the RenderAttrib should be reissued to the GSG with every state change, even if it is the same pointer as it was before; or false for the normal case, to reissue only when the RenderAttrib pointer changes.
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
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 int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
 CPT (RenderAttrib) add_on_light(const NodePath &light) const
 CPT (RenderAttrib) remove_on_light(const NodePath &light) const
 CPT (RenderAttrib) add_off_light(const NodePath &light) const
 CPT (RenderAttrib) remove_off_light(const NodePath &light) const
 CPT (LightAttrib) filter_to_max(int max_lights) const
 CPT (RenderAttrib) add_light(Light *light) const
 CPT (RenderAttrib) remove_light(Light *light) const
virtual bool cull_callback (CullTraverser *trav, const CullTraverserData &data) const
 If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.
virtual TypeHandle force_init_type ()
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter.
int get_best_parent_from_Set (const std::set< int > &) const
Lightget_light (int n) const
 Returns the nth light listed in the attribute.
NodePath get_most_important_light () const
 Returns the most important light (that is, the light with the highest priority) in the LightAttrib, excluding any ambient lights.
int get_num_lights () const
 Returns the number of lights listed in the attribute.
int get_num_off_lights () const
 Returns the number of lights that are turned off by the attribute.
int get_num_on_lights () const
 Returns the number of lights that are turned on by the attribute.
NodePath get_off_light (int n) const
 Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order.
NodePath get_on_light (int n) const
 Returns the nth light turned on by the attribute, sorted in render order.
Operation get_operation () const
 Returns the basic operation type of the LightAttrib.
int get_ref_count () const
 Returns the current reference count.
virtual int get_slot () const
virtual TypeHandle get_type () const
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_all_off () const
 Returns true if this attrib turns off all lights (although it may also turn some on).
virtual bool has_cull_callback () const
 Should be overridden by derived classes to return true if cull_callback() has been defined.
bool has_light (Light *light) const
 Returns true if the indicated light is listed in the attrib, false otherwise.
bool has_off_light (const NodePath &light) const
 Returns true if the indicated light is turned off by the attrib, false otherwise.
bool has_on_light (const NodePath &light) const
 Returns true if the indicated light is turned on by the attrib, false otherwise.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_identity () const
 Returns true if this is an identity attrib: it does not change the set of lights in use.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
virtual bool lower_attrib_can_override () const
 Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.
 MAKE_SEQ (get_on_lights, get_num_on_lights, get_on_light)
 MAKE_SEQ (get_off_lights, get_num_off_lights, get_off_light)
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete (void *ptr, void *)
void operator delete (void *ptr)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
virtual void output (ostream &out) const
void ref () const
 Explicitly increments the reference count.
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero.
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.
virtual void write (ostream &out, int indent_level) 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.

Static Public Member Functions

static TypedWritablechange_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 CPT (RenderAttrib) make(Operation op
static CPT (RenderAttrib) make(Operation op
static CPT (RenderAttrib) make(Operation op
static CPT (RenderAttrib) make_default()
static CPT (RenderAttrib) make(Operation op
static CPT (RenderAttrib) make()
static CPT (RenderAttrib) make_all_off()
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.
static int get_class_slot ()
static TypeHandle get_class_type ()
static int get_num_attribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world.
static void init_attribs ()
 Make sure the global _attribs map is allocated.
static void init_type ()
static void list_attribs (ostream &out)
 Lists all of the RenderAttribs in the cache to the output stream, one per line.
static PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data
static int register_slot (TypeHandle type_handle, int sort, RenderAttribRegistry::MakeDefaultFunc *make_default_func)
 Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number.
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type LightAttrib.
static bool validate_attribs ()
 Ensures that the cache is still stored in sorted order.

Public Attributes

static Lightlight
static Lightlight1
static Light Lightlight2
static Light Light Lightlight3
static Light Light Light Lightlight4
static BamReaderreader = NULL)

Static Public Attributes

static TypedWritable *const Null = (TypedWritable*)0L

Protected Member Functions

 LightAttrib ()
 Use LightAttrib::make() to construct a new LightAttrib object.
 LightAttrib (const LightAttrib &copy)
 Use LightAttrib::make() to construct a new LightAttrib object.
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 CPT (RenderAttrib) compose_impl(const RenderAttrib *other) const
virtual CPT (RenderAttrib) invert_compose_impl(const RenderAttrib *other) const
bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
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
 Outputs a string representation of the given PandaCompareFunc object.

Static Protected Member Functions

static TypedWritablemake_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.
static TypedWritablenew_from_bam (RenderAttrib *attrib, BamReader *manager)

Protected Attributes

bool _always_reissue

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 33 of file lightAttrib.h.


Constructor & Destructor Documentation

LightAttrib::LightAttrib ( ) [inline, protected]

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

Definition at line 23 of file lightAttrib.I.

Referenced by make_from_bam().

LightAttrib::LightAttrib ( const LightAttrib copy) [inline, protected]

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

The copy constructor is only defined to facilitate methods like add_on_light().

Definition at line 35 of file lightAttrib.I.


Member Function Documentation

bool RenderAttrib::always_reissue ( ) const [inline, inherited]

Returns true if the RenderAttrib should be reissued to the GSG with every state change, even if it is the same pointer as it was before; or false for the normal case, to reissue only when the RenderAttrib pointer changes.

Definition at line 62 of file renderAttrib.I.

ReferenceCount * TypedWritableReferenceCount::as_reference_count ( ) [virtual, inherited]

Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

Reimplemented from TypedWritable.

Definition at line 26 of file typedWritableReferenceCount.cxx.

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

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 528 of file renderAttrib.cxx.

References BamReader::register_finalize().

Referenced by RenderAttrib::fillin().

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 79 of file renderAttrib.I.

References RenderAttrib::compare_to_impl(), and TypeHandle::get_index().

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 697 of file lightAttrib.cxx.

References ordered_vector< Key, Compare >::begin(), NodePath::compare_to(), and ordered_vector< Key, Compare >::end().

int LightAttrib::complete_pointers ( TypedWritable **  p_list,
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 978 of file lightAttrib.cxx.

References BamReader::get_aux_data().

bool RenderAttrib::cull_callback ( CullTraverser trav,
const CullTraverserData data 
) const [virtual, inherited]

If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.

This is called each time the RenderAttrib is discovered applied to a Geom in the traversal. It should return true if the Geom is visible, false if it should be omitted.

Reimplemented in TextureAttrib.

Definition at line 134 of file renderAttrib.cxx.

bool TypedWritable::decode_raw_from_bam_stream ( TypedWritable *&  ptr,
ReferenceCount *&  ref_ptr,
const string &  data,
BamReader reader = NULL 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string.

Returns true on success, false on on error.

This variant sets the TypedWritable and ReferenceCount pointers separately; both are pointers to the same object. The reference count is not incremented; it is the caller's responsibility to manage the reference count.

Note that this method cannot be used to retrieve objects that do not inherit from ReferenceCount, because these objects cannot persist beyond the lifetime of the BamReader that reads them. To retrieve these objects from a bam stream, you must construct a BamReader directly.

If you happen to know that the particular object in question inherits from TypedWritableReferenceCount or PandaNode, consider calling the variant of decode_from_bam_stream() defined for those methods, which presents a simpler interface.

Definition at line 353 of file typedWritable.cxx.

References BamReader::init(), DatagramInputFile::open(), DatagramInputFile::read_header(), BamReader::read_object(), ReferenceCount::ref(), BamReader::resolve(), BamReader::set_source(), and ReferenceCount::unref().

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

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

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

string TypedWritable::encode_to_bam_stream ( ) const [inline, inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.

Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 86 of file typedWritable.I.

bool TypedWritable::encode_to_bam_stream ( string &  data,
BamWriter writer = NULL 
) const [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

Definition at line 283 of file typedWritable.cxx.

References BamWriter::init(), DatagramOutputFile::open(), BamWriter::set_target(), DatagramOutputFile::write_header(), and BamWriter::write_object().

void LightAttrib::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual]

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 1081 of file lightAttrib.cxx.

References DatagramIterator::get_bool(), DatagramIterator::get_uint16(), BamReader::read_pointers(), and BamReader::set_aux_data().

Referenced by make_from_bam().

void LightAttrib::finalize ( BamReader manager) [virtual]

Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.

Reimplemented from RenderAttrib.

Definition at line 1010 of file lightAttrib.cxx.

References BamReader::get_aux_data(), ordered_vector< Key, Compare >::push_back(), and ov_set< Key, Compare >::sort().

UpdateSeq TypedWritable::get_bam_modified ( ) const [inline, inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

Definition at line 66 of file typedWritable.I.

Referenced by BamWriter::consider_update(), and BamWriter::write_pointer().

Light * LightAttrib::get_light ( int  n) const

Returns the nth light listed in the attribute.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

Definition at line 295 of file lightAttrib.cxx.

References PandaNode::as_light(), get_num_off_lights(), get_off_light(), get_on_light(), and NodePath::node().

NodePath LightAttrib::get_most_important_light ( ) const

Returns the most important light (that is, the light with the highest priority) in the LightAttrib, excluding any ambient lights.

Returns an empty NodePath if no non-ambient lights are found.

Definition at line 568 of file lightAttrib.cxx.

References PandaNode::as_light(), PandaNode::is_ambient_light(), NodePath::is_empty(), and NodePath::node().

int RenderAttrib::get_num_attribs ( ) [static, inherited]

Returns the total number of unique RenderAttrib objects allocated in the world.

This will go up and down during normal operations.

Definition at line 192 of file renderAttrib.cxx.

int LightAttrib::get_num_lights ( ) const

Returns the number of lights listed in the attribute.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

Definition at line 273 of file lightAttrib.cxx.

References get_num_off_lights(), and get_num_on_lights().

int LightAttrib::get_num_off_lights ( ) const [inline]

Returns the number of lights that are turned off by the attribute.

Definition at line 83 of file lightAttrib.I.

References ordered_vector< Key, Compare >::size().

Referenced by get_light(), get_num_lights(), get_operation(), has_light(), and write_datagram().

int LightAttrib::get_num_on_lights ( ) const [inline]

Returns the number of lights that are turned on by the attribute.

Definition at line 49 of file lightAttrib.I.

References ordered_vector< Key, Compare >::size().

Referenced by ShaderGenerator::analyze_renderstate(), get_num_lights(), and write_datagram().

NodePath LightAttrib::get_off_light ( int  n) const [inline]

Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order.

Definition at line 94 of file lightAttrib.I.

References NodePath::fail(), and ordered_vector< Key, Compare >::size().

Referenced by get_light().

NodePath LightAttrib::get_on_light ( int  n) const [inline]

Returns the nth light turned on by the attribute, sorted in render order.

Definition at line 60 of file lightAttrib.I.

References NodePath::fail(), and ordered_vector< Key, Compare >::size().

Referenced by ShaderGenerator::analyze_renderstate(), and get_light().

LightAttrib::Operation LightAttrib::get_operation ( ) const

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.

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

Definition at line 247 of file lightAttrib.cxx.

References get_num_off_lights(), and has_all_off().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
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 52 of file typedObject.I.

References TypeHandle::get_index().

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool LightAttrib::has_all_off ( ) const [inline]

Returns true if this attrib turns off all lights (although it may also turn some on).

Definition at line 118 of file lightAttrib.I.

Referenced by get_operation(), and NodePath::has_light_off().

bool RenderAttrib::has_cull_callback ( ) const [virtual, inherited]

Should be overridden by derived classes to return true if cull_callback() has been defined.

Otherwise, returns false to indicate cull_callback() does not need to be called for this node during the cull traversal.

Reimplemented in TextureAttrib.

Definition at line 116 of file renderAttrib.cxx.

bool LightAttrib::has_light ( Light light) const

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

This method is now deprecated. LightAttribs nowadays have a separate list of on_lights and off_lights, so this method doesn't make sense. Query the lists independently.

Definition at line 318 of file lightAttrib.cxx.

References get_num_off_lights(), has_off_light(), and has_on_light().

bool LightAttrib::has_off_light ( const NodePath light) const [inline]

Returns true if the indicated light is turned off by the attrib, false otherwise.

Definition at line 106 of file lightAttrib.I.

References ordered_vector< Key, Compare >::end(), and has_on_light().

Referenced by has_light(), and NodePath::has_light_off().

bool LightAttrib::has_on_light ( const NodePath light) const [inline]

Returns true if the indicated light is turned on by the attrib, false otherwise.

Definition at line 72 of file lightAttrib.I.

References ordered_vector< Key, Compare >::end().

Referenced by has_light(), NodePath::has_light(), and has_off_light().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

void RenderAttrib::init_attribs ( ) [static, inherited]

Make sure the global _attribs map is allocated.

This only has to be done once. We could make this map static, but then we run into problems if anyone creates a RenderAttrib object at static init time; it also seems to cause problems when the Panda shared library is unloaded at application exit time.

Definition at line 493 of file renderAttrib.cxx.

References Thread::get_current_thread(), and Thread::get_main_thread().

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
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 129 of file lightAttrib.I.

References ordered_vector< Key, Compare >::empty().

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 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

void RenderAttrib::list_attribs ( ostream &  out) [static, inherited]

Lists all of the RenderAttribs in the cache to the output stream, one per line.

This can be quite a lot of output if the cache is large, so be prepared.

Definition at line 209 of file renderAttrib.cxx.

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

bool RenderAttrib::lower_attrib_can_override ( ) const [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 false if a RenderAttrib on a higher node will compose into a RenderAttrib on a lower node that has a higher override value, or true if the lower RenderAttrib will completely replace the state.

The default behavior is false: normally, a RenderAttrib in the graph cannot completely override a RenderAttrib above it, regardless of its override value--instead, the two attribs are composed. But for some kinds of RenderAttribs, it is useful to allow this kind of override.

This method only handles the one special case of a lower RenderAttrib with a higher override value. If the higher RenderAttrib has a higher override value, it always completely overrides. And if both RenderAttribs have the same override value, they are always composed.

Reimplemented in ColorScaleAttrib, and TextureAttrib.

Definition at line 102 of file renderAttrib.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 1060 of file lightAttrib.cxx.

References fillin(), LightAttrib(), and BamReader::register_finalize().

Referenced by register_with_read_factory().

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

Outputs a string representation of the given PandaCompareFunc object.

Definition at line 394 of file renderAttrib.cxx.

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

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

int RenderAttrib::register_slot ( TypeHandle  type_handle,
int  sort,
RenderAttribRegistry::MakeDefaultFunc *  make_default_func 
) [inline, static, inherited]

Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number.

See RenderAttribRegistry.

Definition at line 115 of file renderAttrib.I.

References RenderAttribRegistry::register_slot().

void LightAttrib::register_with_read_factory ( ) [static]

Tells the BamReader how to create objects of type LightAttrib.

Definition at line 931 of file lightAttrib.cxx.

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

bool TypedWritable::require_fully_complete ( ) const [virtual, inherited]

Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).

Reimplemented in GeomVertexData, ClipPlaneAttrib, and RenderEffects.

Definition at line 118 of file typedWritable.cxx.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

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

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool RenderAttrib::unref ( ) const [virtual, inherited]

This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero.

Reimplemented from ReferenceCount.

Definition at line 146 of file renderAttrib.cxx.

References ReferenceCount::unref().

Referenced by RenderAttrib::finalize().

void TypedWritable::update_bam_nested ( BamWriter manager) [virtual, inherited]

Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

Reimplemented in CFDoCullCommand, and PandaNode.

Definition at line 77 of file typedWritable.cxx.

bool RenderAttrib::validate_attribs ( ) [static, inherited]

Ensures that the cache is still stored in sorted order.

Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderAttrib objects).

Definition at line 229 of file renderAttrib.cxx.

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().

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 942 of file lightAttrib.cxx.

References Datagram::add_bool(), Datagram::add_uint16(), ordered_vector< Key, Compare >::begin(), ordered_vector< Key, Compare >::end(), get_num_off_lights(), get_num_on_lights(), NodePath::node(), and BamWriter::write_pointer().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations