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

Inheritance diagram for TexProjectorEffect:
RenderEffect TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

const RenderEffect addStage (TextureStage stage, const NodePath from, const NodePath to, int lens_index)
 Returns a new TexProjectorEffect just like this one, with the indicated projection for the given stage. More...
 
NodePath getFrom (TextureStage stage)
 Returns the "from" node associated with the TexProjectorEffect on the indicated stage. More...
 
int getLensIndex (TextureStage stage)
 Returns the lens_index associated with the TexProjectorEffect on the indicated stage. More...
 
NodePath getTo (TextureStage stage)
 Returns the "to" node associated with the TexProjectorEffect on the indicated stage. More...
 
bool hasStage (TextureStage stage)
 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 isEmpty ()
 Returns true if no stages are defined in the TexProjectorEffect, false if at least one is. More...
 
const RenderEffect removeStage (TextureStage stage)
 Returns a new TexProjectorEffect just like this one, with the indicated stage removed. More...
 
- Public Member Functions inherited from RenderEffect
int compareTo (const RenderEffect other)
 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...
 
 output (Ostream out)
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
static const RenderEffect make ()
 Constructs a TexProjectorEffect that modifies no stages at all. More...
 
- Static Public Member Functions inherited from RenderEffect
static TypeHandle getClassType ()
 
static int getNumEffects ()
 Returns the total number of unique RenderEffect objects allocated in the world. More...
 
static listEffects (Ostream out)
 Lists all of the RenderEffects in the cache to the output stream, one per line. More...
 
static bool validateEffects ()
 Ensures that the cache is still stored in sorted order. More...
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

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.

Member Function Documentation

◆ addStage()

const RenderEffect addStage ( TextureStage  stage,
const NodePath  from,
const NodePath  to,
int  lens_index 
)

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.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getFrom()

NodePath getFrom ( TextureStage  stage)

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.

◆ getLensIndex()

int getLensIndex ( TextureStage  stage)

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.

◆ getTo()

NodePath getTo ( TextureStage  stage)

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.

◆ hasStage()

bool hasStage ( TextureStage  stage)

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

◆ isEmpty()

bool isEmpty ( )

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

◆ make()

static const RenderEffect make ( )
static

Constructs a TexProjectorEffect that modifies no stages at all.

◆ removeStage()

const RenderEffect removeStage ( TextureStage  stage)

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