This is the base class for a number of special render effects that may be set on scene graph nodes to change the way they render. More...

#include "renderEffect.h"

Inheritance diagram for RenderEffect:

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

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

virtual TypeHandle	get_type () const

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.

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

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

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

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

This is the base class for a number of special render effects that may be set on scene graph nodes to change the way they render.

This includes BillboardEffect, DecalEffect, etc.

RenderEffect represents render properties that must be applied as soon as they are encountered in the scene graph, rather than propagating down to the leaves. This is different from RenderAttrib, which represents properties like color and texture that don't do anything until they propagate down to a GeomNode.

You should not attempt to create or modify a RenderEffect directly; instead, use the make() method of the appropriate kind of effect you want. This will allocate and return a new RenderEffect of the appropriate type, and it may share pointers if possible. Do not modify the new RenderEffect if you wish to change its properties; instead, create a new one.

Definition at line 48 of file renderEffect.h.

Constructor & Destructor Documentation

◆ ~RenderEffect()

RenderEffect::~RenderEffect ( )

virtual

The destructor is responsible for removing the RenderEffect from the global set if it is there.

Definition at line 42 of file renderEffect.cxx.

Member Function Documentation

◆ adjust_transform()

void RenderEffect::adjust_transform	(	ConstPointerTo< TransformState > &	net_transform,
		ConstPointerTo< TransformState > &	node_transform,
		const PandaNode *	node ) const

virtual

Performs some operation on the node's apparent net and/or local transforms.

This will only be called if has_adjust_transform() is redefined to return true.

Both parameters are in/out. The original transforms will be passed in, and they may (or may not) be modified in-place by the RenderEffect.

Reimplemented in BillboardEffect, and CompassEffect.

Definition at line 145 of file renderEffect.cxx.

◆ change_this()

TypedWritable * RenderEffect::change_this	(	TypedWritable *	old_ptr,
		BamReader *	manager )

static

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 295 of file renderEffect.cxx.

References BamReader::register_finalize().

◆ compare_to()

int RenderEffect::compare_to ( const RenderEffect & other ) const

inline

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.

This method is not needed outside of the RenderEffect class because all equivalent RenderEffect objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

Definition at line 22 of file renderEffect.I.

References TypeHandle::get_index.

◆ cull_callback()

void RenderEffect::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 in BillboardEffect, CompassEffect, PolylightEffect, ScissorEffect, and TexProjectorEffect.

Definition at line 122 of file renderEffect.cxx.

◆ finalize()

void RenderEffect::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 TypedWritable.

Definition at line 320 of file renderEffect.cxx.

References ReferenceCount::get_ref_count, and ReferenceCount::unref().

◆ force_init_type()

virtual TypeHandle RenderEffect::force_init_type ( )

inlinevirtual

Reimplemented from TypedWritableReferenceCount.

Definition at line 115 of file renderEffect.h.

◆ get_class_type()

static TypeHandle RenderEffect::get_class_type ( )

inlinestatic

Definition at line 104 of file renderEffect.h.

◆ get_num_effects()

int RenderEffect::get_num_effects ( )

static

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

This will go up and down during normal operations.

Definition at line 170 of file renderEffect.cxx.

◆ get_type()

virtual TypeHandle RenderEffect::get_type ( ) const

inlinevirtual

Reimplemented from TypedWritableReferenceCount.

Definition at line 112 of file renderEffect.h.

◆ has_adjust_transform()

bool RenderEffect::has_adjust_transform ( ) const

virtual

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.

Reimplemented in BillboardEffect, CharacterJointEffect, and CompassEffect.

Definition at line 132 of file renderEffect.cxx.

◆ has_cull_callback()

bool RenderEffect::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 in BillboardEffect, CharacterJointEffect, CompassEffect, PolylightEffect, ScissorEffect, and TexProjectorEffect.

Definition at line 105 of file renderEffect.cxx.

◆ init_type()

static void RenderEffect::init_type ( )

inlinestatic

Definition at line 107 of file renderEffect.h.

◆ list_effects()

void RenderEffect::list_effects ( std::ostream & out )

static

Lists all of the RenderEffects 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 183 of file renderEffect.cxx.

◆ output()

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

virtual

Definition at line 153 of file renderEffect.cxx.

◆ prepare_flatten_transform()

ConstPointerTo< TransformState > RenderEffect::prepare_flatten_transform ( const TransformState * net_transform ) const

virtual

Preprocesses the accumulated transform that is about to be applied to (or through) this node due to a flatten operation.

The returned value will be used instead.

Reimplemented in BillboardEffect.

Definition at line 77 of file renderEffect.cxx.

◆ safe_to_combine()

bool RenderEffect::safe_to_combine ( ) const

virtual

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.

Reimplemented in CharacterJointEffect.

Definition at line 87 of file renderEffect.cxx.

◆ safe_to_transform()

bool RenderEffect::safe_to_transform ( ) const

virtual

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

Reimplemented in BillboardEffect, CharacterJointEffect, and CompassEffect.

Definition at line 67 of file renderEffect.cxx.

◆ validate_effects()

bool RenderEffect::validate_effects ( )

static

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 RenderEffect objects).

Definition at line 198 of file renderEffect.cxx.

◆ write()

void RenderEffect::write	(	std::ostream &	out,
		int	indent_level ) const

virtual

Definition at line 161 of file renderEffect.cxx.

◆ write_datagram()

void RenderEffect::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 TypedWritable.

Reimplemented in BillboardEffect, CharacterJointEffect, CompassEffect, DecalEffect, OccluderEffect, ScissorEffect, ShowBoundsEffect, and TexProjectorEffect.

Definition at line 282 of file renderEffect.cxx.

References TypedWritable::write_datagram().

Referenced by BillboardEffect::write_datagram(), CharacterJointEffect::write_datagram(), CompassEffect::write_datagram(), DecalEffect::write_datagram(), OccluderEffect::write_datagram(), ScissorEffect::write_datagram(), ShowBoundsEffect::write_datagram(), and TexProjectorEffect::write_datagram().

◆ xform()

ConstPointerTo< RenderEffect > RenderEffect::xform ( const LMatrix4 & mat ) const

virtual

Returns a new RenderEffect transformed by the indicated matrix.

Reimplemented in ScissorEffect.

Definition at line 95 of file renderEffect.cxx.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~RenderEffect()

Member Function Documentation

◆ adjust_transform()

◆ change_this()

◆ compare_to()

◆ cull_callback()

◆ finalize()

◆ force_init_type()

◆ get_class_type()

◆ get_num_effects()

◆ get_type()

◆ has_adjust_transform()

◆ has_cull_callback()

◆ init_type()

◆ list_effects()

◆ output()

◆ prepare_flatten_transform()

◆ safe_to_combine()

◆ safe_to_transform()

◆ validate_effects()

◆ write()

◆ write_datagram()

◆ xform()