Panda3D
|
This represents a unique collection of RenderEffect objects that correspond to a particular renderable state. More...
#include "renderEffects.h"
Public Member Functions | |
virtual | ~RenderEffects () |
The destructor is responsible for removing the RenderEffects from the global set if it is there. More... | |
void | adjust_transform (CPT(TransformState) &net_transform, CPT(TransformState) &node_transform, PandaNode *node) const |
Calls adjust_transform() on all effects. More... | |
virtual int | complete_pointers (TypedWritable **plist, BamReader *manager) |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
virtual | CPT (TransformState) prepare_flatten_transform(const TransformState *net_transform) const |
CPT (RenderEffects) xform(const LMatrix4 &mat) const | |
CPT (RenderEffects) add_effect(const RenderEffect *effect) 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. More... | |
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. More... | |
int | find_effect (TypeHandle type) const |
virtual TypeHandle | force_init_type () |
const RenderEffect * | get_effect (int n) const |
Returns the nth effect in the state. More... | |
const RenderEffect * | get_effect (TypeHandle type) const |
int | get_num_effects () const |
Returns the number of separate effects indicated in the state. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
bool | is_empty () const |
Returns true if the state is empty, false otherwise. More... | |
bool | operator< (const RenderEffects &other) const |
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. More... | |
bool | safe_to_combine () const |
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(). More... | |
virtual bool | unref () const |
Explicitly decrements the reference count. More... | |
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. More... | |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
string | encode_to_bam_stream () const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More... | |
bool | encode_to_bam_stream (string &data, BamWriter *writer=NULL) const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More... | |
UpdateSeq | get_bam_modified () const |
Returns the current bam_modified counter. More... | |
void | mark_bam_modified () |
Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More... | |
void | operator= (const TypedWritable ©) |
virtual void | update_bam_nested (BamWriter *manager) |
Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More... | |
![]() | |
TypedObject (const TypedObject ©) | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
const TypedObject * | as_typed_object () const |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
int | get_best_parent_from_Set (const std::set< int > &) const |
int | get_type_index () const |
Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More... | |
bool | is_exact_type (TypeHandle handle) const |
Returns true if the current object is the indicated type exactly. More... | |
bool | is_of_type (TypeHandle handle) const |
Returns true if the current object is or derives from the indicated type. More... | |
void | operator= (const TypedObject ©) |
![]() | |
int | get_ref_count () const |
Returns the current reference count. More... | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. More... | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More... | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More... | |
void | ref () const |
Explicitly increments the reference count. More... | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. More... | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More... | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
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. More... | |
static | CPT (RenderEffects) make_empty() |
static | CPT (RenderEffects) make(const RenderEffect *effect) |
static | CPT (RenderEffects) make(const RenderEffect *effect1 |
static | CPT (RenderEffects) make(const RenderEffect *effect1 |
static | CPT (RenderEffects) make(const RenderEffect *effect1 |
static TypeHandle | get_class_type () |
static int | get_num_states () |
static void | init_states () |
Make sure the global _states map is allocated. More... | |
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. More... | |
static void | register_with_read_factory () |
Tells the BamReader how to create objects of type RenderEffects. More... | |
static bool | validate_states () |
Ensures that the cache is still stored in sorted order. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data |
![]() | |
static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More... | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
This function is declared non-inline to work around a compiler bug in g++ 2.96. More... | |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Public Attributes | |
static const RenderEffect * | effect2 |
static const RenderEffect const RenderEffect * | effect3 |
static const RenderEffect const RenderEffect const RenderEffect * | effect4 |
![]() | |
static BamReader * | reader = NULL) |
Additional Inherited Members | |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
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.
|
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.
References safe_to_transform().
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 init_states().
Referenced by cull_callback().
|
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 finalize(), and BamReader::register_finalize().
Referenced by require_fully_complete().
|
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 TypedWritable::complete_pointers(), and require_fully_complete().
Referenced by write_datagram().
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 adjust_transform().
Referenced by CullTraverserData::apply_transform_and_state(), and validate_states().
|
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 RenderEffect::change_this(), TypedWritable::fillin(), ReferenceCount::get_ref_count(), DatagramIterator::get_uint16(), BamReader::read_pointer(), BamReader::register_change_this(), and ReferenceCount::unref().
Referenced by change_this().
|
inline |
Returns the nth effect in the state.
Definition at line 138 of file renderEffects.I.
References has_decal(), and ordered_vector< Key, Compare, Vector >::size().
Referenced by EggSaver::add_node(), CullTraverserData::apply_transform_and_state(), get_num_effects(), and safe_to_transform().
|
inline |
Returns the number of separate effects indicated in the state.
Definition at line 128 of file renderEffects.I.
References get_effect(), and ordered_vector< Key, Compare, Vector >::size().
Referenced by is_empty().
|
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.
Referenced by has_cull_callback().
|
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.
References has_adjust_transform().
Referenced by CullTraverserData::apply_transform_and_state(), and has_show_tight_bounds().
|
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.
References has_show_bounds().
Referenced by get_effect(), and CullTraverser::traverse_below().
|
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.
References has_show_tight_bounds().
Referenced by CullTraverser::flush_level(), PipeOcclusionCullTraverser::get_texture(), and has_decal().
|
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.
References has_cull_callback().
Referenced by CullTraverser::flush_level(), and has_show_bounds().
|
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(), Thread::get_main_thread(), ShowBoundsEffect::get_tight(), and register_with_read_factory().
Referenced by adjust_transform().
|
inline |
Returns true if the state is empty, false otherwise.
Definition at line 117 of file renderEffects.I.
References ordered_vector< Key, Compare, Vector >::empty(), and get_num_effects().
Referenced by PandaNode::set_effects().
|
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.
References validate_states().
Referenced by safe_to_transform().
|
static |
Tells the BamReader how to create objects of type RenderEffects.
Definition at line 768 of file renderEffects.cxx.
References BamReader::get_factory(), Factory< Type >::register_factory(), and write_datagram().
Referenced by init_states().
|
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.
References change_this().
Referenced by complete_pointers().
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 get_effect(), list_states(), ReferenceCount::unref(), and unref().
Referenced by SceneGraphReducer::check_live_flatten(), and ~RenderEffects().
|
virtual |
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 from ReferenceCount.
Referenced by safe_to_transform().
|
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.
References cull_callback().
Referenced by list_states().
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(), complete_pointers(), TypedWritable::write_datagram(), and BamWriter::write_pointer().
Referenced by register_with_read_factory().