Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
RenderAttrib Class Reference

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"

Inheritance diagram for RenderAttrib:
TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase AlphaTestAttrib AntialiasAttrib AudioVolumeAttrib AuxBitplaneAttrib ClipPlaneAttrib ColorAttrib ColorBlendAttrib ColorScaleAttrib ColorWriteAttrib CullBinAttrib CullFaceAttrib DepthOffsetAttrib DepthTestAttrib DepthWriteAttrib FogAttrib LightAttrib LightRampAttrib MaterialAttrib RenderModeAttrib RescaleNormalAttrib ScissorAttrib ShadeModelAttrib ShaderAttrib StencilAttrib TexGenAttrib TexMatrixAttrib TextureAttrib TransparencyAttrib

List of all members.

Classes

class  Empty

Public Types

enum  PandaCompareFunc {
  M_none = 0, M_never, M_less, M_equal,
  M_less_equal, M_greater, M_not_equal, M_greater_equal,
  M_always
}
enum  TexGenMode {
  M_off, M_eye_sphere_map, M_world_cube_map, M_eye_cube_map,
  M_world_normal, M_eye_normal, M_world_position, M_unused,
  M_eye_position, M_point_sprite, M_light_vector, M_constant
}

Public Member Functions

virtual ~RenderAttrib ()
 The destructor is responsible for removing the RenderAttrib from the global set if it is there.
bool always_reissue () const
 Returns true if the RenderAttrib should be reissued to the GSG with every state change, even if it is the same pointer as it was before; or false for the normal case, to reissue only when the RenderAttrib pointer changes.
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.
 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.
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.
virtual TypeHandle force_init_type ()
size_t get_hash () const
 Returns a suitable hash value for phash_map.
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.
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.
virtual void output (ostream &out) const
virtual bool unref () const
 This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero.
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.

Static Public Member Functions

static TypedWritablechange_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 int garbage_collect ()
 Performs a garbage-collection cycle.
static TypeHandle get_class_type ()
static int get_num_attribs ()
 Returns the total number of unique RenderAttrib objects allocated in the world.
static void init_attribs ()
 Make sure the global _attribs map is allocated.
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.
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.
static bool validate_attribs ()
 Ensures that the cache is still stored in sorted order.

Protected Member Functions

virtual int compare_to_impl (const RenderAttrib *other) const
 Intended to be overridden by derived RenderAttrib types to return a unique number indicating whether this RenderAttrib is equivalent to the other one.
virtual CPT (RenderAttrib) compose_impl(const RenderAttrib *other) const
virtual CPT (RenderAttrib) invert_compose_impl(const RenderAttrib *other) const
virtual CPT (RenderAttrib) get_auto_shader_attrib_impl(const RenderState *state) const
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 RenderAttrib.
virtual size_t get_hash_impl () const
 Intended to be overridden by derived RenderAttrib types to return a unique hash for these particular properties.
void output_comparefunc (ostream &out, PandaCompareFunc fn) const
 Outputs a string representation of the given PandaCompareFunc object.

Static Protected Member Functions

static CPT (RenderAttrib) return_new(RenderAttrib *attrib)
static CPT (RenderAttrib) return_unique(RenderAttrib *attrib)
static TypedWritablenew_from_bam (RenderAttrib *attrib, BamReader *manager)

Protected Attributes

bool _always_reissue

Detailed Description

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.


Constructor & Destructor Documentation

The destructor is responsible for removing the RenderAttrib from the global set if it is there.

Definition at line 72 of file renderAttrib.cxx.


Member Function Documentation

bool RenderAttrib::always_reissue ( ) const [inline]

Returns true if the RenderAttrib should be reissued to the GSG with every state change, even if it is the same pointer as it was before; or false for the normal case, to reissue only when the RenderAttrib pointer changes.

Definition at line 62 of file renderAttrib.I.

TypedWritable * RenderAttrib::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 645 of file renderAttrib.cxx.

References BamReader::register_finalize().

Referenced by fillin().

int RenderAttrib::compare_to ( const RenderAttrib other) const [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 compare_to_impl(), and TypeHandle::get_index().

Referenced by validate_attribs().

int RenderAttrib::compare_to_impl ( const RenderAttrib other) const [protected, virtual]

Intended to be overridden by derived RenderAttrib types to return a unique number indicating whether this RenderAttrib is equivalent to the other one.

This should return 0 if the two RenderAttrib objects are equivalent, a number less than zero if this one should be sorted before the other one, and a number greater than zero otherwise.

This will only be called with two RenderAttrib objects whose get_type() functions return the same.

Reimplemented in StencilAttrib, ShaderAttrib, ClipPlaneAttrib, LightAttrib, ColorBlendAttrib, TextureAttrib, AuxBitplaneAttrib, TexGenAttrib, TexMatrixAttrib, RenderModeAttrib, DepthOffsetAttrib, TransparencyAttrib, LightRampAttrib, AntialiasAttrib, RescaleNormalAttrib, ColorWriteAttrib, ScissorAttrib, ColorScaleAttrib, CullFaceAttrib, ColorAttrib, AudioVolumeAttrib, ShadeModelAttrib, DepthWriteAttrib, MaterialAttrib, AlphaTestAttrib, CullBinAttrib, FogAttrib, and DepthTestAttrib.

Definition at line 476 of file renderAttrib.cxx.

Referenced by compare_to().

bool RenderAttrib::cull_callback ( CullTraverser trav,
const CullTraverserData data 
) const [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.

void RenderAttrib::fillin ( DatagramIterator scan,
BamReader manager 
) [protected, virtual]
void RenderAttrib::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.

Reimplemented in LightAttrib.

Definition at line 673 of file renderAttrib.cxx.

References ReferenceCount::get_ref_count(), and unref().

size_t RenderAttrib::get_hash ( ) const [inline]

Returns a suitable hash value for phash_map.

Definition at line 98 of file renderAttrib.I.

References integer_hash< Key, Compare >::add_hash(), and get_hash_impl().

Referenced by validate_attribs().

size_t RenderAttrib::get_hash_impl ( ) const [protected, virtual]

Intended to be overridden by derived RenderAttrib types to return a unique hash for these particular properties.

RenderAttribs that compare the same with compare_to_impl(), above, should return the same hash; RenderAttribs that compare differently should return a different hash.

Reimplemented in StencilAttrib, ShaderAttrib, ClipPlaneAttrib, LightAttrib, ColorBlendAttrib, TextureAttrib, AuxBitplaneAttrib, TexGenAttrib, TexMatrixAttrib, RenderModeAttrib, DepthOffsetAttrib, TransparencyAttrib, LightRampAttrib, AntialiasAttrib, RescaleNormalAttrib, ColorWriteAttrib, ScissorAttrib, ColorScaleAttrib, CullFaceAttrib, ColorAttrib, AudioVolumeAttrib, ShadeModelAttrib, DepthWriteAttrib, MaterialAttrib, AlphaTestAttrib, CullBinAttrib, FogAttrib, and DepthTestAttrib.

Definition at line 491 of file renderAttrib.cxx.

Referenced by get_hash().

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

bool RenderAttrib::has_cull_callback ( ) const [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.

void RenderAttrib::init_attribs ( ) [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 610 of file renderAttrib.cxx.

References Thread::get_current_thread(), and Thread::get_main_thread().

void RenderAttrib::list_attribs ( ostream &  out) [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().

bool RenderAttrib::lower_attrib_can_override ( ) const [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.

void RenderAttrib::output_comparefunc ( ostream &  out,
PandaCompareFunc  fn 
) const [protected]

Outputs a string representation of the given PandaCompareFunc object.

Definition at line 538 of file renderAttrib.cxx.

int RenderAttrib::register_slot ( TypeHandle  type_handle,
int  sort,
RenderAttribRegistry::MakeDefaultFunc *  make_default_func 
) [inline, static]

Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number.

See RenderAttribRegistry.

Definition at line 154 of file renderAttrib.I.

References RenderAttribRegistry::register_slot().

bool RenderAttrib::unref ( ) const [virtual]

This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero.

Reimplemented from ReferenceCount.

Definition at line 161 of file renderAttrib.cxx.

References ReferenceCount::unref().

Referenced by finalize().

bool RenderAttrib::validate_attribs ( ) [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(), get_hash(), 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().

void RenderAttrib::write_datagram ( BamWriter manager,
Datagram dg 
) [virtual]

The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations