---

PGMouseWatcherGroup Class Reference

This is a specialization on MouseWatcherGroup, to associate it with a PGTop. More...

#include <pgMouseWatcherGroup.h>

Inheritance diagram for PGMouseWatcherGroup:

List of all members.

Public Member Functions
	PGMouseWatcherGroup (PGTop *top)
virtual	~PGMouseWatcherGroup ()
void	clear_top (PGTop *top)
	Called by the PGTop object to indicate that it is no longer keeping the pointer to the PGMouseWatcherGroup object.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
bool	add_region (MouseWatcherRegion *region)
	Adds the indicated region to the set of regions in the group.
bool	has_region (MouseWatcherRegion *region) const
	Returns true if the indicated region has already been added to the MouseWatcherGroup, false otherwise.
bool	remove_region (MouseWatcherRegion *region)
	Removes the indicated region from the group.
MouseWatcherRegion *	find_region (const string &name) const
	Returns a pointer to the first region found with the indicated name.
void	clear_regions ()
	Removes all the regions from the group.
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
TypeHandle	get_class_type ()
void	init_type ()
Protected Types
typedef pvector< PointerTo< MouseWatcherRegion > >	Regions
Protected Attributes
Regions	_regions
Private Attributes
PGTop *	_top
Static Private Attributes
TypeHandle	_type_handle

---

Detailed Description

This is a specialization on MouseWatcherGroup, to associate it with a PGTop.

Originally we had PGTop multiply inheriting from NamedNode and MouseWatcherGroup, but this causes problems with circular reference counts.

Definition at line 47 of file pgMouseWatcherGroup.h.

---

Member Typedef Documentation

typedef pvector< PointerTo< MouseWatcherRegion > > MouseWatcherGroup::Regions [protected, inherited]

Definition at line 53 of file mouseWatcherGroup.h.

---

Constructor & Destructor Documentation

PGMouseWatcherGroup::PGMouseWatcherGroup (  PGTop *  top  )  [inline]

Definition at line 32 of file pgMouseWatcherGroup.I. References _top, INLINE, nassertv, and NULL.

PGMouseWatcherGroup::~PGMouseWatcherGroup (   )  [virtual]

Definition at line 36 of file pgMouseWatcherGroup.cxx.

---

Member Function Documentation

bool MouseWatcherGroup::add_region (  MouseWatcherRegion *  region  )  [inherited]

Adds the indicated region to the set of regions in the group. Returns true if it was successfully added, or false if it was already on the list. Definition at line 52 of file mouseWatcherGroup.cxx. References MouseWatcherGroup::_regions. Referenced by PGTop::get_mouse_watcher().

void MouseWatcherGroup::clear_regions (   )  [inherited]

Removes all the regions from the group. Definition at line 163 of file mouseWatcherGroup.cxx.

void PGMouseWatcherGroup::clear_top (  PGTop *  top  )  [inline]

Called by the PGTop object to indicate that it is no longer keeping the pointer to the PGMouseWatcherGroup object. Definition at line 48 of file pgMouseWatcherGroup.I.

MouseWatcherRegion * MouseWatcherGroup::find_region (  const string &  name  )  const [inherited]

Returns a pointer to the first region found with the indicated name. If multiple regions share the same name, the one that is returned is indeterminate. Definition at line 142 of file mouseWatcherGroup.cxx.

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

Definition at line 69 of file pgMouseWatcherGroup.h.

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

Reimplemented from MouseWatcherGroup. Definition at line 58 of file pgMouseWatcherGroup.h.

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

Definition at line 66 of file pgMouseWatcherGroup.h.

bool MouseWatcherGroup::has_region (  MouseWatcherRegion *  region  )  const [inherited]

Returns true if the indicated region has already been added to the MouseWatcherGroup, false otherwise. Definition at line 86 of file mouseWatcherGroup.cxx. References MouseWatcherGroup::_regions, and PT.

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

Reimplemented from MouseWatcherGroup. Definition at line 61 of file pgMouseWatcherGroup.h.

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

bool MouseWatcherGroup::remove_region (  MouseWatcherRegion *  region  )  [inherited]

Removes the indicated region from the group. Returns true if it was successfully removed, or false if it wasn't there in the first place. Reimplemented in MouseWatcher. Definition at line 112 of file mouseWatcherGroup.cxx. References MouseWatcherGroup::_regions, Namable::get_name(), and NULL. Referenced by MouseWatcher::~MouseWatcher().

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

---

Member Data Documentation

Regions MouseWatcherGroup::_regions [protected, inherited]

Definition at line 54 of file mouseWatcherGroup.h. Referenced by MouseWatcherGroup::add_region(), MouseWatcherGroup::has_region(), MouseWatcher::output(), MouseWatcher::press(), and MouseWatcherGroup::remove_region().

PGTop* PGMouseWatcherGroup::_top [private]

Definition at line 55 of file pgMouseWatcherGroup.h. Referenced by PGMouseWatcherGroup().

TypeHandle PGMouseWatcherGroup::_type_handle [static, private]

Reimplemented from MouseWatcherGroup. Definition at line 25 of file pgMouseWatcherGroup.cxx.

---

The documentation for this class was generated from the following files:

• panda/src/pgui/pgMouseWatcherGroup.h
• panda/src/pgui/pgMouseWatcherGroup.cxx
• panda/src/pgui/pgMouseWatcherGroup.I

---