This effect automatically applies a computed texture matrix to the specified texture stage, according to the relative position of two specified nodes. More...

#include "texProjectorEffect.h"

Inheritance diagram for TexProjectorEffect:

Public Member Functions
ConstPointerTo< RenderEffect >	add_stage (TextureStage *stage, const NodePath &from, const NodePath &to, int lens_index=0) const
	Returns a new TexProjectorEffect just like this one, with the indicated projection for the given stage.

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

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

NodePath	get_from (TextureStage *stage) const
	Returns the "from" node associated with the TexProjectorEffect on the indicated stage.

int	get_lens_index (TextureStage *stage) const
	Returns the lens_index associated with the TexProjectorEffect on the indicated stage.

NodePath	get_to (TextureStage *stage) const
	Returns the "to" node associated with the TexProjectorEffect on the indicated stage.

virtual TypeHandle	get_type () const

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

bool	has_stage (TextureStage *stage) const
	Returns true if there is a transform associated with the indicated stage, or false otherwise (in which case get_transform(stage) will return the identity transform).

bool	is_empty () const
	Returns true if no stages are defined in the TexProjectorEffect, false if at least one is.

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

ConstPointerTo< RenderEffect >	remove_stage (TextureStage *stage) const
	Returns a new TexProjectorEffect just like this one, with the indicated stage removed.

virtual void	write_datagram (BamWriter *manager, Datagram &dg)
	Writes the contents of this object to the datagram for shipping out to a Bam file.

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

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 TexProjectorEffect that modifies no stages at all.

static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type TexProjectorEffect.

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

This effect automatically applies a computed texture matrix to the specified texture stage, according to the relative position of two specified nodes.

The relative transform from the "from" node to the "to" node is applied directly to the texture matrix each frame. If the "to" node happens to be a LensNode, its lens projection matrix is applied as well.

This can be used to apply a number of special effects. Fundamentally, it may simply be used to provide a separate PandaNode that may be adjusted (e.g. via a LerpInterval) in order to easily apply a linear transformation to an object's texture coordinates (rather than having to explicitly call NodePath.set_tex_transform() each frame).

In a more sophisticated case, the TexProjectorEffect is particularly useful in conjunction with a TexGenAttrib that specifies a mode of M_world_position (which copies the world position of each vertex to the texture coordinates). Then the TexProjector can be used to convert these world coordinates to the relative coordinates of a particular node, causing (for instance) a texture to appear to follow a node around as it moves through the world. With a LensNode, you can project a texture onto the walls, for instance to apply a flashlight effect or an image-based shadow.

Definition at line 49 of file texProjectorEffect.h.

Constructor & Destructor Documentation

◆ ~TexProjectorEffect()

TexProjectorEffect::~TexProjectorEffect ( )

virtual

Definition at line 31 of file texProjectorEffect.cxx.

Member Function Documentation

◆ add_stage()

ConstPointerTo< RenderEffect > TexProjectorEffect::add_stage	(	TextureStage *	stage,
		const NodePath &	from,
		const NodePath &	to,
		int	lens_index = 0 ) const

Returns a new TexProjectorEffect just like this one, with the indicated projection for the given stage.

If this stage already exists, its projection definition is replaced.

The relative transform between the "from" and the "to" nodes is automatically applied to the texture transform each frame.

Furthermore, if the "to" node is a LensNode, its projection matrix is also applied to the texture transform. In this case, the lens_index may be used to select the particular lens that should be used.

Definition at line 61 of file texProjectorEffect.cxx.

◆ complete_pointers()

int TexProjectorEffect::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 310 of file texProjectorEffect.cxx.

References TypedWritable::complete_pointers().

◆ cull_callback()

void TexProjectorEffect::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 179 of file texProjectorEffect.cxx.

References TexMatrixAttrib::add_stage(), RenderState::compose(), LensNode::get_lens(), Lens::get_projection_mat(), NodePath::get_transform(), RenderState::make(), and TexMatrixAttrib::make().

◆ force_init_type()

virtual TypeHandle TexProjectorEffect::force_init_type ( )

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 123 of file texProjectorEffect.h.

◆ get_class_type()

static TypeHandle TexProjectorEffect::get_class_type ( )

inlinestatic

Definition at line 112 of file texProjectorEffect.h.

◆ get_from()

NodePath TexProjectorEffect::get_from ( TextureStage * stage ) const

Returns the "from" node associated with the TexProjectorEffect on the indicated stage.

The relative transform between the "from" and the "to" nodes is automatically applied to the texture transform each frame.

Definition at line 107 of file texProjectorEffect.cxx.

References NodePath::fail(), and NodePath::find().

Referenced by NodePath::get_tex_projector_from().

◆ get_lens_index()

int TexProjectorEffect::get_lens_index ( TextureStage * stage ) const

Returns the lens_index associated with the TexProjectorEffect on the indicated stage.

This is only used if the "to" node is a LensNode, in which case it specifies the particular lens that should be used.

Definition at line 134 of file texProjectorEffect.cxx.

◆ get_to()

NodePath TexProjectorEffect::get_to ( TextureStage * stage ) const

Returns the "to" node associated with the TexProjectorEffect on the indicated stage.

The relative transform between the "from" and the "to" nodes is automatically applied to the texture transform each frame.

Furthermore, if the "to" node is a LensNode, its projection matrix is also applied to the texture transform.

Definition at line 122 of file texProjectorEffect.cxx.

References NodePath::fail(), and NodePath::find().

Referenced by NodePath::get_tex_projector_to().

◆ get_type()

virtual TypeHandle TexProjectorEffect::get_type ( ) const

inlinevirtual

Reimplemented from RenderEffect.

Definition at line 120 of file texProjectorEffect.h.

◆ has_cull_callback()

bool TexProjectorEffect::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 162 of file texProjectorEffect.cxx.

◆ has_stage()

bool TexProjectorEffect::has_stage ( TextureStage * stage ) const

Returns true if there is a transform associated with the indicated stage, or false otherwise (in which case get_transform(stage) will return the identity transform).

Definition at line 96 of file texProjectorEffect.cxx.

Referenced by NodePath::has_tex_projector().

◆ init_type()

static void TexProjectorEffect::init_type ( )

inlinestatic

Definition at line 115 of file texProjectorEffect.h.

◆ is_empty()

bool TexProjectorEffect::is_empty ( ) const

Returns true if no stages are defined in the TexProjectorEffect, false if at least one is.

Definition at line 86 of file texProjectorEffect.cxx.

◆ make()

ConstPointerTo< RenderEffect > TexProjectorEffect::make ( )

static

Constructs a TexProjectorEffect that modifies no stages at all.

Definition at line 38 of file texProjectorEffect.cxx.

Referenced by NodePath::set_tex_projector().

◆ output()

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

virtual

Reimplemented from RenderEffect.

Definition at line 144 of file texProjectorEffect.cxx.

◆ register_with_read_factory()

void TexProjectorEffect::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type TexProjectorEffect.

Definition at line 282 of file texProjectorEffect.cxx.

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

Referenced by init_libpgraph().

◆ remove_stage()

ConstPointerTo< RenderEffect > TexProjectorEffect::remove_stage ( TextureStage * stage ) const

Returns a new TexProjectorEffect just like this one, with the indicated stage removed.

Definition at line 75 of file texProjectorEffect.cxx.

Referenced by NodePath::clear_tex_projector().

◆ write_datagram()

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

Definition at line 291 of file texProjectorEffect.cxx.

References Datagram::add_uint16(), and RenderEffect::write_datagram().

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~TexProjectorEffect()

Member Function Documentation

◆ add_stage()

◆ complete_pointers()

◆ cull_callback()

◆ force_init_type()

◆ get_class_type()

◆ get_from()

◆ get_lens_index()

◆ get_to()

◆ get_type()

◆ has_cull_callback()

◆ has_stage()

◆ init_type()

◆ is_empty()

◆ make()

◆ output()

◆ register_with_read_factory()

◆ remove_stage()

◆ write_datagram()