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

dDrawable Class Reference

Object that can be drawn (i.e. More...

#include <drawable.h>

Inheritance diagram for dDrawable:


Public Types
enum	BoundingVolumeType { BVT_static, BVT_dynamic_sphere }
Public Member Functions
	dDrawable ()
virtual	~dDrawable ()
virtual void	draw (GraphicsStateGuardianBase *)
	Actually draws the Drawable with the indicated GSG.
virtual bool	is_dynamic () const
	Returns true if the Drawable has any dynamic properties that are expected to change from one frame to the next, or false if the Drawable is largely static.
virtual void	write_datagram (BamWriter *manager, Datagram &me)
	Function to write the important information in the particular object to a Datagram.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
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.
virtual void	config (void)
void	check_config () const
bool	is_dirty (void) const
void	make_dirty (void)
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().
virtual void	finalize ()
	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.
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.
void	set_bound (BoundingVolumeType type)
	Sets the type of the bounding volume that will be dynamically computed for this particular node.
void	set_bound (const BoundingVolume &volume)
	Explicitly sets a new bounding volume on this node.
const BoundingVolume &	get_bound () const
	Returns the current bounding volume on this node, possibly forcing a recompute.
bool	mark_bound_stale ()
	Marks the current bounding volume as stale, so that it will be recomputed later.
void	force_bound_stale ()
	Marks the current volume as stale and propagates the effect at least one level, even if it had already been marked stale.
bool	is_bound_stale () const
	Returns true if the bound is currently marked stale and will be recomputed the next time get_bound() is called.
void	set_final (bool flag)
	Sets the "final" flag on this BoundedObject.
bool	is_final () const
	Returns the current state of the "final" flag.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Static Public Attributes
TypedWritable *const	Null = (TypedWritable*)0L
Protected Member Functions
virtual void	propagate_stale_bound ()
	Called by BoundedObject::mark_bound_stale(), this should make sure that all bounding volumes that depend on this one are marked stale also.
void	fillin (DatagramIterator &scan, BamReader *manager)
	This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.
virtual BoundingVolume *	recompute_bound ()
	Recomputes the dynamic bounding volume for this object.
const BoundingVolume *	get_bound_ptr () const
	Returns the state of the _bound pointer.
BoundingVolume *	set_bound_ptr (BoundingVolume *bound)
	Changes the _bound pointer.
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

Object that can be drawn (i.e.

issues graphics commands). NOTE: We had to change the name to dDrawable because the stupid bastards who wrote X didn't add a prefix to their variable names

Definition at line 58 of file drawable.h.

Member Enumeration Documentation

enum BoundedObject::BoundingVolumeType [inherited]

Enumeration values:

BVT_static

BVT_dynamic_sphere

Definition at line 58 of file boundedObject.h.

Constructor & Destructor Documentation

dDrawable::dDrawable ( )

Definition at line 35 of file drawable.cxx.

dDrawable::~dDrawable ( ) [virtual]

Definition at line 50 of file drawable.cxx.
References WritableConfigurable::config(), and WritableConfigurable::is_dirty().

Member Function Documentation

void WritableConfigurable::check_config ( ) const [inline, inherited]

Definition at line 70 of file writableConfigurable.h.
References PUBLISHED.
Referenced by Geom::set_lengths().

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

virtual void WritableConfigurable::config ( void ) [inline, virtual, inherited]

Reimplemented in Geom, ImageBuffer, and PixelBuffer.
Definition at line 69 of file writableConfigurable.h.
Referenced by ~dDrawable().

void dDrawable::draw ( GraphicsStateGuardianBase * ) [virtual]

Actually draws the Drawable with the indicated GSG.
At this level, this doesn't do very much.
Reimplemented in Geom.
Definition at line 64 of file drawable.cxx.

void dDrawable::fillin ( DatagramIterator & scan,

BamReader * manager

) [protected]

This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.
It is defined at the TypedWritable level so that derived classes may call up the inheritance chain from their own fillin() method.
Reimplemented from TypedWritable.
Reimplemented in Geom, GeomLine, GeomLinestrip, GeomPoint, and GeomSprite.

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

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 in PartBundle, RenderAttrib, RenderEffect, RenderEffects, RenderState, and TransformState.
Definition at line 112 of file typedWritable.cxx.
Referenced by BamReader::skip_pointer().

void BoundedObject::force_bound_stale ( ) [inline, inherited]

Marks the current volume as stale and propagates the effect at least one level, even if it had already been marked stale.

Definition at line 188 of file boundedObject.I.
References BoundedObject::_cycler, BoundedObject::F_final, and INLINE.
Referenced by PandaNode::remove_child().

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

Reimplemented from WritableConfigurable.
Reimplemented in Geom, GeomLine, GeomLinestrip, GeomPoint, GeomPolygon, GeomQuad, GeomSphere, GeomSprite, GeomTri, GeomTrifan, and GeomTristrip.
Definition at line 97 of file drawable.h.

const BoundingVolume & BoundedObject::get_bound ( ) const [inherited]

Returns the current bounding volume on this node, possibly forcing a recompute.
A node's bounding volume encloses only the node itself, irrespective of the nodes above or below it in the graph. This is different from the bounding volumes on the arcs, which enclose all geometry below them.
Reimplemented in PandaNode.
Definition at line 59 of file boundedObject.cxx.
Referenced by PandaNode::clear_effect(), PandaNode::get_state(), and CollisionLevelState::reserve().

const BoundingVolume * BoundedObject::get_bound_ptr ( ) const [inline, protected, inherited]

Returns the state of the _bound pointer.
To be used only internally by derived classes.
This returns a const pointer only; the bounding volume should not be modified directly, because that might interfere with pipelining. Instead, create a new copy with make_copy(), modify the copy, and set_bound_ptr() with the copy.
Alternatively, if you have just called recompute_bound(), which is guaranteed to reset the pointer, just use the return value from that as a non-const BoundingVolume pointer.
Definition at line 318 of file boundedObject.I.

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

Reimplemented from ReferenceCount.
Reimplemented in Geom, GeomLine, GeomLinestrip, GeomPoint, GeomPolygon, GeomQuad, GeomSphere, GeomSprite, GeomTri, GeomTrifan, and GeomTristrip.
Definition at line 78 of file drawable.h.
Referenced by Geom::get_class_type(), and Geom::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 dDrawable::get_type ( void ) const [inline, virtual]

Reimplemented from WritableConfigurable.
Reimplemented in Geom, GeomLine, GeomLinestrip, GeomPoint, GeomPolygon, GeomQuad, GeomSphere, GeomSprite, GeomTri, GeomTrifan, and GeomTristrip.
Definition at line 92 of file drawable.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 dDrawable::init_type ( void ) [inline, static]

Reimplemented from ReferenceCount.
Reimplemented in Geom, GeomLine, GeomLinestrip, GeomPoint, GeomPolygon, GeomQuad, GeomSphere, GeomSprite, GeomTri, GeomTrifan, and GeomTristrip.
Definition at line 83 of file drawable.h.
References BoundedObject::get_class_type(), and BoundedObject::init_type().
Referenced by Geom::init_type().

bool BoundedObject::is_bound_stale ( ) const [inline, inherited]

Returns true if the bound is currently marked stale and will be recomputed the next time get_bound() is called.
This function is defined up at the top of this file, because several of the inline functions below reference it.
Definition at line 217 of file boundedObject.I.
References BoundedObject::_cycler, and INLINE.
Referenced by BoundedObject::~BoundedObject().

bool WritableConfigurable::is_dirty ( void ) const [inline, inherited]

Definition at line 82 of file writableConfigurable.h.
Referenced by Geom::get_texcoords(), and ~dDrawable().

bool dDrawable::is_dynamic ( ) const [virtual]

Returns true if the Drawable has any dynamic properties that are expected to change from one frame to the next, or false if the Drawable is largely static.

Reimplemented in Geom.
Definition at line 85 of file drawable.cxx.
Referenced by CRGraphicsStateGuardian::apply_texture().

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 BoundedObject::is_final ( ) const [inline, inherited]

Returns the current state of the "final" flag.
Initially, this flag is off (false), but it may be changed by an explicit call to set_final(). See set_final().
Definition at line 280 of file boundedObject.I.

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

void WritableConfigurable::make_dirty ( void ) [inline, inherited]

Definition at line 83 of file writableConfigurable.h.
Referenced by GeomSphere::draw_immediate(), Geom::get_coords_index(), GeomTri::get_tris(), PixelBuffer::set_size(), PixelBuffer::set_xorg(), PixelBuffer::set_ysize(), PixelBuffer::stencil_buffer(), Geom::transform_vertices(), and GeomLine::write_datagram().

bool BoundedObject::mark_bound_stale ( ) [inline, inherited]

Marks the current bounding volume as stale, so that it will be recomputed later.
This may have a cascading effect up to the root of all graphs of which the node is a part. Returns true if the setting was changed, or false if it was already marked stale (or if it is a static bounding volume).
Definition at line 162 of file boundedObject.I.
References BoundedObject::_cycler, BoundedObject::F_bound_stale, and INLINE.
Referenced by CollisionSphere::CollisionSphere(), GeomNode::combine_with(), CollisionPlane::get_normal(), PGItem::instance_to_state_def(), CollisionPlane::make_copy(), PGItem::set_active(), CollisionSphere::set_center(), TextNode::set_coordinate_system(), PandaNode::set_effect(), CollisionNode::set_from_collide_mask(), GeomNode::set_geom_state(), CollisionRay::set_origin(), CollisionSegment::set_point_a(), CollisionSphere::test_intersection(), CollisionSegment::test_intersection(), CollisionRay::test_intersection(), and CollisionNode::xform().

void dDrawable::propagate_stale_bound ( ) [protected, virtual]

Called by BoundedObject::mark_bound_stale(), this should make sure that all bounding volumes that depend on this one are marked stale also.

Reimplemented from BoundedObject.
Definition at line 102 of file drawable.cxx.

BoundingVolume * BoundedObject::recompute_bound ( ) [protected, virtual, inherited]

Recomputes the dynamic bounding volume for this object.
The default behavior is the compute an empty bounding volume; this may be overridden to extend it to create a nonempty bounding volume. However, after calling this function, it is guaranteed that the _bound pointer will not be shared with any other stage of the pipeline, and this new pointer is returned.
Reimplemented in CollisionNode, CollisionPlane, CollisionPolygon, CollisionRay, CollisionSegment, CollisionSphere, Geom, and PandaNode.
Definition at line 134 of file boundedObject.cxx.
Referenced by CollisionSphere::get_collision_origin().

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 BoundedObject::set_bound ( const BoundingVolume & volume ) [inline, inherited]

Explicitly sets a new bounding volume on this node.
This will be a static bounding volume that will no longer be recomputed automatically.
Reimplemented in PandaNode.
Definition at line 135 of file boundedObject.I.
References BoundedObject::F_bound_stale.

void BoundedObject::set_bound ( BoundedObject::BoundingVolumeType type ) [inline, inherited]

Sets the type of the bounding volume that will be dynamically computed for this particular node.
Presently, this should only be BVT_dynamic_sphere.
Definition at line 115 of file boundedObject.I.

BoundingVolume * BoundedObject::set_bound_ptr ( BoundingVolume * bound ) [inline, protected, inherited]

Changes the _bound pointer.
To be used only internally by derived classes, usually in recompute_bound(). The return value is the same pointer passed in, as a convenience (it will now be reference counted).
Definition at line 340 of file boundedObject.I.

void BoundedObject::set_final ( bool flag ) [inline, inherited]

Sets the "final" flag on this BoundedObject.
If this is true, than no bounding volume need be tested below it; a positive intersection with this bounding volume is deemed to be a positive intersection with all geometry inside.
This is useful to quickly force a larger bounding volume around a node when the GeomNodes themselves are inaccurate for some reason, without forcing a recompute of every nested bounding volume. It's also helpful when the bounding volume is tricked by some special properties, like billboards, that may move geometry out of its bounding volume otherwise.
Definition at line 256 of file boundedObject.I.

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 dDrawable::write_datagram ( BamWriter * manager,

Datagram & me

) [virtual]

Function to write the important information in the particular object to a Datagram.

Implements WritableConfigurable.
Reimplemented in Geom, GeomLine, GeomLinestrip, GeomPoint, and GeomSprite.
Definition at line 119 of file drawable.cxx.