Panda3D
|
Indicates which set of lights should be considered "on" to illuminate geometry at this level and below. More...
#include "lightAttrib.h"
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_unused2 , M_constant } |
Public Member Functions | |
virtual | ~LightAttrib () |
Destructor. | |
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_light(Light *light) const | |
CPT (RenderAttrib) add_off_light(const NodePath &light) const | |
CPT (RenderAttrib) add_on_light(const NodePath &light) const | |
CPT (RenderAttrib) remove_light(Light *light) const | |
CPT (RenderAttrib) remove_off_light(const NodePath &light) const | |
CPT (RenderAttrib) remove_on_light(const NodePath &light) const | |
CPT (RenderAttrib) replace_off_light(const NodePath &source | |
CPT (RenderAttrib) replace_on_light(const NodePath &source | |
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 () |
LColor | get_ambient_contribution () const |
Light * | get_light (int n) const |
Returns the nth light listed in the attribute. | |
NodePath | get_most_important_light () const |
int | get_num_lights () const |
Returns the number of lights listed in the attribute. | |
size_t | get_num_non_ambient_lights () const |
Returns the number of non-ambient lights that are turned on by this attribute. | |
size_t | get_num_off_lights () const |
size_t | get_num_on_lights () const |
NodePath | get_off_light (size_t n) const |
NodePath | get_on_light (size_t n) const |
Operation | get_operation () const |
Returns the basic operation type of the LightAttrib. | |
virtual int | get_slot () const |
virtual TypeHandle | get_type () const |
bool | has_all_off () const |
Returns true if this attrib turns off all lights (although it may also turn some on). | |
bool | has_any_on_light () const |
Returns true if any light is turned on by the attrib, false otherwise. | |
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 | is_identity () const |
Returns true if this is an identity attrib: it does not change the set of lights in use. | |
virtual void | output (std::ostream &out) const |
virtual void | write (std::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. | |
![]() | |
RenderAttrib (const RenderAttrib ©)=delete | |
virtual | ~RenderAttrib () |
The destructor is responsible for removing the RenderAttrib from the global set if it is there. | |
int | compare_to (const RenderAttrib &other) const |
CPT (RenderAttrib) compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) get_unique() const | |
CPT (RenderAttrib) invert_compose(const RenderAttrib *other) 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. | |
size_t | get_hash () const |
virtual bool | has_cull_callback () const |
Should be overridden by derived classes to return true if cull_callback() has been defined. | |
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. | |
RenderAttrib & | operator= (const RenderAttrib ©)=delete |
virtual bool | unref () const final |
This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero. | |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
vector_uchar | encode_to_bam_stream () const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. | |
bool | encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
UpdateSeq | get_bam_modified () const |
Returns the current bam_modified counter. | |
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= (const TypedWritable ©) |
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. | |
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. | |
![]() | |
TypedObject (const TypedObject ©)=default | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. | |
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. | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. | |
TypedObject & | operator= (const TypedObject ©)=default |
![]() | |
void | operator delete (void *, void *) |
void | operator delete (void *ptr) |
void | operator delete[] (void *, void *) |
void | operator delete[] (void *ptr) |
void * | operator new (size_t size) |
void * | operator new (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
![]() | |
int | get_ref_count () const |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
void | ref () const |
Explicitly increments the reference count. | |
bool | ref_if_nonzero () const |
Atomically increases the reference count of this object if it is not zero. | |
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. | |
bool | unref_if_one () const |
Atomically decreases the reference count of this object if it is one. | |
WeakReferenceList * | weak_ref () |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref () |
Removes the indicated PointerToVoid as a weak reference to this object. | |
Static Public Member Functions | |
static | CPT (RenderAttrib) make() |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make(Operation op |
static | CPT (RenderAttrib) make_all_off() |
static | CPT (RenderAttrib) make_default() |
static int | get_class_slot () |
static TypeHandle | get_class_type () |
static void | init_type () |
static void | register_with_read_factory () |
Tells the BamReader how to create objects of type LightAttrib. | |
![]() | |
static 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 int | garbage_collect () |
Performs a garbage-collection cycle. | |
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 (std::ostream &out) |
Lists all of the RenderAttribs in the cache to the output stream, one per line. | |
static int | register_slot (TypeHandle type_handle, int sort, RenderAttrib *default_attrib) |
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number. | |
static bool | validate_attribs () |
Ensures that the cache is still stored in sorted order. | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data |
![]() | |
static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr) |
Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
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. | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes | |
const NodePath &dest | const |
get_class_slot | |
get_num_off_lights | |
Returns the number of lights that are turned off by the attribute. | |
get_num_on_lights | |
Returns the number of lights that are turned on by the attribute. | |
get_off_light | |
Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order. | |
get_on_light | |
Returns the nth light turned on by the attribute, sorted in render order. | |
static Light * | light |
static Light * | light1 |
static Light Light * | light2 |
static Light Light Light * | light3 |
static Light Light Light Light * | light4 |
![]() | |
get_slot | |
![]() | |
static BamReader * | reader = nullptr) |
![]() | |
get_type | |
![]() | |
get_ref_count | |
Returns the current reference count. | |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = nullptr |
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 30 of file lightAttrib.h.
typedef pvector<PT(PandaNode) > LightAttrib::NodeList |
Definition at line 140 of file lightAttrib.h.
enum LightAttrib::Operation |
Definition at line 40 of file lightAttrib.h.
|
virtual |
Destructor.
Definition at line 73 of file lightAttrib.cxx.
References PandaNode::as_light(), Light::attrib_unref(), NodePath::is_empty(), and NodePath::node().
|
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 1011 of file lightAttrib.cxx.
References TypedWritable::complete_pointers(), BamReader::get_aux_data(), BamReader::get_file_minor_ver(), and ordered_vector< Key, Compare, Vector >::size().
|
virtual |
Reimplemented from RenderAttrib.
|
virtual |
Reimplemented from RenderAttrib.
|
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 1052 of file lightAttrib.cxx.
References PandaNode::as_light(), Light::attrib_ref(), ordered_vector< Key, Compare, Vector >::back(), AttribNodeRegistry::find_node(), BamReader::get_aux_data(), BamReader::get_file_minor_ver(), AttribNodeRegistry::get_node, ordered_vector< Key, Compare, Vector >::push_back(), ordered_vector< Key, Compare, Vector >::reserve(), ordered_vector< Key, Compare, Vector >::size(), and ov_set< Key, Compare, Vector >::sort().
|
inlinevirtual |
Reimplemented from RenderAttrib.
Definition at line 175 of file lightAttrib.h.
|
inlinestatic |
Definition at line 130 of file lightAttrib.h.
|
inlinestatic |
Definition at line 163 of file lightAttrib.h.
Light * LightAttrib::get_light | ( | int | n | ) | const |
Returns the nth light listed in the attribute.
Definition at line 306 of file lightAttrib.cxx.
References get_num_off_lights, get_off_light, and get_on_light.
int LightAttrib::get_num_lights | ( | ) | const |
Returns the number of lights listed in the attribute.
Definition at line 287 of file lightAttrib.cxx.
References get_num_off_lights, and get_num_on_lights.
|
inline |
Returns the number of non-ambient lights that are turned on by this attribute.
Definition at line 34 of file lightAttrib.I.
Referenced by GraphicsStateGuardian::do_issue_light(), GraphicsStateGuardian::fetch_specified_part(), and PT().
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 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 264 of file lightAttrib.cxx.
References get_num_off_lights, and has_all_off().
|
inlinevirtual |
Implements RenderAttrib.
Definition at line 133 of file lightAttrib.h.
|
inlinevirtual |
Reimplemented from RenderAttrib.
Definition at line 172 of file lightAttrib.h.
|
inline |
Returns true if this attrib turns off all lights (although it may also turn some on).
Definition at line 99 of file lightAttrib.I.
Referenced by get_operation(), and NodePath::has_light_off().
|
inline |
Returns true if any light is turned on by the attrib, false otherwise.
Definition at line 62 of file lightAttrib.I.
References ordered_vector< Key, Compare, Vector >::empty().
Referenced by StandardMunger::StandardMunger(), GraphicsStateGuardian::do_issue_light(), and GraphicsStateGuardian::fetch_specified_part().
bool LightAttrib::has_light | ( | Light * | light | ) | const |
Returns true if the indicated light is listed in the attrib, false otherwise.
Definition at line 326 of file lightAttrib.cxx.
References get_num_off_lights, has_off_light(), and has_on_light().
|
inline |
Returns true if the indicated light is turned off by the attrib, false otherwise.
Definition at line 89 of file lightAttrib.I.
References ordered_vector< Key, Compare, Vector >::end(), and has_on_light().
Referenced by has_light(), and NodePath::has_light_off().
|
inline |
Returns true if the indicated light is turned on by the attrib, false otherwise.
Definition at line 54 of file lightAttrib.I.
References ordered_vector< Key, Compare, Vector >::end().
Referenced by NodePath::has_light(), has_light(), and has_off_light().
|
inlinestatic |
Definition at line 166 of file lightAttrib.h.
|
inline |
Returns true if this is an identity attrib: it does not change the set of lights in use.
Definition at line 108 of file lightAttrib.I.
References ordered_vector< Key, Compare, Vector >::empty().
|
virtual |
Reimplemented from RenderAttrib.
|
static |
Tells the BamReader how to create objects of type LightAttrib.
Definition at line 962 of file lightAttrib.cxx.
References BamReader::get_factory(), and Factory< Type >::register_factory().
Referenced by init_libpgraph().
|
virtual |
Reimplemented from RenderAttrib.
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from RenderAttrib.
Definition at line 971 of file lightAttrib.cxx.
References Datagram::add_bool(), Datagram::add_uint16(), ordered_vector< Key, Compare, Vector >::begin(), ordered_vector< Key, Compare, Vector >::end(), BamWriter::get_file_minor_ver(), get_num_off_lights, get_num_on_lights, RenderAttrib::write_datagram(), and BamWriter::write_pointer().
const NodePath &dest LightAttrib::const |
Definition at line 88 of file lightAttrib.h.
LightAttrib::get_class_slot |
Definition at line 136 of file lightAttrib.h.
|
inline |
Returns the number of lights that are turned off by the attribute.
Definition at line 80 of file lightAttrib.h.
Referenced by NodePath::copy_to(), get_light(), get_num_lights(), get_operation(), has_light(), and write_datagram().
|
inline |
Returns the number of lights that are turned on by the attribute.
Definition at line 74 of file lightAttrib.h.
Referenced by NodePath::copy_to(), SpeedTreeNode::cull_callback(), get_num_lights(), and write_datagram().
|
inline |
Returns the nth light turned off by the attribute, sorted in arbitrary (pointer) order.
Definition at line 80 of file lightAttrib.h.
Referenced by NodePath::copy_to(), and get_light().
|
inline |
Returns the nth light turned on by the attribute, sorted in render order.
Definition at line 74 of file lightAttrib.h.
Referenced by NodePath::copy_to(), SpeedTreeNode::cull_callback(), GraphicsStateGuardian::do_issue_light(), GraphicsStateGuardian::fetch_specified_part(), get_light(), and PT().
Light* LightAttrib::light |
Definition at line 46 of file lightAttrib.h.
static Light * LightAttrib::light1 |
Definition at line 48 of file lightAttrib.h.
Definition at line 48 of file lightAttrib.h.
Definition at line 51 of file lightAttrib.h.