Panda3D
|
This represents a unique collection of RenderEffect objects that correspond to a particular renderable state. More...
Public Member Functions | |
RenderEffects const | addEffect (RenderEffect const effect) |
Returns a new RenderEffects object that represents the same as the source state, with the new RenderEffect added. | |
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. | |
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. | |
int | findEffect (TypeHandle type) |
Searches for an effect with the indicated type in the state, and returns its index if it is found, or -1 if it is not. | |
UpdateSeq | getBamModified () |
Returns the current bam_modified counter. | |
RenderEffect const | getEffect (int n) |
Returns the nth effect in the state. | |
RenderEffect const | getEffect (TypeHandle type) |
Looks for a RenderEffect of the indicated type in the state, and returns it if it is found, or NULL if it is not. | |
int | getNumEffects () |
Returns the number of separate effects indicated in the state. | |
int | getRefCount () |
Returns the current reference count. | |
TypeHandle | getType () |
int | getTypeIndex () |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. | |
bool | isEmpty () |
Returns true if the state is empty, false otherwise. | |
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. | |
bool | operator< (RenderEffects 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. | |
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. | |
RenderEffects const | removeEffect (TypeHandle type) |
Returns a new RenderEffects object that represents the same as the source state, with the indicated RenderEffect 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 | getNumStates () |
Returns the total number of unique RenderEffects objects allocated in the world. | |
static | listStates (ostream out) |
Lists all of the RenderEffects in the cache to the output stream, one per line. | |
static RenderEffects const | make (RenderEffect const effect) |
Returns a RenderEffects with one effect set. | |
static RenderEffects const | make (RenderEffect const effect1, RenderEffect const effect2, RenderEffect const effect3) |
Returns a RenderEffects with three effects set. | |
static RenderEffects const | make (RenderEffect const effect1, RenderEffect const effect2, RenderEffect const effect3, RenderEffect const effect4) |
Returns a RenderEffects with four effects set. | |
static RenderEffects const | make (RenderEffect const effect1, RenderEffect const effect2) |
Returns a RenderEffects with two effects set. | |
static RenderEffects const | makeEmpty () |
Returns a RenderEffects with no effects set. | |
static bool | validateStates () |
Ensures that the cache is still stored in sorted order. |
This represents a unique collection of RenderEffect objects that correspond to a particular renderable state.
You should not attempt to create or modify a RenderEffects object directly. Instead, call one of the make() functions to create one for you. And instead of modifying a RenderEffects object, create a new one.
RenderEffects const addEffect | ( | RenderEffect const | effect | ) |
Returns a new RenderEffects object that represents the same as the source state, with the new RenderEffect added.
If there is already a RenderEffect with the same type, it is replaced.
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.
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.
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.
int findEffect | ( | TypeHandle | type | ) |
Searches for an effect with the indicated type in the state, and returns its index if it is found, or -1 if it is not.
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 TypedWritableReferenceCount.
RenderEffect const getEffect | ( | int | n | ) |
Returns the nth effect in the state.
RenderEffect const getEffect | ( | TypeHandle | type | ) |
Looks for a RenderEffect of the indicated type in the state, and returns it if it is found, or NULL if it is not.
int getNumEffects | ( | ) |
Returns the number of separate effects indicated in the state.
static int getNumStates | ( | ) | [static] |
Returns the total number of unique RenderEffects objects allocated in the world.
This will go up and down during normal operations.
int getRefCount | ( | ) | [inherited] |
Returns the current reference count.
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 isEmpty | ( | ) |
Returns true if the state is empty, false otherwise.
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 listStates | ( | 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.
static RenderEffects const make | ( | RenderEffect const | effect | ) | [static] |
Returns a RenderEffects with one effect set.
static RenderEffects const make | ( | RenderEffect const | effect1, |
RenderEffect const | effect2 | ||
) | [static] |
Returns a RenderEffects with two effects set.
static RenderEffects const make | ( | RenderEffect const | effect1, |
RenderEffect const | effect2, | ||
RenderEffect const | effect3 | ||
) | [static] |
Returns a RenderEffects with three effects set.
static RenderEffects const make | ( | RenderEffect const | effect1, |
RenderEffect const | effect2, | ||
RenderEffect const | effect3, | ||
RenderEffect const | effect4 | ||
) | [static] |
Returns a RenderEffects with four effects set.
static RenderEffects const makeEmpty | ( | ) | [static] |
Returns a RenderEffects with no effects set.
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.
bool operator< | ( | RenderEffects 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.
This method is not needed outside of the RenderEffects class because all equivalent RenderEffects objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.
output | ( | ostream | out | ) |
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.
RenderEffects const removeEffect | ( | TypeHandle | type | ) |
Returns a new RenderEffects object that represents the same as the source state, with the indicated RenderEffect 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 validateStates | ( | ) | [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 RenderEffects objects).