This is the base class for a number of render attributes (other than transform) that may be set on scene graph nodes to control the appearance of geometry. More...
#include "renderAttrib.h"
Public Member Functions | |
virtual | ~RenderAttrib () |
The destructor is responsible for removing the RenderAttrib from the global set if it is there. More... | |
bool | always_reissue () const |
int | compare_to (const RenderAttrib &other) const |
Provides an arbitrary ordering among all unique RenderAttribs, so we can store the essentially different ones in a big set and throw away the rest. More... | |
CPT (RenderAttrib) compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const | |
CPT (RenderAttrib) get_unique() const | |
CPT (RenderAttrib) get_auto_shader_attrib(const RenderState *state) const | |
virtual bool | cull_callback (CullTraverser *trav, const CullTraverserData &data) const |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time. 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... | |
virtual TypeHandle | force_init_type () |
size_t | get_hash () const |
Returns a suitable hash value for phash_map. More... | |
virtual int | get_slot () const =0 |
virtual TypeHandle | get_type () const |
virtual bool | has_cull_callback () const |
Should be overridden by derived classes to return true if cull_callback() has been defined. More... | |
virtual bool | lower_attrib_can_override () const |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact. More... | |
virtual void | output (ostream &out) const |
virtual bool | unref () const FINAL |
Explicitly decrements the reference count. More... | |
virtual 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 ©) | |
virtual int | complete_pointers (TypedWritable **p_list, BamReader *manager) |
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More... | |
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 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... | |
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 int | garbage_collect () |
Performs a garbage-collection cycle. More... | |
static TypeHandle | get_class_type () |
static int | get_num_attribs () |
Returns the total number of unique RenderAttrib objects allocated in the world. More... | |
static void | init_attribs () |
Make sure the global _attribs map is allocated. More... | |
static void | init_type () |
static void | list_attribs (ostream &out) |
Lists all of the RenderAttribs in the cache to the output stream, one per line. More... | |
static int | register_slot (TypeHandle type_handle, int sort, RenderAttribRegistry::MakeDefaultFunc *make_default_func) |
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number. More... | |
static bool | validate_attribs () |
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 () |
Additional Inherited Members | |
![]() | |
static BamReader * | reader = NULL) |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
This is the base class for a number of render attributes (other than transform) that may be set on scene graph nodes to control the appearance of geometry.
This includes TextureAttrib, ColorAttrib, etc.
RenderAttrib represents render attributes that always propagate down to the leaves without regard to the particular node they are assigned to. A RenderAttrib will have the same effect on a leaf node whether it is assigned to the graph at the leaf or several nodes above. This is different from RenderEffect, which represents a particular render property that is applied immediately to the node on which it is encountered, like billboarding or decaling.
You should not attempt to create or modify a RenderAttrib directly; instead, use the make() method of the appropriate kind of attrib you want. This will allocate and return a new RenderAttrib of the appropriate type, and it may share pointers if possible. Do not modify the new RenderAttrib if you wish to change its properties; instead, create a new one.
Definition at line 60 of file renderAttrib.h.
|
virtual |
The destructor is responsible for removing the RenderAttrib from the global set if it is there.
Definition at line 72 of file renderAttrib.cxx.
|
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 647 of file renderAttrib.cxx.
References BamReader::register_finalize().
|
inline |
Provides an arbitrary ordering among all unique RenderAttribs, 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 RenderAttrib class because all equivalent RenderAttrib objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.
Definition at line 79 of file renderAttrib.I.
References TypeHandle::get_index().
Referenced by validate_attribs().
|
virtual |
If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.
This is called each time the RenderAttrib is discovered applied to a Geom in the traversal. It should return true if the Geom is visible, false if it should be omitted.
Reimplemented in TextureAttrib.
Definition at line 139 of file renderAttrib.cxx.
|
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.
Reimplemented in LightAttrib.
Definition at line 675 of file renderAttrib.cxx.
References ReferenceCount::get_ref_count(), and unref().
|
static |
Performs a garbage-collection cycle.
This is called automatically from RenderState::garbage_collect(); see that method for more information.
Definition at line 258 of file renderAttrib.cxx.
References SimpleHashMap< Key, Value, Compare >::get_key(), SimpleHashMap< Key, Value, Compare >::get_num_entries(), ReferenceCount::get_ref_count(), SimpleHashMap< Key, Value, Compare >::get_size(), SimpleHashMap< Key, Value, Compare >::has_element(), and SimpleHashMap< Key, Value, Compare >::validate().
Referenced by RenderState::garbage_collect().
|
inline |
Returns a suitable hash value for phash_map.
Definition at line 98 of file renderAttrib.I.
|
static |
Returns the total number of unique RenderAttrib objects allocated in the world.
This will go up and down during normal operations.
Definition at line 219 of file renderAttrib.cxx.
References SimpleHashMap< Key, Value, Compare >::get_num_entries().
|
virtual |
Should be overridden by derived classes to return true if cull_callback() has been defined.
Otherwise, returns false to indicate cull_callback() does not need to be called for this node during the cull traversal.
Reimplemented in TextureAttrib.
Definition at line 121 of file renderAttrib.cxx.
|
static |
Make sure the global _attribs 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 RenderAttrib 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 612 of file renderAttrib.cxx.
References Thread::get_current_thread(), and Thread::get_main_thread().
|
static |
Lists all of the RenderAttribs 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 236 of file renderAttrib.cxx.
References SimpleHashMap< Key, Value, Compare >::get_key(), SimpleHashMap< Key, Value, Compare >::get_num_entries(), SimpleHashMap< Key, Value, Compare >::get_size(), and SimpleHashMap< Key, Value, Compare >::has_element().
|
virtual |
Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.
This should return false if a RenderAttrib on a higher node will compose into a RenderAttrib on a lower node that has a higher override value, or true if the lower RenderAttrib will completely replace the state.
The default behavior is false: normally, a RenderAttrib in the graph cannot completely override a RenderAttrib above it, regardless of its override value–instead, the two attribs are composed. But for some kinds of RenderAttribs, it is useful to allow this kind of override.
This method only handles the one special case of a lower RenderAttrib with a higher override value. If the higher RenderAttrib has a higher override value, it always completely overrides. And if both RenderAttribs have the same override value, they are always composed.
Reimplemented in TextureAttrib, and ColorScaleAttrib.
Definition at line 107 of file renderAttrib.cxx.
|
inlinestatic |
Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number.
See RenderAttribRegistry.
Definition at line 163 of file renderAttrib.I.
References RenderAttribRegistry::register_slot().
|
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 finalize().
|
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 RenderAttrib objects).
Definition at line 314 of file renderAttrib.cxx.
References compare_to(), SimpleHashMap< Key, Value, Compare >::get_key(), SimpleHashMap< Key, Value, Compare >::get_size(), SimpleHashMap< Key, Value, Compare >::has_element(), SimpleHashMap< Key, Value, Compare >::is_empty(), and SimpleHashMap< Key, Value, Compare >::validate().
Writes the contents of this object to the datagram for shipping out to a Bam file.
Reimplemented from TypedWritable.
Reimplemented in TextureAttrib, StencilAttrib, LightAttrib, ClipPlaneAttrib, TexGenAttrib, ColorBlendAttrib, TexMatrixAttrib, AuxBitplaneAttrib, DepthOffsetAttrib, RenderModeAttrib, LightRampAttrib, ColorScaleAttrib, TransparencyAttrib, AntialiasAttrib, ScissorAttrib, RescaleNormalAttrib, ColorAttrib, CullFaceAttrib, AudioVolumeAttrib, ColorWriteAttrib, ShadeModelAttrib, DepthWriteAttrib, AlphaTestAttrib, MaterialAttrib, CullBinAttrib, FogAttrib, and DepthTestAttrib.
Definition at line 631 of file renderAttrib.cxx.
References TypedWritable::write_datagram().
Referenced by DepthTestAttrib::write_datagram(), FogAttrib::write_datagram(), CullBinAttrib::write_datagram(), AlphaTestAttrib::write_datagram(), MaterialAttrib::write_datagram(), DepthWriteAttrib::write_datagram(), ColorWriteAttrib::write_datagram(), ShadeModelAttrib::write_datagram(), AudioVolumeAttrib::write_datagram(), CullFaceAttrib::write_datagram(), ColorAttrib::write_datagram(), RescaleNormalAttrib::write_datagram(), AntialiasAttrib::write_datagram(), ScissorAttrib::write_datagram(), ColorScaleAttrib::write_datagram(), TransparencyAttrib::write_datagram(), LightRampAttrib::write_datagram(), RenderModeAttrib::write_datagram(), DepthOffsetAttrib::write_datagram(), AuxBitplaneAttrib::write_datagram(), TexMatrixAttrib::write_datagram(), ColorBlendAttrib::write_datagram(), TexGenAttrib::write_datagram(), ClipPlaneAttrib::write_datagram(), LightAttrib::write_datagram(), StencilAttrib::write_datagram(), and TextureAttrib::write_datagram().