Panda3D
|
This effect automatically applies a computed texture matrix to the specified texture stage, according to the relative position of two specified nodes. More...
Public Member Functions | |
RenderEffect const | addStage (TextureStage stage, NodePath const from, NodePath const to) |
Returns a new TexProjectorEffect just like this one, with the indicated projection for the given stage. | |
int | compareTo (RenderEffect const 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. | |
bool | encodeToBamStream (basic_stringchar data) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
string | encodeToBamStream () |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. | |
bool | encodeToBamStream (basic_stringchar data, BamWriter writer) |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
NodePath | getFrom (TextureStage stage) |
Returns the "from" node associated with the TexProjectorEffect on the indicated stage. | |
int | getRefCount () |
Returns the current reference count. | |
NodePath | getTo (TextureStage stage) |
Returns the "to" node associated with the TexProjectorEffect on the indicated stage. | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
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). | |
bool | isEmpty () |
Returns true if no stages are defined in the TexProjectorEffect, false if at least one is. | |
bool | isExactType (TypeHandle handle) |
Returns true if the current object is the indicated type exactly. | |
bool | isOfType (TypeHandle handle) |
Returns true if the current object is or derives from the indicated type. | |
markBamModified () | |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. | |
output (ostream out) | |
PyObject | reduce (PyObject self) |
This special Python method is implement to provide support for the pickle module. | |
PyObject | reducePersist (PyObject self, PyObject pickler) |
This special Python method is implement to provide support for the pickle module. | |
ref () | |
Explicitly increments the reference count. | |
RenderEffect const | removeStage (TextureStage stage) |
Returns a new TexProjectorEffect just like this one, with the indicated stage removed. | |
bool | testRefCountIntegrity () |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | testRefCountNonzero () |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
bool | unref () |
Explicitly decrements the reference count. | |
write (ostream out, int indent_level) | |
Static Public Member Functions | |
static TypedWritableReferenceCount | decodeFromBamStream (string data, BamReader reader) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. | |
static TypedWritableReferenceCount | decodeFromBamStream (string data) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. | |
static TypeHandle | getClassType () |
static int | getNumEffects () |
Returns the total number of unique RenderEffect objects allocated in the world. | |
static | listEffects (ostream out) |
Lists all of the RenderEffects in the cache to the output stream, one per line. | |
static RenderEffect const | make () |
Constructs a TexProjectorEffect that modifies no stages at all. | |
static bool | validateEffects () |
Ensures that the cache is still stored in sorted order. |
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.
RenderEffect const addStage | ( | TextureStage | stage, |
NodePath const | from, | ||
NodePath const | to | ||
) |
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.
int compareTo | ( | RenderEffect const | other | ) | [inherited] |
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.
static TypedWritableReferenceCount decodeFromBamStream | ( | string | data | ) | [static, inherited] |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
Returns NULL on error.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
static TypedWritableReferenceCount decodeFromBamStream | ( | string | data, |
BamReader | reader | ||
) | [static, inherited] |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
Returns NULL on error.
This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.
string encodeToBamStream | ( | ) | [inherited] |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
Returns empty string on failure.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data, |
BamWriter | writer | ||
) | [inherited] |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
Returns true on success, false on failure.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
bool encodeToBamStream | ( | basic_stringchar | data | ) | [inherited] |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
Returns true on success, false on failure.
This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.
UpdateSeq getBamModified | ( | ) | [inherited] |
Returns the current bam_modified counter.
This counter is normally incremented automatically whenever the object is modified.
static TypeHandle getClassType | ( | ) | [static] |
Reimplemented from RenderEffect.
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.
static int getNumEffects | ( | ) | [static, inherited] |
Returns the total number of unique RenderEffect objects allocated in the world.
This will go up and down during normal operations.
int getRefCount | ( | ) | [inherited] |
Returns the current reference count.
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.
TypeHandle getType | ( | ) | [inherited] |
Reimplemented in AnimChannelBase.
int getTypeIndex | ( | ) | [inherited] |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
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).
bool isEmpty | ( | ) |
Returns true if no stages are defined in the TexProjectorEffect, false if at least one is.
bool isExactType | ( | TypeHandle | handle | ) | [inherited] |
Returns true if the current object is the indicated type exactly.
bool isOfType | ( | TypeHandle | handle | ) | [inherited] |
Returns true if the current object is or derives from the indicated type.
static listEffects | ( | ostream | out | ) | [static, inherited] |
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.
static RenderEffect const make | ( | ) | [static] |
Constructs a TexProjectorEffect that modifies no stages at all.
markBamModified | ( | ) | [inherited] |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients.
output | ( | ostream | out | ) | [inherited] |
PyObject reduce | ( | PyObject | self | ) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.
PyObject reducePersist | ( | PyObject | self, |
PyObject | pickler | ||
) | [inherited] |
This special Python method is implement to provide support for the pickle module.
This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.
ref | ( | ) | [inherited] |
Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
RenderEffect const removeStage | ( | TextureStage | stage | ) |
Returns a new TexProjectorEffect just like this one, with the indicated stage removed.
bool testRefCountIntegrity | ( | ) | [inherited] |
Does some easy checks to make sure that the reference count isn't completely bogus.
Returns true if ok, false otherwise.
Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.
bool testRefCountNonzero | ( | ) | [inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
bool unref | ( | ) | [inherited] |
Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.
Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.
static bool validateEffects | ( | ) | [static, inherited] |
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).