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

ShowBoundsEffect Class Reference

Applied to a GeomNode to cause a visible bounding volume to be drawn for this node. More...

#include <showBoundsEffect.h>

Inheritance diagram for ShowBoundsEffect:


Public Member Functions
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 TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
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 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	finalize ()
	Method to ensure that any necessary clean up tasks that have to be performed by this object are performed.
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
ConstPointerTo< RenderEffect >	make ()
	Constructs a new ShowBoundsEffect object.
void	register_with_read_factory ()
	Tells the BamReader how to create objects of type ShowBoundsEffect.
TypeHandle	get_class_type ()
void	init_type ()
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 Public Attributes
TypedWritable *const	Null = (TypedWritable*)0L
Protected Member Functions
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 int	compare_to_impl (const RenderEffect *other) const
	Intended to be overridden by derived ShowBoundsEffect types to return a unique number indicating whether this ShowBoundsEffect is equivalent to the other one.
virtual RenderEffect *	make_default_impl () const
	Intended to be overridden by derived ShowBoundsEffect types to specify what the default property for a ShowBoundsEffect of this type should be.
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 ShowBoundsEffect.
Static Protected Member Functions
TypedWritable *	make_from_bam (const FactoryParams &params)
	This function is called by the BamReader's factory when a new object of type ShowBoundsEffect is encountered in the Bam file.
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 Member Functions
	ShowBoundsEffect ()
	Use ShowBoundsEffect::make() to construct a new ShowBoundsEffect object.
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

Applied to a GeomNode to cause a visible bounding volume to be drawn for this node.

This is generally used only during development to help identify bounding volume issues.

Definition at line 42 of file showBoundsEffect.h.

Constructor & Destructor Documentation

ShowBoundsEffect::ShowBoundsEffect ( ) [inline, private]

Use ShowBoundsEffect::make() to construct a new ShowBoundsEffect object.

Definition at line 34 of file showBoundsEffect.I.

Member Function Documentation

TypedWritable * RenderEffect::change_this ( TypedWritable * old_ptr,

BamReader * manager

) [static, inherited]

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, inherited]

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 ShowBoundsEffect::compare_to_impl ( const RenderEffect * other ) const [protected, virtual]

Intended to be overridden by derived ShowBoundsEffect types to return a unique number indicating whether this ShowBoundsEffect is equivalent to the other one.
This should return 0 if the two ShowBoundsEffect 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 ShowBoundsEffect objects whose get_type() functions return the same.
Reimplemented from RenderEffect.
Definition at line 90 of file showBoundsEffect.cxx.
References get_class_type(), BamReader::get_factory(), make_from_bam(), and Factory< TypedWritable >::register_factory().

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 ShowBoundsEffect::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 ShowBoundsEffect.

Reimplemented from RenderEffect.
Definition at line 190 of file showBoundsEffect.cxx.
Referenced by make_default_impl().

void RenderEffect::finalize ( void ) [virtual, inherited]

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 ShowBoundsEffect::force_init_type ( void ) [inline, virtual]

Reimplemented from RenderEffect.
Definition at line 74 of file showBoundsEffect.h.

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

Reimplemented from RenderEffect.
Definition at line 63 of file showBoundsEffect.h.
Referenced by compare_to_impl().

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 ShowBoundsEffect::get_type ( void ) const [inline, virtual]

Reimplemented from RenderEffect.
Definition at line 71 of file showBoundsEffect.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 ShowBoundsEffect::init_type ( void ) [inline, static]

Reimplemented from RenderEffect.
Definition at line 66 of file showBoundsEffect.h.

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

ConstPointerTo< RenderEffect > ShowBoundsEffect::make ( ) [static]

Constructs a new ShowBoundsEffect object.

Definition at line 39 of file showBoundsEffect.cxx.

RenderEffect * ShowBoundsEffect::make_default_impl ( ) const [protected, virtual]

Intended to be overridden by derived ShowBoundsEffect types to specify what the default property for a ShowBoundsEffect of this type should be.
This should return a newly-allocated ShowBoundsEffect of the same type that corresponds to whatever the standard default for this kind of ShowBoundsEffect is.
Definition at line 117 of file showBoundsEffect.cxx.
References fillin(), and parse_params().

TypedWritable * ShowBoundsEffect::make_from_bam ( const FactoryParams & params ) [static, protected]

This function is called by the BamReader's factory when a new object of type ShowBoundsEffect is encountered in the Bam file.
It should create the ShowBoundsEffect and extract its information from the file.
Definition at line 166 of file showBoundsEffect.cxx.
Referenced by compare_to_impl().

TypedWritable* RenderEffect::new_from_bam ( RenderEffect * effect,

BamReader * manager

) [static, protected, inherited]

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

Reimplemented in BillboardEffect, and CompassEffect.
Definition at line 157 of file renderEffect.cxx.
References RenderEffect::_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().

void ShowBoundsEffect::register_with_read_factory ( void ) [static]

Tells the BamReader how to create objects of type ShowBoundsEffect.

Definition at line 132 of file showBoundsEffect.cxx.
References RenderEffect::fillin().

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

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 ShowBoundsEffect::safe_to_combine ( ) const [protected, 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 from RenderEffect.
Definition at line 57 of file showBoundsEffect.cxx.

bool RenderEffect::safe_to_transform ( ) const [virtual, inherited]

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, inherited]

Definition at line 170 of file renderEffect.cxx.

void ShowBoundsEffect::write_datagram ( BamWriter * manager,

Datagram & dg

) [virtual]

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

Reimplemented from RenderEffect.
Definition at line 147 of file showBoundsEffect.cxx.

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

Returns a new RenderEffect transformed by the indicated matrix.

Definition at line 144 of file renderEffect.cxx.
References nassertr, and NULL.