A PolylightEffect can be used on a node to define a LightGroup for that node. More...

#include "polylightEffect.h"

Inheritance diagram for PolylightEffect:

Public Types
enum	ContribType { CT_proximal , CT_all }

typedef pvector< NodePath >	LightGroup

Public Member Functions
ConstPointerTo< RenderEffect >	add_light (const NodePath &newlight) const
	Add a PolylightNode object to this effect and return a new effect.

virtual void	cull_callback (CullTraverser *trav, CullTraverserData &data, ConstPointerTo< TransformState > &node_transform, ConstPointerTo< RenderState > &node_state) 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.

ConstPointerTo< RenderAttrib >	do_poly_light (const SceneSetup scene, const CullTraverserData data, const TransformState *node_transform) const
	Gets the node's position and based on distance from lights in the lightgroup calculates the color to be modulated in.

virtual TypeHandle	force_init_type ()

ContribType	get_contrib () const
	Returns CT_all or CT_proximal.

LPoint3	get_effect_center () const
	Return the value of the _effect_center.

virtual TypeHandle	get_type () const

PN_stdfloat	get_weight () const
	Get the weight value.

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

bool	has_light (const NodePath &light) const
	Returns true if the indicated light is listed in the PolylightEffect, false otherwise.

virtual void	output (std::ostream &out) const

ConstPointerTo< RenderEffect >	remove_light (const NodePath &newlight) const
	Remove a light from this effect.

ConstPointerTo< RenderEffect >	set_contrib (ContribType c) const
	Set Contrib Type and return a new effect... the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make.

ConstPointerTo< RenderEffect >	set_effect_center (const LPoint3 &ec) const
	Set weight and return a new effect... the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make.

ConstPointerTo< RenderEffect >	set_weight (PN_stdfloat w) const
	Set weight and return a new effect... the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make.

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

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

virtual void	adjust_transform (ConstPointerTo< TransformState > &net_transform, ConstPointerTo< TransformState > &node_transform, const PandaNode *node) const
	Performs some operation on the node's apparent net and/or local transforms.

int	compare_to (const RenderEffect &other) const
	Provides an arbitrary ordering among all unique RenderEffects, so we can store the essentially different ones in a big set and throw away the rest.

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 bool	has_adjust_transform () const
	Should be overridden by derived classes to return true if adjust_transform() has been defined, and therefore the RenderEffect has some effect on the node's apparent local and net transforms.

RenderEffect &	operator= (const RenderEffect &copy)=delete

virtual ConstPointerTo< TransformState >	prepare_flatten_transform (const TransformState *net_transform) const
	Preprocesses the accumulated transform that is about to be applied to (or through) this node due to a flatten operation.

virtual bool	safe_to_combine () const
	Returns true if this kind of effect can safely be combined with sibling nodes that share the exact same effect, or false if this is not a good idea.

virtual bool	safe_to_transform () const
	Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise.

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.

virtual ConstPointerTo< RenderEffect >	xform (const LMatrix4 &mat) const
	Returns a new RenderEffect transformed by the indicated matrix.

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.

void	operator= (const TypedWritableReferenceCount &copy)

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

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

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

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.

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.

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 &copy)=default

Public Member Functions inherited from MemoryBase
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)

Public Member Functions inherited from ReferenceCount
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.

virtual bool	unref () const
	Explicitly decrements the reference count.

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 TypeHandle	get_class_type ()

static void	init_type ()

static ConstPointerTo< RenderEffect >	make ()
	Constructs a new PolylightEffect object.

static ConstPointerTo< RenderEffect >	make (PN_stdfloat weight, ContribType contrib, const LPoint3 &effect_center)
	Constructs a new PolylightEffect object.

static ConstPointerTo< RenderEffect >	make (PN_stdfloat weight, ContribType contrib, const LPoint3 &effect_center, const LightGroup &lights)
	Constructs a new PolylightEffect object.

Static Public Member Functions inherited from RenderEffect
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 TypeHandle	get_class_type ()

static int	get_num_effects ()
	Returns the total number of unique RenderEffect objects allocated in the world.

static void	init_type ()

static void	list_effects (std::ostream &out)
	Lists all of the RenderEffects in the cache to the output stream, one per line.

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

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.

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.

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

static void	init_type ()

Additional Inherited Members
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.

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

Detailed Description

A PolylightEffect can be used on a node to define a LightGroup for that node.

A LightGroup contains PolylightNodes which are essentially nodes that add color to the polygons of a model based on distance. PolylightNode is a cheap way to get lighting effects specially for night scenes

Definition at line 35 of file polylightEffect.h.

Member Typedef Documentation

◆ LightGroup

typedef pvector< NodePath > PolylightEffect::LightGroup

Definition at line 42 of file polylightEffect.h.

Member Enumeration Documentation

◆ ContribType

enum PolylightEffect::ContribType

Definition at line 37 of file polylightEffect.h.

Member Function Documentation

◆ add_light()

ConstPointerTo< RenderEffect > PolylightEffect::add_light ( const NodePath & newlight ) const

Add a PolylightNode object to this effect and return a new effect.

Definition at line 389 of file polylightEffect.cxx.

Referenced by NodePath::set_light().

◆ cull_callback()

void PolylightEffect::cull_callback	(	CullTraverser *	trav,
		CullTraverserData &	data,
		ConstPointerTo< TransformState > &	node_transform,
		ConstPointerTo< RenderState > &	node_state ) const

virtual

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 may include additional manipulation of render state or additional visible/invisible decisions, or any other arbitrary operation.

At the time this function is called, the current node's transform and state have not yet been applied to the net_transform and net_state. This callback may modify the node_transform and node_state to apply an effective change to the render state at this level.

Reimplemented from RenderEffect.

Definition at line 89 of file polylightEffect.cxx.

References RenderState::compose(), do_poly_light(), CullTraverser::get_scene(), and RenderState::make().

◆ do_poly_light()

ConstPointerTo< RenderAttrib > PolylightEffect::do_poly_light	(	const SceneSetup *	scene,
		const CullTraverserData *	data,
		const TransformState *	node_transform ) const

Gets the node's position and based on distance from lights in the lightgroup calculates the color to be modulated in.

If the avatar is in the range of multiple lights, then determine, which light it is closer to, and get the weight of the scene_color in respect to that light's proximity.

Definition at line 107 of file polylightEffect.cxx.

References PolylightNode::flicker(), PolylightNode::get_attenuation(), PolylightNode::get_color(), NodePath::get_color_scale(), SceneSetup::get_cull_center(), PolylightNode::get_pos(), PolylightNode::get_radius(), NodePath::get_relative_point(), SceneSetup::get_scene_root(), PolylightNode::is_enabled(), PolylightNode::is_flickering(), and ColorScaleAttrib::make().

Referenced by cull_callback().

◆ force_init_type()

virtual TypeHandle PolylightEffect::force_init_type ( )

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 96 of file polylightEffect.h.

◆ get_class_type()

static TypeHandle PolylightEffect::get_class_type ( )

inlinestatic

Definition at line 85 of file polylightEffect.h.

◆ get_contrib()

PolylightEffect::ContribType PolylightEffect::get_contrib ( ) const

inline

Returns CT_all or CT_proximal.

Definition at line 45 of file polylightEffect.I.

◆ get_effect_center()

LPoint3 PolylightEffect::get_effect_center ( ) const

inline

Return the value of the _effect_center.

Definition at line 53 of file polylightEffect.I.

◆ get_type()

virtual TypeHandle PolylightEffect::get_type ( ) const

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 93 of file polylightEffect.h.

◆ get_weight()

PN_stdfloat PolylightEffect::get_weight ( ) const

inline

Get the weight value.

Definition at line 37 of file polylightEffect.I.

◆ has_cull_callback()

bool PolylightEffect::has_cull_callback ( ) const

virtual

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 effect during the cull traversal.

Reimplemented from RenderEffect.

Definition at line 72 of file polylightEffect.cxx.

◆ has_light()

bool PolylightEffect::has_light ( const NodePath & light ) const

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

Definition at line 459 of file polylightEffect.cxx.

Referenced by NodePath::has_light().

◆ init_type()

static void PolylightEffect::init_type ( )

inlinestatic

Definition at line 88 of file polylightEffect.h.

◆ make() [1/3]

ConstPointerTo< RenderEffect > PolylightEffect::make ( )

static

Constructs a new PolylightEffect object.

Definition at line 32 of file polylightEffect.cxx.

Referenced by NodePath::set_light().

◆ make() [2/3]

ConstPointerTo< RenderEffect > PolylightEffect::make	(	PN_stdfloat	weight,
		ContribType	contrib,
		const LPoint3 &	effect_center )

static

Constructs a new PolylightEffect object.

Definition at line 44 of file polylightEffect.cxx.

◆ make() [3/3]

ConstPointerTo< RenderEffect > PolylightEffect::make	(	PN_stdfloat	weight,
		ContribType	contrib,
		const LPoint3 &	effect_center,
		const LightGroup &	lights )

static

Constructs a new PolylightEffect object.

Definition at line 56 of file polylightEffect.cxx.

◆ output()

void PolylightEffect::output ( std::ostream & out ) const

virtual

Reimplemented from RenderEffect.

Definition at line 338 of file polylightEffect.cxx.

◆ remove_light()

ConstPointerTo< RenderEffect > PolylightEffect::remove_light ( const NodePath & newlight ) const

Remove a light from this effect.

Return the new updated effect

Definition at line 400 of file polylightEffect.cxx.

Referenced by NodePath::clear_light().

◆ set_contrib()

ConstPointerTo< RenderEffect > PolylightEffect::set_contrib ( ContribType c ) const

Set Contrib Type and return a new effect... the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make.

Definition at line 435 of file polylightEffect.cxx.

◆ set_effect_center()

ConstPointerTo< RenderEffect > PolylightEffect::set_effect_center ( const LPoint3 & ec ) const

Set weight and return a new effect... the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make.

Definition at line 448 of file polylightEffect.cxx.

◆ set_weight()

ConstPointerTo< RenderEffect > PolylightEffect::set_weight ( PN_stdfloat w ) const

Set weight and return a new effect... the reason this couldnt be done through make was because that would return a new effect without the lightgroup which is static and cant be accessed Here, we just pass that to the make.

Definition at line 422 of file polylightEffect.cxx.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LightGroup

Member Enumeration Documentation

◆ ContribType

Member Function Documentation

◆ add_light()

◆ cull_callback()

◆ do_poly_light()

◆ force_init_type()

◆ get_class_type()

◆ get_contrib()

◆ get_effect_center()

◆ get_type()

◆ get_weight()

◆ has_cull_callback()

◆ has_light()

◆ init_type()

◆ make() [1/3]

◆ make() [2/3]

◆ make() [3/3]

◆ output()

◆ remove_light()

◆ set_contrib()

◆ set_effect_center()

◆ set_weight()