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

MouseWatcherRegion Class Reference

This is the class that defines a rectangular region on the screen for the MouseWatcher. More...

#include <mouseWatcherRegion.h>

Inheritance diagram for MouseWatcherRegion:


Public Types
enum	SuppressFlags { SF_mouse_button = 0x001, SF_other_button = 0x002, SF_any_button = 0x003, SF_mouse_position = 0x004 }
Public Member Functions
	MouseWatcherRegion (const string &name, float left, float right, float bottom, float top)
	MouseWatcherRegion (const string &name, const LVecBase4f &frame)
void	set_frame (float left, float right, float bottom, float top)
void	set_frame (const LVecBase4f &frame)
const LVecBase4f &	get_frame () const
float	get_area () const
	Returns the area of the rectangular region.
void	set_sort (int sort)
	Changes the sorting order of this particular region.
int	get_sort () const
	Returns the current sorting order of this region.
void	set_active (bool active)
	Sets whether the region is active or not.
bool	get_active () const
	Returns whether the region is active or not.
void	set_keyboard (bool keyboard)
	Sets whether the region is interested in global keyboard events.
bool	get_keyboard () const
	Returns whether the region is interested in global keyboard events; see set_keyboard().
void	set_suppress_flags (int suppress_flags)
	Sets which events are suppressed when the mouse is over the region.
int	get_suppress_flags () const
	Returns the current suppress_flags.
void	output (ostream &out) const
	Outputs the Namable.
void	write (ostream &out, int indent_level=0) const
bool	operator< (const MouseWatcherRegion &other) const
	Returns true if this region should be preferred over the other region when they overlap, false otherwise.
virtual void	enter (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse enters the region.
virtual void	exit (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse exits the region.
virtual void	within (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region.
virtual void	without (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.
virtual void	press (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever a mouse or keyboard button is depressed while the mouse is within the region.
virtual void	release (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released.
virtual void	keystroke (const MouseWatcherParameter &param)
	This is a callback hook function, called whenever a keystroke is generated by the user.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
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.
void	set_name (const string &name)
void	clear_name ()
	Resets the Namable's name to empty.
bool	has_name () const
	Returns true if the Namable has a nonempty name set, false if the name is empty.
const string &	get_name () const
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Private Types
enum	Flags { F_suppress_flags = 0x0ff, F_active = 0x100, F_keyboard = 0x200 }
Private Attributes
LVecBase4f	_frame
float	_area
int	_sort
int	_flags
ModifierButtons	_mods
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

This is the class that defines a rectangular region on the screen for the MouseWatcher.

Definition at line 44 of file mouseWatcherRegion.h.

Member Enumeration Documentation

enum MouseWatcherRegion::Flags [private]

Enumeration values:

F_suppress_flags

F_active

F_keyboard

Definition at line 93 of file mouseWatcherRegion.h.

enum MouseWatcherRegion::SuppressFlags

Enumeration values:

SF_mouse_button

SF_other_button

SF_any_button

SF_mouse_position

Definition at line 64 of file mouseWatcherRegion.h.

Constructor & Destructor Documentation

MouseWatcherRegion::MouseWatcherRegion ( const string & name,

float left,

float right,

float bottom,

float top

) [inline]

Definition at line 31 of file mouseWatcherRegion.I.

MouseWatcherRegion::MouseWatcherRegion ( const string & name,

const LVecBase4f & frame

) [inline]

Definition at line 48 of file mouseWatcherRegion.I.
References INLINE, and set_frame().

Member Function Documentation

void Namable::clear_name ( ) [inline, inherited]

Resets the Namable's name to empty.

Definition at line 82 of file namable.I.
References Namable::_name, and INLINE.

void MouseWatcherRegion::enter ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever the mouse enters the region.
The mouse is only considered to be "entered" in one region at a time; in the case of nested regions, it exits the outer region before entering the inner one.
Reimplemented in PGMouseWatcherRegion.
Definition at line 72 of file mouseWatcherRegion.cxx.

void MouseWatcherRegion::exit ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever the mouse exits the region.
The mouse is only considered to be "entered" in one region at a time; in the case of nested regions, it exits the outer region before entering the inner one.
Reimplemented in PGMouseWatcherRegion.
Definition at line 92 of file mouseWatcherRegion.cxx.

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

Reimplemented from TypedReferenceCount.
Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 117 of file mouseWatcherRegion.h.

bool MouseWatcherRegion::get_active ( void ) const [inline]

Returns whether the region is active or not.
See set_active().
Definition at line 182 of file mouseWatcherRegion.I.
References _flags, F_suppress_flags, and INLINE.

float MouseWatcherRegion::get_area ( ) const [inline]

Returns the area of the rectangular region.

Definition at line 102 of file mouseWatcherRegion.I.
References _sort.

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

Reimplemented from Namable.
Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 104 of file mouseWatcherRegion.h.

const LVecBase4f & MouseWatcherRegion::get_frame ( ) const [inline]

Definition at line 89 of file mouseWatcherRegion.I.
References INLINE.

bool MouseWatcherRegion::get_keyboard ( ) const [inline]

Returns whether the region is interested in global keyboard events; see set_keyboard().

Definition at line 224 of file mouseWatcherRegion.I.
Referenced by MouseWatcher::press().

const string & Namable::get_name ( ) const [inline, inherited]

Definition at line 109 of file namable.I.
Referenced by ComputedVerticesMaker::add_normal(), GLGraphicsStateGuardian::begin_bind_clip_planes(), GLGraphicsStateGuardian::begin_bind_lights(), BuilderBucket::BuilderBucket(), EggVertex::clear_grefs(), AnimBundleMaker::create_xfm_channel(), SceneGraphReducer::do_flatten_siblings(), BuilderBucket::done_geom(), DXTextureContext8::DXTextureContext8(), PartGroup::find_child(), EggLoader::find_collision_geometry(), EggGroupUniquifier::get_category(), PartBundle::get_control_effect(), PartGroup::get_num_children(), EggMorph< Parameter >::get_offset(), AnimChannelBase::has_changed(), Namable::has_name(), EggMaterial::is_equivalent_to(), Texture::load(), EggLoader::make_node(), AnimBundleMaker::make_node(), FindApproxPath::Component::matches(), LineSegs::move_to(), MovingPartBase::MovingPartBase(), NodeMap::NodeMap(), EggMorph< Parameter >::operator<(), operator<<(), output(), AnimGroup::output(), EggXfmSAnim::r_transform(), Texture::read(), MouseWatcherGroup::remove_region(), EggLoader::reparent_decals(), CRGraphicsStateGuardian::set_blend_mode(), NodePath::set_color(), GLGraphicsStateGuardian::set_draw_buffer(), AnimChannelScalarTable::set_table(), NodePath::set_transparency(), NodePathComponent::uncollapse(), Texture::unprepare(), TextNode::wordwrap_to(), MovingPartBase::write(), CollisionNode::xform(), and EggVertex::~EggVertex().

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

int MouseWatcherRegion::get_sort ( ) const [inline]

Returns the current sorting order of this region.
See set_sort().
Definition at line 142 of file mouseWatcherRegion.I.
References _flags, and F_active.

int MouseWatcherRegion::get_suppress_flags ( ) const [inline]

Returns the current suppress_flags.
See set_suppress_flags().
Definition at line 268 of file mouseWatcherRegion.I.

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

Reimplemented from TypedReferenceCount.
Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 114 of file mouseWatcherRegion.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.

bool Namable::has_name ( ) const [inline, inherited]

Returns true if the Namable has a nonempty name set, false if the name is empty.

Definition at line 97 of file namable.I.
References Namable::get_name(), and INLINE.
Referenced by EggGroupUniquifier::EggGroupUniquifier(), Texture::read(), and Texture::Texture().

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

Reimplemented from Namable.
Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 107 of file mouseWatcherRegion.h.
References Namable::get_class_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().

void MouseWatcherRegion::keystroke ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever a keystroke is generated by the user.

Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 176 of file mouseWatcherRegion.cxx.
Referenced by MouseWatcher::press().

bool MouseWatcherRegion::operator< ( const MouseWatcherRegion & other ) const [inline]

Returns true if this region should be preferred over the other region when they overlap, false otherwise.

Definition at line 283 of file mouseWatcherRegion.I.

void MouseWatcherRegion::output ( ostream & out ) const

Outputs the Namable.
This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.
Reimplemented from Namable.
Definition at line 37 of file mouseWatcherRegion.cxx.
References _frame, _sort, Namable::get_name(), and indent().

void MouseWatcherRegion::press ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever a mouse or keyboard button is depressed while the mouse is within the region.

Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 146 of file mouseWatcherRegion.cxx.
Referenced by MouseWatcher::release().

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 MouseWatcherRegion::release ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released.

Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 162 of file mouseWatcherRegion.cxx.

void MouseWatcherRegion::set_active ( bool active ) [inline]

Sets whether the region is active or not.
If it is not active, the MouseWatcher will never consider the mouse to be over the region. The region might still receive keypress events if its set_keyboard() flag is true.
Definition at line 163 of file mouseWatcherRegion.I.

void MouseWatcherRegion::set_frame ( const LVecBase4f & frame ) [inline]

Definition at line 76 of file mouseWatcherRegion.I.
References _frame.

void MouseWatcherRegion::set_frame ( float left,

float right,

float bottom,

float top

) [inline]

Definition at line 64 of file mouseWatcherRegion.I.
References _area, _frame, and INLINE.
Referenced by MouseWatcherRegion().

void MouseWatcherRegion::set_keyboard ( bool keyboard ) [inline]

Sets whether the region is interested in global keyboard events.
If this is true, then any keyboard button events will be passed to press() and release() regardless of the position of the mouse onscreen; otherwise, these events will only be passed if the mouse is over the region.
Definition at line 205 of file mouseWatcherRegion.I.
References _area, _sort, and INLINE.

void Namable::set_name ( const string & name ) [inline, inherited]

Definition at line 69 of file namable.I.
References Namable::_name.
Referenced by BuilderBucket::BuilderBucket(), SceneGraphReducer::do_flatten_siblings(), Texture::read(), PandaNode::reparent(), and Texture::Texture().

void MouseWatcherRegion::set_sort ( int sort ) [inline]

Changes the sorting order of this particular region.
The sorting order is used to resolve conflicts in the case of overlapping region; the region with the highest sort value will be preferred, and between regions of the same sort value, the smallest region will be preferred. The default sorting order, if none is explicitly specified, is 0.
Definition at line 127 of file mouseWatcherRegion.I.
References _flags, and F_active.

void MouseWatcherRegion::set_suppress_flags ( int suppress_flags ) [inline]

Sets which events are suppressed when the mouse is over the region.
This is the union of zero or more various SF_* values. Normally, this is 0, indicating that no events are suppressed.
If you set this to a non-zero value, for instance SF_mouse_position, then the mouse position will not be sent along the data graph when the mouse is over this particular region.
Definition at line 253 of file mouseWatcherRegion.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 MouseWatcherRegion::within ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region.
This is different from "enter", which is only called whenever the mouse is within only that region.
Reimplemented in PGMouseWatcherRegion.
Definition at line 114 of file mouseWatcherRegion.cxx.

void MouseWatcherRegion::without ( const MouseWatcherParameter & param ) [virtual]

This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.
See within().
Reimplemented in PGMouseWatcherRegion.
Definition at line 130 of file mouseWatcherRegion.cxx.

void MouseWatcherRegion::write ( ostream & out,

int indent_level = 0

) const

Definition at line 49 of file mouseWatcherRegion.cxx.

Member Data Documentation

float MouseWatcherRegion::_area [private]

Definition at line 90 of file mouseWatcherRegion.h.
Referenced by set_frame(), and set_keyboard().

int MouseWatcherRegion::_flags [private]

Definition at line 100 of file mouseWatcherRegion.h.
Referenced by get_active(), get_sort(), and set_sort().

LVecBase4f MouseWatcherRegion::_frame [private]

Definition at line 89 of file mouseWatcherRegion.h.
Referenced by output(), and set_frame().

ModifierButtons MouseWatcherRegion::_mods [private]

Definition at line 101 of file mouseWatcherRegion.h.

int MouseWatcherRegion::_sort [private]

Definition at line 91 of file mouseWatcherRegion.h.
Referenced by get_area(), output(), and set_keyboard().

TypeHandle MouseWatcherRegion::_type_handle [static, private]

Reimplemented from Namable.
Reimplemented in PGMouseWatcherBackground, and PGMouseWatcherRegion.
Definition at line 27 of file mouseWatcherRegion.cxx.

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

panda/src/tform/mouseWatcherRegion.h
panda/src/tform/mouseWatcherRegion.cxx
panda/src/tform/mouseWatcherRegion.I

Generated on Fri May 2 00:52:23 2003 for Panda by

1.3

MouseWatcherRegion Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation