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

PGMouseWatcherRegion Class Reference

This is a specialization on MouseWatcherRegion, to add a bit more fields that are relevant to the PG system. More...

#include <pgMouseWatcherRegion.h>

Inheritance diagram for PGMouseWatcherRegion:

MouseWatcherRegion TypedReferenceCount Namable TypedObject ReferenceCount List of all members.

Public Types

enum  SuppressFlags { SF_mouse_button = 0x001, SF_other_button = 0x002, SF_any_button = 0x003, SF_mouse_position = 0x004 }

Public Member Functions

 PGMouseWatcherRegion (PGItem *item)
virtual ~PGMouseWatcherRegion ()
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 the user presses a key.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
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.

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 Attributes

PGItem * _item

Static Private Attributes

int _next_index = 0
TypeHandle _type_handle

Friends

class PGItem

Detailed Description

This is a specialization on MouseWatcherRegion, to add a bit more fields that are relevant to the PG system.

Each PGItem corresponds to exactly one PGMouseWatcherRegion.

Definition at line 44 of file pgMouseWatcherRegion.h.

Member Enumeration Documentation

enum MouseWatcherRegion::SuppressFlags [inherited]
 

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

PGMouseWatcherRegion::PGMouseWatcherRegion (  PGItem *  item  ) 
 

Definition at line 39 of file pgMouseWatcherRegion.cxx.

PGMouseWatcherRegion::~PGMouseWatcherRegion (   )  [virtual]
 

Definition at line 56 of file pgMouseWatcherRegion.cxx.

References _item, PGItem::enter(), and NULL.

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 PGMouseWatcherRegion::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 from MouseWatcherRegion.

Definition at line 77 of file pgMouseWatcherRegion.cxx.

References _item, PGItem::exit(), and NULL.

void PGMouseWatcherRegion::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 from MouseWatcherRegion.

Definition at line 100 of file pgMouseWatcherRegion.cxx.

References _item, NULL, and PGItem::without().

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

Reimplemented from MouseWatcherRegion.

Definition at line 73 of file pgMouseWatcherRegion.h.

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

Returns whether the region is active or not.

See set_active().

Definition at line 182 of file mouseWatcherRegion.I.

References MouseWatcherRegion::_flags, MouseWatcherRegion::F_suppress_flags, and INLINE.

float MouseWatcherRegion::get_area (   )  const [inline, inherited]
 

Returns the area of the rectangular region.

Definition at line 102 of file mouseWatcherRegion.I.

References MouseWatcherRegion::_sort.

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

Reimplemented from MouseWatcherRegion.

Definition at line 62 of file pgMouseWatcherRegion.h.

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

Definition at line 89 of file mouseWatcherRegion.I.

References INLINE.

bool MouseWatcherRegion::get_keyboard (   )  const [inline, inherited]
 

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<<(), MouseWatcherRegion::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, inherited]
 

Returns the current sorting order of this region.

See set_sort().

Definition at line 142 of file mouseWatcherRegion.I.

References MouseWatcherRegion::_flags, and MouseWatcherRegion::F_active.

int MouseWatcherRegion::get_suppress_flags (   )  const [inline, inherited]
 

Returns the current suppress_flags.

See set_suppress_flags().

Definition at line 268 of file mouseWatcherRegion.I.

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

Reimplemented from MouseWatcherRegion.

Definition at line 70 of file pgMouseWatcherRegion.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 PGMouseWatcherRegion::init_type (  void   )  [inline, static]
 

Reimplemented from MouseWatcherRegion.

Definition at line 65 of file pgMouseWatcherRegion.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().

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

This is a callback hook function, called whenever the user presses a key.

Reimplemented from MouseWatcherRegion.

Definition at line 199 of file pgMouseWatcherRegion.cxx.

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

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

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 MouseWatcherRegion::_frame, MouseWatcherRegion::_sort, Namable::get_name(), and indent().

void PGMouseWatcherRegion::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 from MouseWatcherRegion.

Definition at line 163 of file pgMouseWatcherRegion.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 PGMouseWatcherRegion::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 from MouseWatcherRegion.

Definition at line 182 of file pgMouseWatcherRegion.cxx.

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

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

Definition at line 76 of file mouseWatcherRegion.I.

References MouseWatcherRegion::_frame.

void MouseWatcherRegion::set_frame (  float  left,
float  right,
float  bottom,
float  top
)  [inline, inherited]
 

Definition at line 64 of file mouseWatcherRegion.I.

References MouseWatcherRegion::_area, MouseWatcherRegion::_frame, and INLINE.

Referenced by MouseWatcherRegion::MouseWatcherRegion().

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

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 MouseWatcherRegion::_area, MouseWatcherRegion::_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, inherited]
 

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 MouseWatcherRegion::_flags, and MouseWatcherRegion::F_active.

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

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 PGMouseWatcherRegion::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 from MouseWatcherRegion.

Definition at line 125 of file pgMouseWatcherRegion.cxx.

void PGMouseWatcherRegion::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 from MouseWatcherRegion.

Definition at line 144 of file pgMouseWatcherRegion.cxx.

References _item, PGItem::keystroke(), and NULL.

void MouseWatcherRegion::write (  ostream &  out,
int  indent_level = 0
)  const [inherited]
 

Definition at line 49 of file mouseWatcherRegion.cxx.

Friends And Related Function Documentation

friend class PGItem [friend]
 

Definition at line 78 of file pgMouseWatcherRegion.h.

Member Data Documentation

PGItem* PGMouseWatcherRegion::_item [private]
 

Definition at line 58 of file pgMouseWatcherRegion.h.

Referenced by enter(), exit(), without(), and ~PGMouseWatcherRegion().

int PGMouseWatcherRegion::_next_index = 0 [static, private]
 

Definition at line 27 of file pgMouseWatcherRegion.cxx.

TypeHandle PGMouseWatcherRegion::_type_handle [static, private]
 

Reimplemented from MouseWatcherRegion.

Definition at line 28 of file pgMouseWatcherRegion.cxx.

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:53:29 2003 for Panda by doxygen1.3