Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

RenderEffect Class Reference

This is the base class for a number of special render effects that may be set on scene graph nodes to change the way they render. More...

#include <renderEffect.h>

Inheritance diagram for RenderEffect:

TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject BillboardEffect CompassEffect DecalEffect ShowBoundsEffect List of all members.

Public Member Functions

virtual ~RenderEffect ()
 The destructor is responsible for removing the RenderEffect from the global set if it is there.

int compare_to (const RenderEffect &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.

virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise.

virtual bool safe_to_combine () const
 Returns true if this kind of effect can safely be combined with sibling nodes that share the exact same effect, or false if this is not a good idea.

virtual ConstPointerTo< RenderEffect > xform (const LMatrix4f &mat) const
 Returns a new RenderEffect transformed by the indicated matrix.

virtual void output (ostream &out) const
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.

virtual void finalize ()
 Method to ensure that any necessary clean up tasks that have to be performed by this object are performed.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
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().

int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.

bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.

int get_ref_count () const
 Returns the current reference count.

int ref () const
 Explicitly increments the reference count.

int unref () const
 Explicitly decrements the reference count.

void test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.


Static Public Member Functions

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.

TypeHandle get_class_type ()
void init_type ()

Static Public Attributes

TypedWritable *const Null = (TypedWritable*)0L

Protected Member Functions

 RenderEffect ()
virtual int compare_to_impl (const RenderEffect *other) const
 Intended to be overridden by derived RenderEffect types to return a unique number indicating whether this RenderEffect is equivalent to the other one.

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 RenderEffect.


Static Protected Member Functions

ConstPointerTo< RenderEffect > return_new (RenderEffect *effect)
 This function is used by derived RenderEffect types to share a common RenderEffect pointer for all equivalent RenderEffect objects.

TypedWritable * new_from_bam (RenderEffect *effect, BamReader *manager)

Private Types

typedef pset< const RenderEffect *,
IndirectCompareTo< RenderEffect > > 		Effects

Private Member Functions

 RenderEffect (const RenderEffect &copy)
 RenderEffects are not meant to be copied.

void operator= (const RenderEffect &copy)
 RenderEffects are not meant to be copied.


Private Attributes

Effects::iterator _saved_entry

Static Private Attributes

Effects _effects
TypeHandle _type_handle

Detailed Description

This is the base class for a number of special render effects that may be set on scene graph nodes to change the way they render.

This includes BillboardEffect, DecalEffect, etc.

RenderEffect represents render properties that must be applied as soon as they are encountered in the scene graph, rather than propagating down to the leaves. This is different from RenderAttrib, which represents properties like color and texture that don't do anything until they propagate down to a GeomNode.

You should not attempt to create or modify a RenderEffect directly; instead, use the make() method of the appropriate kind of effect you want. This will allocate and return a new RenderEffect of the appropriate type, and it may share pointers if possible. Do not modify the new RenderEffect if you wish to change its properties; instead, create a new one.

Definition at line 80 of file renderEffect.h.

Member Typedef Documentation

typedef pset<const RenderEffect *, IndirectCompareTo<RenderEffect> > RenderEffect::Effects [private]
 

Definition at line 106 of file renderEffect.h.

Constructor & Destructor Documentation

RenderEffect::RenderEffect (   )  [protected]
 

Definition at line 37 of file renderEffect.cxx.

References nassertv.

RenderEffect::RenderEffect (  const RenderEffect &  copy  )  [private]
 

RenderEffects are not meant to be copied.

Definition at line 50 of file renderEffect.cxx.

References nassertv.

RenderEffect::~RenderEffect (   )  [virtual]
 

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

Definition at line 78 of file renderEffect.cxx.

References _effects, and _saved_entry.

Member Function Documentation

TypedWritable * RenderEffect::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 294 of file renderEffect.cxx.

int RenderEffect::compare_to (  const RenderEffect &  other  )  const [inline]
 

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 RenderEffect class because all equivalent RenderEffect objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

Definition at line 46 of file renderEffect.I.

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

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

This should return 0 if the two RenderEffect 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 RenderEffect objects whose get_type() functions return the same.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 254 of file renderEffect.cxx.

int TypedWritable::complete_pointers (  TypedWritable **  p_list,
BamReader *  manager
)  [virtual, inherited]
 

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

This is the callback function that is made by the BamReader at some later point, after all of the required pointers have been filled in. It is necessary because there might be forward references in a bam file; when we call read_pointer() in fillin(), the object may not have been read from the file yet, so we do not have a pointer available at that time. Thus, instead of returning a pointer, read_pointer() simply reserves a later callback. This function provides that callback. The calling object is responsible for keeping track of the number of times it called read_pointer() and extracting the same number of pointers out of the supplied vector, and storing them appropriately within the object.

Reimplemented in AnimBundleNode, AnimGroup, PartBundleNode, PartGroup, Character, CharacterJoint, CollisionNode, GeomSprite, PiecewiseCurve, ClipPlaneAttrib, FogAttrib, LensNode, LightAttrib, MaterialAttrib, RenderEffects, RenderState, TextureAttrib, Person, and Child.

Definition at line 94 of file typedWritable.cxx.

Referenced by RenderState::do_invert_compose().

void RenderEffect::fillin (  DatagramIterator &  scan,
BamReader *  manager
)  [protected]
 

This internal function is called by make_from_bam to read in all of the relevant data from the BamFile for the new RenderEffect.

Reimplemented from TypedWritable.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 350 of file renderEffect.cxx.

Referenced by ShowBoundsEffect::register_with_read_factory(), CompassEffect::register_with_read_factory(), DecalEffect::write_datagram(), and BillboardEffect::write_datagram().

void RenderEffect::finalize (  void   )  [virtual]
 

Method to ensure that any necessary clean up tasks that have to be performed by this object are performed.

Reimplemented from TypedWritable.

Definition at line 325 of file renderEffect.cxx.

virtual TypeHandle RenderEffect::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from TypedWritableReferenceCount.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 132 of file renderEffect.h.

TypeHandle RenderEffect::get_class_type (  void   )  [inline, static]
 

Reimplemented from TypedWritableReferenceCount.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 121 of file renderEffect.h.

Referenced by DecalEffect::get_class_type(), BillboardEffect::get_class_type(), DecalEffect::init_type(), and BillboardEffect::init_type().

int ReferenceCount::get_ref_count (   )  const [inline, inherited]
 

Returns the current reference count.

Definition at line 183 of file referenceCount.I.

Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle RenderEffect::get_type (  void   )  const [inline, virtual]
 

Reimplemented from TypedWritableReferenceCount.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 129 of file renderEffect.h.

int TypedObject::get_type_index (   )  const [inline, inherited]
 

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

Definition at line 71 of file typedObject.I.

References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

void RenderEffect::init_type (  void   )  [inline, static]
 

Reimplemented from TypedWritableReferenceCount.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 124 of file renderEffect.h.

Referenced by DecalEffect::init_type(), and BillboardEffect::init_type().

bool TypedObject::is_exact_type (  TypeHandle  handle  )  const [inline, inherited]
 

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

Definition at line 101 of file typedObject.I.

Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type (  TypeHandle  handle  )  const [inline, inherited]
 

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

Definition at line 86 of file typedObject.I.

Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

TypedWritable* RenderEffect::new_from_bam (  RenderEffect *  effect,
BamReader *  manager
)  [static, protected]
 

void RenderEffect::operator= (  const RenderEffect &  copy  )  [private]
 

RenderEffects are not meant to be copied.

Definition at line 63 of file renderEffect.cxx.

References _effects, and _saved_entry.

void RenderEffect::output (  ostream &  out  )  const [virtual]
 

Reimplemented in BillboardEffect, and CompassEffect.

Definition at line 157 of file renderEffect.cxx.

References _effects.

int ReferenceCount::ref (   )  const [inline, inherited]
 

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.

Definition at line 225 of file referenceCount.I.

Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

ConstPointerTo< RenderEffect > RenderEffect::return_new (  RenderEffect *  effect  )  [static, protected]
 

This function is used by derived RenderEffect types to share a common RenderEffect pointer for all equivalent RenderEffect objects.

The make() function of the derived type should create a new RenderEffect and pass it through return_new(), which will either save the pointer and return it unchanged (if this is the first similar such object) or delete it and return an equivalent pointer (if there was already a similar object saved).

Definition at line 201 of file renderEffect.cxx.

References TypedWritable::write_datagram().

bool RenderEffect::safe_to_combine (   )  const [virtual]
 

Returns true if this kind of effect can safely be combined with sibling nodes that share the exact same effect, or false if this is not a good idea.

Reimplemented in DecalEffect, and ShowBoundsEffect.

Definition at line 129 of file renderEffect.cxx.

References indent().

bool RenderEffect::safe_to_transform (   )  const [virtual]
 

Returns true if it is generally safe to transform this particular kind of RenderEffect by calling the xform() method, false otherwise.

Reimplemented in BillboardEffect, and CompassEffect.

Definition at line 112 of file renderEffect.cxx.

void ReferenceCount::test_ref_count_integrity (   )  const [inline, inherited]
 

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.

References INLINE.

Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref (   )  const [inline, inherited]
 

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.

Definition at line 293 of file referenceCount.I.

References INLINE.

Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

void RenderEffect::write (  ostream &  out,
int  indent_level
)  const [virtual]
 

Definition at line 170 of file renderEffect.cxx.

void RenderEffect::write_datagram (  BamWriter *  manager,
Datagram &  dg
)  [virtual]
 

Writes the contents of this object to the datagram for shipping out to a Bam file.

Implements TypedWritableReferenceCount.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 269 of file renderEffect.cxx.

Referenced by DecalEffect::compare_to_impl().

ConstPointerTo< RenderEffect > RenderEffect::xform (  const LMatrix4f &  mat  )  const [virtual]
 

Returns a new RenderEffect transformed by the indicated matrix.

Definition at line 144 of file renderEffect.cxx.

References nassertr, and NULL.

Member Data Documentation

RenderEffect::Effects RenderEffect::_effects [static, private]
 

Definition at line 26 of file renderEffect.cxx.

Referenced by operator=(), output(), and ~RenderEffect().

Effects::iterator RenderEffect::_saved_entry [private]
 

Definition at line 109 of file renderEffect.h.

Referenced by operator=(), and ~RenderEffect().

TypeHandle RenderEffect::_type_handle [static, private]
 

Reimplemented from TypedWritableReferenceCount.

Reimplemented in BillboardEffect, CompassEffect, DecalEffect, and ShowBoundsEffect.

Definition at line 27 of file renderEffect.cxx.

TypedWritable *const TypedWritable::Null = (TypedWritable*)0L [static, inherited]
 

Definition at line 25 of file typedWritable.cxx.

Referenced by Child::complete_pointers(), Parent::complete_pointers(), Person::complete_pointers(), LoaderFileTypeBam::get_extension(), PartGroup::pick_channel_index(), BamReader::read_pointer(), and AnimGroup::write_datagram().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:54:41 2003 for Panda by doxygen1.3