RenderEffects

Inheritance:

Methods of RenderEffects:

Methods of TypedWritableReferenceCount:

Methods of TypedWritable:

Methods of TypedObject:

Methods of ReferenceCount:

addEffect
ConstPointerTo< RenderEffects > RenderEffects::add_effect(RenderEffect const *effect) const;

Description: 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 RenderEffects::find_effect(TypeHandle type) const;

Description: 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 RenderEffects::get_class_type(void);

Undocumented function.

getEffect
RenderEffect const *RenderEffects::get_effect(int n) const;

Description: Returns the nth effect in the state.
Description: Looks for a RenderEffect of the indicated type in the state, and returns it if it is found, or NULL if it is not.

getNumEffects
int RenderEffects::get_num_effects(void) const;

Description: Returns the number of separate effects indicated in the state.

getNumStates
static int RenderEffects::get_num_states(void);

Description: Returns the total number of unique RenderEffects objects allocated in the world. This will go up and down during normal operations.

isEmpty
bool RenderEffects::is_empty(void) const;

Description: Returns true if the state is empty, false otherwise.

listStates
static void RenderEffects::list_states(ostream &out);

Description: Lists all of the RenderEffectss 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
static ConstPointerTo< RenderEffects > RenderEffects::make(RenderEffect const *effect);

Description: Returns a RenderEffects with one effect set.
Description: Returns a RenderEffects with two effects set.
Description: Returns a RenderEffects with three effects set.
Description: Returns a RenderEffects with four effects set.

makeEmpty
static ConstPointerTo< RenderEffects > RenderEffects::make_empty(void);

Description: Returns a RenderEffects with no effects set.

operator <
bool RenderEffects::operator <(RenderEffects const &other) const;

Description: Provides an arbitrary ordering among all unique RenderEffectss, 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
void RenderEffects::output(ostream &out) const;

Description:

removeEffect
ConstPointerTo< RenderEffects > RenderEffects::remove_effect(TypeHandle type) const;

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

validateStates
static bool RenderEffects::validate_states(void);

Description: 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
void RenderEffects::write(ostream &out, int indent_level) const;

Description:

getClassType
static TypeHandle TypedWritableReferenceCount::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedWritable::get_class_type(void);

Undocumented function.

getBestParentFromSet
int TypedObject::get_best_parent_from_Set(set< int > const &) const;

Description: Returns true if the current object is the indicated type exactly.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

Description: 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().

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

Description: Returns true if the current object is or derives from the indicated type.

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
int ReferenceCount::ref(void) const;

Description: 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.
The return value is the new reference count.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

unref
int ReferenceCount::unref(void) const;

Description: 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; plus, we don't have a virtual destructor anyway.) 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 the new reference count.