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

PGMouseWatcherParameter Class Reference

This specialization on MouseWatcherParameter allows us to tag on additional elements to events for the gui system, and also inherits from TypedReferenceCount so we can attach this thing to an event. More...

#include <pgMouseWatcherParameter.h>

Inheritance diagram for PGMouseWatcherParameter:

List of all members.


Public Types
enum	Flags { F_has_button = 0x001, F_has_mouse = 0x002, F_is_outside = 0x004, F_has_keycode = 0x008 }
Public Member Functions
	PGMouseWatcherParameter ()
	PGMouseWatcherParameter (const MouseWatcherParameter &copy)
void	operator= (const MouseWatcherParameter &copy)
virtual	~PGMouseWatcherParameter ()
void	output (ostream &out) const
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_button (const ButtonHandle &button)
	Sets the mouse or keyboard button that generated this event, if any.
void	set_keycode (int keycode)
	Sets the keycode associated with this event, if any.
void	set_modifier_buttons (const ModifierButtons &mods)
	Sets the modifier buttons that were being held while this event was generated.
void	set_mouse (const LPoint2f &mouse)
	Sets the mouse position that was current at the time the event was generated.
void	set_outside (bool flag)
	Sets the state of the "outside" flag.
bool	has_button () const
	Returns true if this parameter has an associated mouse or keyboard button, false otherwise.
ButtonHandle	get_button () const
	Returns the mouse or keyboard button associated with this event.
bool	has_keycode () const
	Returns true if this parameter has an associated keycode, false otherwise.
int	get_keycode () const
	Returns the keycode associated with this event.
const ModifierButtons &	get_modifier_buttons () const
	Returns the set of modifier buttons that were being held down while the event was generated.
bool	has_mouse () const
	Returns true if this parameter has an associated mouse position, false otherwise.
const LPoint2f &	get_mouse () const
	Returns the mouse position at the time the event was generated, in the normalized range (-1 ..
bool	is_outside () const
	Returns true if the mouse was outside the region at the time the event was generated, false otherwise.
Static Public Member Functions
TypeHandle	get_class_type ()
void	init_type ()
Public Attributes
ButtonHandle	_button
short	_keycode
ModifierButtons	_mods
LPoint2f	_mouse
int	_flags
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

This specialization on MouseWatcherParameter allows us to tag on additional elements to events for the gui system, and also inherits from TypedReferenceCount so we can attach this thing to an event.

Definition at line 45 of file pgMouseWatcherParameter.h.

Member Enumeration Documentation

enum MouseWatcherParameter::Flags [inherited]

Enumeration values:

F_has_button

F_has_mouse

F_is_outside

F_has_keycode

Definition at line 77 of file mouseWatcherParameter.h.

Constructor & Destructor Documentation

PGMouseWatcherParameter::PGMouseWatcherParameter ( ) [inline]

Definition at line 32 of file pgMouseWatcherParameter.I.
References INLINE.

PGMouseWatcherParameter::PGMouseWatcherParameter ( const MouseWatcherParameter & copy ) [inline]

Definition at line 44 of file pgMouseWatcherParameter.I.
References INLINE, and MouseWatcherParameter::operator=().

PGMouseWatcherParameter::~PGMouseWatcherParameter ( ) [virtual]

Definition at line 35 of file pgMouseWatcherParameter.cxx.
References MouseWatcherParameter::output().

Member Function Documentation

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

Reimplemented from TypedReferenceCount.
Definition at line 72 of file pgMouseWatcherParameter.h.

ButtonHandle MouseWatcherParameter::get_button ( ) const [inline, inherited]

Returns the mouse or keyboard button associated with this event.
If has_button(), above, returns false, this returns ButtonHandle::none().
Definition at line 195 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_flags, and MouseWatcherParameter::F_has_mouse.
Referenced by PGButton::enter(), PGItem::exit(), and PGButton::exit().

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

Reimplemented from TypedReferenceCount.
Definition at line 61 of file pgMouseWatcherParameter.h.

int MouseWatcherParameter::get_keycode ( ) const [inline, inherited]

Returns the keycode associated with this event.
If has_keycode(), above, returns false, this returns 0.
Definition at line 225 of file mouseWatcherParameter.I.

const ModifierButtons & MouseWatcherParameter::get_modifier_buttons ( ) const [inline, inherited]

Returns the set of modifier buttons that were being held down while the event was generated.

Definition at line 240 of file mouseWatcherParameter.I.

const LPoint2f & MouseWatcherParameter::get_mouse ( ) const [inline, inherited]

Returns the mouse position at the time the event was generated, in the normalized range (-1 ..
1). It is valid to call this only if has_mouse() returned true.
Definition at line 272 of file mouseWatcherParameter.I.

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

Reimplemented from TypedReferenceCount.
Definition at line 69 of file pgMouseWatcherParameter.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 MouseWatcherParameter::has_button ( ) const [inline, inherited]

Returns true if this parameter has an associated mouse or keyboard button, false otherwise.

Definition at line 178 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_mods, and INLINE.

bool MouseWatcherParameter::has_keycode ( ) const [inline, inherited]

Returns true if this parameter has an associated keycode, false otherwise.

Definition at line 210 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_flags, MouseWatcherParameter::F_is_outside, and INLINE.

bool MouseWatcherParameter::has_mouse ( ) const [inline, inherited]

Returns true if this parameter has an associated mouse position, false otherwise.

Definition at line 255 of file mouseWatcherParameter.I.

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

Reimplemented from TypedReferenceCount.
Definition at line 64 of file pgMouseWatcherParameter.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().

bool MouseWatcherParameter::is_outside ( ) const [inline, inherited]

Returns true if the mouse was outside the region at the time the event was generated, false otherwise.
This is only valid for "release" type events.
Definition at line 290 of file mouseWatcherParameter.I.
Referenced by PGButton::exit().

void PGMouseWatcherParameter::operator= ( const MouseWatcherParameter & copy ) [inline]

Reimplemented from MouseWatcherParameter.
Definition at line 58 of file pgMouseWatcherParameter.I.

void PGMouseWatcherParameter::output ( ostream & out ) const

Reimplemented from MouseWatcherParameter.
Definition at line 47 of file pgMouseWatcherParameter.cxx.

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 MouseWatcherParameter::set_button ( const ButtonHandle & button ) [inline, inherited]

Sets the mouse or keyboard button that generated this event, if any.

Definition at line 94 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_mods, and INLINE.

void MouseWatcherParameter::set_keycode ( int keycode ) [inline, inherited]

Sets the keycode associated with this event, if any.

Definition at line 108 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_flags, MouseWatcherParameter::_mouse, MouseWatcherParameter::F_has_mouse, and INLINE.
Referenced by MouseWatcher::press().

void MouseWatcherParameter::set_modifier_buttons ( const ModifierButtons & mods ) [inline, inherited]

Sets the modifier buttons that were being held while this event was generated.

Definition at line 124 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_flags, and MouseWatcherParameter::F_is_outside.
Referenced by MouseWatcher::press().

void MouseWatcherParameter::set_mouse ( const LPoint2f & mouse ) [inline, inherited]

Sets the mouse position that was current at the time the event was generated.

Definition at line 139 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_flags, and MouseWatcherParameter::F_has_button.
Referenced by MouseWatcher::press().

void MouseWatcherParameter::set_outside ( bool flag ) [inline, inherited]

Sets the state of the "outside" flag.
This is true if the mouse was outside the region at the time the event was generated, false otherwise. This only has meaning for "release" events.
Definition at line 159 of file mouseWatcherParameter.I.
References MouseWatcherParameter::_flags, MouseWatcherParameter::F_has_keycode, and INLINE.
Referenced by MouseWatcher::press().

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

ButtonHandle MouseWatcherParameter::_button [inherited]

Definition at line 72 of file mouseWatcherParameter.h.
Referenced by MouseWatcherParameter::MouseWatcherParameter().

int MouseWatcherParameter::_flags [inherited]

Definition at line 83 of file mouseWatcherParameter.h.
Referenced by MouseWatcherParameter::get_button(), MouseWatcherParameter::has_keycode(), MouseWatcherParameter::MouseWatcherParameter(), MouseWatcherParameter::set_keycode(), MouseWatcherParameter::set_modifier_buttons(), MouseWatcherParameter::set_mouse(), MouseWatcherParameter::set_outside(), and MouseWatcherParameter::~MouseWatcherParameter().

short MouseWatcherParameter::_keycode [inherited]

Definition at line 73 of file mouseWatcherParameter.h.
Referenced by MouseWatcherParameter::MouseWatcherParameter(), and MouseWatcherParameter::~MouseWatcherParameter().

ModifierButtons MouseWatcherParameter::_mods [inherited]

Definition at line 74 of file mouseWatcherParameter.h.
Referenced by MouseWatcherParameter::has_button(), MouseWatcherParameter::MouseWatcherParameter(), and MouseWatcherParameter::set_button().

LPoint2f MouseWatcherParameter::_mouse [inherited]

Definition at line 75 of file mouseWatcherParameter.h.
Referenced by MouseWatcherParameter::MouseWatcherParameter(), and MouseWatcherParameter::set_keycode().

TypeHandle PGMouseWatcherParameter::_type_handle [static, private]

Reimplemented from TypedReferenceCount.
Definition at line 24 of file pgMouseWatcherParameter.cxx.

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

panda/src/pgui/pgMouseWatcherParameter.h
panda/src/pgui/pgMouseWatcherParameter.cxx
panda/src/pgui/pgMouseWatcherParameter.I

Generated on Fri May 2 00:53:28 2003 for Panda by

1.3

PGMouseWatcherParameter Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation