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:

Classes
class	BamAuxData

Public Types
typedef pvector< PT(PandaNode) >	NodeList

enum	Operation { O_set, O_add, O_remove }

Public Types inherited from RenderAttrib
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. More...

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

	CPT (RenderAttrib) add_light(Light *light) const

	CPT (RenderAttrib) remove_light(Light *light) const

	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

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

virtual TypeHandle	force_init_type ()

LColor	get_ambient_contribution () const

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

NodePath	get_most_important_light () const

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

size_t	get_num_non_ambient_lights () const
	Returns the number of non-ambient lights that are turned on by this attribute. More...

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

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

bool	has_any_on_light () const
	Returns true if any light is turned on by the attrib, false otherwise. More...

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

bool	has_off_light (const NodePath &light) const
	Returns true if the indicated light is turned off by the attrib, false otherwise. More...

bool	has_on_light (const NodePath &light) const
	Returns true if the indicated light is turned on by the attrib, false otherwise. More...

bool	is_identity () const
	Returns true if this is an identity attrib: it does not change the set of lights in use. More...

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

Public Member Functions inherited from RenderAttrib
	RenderAttrib (const RenderAttrib &copy)=delete

virtual	~RenderAttrib ()
	The destructor is responsible for removing the RenderAttrib from the global set if it is there. More...

int	compare_to (const RenderAttrib &other) const

	CPT (RenderAttrib) compose(const RenderAttrib *other) const

	CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const

	CPT (RenderAttrib) get_unique() 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. More...

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

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

RenderAttrib &	operator= (const RenderAttrib &copy)=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. More...

Public Member Functions inherited from TypedWritableReferenceCount
	TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)

virtual ReferenceCount *	as_reference_count ()
	Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...

void	operator= (const TypedWritableReferenceCount &copy)

Public Member Functions inherited from TypedWritable
	TypedWritable (const TypedWritable &copy)

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

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

UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter. More...

void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...

void	operator= (const TypedWritable &copy)

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

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

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

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

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

int	get_best_parent_from_Set (const std::set< int > &) const

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

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

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

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

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

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

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

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Static Public Member Functions
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_default()

static	CPT (RenderAttrib) make()

static	CPT (RenderAttrib) make_all_off()

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

Static Public Member Functions inherited from RenderAttrib
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. More...

static int	garbage_collect ()
	Performs a garbage-collection cycle. More...

static TypeHandle	get_class_type ()

static int	get_num_attribs ()
	Returns the total number of unique RenderAttrib objects allocated in the world. More...

static void	init_attribs ()
	Make sure the global _attribs map is allocated. More...

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

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

static bool	validate_attribs ()
	Ensures that the cache is still stored in sorted order. More...

Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

static	PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data

Static Public Member Functions inherited from TypedWritable
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. More...

static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

static void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96. More...

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Public Attributes
	get_class_slot

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

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

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

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

static Light *	light

static Light *	light1

static Light Light *	light2

static Light Light Light *	light3

static Light Light Light Light *	light4

Public Attributes inherited from RenderAttrib
	get_slot

Public Attributes inherited from TypedWritableReferenceCount
static BamReader *	reader = nullptr)

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

Additional Inherited Members
Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

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

Constructor & Destructor Documentation

◆ ~LightAttrib()

LightAttrib::~LightAttrib ( )

virtual

Destructor.

Definition at line 74 of file lightAttrib.cxx.

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

Member Function Documentation

◆ complete_pointers()

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

◆ finalize()

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

References BamReader::get_file_minor_ver().

◆ get_light()

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

◆ get_num_lights()

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

◆ get_num_non_ambient_lights()

size_t LightAttrib::get_num_non_ambient_lights ( ) const

inline

Returns the number of non-ambient lights that are turned on by this attribute.

Definition at line 35 of file lightAttrib.I.

Referenced by PT().

◆ get_operation()

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.

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

◆ has_all_off()

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 99 of file lightAttrib.I.

◆ has_any_on_light()

bool LightAttrib::has_any_on_light ( ) const

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

◆ has_light()

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

◆ has_off_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 89 of file lightAttrib.I.

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

◆ has_on_light()

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 54 of file lightAttrib.I.

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

Referenced by has_off_light().

◆ is_identity()

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 108 of file lightAttrib.I.

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

◆ register_with_read_factory()

void LightAttrib::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type LightAttrib.

Definition at line 907 of file lightAttrib.cxx.

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

Referenced by init_libpgraph().

◆ write_datagram()

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

References Datagram::add_bool(), Datagram::add_uint16(), BamWriter::get_file_minor_ver(), RenderAttrib::write_datagram(), and BamWriter::write_pointer().

Member Data Documentation

◆ get_num_off_lights

size_t LightAttrib::get_num_off_lights

inline

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

Definition at line 80 of file lightAttrib.h.

◆ get_num_on_lights

size_t LightAttrib::get_num_on_lights

inline

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

Definition at line 74 of file lightAttrib.h.

◆ get_off_light

NodePath LightAttrib::get_off_light

inline

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

Definition at line 80 of file lightAttrib.h.

◆ get_on_light

NodePath LightAttrib::get_on_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 PT().

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

panda/src/pgraph/lightAttrib.h
panda/src/pgraph/lightAttrib.cxx
panda/src/pgraph/lightAttrib.I

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~LightAttrib()

Member Function Documentation

◆ complete_pointers()

◆ finalize()

◆ get_light()

◆ get_num_lights()

◆ get_num_non_ambient_lights()

◆ get_operation()

◆ has_all_off()

◆ has_any_on_light()

◆ has_light()

◆ has_off_light()

◆ has_on_light()

◆ is_identity()

◆ register_with_read_factory()

◆ write_datagram()

Member Data Documentation

◆ get_num_off_lights

◆ get_num_on_lights

◆ get_off_light

◆ get_on_light