Panda3D
Public Member Functions | Static Public Member Functions | List of all members
RenderEffects Class Reference

This represents a unique collection of RenderEffect objects that correspond to a particular renderable state. More...

Inheritance diagram for RenderEffects:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

const RenderEffects addEffect (const RenderEffect effect)
 Returns a new RenderEffects object that represents the same as the source state, with the new RenderEffect added. More...
 
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. More...
 
const RenderEffect 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. More...
 
const RenderEffect getEffect (int n)
 Returns the nth effect in the state. More...
 
int getNumEffects ()
 Returns the number of separate effects indicated in the state. More...
 
bool isEmpty ()
 Returns true if the state is empty, false otherwise. More...
 
const RenderEffect operator [] (TypeHandle type)
 Returns the effect in the state with the given type. More...
 
const RenderEffect operator [] (int n)
 Returns the nth effect in the state. More...
 
bool operator< (const RenderEffects other)
 
 output (Ostream out)
 
const RenderEffects removeEffect (TypeHandle type)
 Returns a new RenderEffects object that represents the same as the source state, with the indicated RenderEffect removed. More...
 
int size ()
 Returns the number of separate effects indicated in the state. More...
 
 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 int getNumStates ()
 Returns the total number of unique RenderEffects objects allocated in the world. More...
 
static listStates (Ostream out)
 Lists all of the RenderEffects in the cache to the output stream, one per line. More...
 
static const RenderEffects make (const RenderEffect effect)
 Returns a RenderEffects with one effect set. More...
 
static const RenderEffects make (const RenderEffect effect1, const RenderEffect effect2)
 Returns a RenderEffects with two effects set. More...
 
static const RenderEffects make (const RenderEffect effect1, const RenderEffect effect2, const RenderEffect effect3)
 Returns a RenderEffects with three effects set. More...
 
static const RenderEffects make (const RenderEffect effect1, const RenderEffect effect2, const RenderEffect effect3, const RenderEffect effect4)
 Returns a RenderEffects with four effects set. More...
 
static const RenderEffects makeEmpty ()
 Returns a RenderEffects with no effects set. More...
 
static bool validateStates ()
 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 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.

Member Function Documentation

◆ addEffect()

const RenderEffects addEffect ( const RenderEffect  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.

◆ findEffect()

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.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getEffect() [1/2]

const RenderEffect 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.

◆ getEffect() [2/2]

const RenderEffect getEffect ( int  n)

Returns the nth effect in the state.

◆ getNumEffects()

int getNumEffects ( )

Returns the number of separate effects indicated in the state.

◆ getNumStates()

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.

◆ isEmpty()

bool isEmpty ( )

Returns true if the state is empty, false otherwise.

◆ listStates()

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.

◆ make() [1/4]

static const RenderEffects make ( const RenderEffect  effect)
static

Returns a RenderEffects with one effect set.

◆ make() [2/4]

static const RenderEffects make ( const RenderEffect  effect1,
const RenderEffect  effect2 
)
static

Returns a RenderEffects with two effects set.

◆ make() [3/4]

static const RenderEffects make ( const RenderEffect  effect1,
const RenderEffect  effect2,
const RenderEffect  effect3 
)
static

Returns a RenderEffects with three effects set.

◆ make() [4/4]

static const RenderEffects make ( const RenderEffect  effect1,
const RenderEffect  effect2,
const RenderEffect  effect3,
const RenderEffect  effect4 
)
static

Returns a RenderEffects with four effects set.

◆ makeEmpty()

static const RenderEffects makeEmpty ( )
static

Returns a RenderEffects with no effects set.

◆ operator []() [1/2]

const RenderEffect operator [] ( TypeHandle  type)

Returns the effect in the state with the given type.

◆ operator []() [2/2]

const RenderEffect operator [] ( int  n)

Returns the nth effect in the state.

◆ operator<()

bool operator< ( const RenderEffects  other)

◆ output()

output ( Ostream  out)

◆ removeEffect()

const RenderEffects removeEffect ( TypeHandle  type)

Returns a new RenderEffects object that represents the same as the source state, with the indicated RenderEffect removed.

◆ size()

int size ( )

Returns the number of separate effects indicated in the state.

◆ validateStates()

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

◆ write()

write ( Ostream  out,
int  indent_level 
)