Panda3D
 All Classes Functions Variables Enumerations
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
TexProjectorEffect Class Reference

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:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Member Functions

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 (RenderEffect) add_stage(TextureStage *stage
 
 CPT (RenderEffect) remove_stage(TextureStage *stage) 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. More...
 
virtual TypeHandle force_init_type ()
 
NodePath get_from (TextureStage *stage) const
 Returns the "from" node associated with the TexProjectorEffect on the indicated stage. More...
 
int get_lens_index (TextureStage *stage) const
 Returns the lens_index associated with the TexProjectorEffect on the indicated stage. More...
 
NodePath get_to (TextureStage *stage) const
 Returns the "to" node associated with the TexProjectorEffect on the indicated stage. More...
 
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. More...
 
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). More...
 
bool is_empty () const
 Returns true if no stages are defined in the TexProjectorEffect, false if at least one is. More...
 
virtual void output (ostream &out) 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 RenderEffect
virtual ~RenderEffect ()
 The destructor is responsible for removing the RenderEffect from the global set if it is there. More...
 
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. More...
 
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. More...
 
virtual CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) 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 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. More...
 
virtual bool safe_to_combine () const
 
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. More...
 
virtual void write (ostream &out, int indent_level) const
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_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)
 
string encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More...
 
bool encode_to_bam_stream (string &data, BamWriter *writer=NULL) 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)
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_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...
 
void operator= (const TypedObject &copy)
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 Returns the current reference count. More...
 
WeakReferenceListget_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 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...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static CPT (RenderEffect) make()
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type TexProjectorEffect. More...
 
- Static Public Member Functions inherited from RenderEffect
static TypedWritablechange_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 TypeHandle get_class_type ()
 
static int get_num_effects ()
 Returns the total number of unique RenderEffect objects allocated in the world. More...
 
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. More...
 
static bool validate_effects ()
 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(const string &data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. 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

const NodePathfrom
 
const NodePath const NodePath int lens_index = 0) const
 
const NodePath const NodePathto
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = NULL)
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = (TypedWritable*)0L
 

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 59 of file texProjectorEffect.h.

Member Function Documentation

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 366 of file texProjectorEffect.cxx.

References TypedWritable::complete_pointers().

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

Definition at line 222 of file texProjectorEffect.cxx.

References Lens::get_projection_mat().

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 130 of file texProjectorEffect.cxx.

References NodePath::fail().

Referenced by NodePath::get_tex_projector_from().

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 166 of file texProjectorEffect.cxx.

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 150 of file texProjectorEffect.cxx.

References NodePath::fail().

Referenced by NodePath::get_tex_projector_to().

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 200 of file texProjectorEffect.cxx.

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 115 of file texProjectorEffect.cxx.

Referenced by NodePath::has_tex_projector().

bool TexProjectorEffect::is_empty ( ) const

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

Definition at line 102 of file texProjectorEffect.cxx.

void TexProjectorEffect::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type TexProjectorEffect.

Definition at line 332 of file texProjectorEffect.cxx.

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

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 343 of file texProjectorEffect.cxx.

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


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