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:

List of all members.

Public Member Functions
virtual	~RenderEffect ()
	The destructor is responsible for removing the RenderEffect from the global set if it is there.
virtual void	adjust_transform (CPT(TransformState)&net_transform, CPT(TransformState)&node_transform, 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	CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) const
virtual	CPT (RenderEffect) xform(const LMatrix4 &mat) const
virtual void	cull_callback (CullTraverser *trav, CullTraverserData &data, CPT(TransformState)&node_transform, CPT(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.
virtual void	output (ostream &out) const
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 (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 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 (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.
Protected Member Functions
virtual int	compare_to_impl (const RenderEffect *other) const
	Intended to be overridden by derived RenderEffect types to return a unique number indicating whether this RenderEffect is equivalent to the other one.
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 RenderEffect.
Static Protected Member Functions
static	CPT (RenderEffect) return_new(RenderEffect *effect)
static TypedWritable *	new_from_bam (RenderEffect effect, BamReader manager)

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 56 of file renderEffect.h.

Constructor & Destructor Documentation

RenderEffect::~RenderEffect ( ) [virtual]

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

Definition at line 68 of file renderEffect.cxx.

Member Function Documentation

void RenderEffect::adjust_transform	(	CPT(TransformState)&	net_transform,
		CPT(TransformState)&	node_transform,
		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 CompassEffect, BillboardEffect, and CharacterJointEffect.

Definition at line 198 of file renderEffect.cxx.

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

References BamReader::register_finalize().

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 29 of file renderEffect.I.

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

int RenderEffect::compare_to_impl ( const RenderEffect * other ) const [protected, virtual]

Intended to be overridden by derived RenderEffect types to return a unique number indicating whether this RenderEffect is equivalent to the other one.

This should return 0 if the two RenderEffect 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 RenderEffect objects whose get_type() functions return the same.

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

Definition at line 347 of file renderEffect.cxx.

Referenced by compare_to().

void RenderEffect::cull_callback	(	CullTraverser *	trav,
		CullTraverserData &	data,
		CPT(TransformState)&	node_transform,
		CPT(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 TexProjectorEffect, CompassEffect, PolylightEffect, ScissorEffect, BillboardEffect, and CharacterJointEffect.

Definition at line 169 of file renderEffect.cxx.

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

Reimplemented from TypedWritable.

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

Definition at line 422 of file renderEffect.cxx.

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

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

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

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 CompassEffect, BillboardEffect, and CharacterJointEffect.

Definition at line 182 of file renderEffect.cxx.

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

Definition at line 147 of file renderEffect.cxx.

void RenderEffect::list_effects ( 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 245 of file renderEffect.cxx.

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, ShowBoundsEffect, and DecalEffect.

Definition at line 122 of file renderEffect.cxx.

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 CompassEffect, BillboardEffect, and CharacterJointEffect.

Definition at line 97 of file renderEffect.cxx.

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

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 TexProjectorEffect, CompassEffect, BillboardEffect, ScissorEffect, OccluderEffect, CharacterJointEffect, ShowBoundsEffect, and DecalEffect.

Definition at line 358 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

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation