Panda3D
|
This represents a unique collection of RenderEffect objects that correspond to a particular renderable state. More...
#include "renderEffects.h"
Classes | |
class | Effect |
Public Member Functions | |
virtual | ~RenderEffects () |
The destructor is responsible for removing the RenderEffects from the global set if it is there. | |
void | adjust_transform (CPT(TransformState)&net_transform, CPT(TransformState)&node_transform, PandaNode *node) const |
Calls adjust_transform() on all effects. | |
virtual int | complete_pointers (TypedWritable **plist, BamReader *manager) |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). | |
CPT (RenderEffects) xform(const LMatrix4 &mat) const | |
CPT (RenderEffects) add_effect(const RenderEffect *effect) const | |
virtual | CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) const |
CPT (RenderEffects) remove_effect(TypeHandle type) const | |
void | cull_callback (CullTraverser *trav, CullTraverserData &data, CPT(TransformState)&node_transform, CPT(RenderState)&node_state) const |
Calls cull_callback() on all effects. | |
virtual void | finalize (BamReader *manager) |
Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. | |
int | find_effect (TypeHandle type) const |
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. | |
virtual TypeHandle | force_init_type () |
const RenderEffect * | get_effect (int n) const |
Returns the nth effect in the state. | |
const RenderEffect * | get_effect (TypeHandle type) const |
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 | get_num_effects () const |
Returns the number of separate effects indicated in the state. | |
virtual TypeHandle | get_type () const |
bool | has_adjust_transform () const |
This function is provided as an optimization, to speed up the render-time checking for the existance of an effect with a compute_adjust_transform on this state. | |
bool | has_cull_callback () const |
This function is provided as an optimization, to speed up the render-time checking for the existance of an effect with a cull_callback on this state. | |
bool | has_decal () const |
This function is provided as an optimization, to speed up the render-time checking for the existance of a DecalEffect on this state. | |
bool | has_show_bounds () const |
This function is provided as an optimization, to speed up the render-time checking for the existance of a ShowBoundsEffect on this state. | |
bool | has_show_tight_bounds () const |
If has_show_bounds() returns true, this will return true if the ShowBoundsEffect in question requests showing a "tight" bound. | |
bool | is_empty () const |
Returns true if the state is empty, false otherwise. | |
bool | operator< (const RenderEffects &other) const |
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. | |
void | output (ostream &out) const |
virtual bool | require_fully_complete () const |
Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. | |
bool | safe_to_combine () const |
Returns true if all of the effects in this set can safely be shared with a sibling node that has the exact same set of effects, or false if this would be bad for any of the effects. | |
bool | safe_to_transform () const |
Returns true if all of the effects in this set can safely be transformed, and therefore the complete set can be transformed, by calling xform(). | |
virtual bool | unref () const |
This method overrides ReferenceCount::unref() to check whether the remaining reference count is entirely in the cache, and if so, it checks for and breaks a cycle in the cache involving this object. | |
void | write (ostream &out, int indent_level) const |
virtual void | write_datagram (BamWriter *manager, Datagram &dg) |
Writes the contents of this object to the datagram for shipping out to a Bam file. | |
Static Public Member Functions | |
static TypedWritable * | change_this (TypedWritable *old_ptr, BamReader *manager) |
Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. | |
static | CPT (RenderEffects) make_empty() |
static | CPT (RenderEffects) make(const RenderEffect *effect1 |
static | CPT (RenderEffects) make(const RenderEffect *effect) |
static | CPT (RenderEffects) make(const RenderEffect *effect1 |
static | CPT (RenderEffects) make(const RenderEffect *effect1 |
static TypeHandle | get_class_type () |
static int | get_num_states () |
Returns the total number of unique RenderEffects objects allocated in the world. | |
static void | init_states () |
Make sure the global _states map is allocated. | |
static void | init_type () |
static void | list_states (ostream &out) |
Lists all of the RenderEffects in the cache to the output stream, one per line. | |
static void | register_with_read_factory () |
Tells the BamReader how to create objects of type RenderEffects. | |
static bool | validate_states () |
Ensures that the cache is still stored in sorted order. | |
Public Attributes | |
static const RenderEffect * | effect2 |
static const RenderEffect const RenderEffect * | effect3 |
static const RenderEffect const RenderEffect const RenderEffect * | effect4 |
Protected Member Functions | |
RenderEffects () | |
Actually, this could be a private constructor, since no one inherits from RenderEffects, but gcc gives us a spurious warning if all constructors are private. | |
void | fillin (DatagramIterator &scan, BamReader *manager) |
This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new RenderEffects. | |
Static Protected Member Functions | |
static TypedWritable * | make_from_bam (const FactoryParams ¶ms) |
This function is called by the BamReader's factory when a new object of type RenderEffects is encountered in the Bam file. |
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.
Definition at line 46 of file renderEffects.h.
RenderEffects::RenderEffects | ( | ) | [protected] |
Actually, this could be a private constructor, since no one inherits from RenderEffects, but gcc gives us a spurious warning if all constructors are private.
Definition at line 46 of file renderEffects.cxx.
Referenced by make_from_bam().
RenderEffects::~RenderEffects | ( | ) | [virtual] |
The destructor is responsible for removing the RenderEffects from the global set if it is there.
Definition at line 81 of file renderEffects.cxx.
void RenderEffects::adjust_transform | ( | CPT(TransformState)& | net_transform, |
CPT(TransformState)& | node_transform, | ||
PandaNode * | node | ||
) | const |
Calls adjust_transform() on all effects.
You may check has_adjust_transform() first to see if any effects define this method to do anything useful.
The order in which the individual effects are applied is not defined, so if more than one effect applies a change to the transform on any particular node, you might get indeterminate results.
Definition at line 564 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().
TypedWritable * RenderEffects::change_this | ( | TypedWritable * | old_ptr, |
BamReader * | manager | ||
) | [static] |
Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired.
Most objects don't change pointers after completion, but some need to.
Once this function has been called, the old pointer will no longer be accessed.
Definition at line 867 of file renderEffects.cxx.
References BamReader::register_finalize().
Referenced by make_from_bam().
int RenderEffects::complete_pointers | ( | TypedWritable ** | p_list, |
BamReader * | manager | ||
) | [virtual] |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
Returns the number of pointers processed.
Reimplemented from TypedWritable.
Definition at line 802 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), ordered_vector< Key, Compare >::size(), and ov_set< Key, Compare >::sort().
void RenderEffects::cull_callback | ( | CullTraverser * | trav, |
CullTraverserData & | data, | ||
CPT(TransformState)& | node_transform, | ||
CPT(RenderState)& | node_state | ||
) | const |
Calls cull_callback() on all effects.
You may check has_cull_callback() first to see if any effects define this method to do anything useful.
Definition at line 542 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().
Referenced by CullTraverserData::apply_transform_and_state().
void RenderEffects::fillin | ( | DatagramIterator & | scan, |
BamReader * | manager | ||
) | [protected, virtual] |
This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new RenderEffects.
Reimplemented from TypedWritable.
Definition at line 936 of file renderEffects.cxx.
References DatagramIterator::get_uint16(), ordered_vector< Key, Compare >::push_back(), and BamReader::read_pointer().
Referenced by make_from_bam().
void RenderEffects::finalize | ( | BamReader * | manager | ) | [virtual] |
Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.
Reimplemented from TypedWritable.
Definition at line 895 of file renderEffects.cxx.
References ReferenceCount::get_ref_count(), and unref().
int RenderEffects::find_effect | ( | TypeHandle | type | ) | const |
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.
Definition at line 208 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().
const RenderEffect * RenderEffects::get_effect | ( | TypeHandle | type | ) | const |
Looks for a RenderEffect of the indicated type in the state, and returns it if it is found, or NULL if it is not.
Definition at line 376 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::end().
const RenderEffect * RenderEffects::get_effect | ( | int | n | ) | const [inline] |
Returns the nth effect in the state.
Definition at line 138 of file renderEffects.I.
References ordered_vector< Key, Compare >::size().
Referenced by CullTraverserData::apply_transform_and_state().
int RenderEffects::get_num_effects | ( | ) | const [inline] |
Returns the number of separate effects indicated in the state.
Definition at line 128 of file renderEffects.I.
References ordered_vector< Key, Compare >::size().
int RenderEffects::get_num_states | ( | ) | [static] |
Returns the total number of unique RenderEffects objects allocated in the world.
This will go up and down during normal operations.
Definition at line 465 of file renderEffects.cxx.
bool RenderEffects::has_adjust_transform | ( | ) | const [inline] |
This function is provided as an optimization, to speed up the render-time checking for the existance of an effect with a compute_adjust_transform on this state.
Definition at line 228 of file renderEffects.I.
bool RenderEffects::has_cull_callback | ( | ) | const [inline] |
This function is provided as an optimization, to speed up the render-time checking for the existance of an effect with a cull_callback on this state.
Definition at line 210 of file renderEffects.I.
Referenced by CullTraverserData::apply_transform_and_state().
bool RenderEffects::has_decal | ( | ) | const [inline] |
This function is provided as an optimization, to speed up the render-time checking for the existance of a DecalEffect on this state.
It returns true if a DecalEffect exists, false otherwise. Note that since there is no additional information stored on the DecalEffect, there's no point in returning it if it exists.
Definition at line 155 of file renderEffects.I.
Referenced by CullTraverser::traverse_below().
bool RenderEffects::has_show_bounds | ( | ) | const [inline] |
This function is provided as an optimization, to speed up the render-time checking for the existance of a ShowBoundsEffect on this state.
It returns true if a ShowBoundsEffect exists, false otherwise. Note that since there is no additional information stored on the ShowBoundsEffect, there's no point in returning it if it exists.
Definition at line 176 of file renderEffects.I.
Referenced by PipeOcclusionCullTraverser::is_in_view(), and CullTraverser::traverse().
bool RenderEffects::has_show_tight_bounds | ( | ) | const [inline] |
If has_show_bounds() returns true, this will return true if the ShowBoundsEffect in question requests showing a "tight" bound.
Definition at line 193 of file renderEffects.I.
Referenced by CullTraverser::traverse().
void RenderEffects::init_states | ( | ) | [static] |
Make sure the global _states map is allocated.
This only has to be done once. We could make this map static, but then we run into problems if anyone creates a RenderEffects object at static init time; it also seems to cause problems when the Panda shared library is unloaded at application exit time.
Definition at line 584 of file renderEffects.cxx.
References Thread::get_current_thread(), and Thread::get_main_thread().
bool RenderEffects::is_empty | ( | ) | const [inline] |
Returns true if the state is empty, false otherwise.
Definition at line 117 of file renderEffects.I.
References ordered_vector< Key, Compare >::empty().
Referenced by SceneGraphReducer::r_flatten(), and PandaNode::set_effects().
void RenderEffects::list_states | ( | 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.
Definition at line 481 of file renderEffects.cxx.
TypedWritable * RenderEffects::make_from_bam | ( | const FactoryParams & | params | ) | [static, protected] |
This function is called by the BamReader's factory when a new object of type RenderEffects is encountered in the Bam file.
It should create the RenderEffects and extract its information from the file.
Definition at line 916 of file renderEffects.cxx.
References change_this(), fillin(), BamReader::register_change_this(), and RenderEffects().
Referenced by register_with_read_factory().
bool RenderEffects::operator< | ( | const RenderEffects & | other | ) | const |
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.
Definition at line 191 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().
void RenderEffects::register_with_read_factory | ( | ) | [static] |
Tells the BamReader how to create objects of type RenderEffects.
Definition at line 768 of file renderEffects.cxx.
References BamReader::get_factory(), make_from_bam(), and Factory< Type >::register_factory().
bool RenderEffects::require_fully_complete | ( | ) | const [virtual] |
Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.
If this is the case, override this method to return true, and be careful with circular references (which would make the object unreadable from a bam file).
Reimplemented from TypedWritable.
Definition at line 844 of file renderEffects.cxx.
bool RenderEffects::safe_to_combine | ( | ) | const |
Returns true if all of the effects in this set can safely be shared with a sibling node that has the exact same set of effects, or false if this would be bad for any of the effects.
Definition at line 138 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().
Referenced by SceneGraphReducer::consider_child(), and SceneGraphReducer::flatten_siblings().
bool RenderEffects::safe_to_transform | ( | ) | const |
Returns true if all of the effects in this set can safely be transformed, and therefore the complete set can be transformed, by calling xform().
Definition at line 97 of file renderEffects.cxx.
References ordered_vector< Key, Compare >::begin(), and ordered_vector< Key, Compare >::end().
Referenced by SceneGraphReducer::r_apply_attribs().
bool RenderEffects::unref | ( | ) | const [virtual] |
This method overrides ReferenceCount::unref() to check whether the remaining reference count is entirely in the cache, and if so, it checks for and breaks a cycle in the cache involving this object.
This is designed to prevent leaks from cyclical references within the cache.
Note that this is not a virtual method, and cannot be because ReferenceCount itself declares no virtual methods (it avoids the overhead of a virtual function pointer). But this doesn't matter, because PT(TransformState) is a template class, and will call the appropriate method even though it is non-virtual.
Reimplemented from ReferenceCount.
Definition at line 403 of file renderEffects.cxx.
References ReferenceCount::unref().
Referenced by finalize().
bool RenderEffects::validate_states | ( | ) | [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).
Definition at line 499 of file renderEffects.cxx.
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from TypedWritable.
Definition at line 779 of file renderEffects.cxx.
References Datagram::add_uint16(), ordered_vector< Key, Compare >::begin(), ordered_vector< Key, Compare >::end(), ordered_vector< Key, Compare >::size(), and BamWriter::write_pointer().