Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all 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:
TypedWritableReferenceCount Namable TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase PGMouseWatcherBackground PGMouseWatcherRegion

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 std::string &name, PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 
 MouseWatcherRegion (const std::string &name, const LVecBase4 &frame)
 
virtual void candidate (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever an IME candidate is highlighted by the user. More...
 
virtual void enter_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse enters the region. More...
 
virtual void exit_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse exits the region. More...
 
virtual TypeHandle force_init_type ()
 
bool get_active () const
 
PN_stdfloat get_area () const
 
const LVecBase4 & get_frame () const
 
bool get_keyboard () const
 
int get_sort () const
 
int get_suppress_flags () const
 
virtual TypeHandle get_type () const
 
virtual void keystroke (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever a keystroke is generated by the user. More...
 
virtual void move (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever a mouse is moved within the region. More...
 
bool operator< (const MouseWatcherRegion &other) const
 Returns true if this region should be preferred over the other region when they overlap, false otherwise. More...
 
void output (std::ostream &out) const
 
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. More...
 
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. More...
 
void set_active (bool active)
 
void set_frame (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 
void set_frame (const LVecBase4 &frame)
 
void set_keyboard (bool keyboard)
 
void set_sort (int sort)
 
void set_suppress_flags (int suppress_flags)
 
virtual void within_region (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. More...
 
virtual void without_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region. More...
 
void write (std::ostream &out, int indent_level=0) const
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
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(). More...
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual 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. More...
 
virtual void finalize (BamReader *manager)
 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. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const std::string &initial_name="")
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const std::string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
void output (std::ostream &out) const
 Outputs the Namable. More...
 
void set_name (const std::string &name)
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_active
 Returns whether the region is active or not. More...
 
 get_area
 Returns the area of the rectangular region. More...
 
 get_frame
 
 get_keyboard
 Returns whether the region is interested in global keyboard events; see set_keyboard(). More...
 
 get_sort
 Returns the current sorting order of this region. More...
 
 get_suppress_flags
 Returns the current suppress_flags. More...
 
 set_active
 Sets whether the region is active or not. More...
 
 set_frame
 
 set_keyboard
 Sets whether the region is interested in global keyboard events. More...
 
 set_sort
 Changes the sorting order of this particular region. More...
 
 set_suppress_flags
 Sets which events are suppressed when the mouse is over the region. More...
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from Namable
 get_name
 
 set_name
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

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

Definition at line 31 of file mouseWatcherRegion.h.

Member Function Documentation

◆ candidate()

void MouseWatcherRegion::candidate ( const MouseWatcherParameter param)
virtual

This is a callback hook function, called whenever an IME candidate is highlighted by the user.

Reimplemented in PGMouseWatcherRegion, and PGMouseWatcherBackground.

Definition at line 106 of file mouseWatcherRegion.cxx.

◆ enter_region()

void MouseWatcherRegion::enter_region ( 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 46 of file mouseWatcherRegion.cxx.

◆ exit_region()

void MouseWatcherRegion::exit_region ( 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 56 of file mouseWatcherRegion.cxx.

◆ keystroke()

void MouseWatcherRegion::keystroke ( const MouseWatcherParameter param)
virtual

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

Reimplemented in PGMouseWatcherRegion, and PGMouseWatcherBackground.

Definition at line 98 of file mouseWatcherRegion.cxx.

◆ move()

void MouseWatcherRegion::move ( const MouseWatcherParameter param)
virtual

This is a callback hook function, called whenever a mouse is moved within the region.

Reimplemented in PGMouseWatcherRegion.

Definition at line 114 of file mouseWatcherRegion.cxx.

◆ operator<()

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 166 of file mouseWatcherRegion.I.

◆ press()

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 PGMouseWatcherRegion, and PGMouseWatcherBackground.

Definition at line 82 of file mouseWatcherRegion.cxx.

◆ release()

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 PGMouseWatcherRegion, and PGMouseWatcherBackground.

Definition at line 90 of file mouseWatcherRegion.cxx.

◆ within_region()

void MouseWatcherRegion::within_region ( 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 66 of file mouseWatcherRegion.cxx.

◆ without_region()

void MouseWatcherRegion::without_region ( const MouseWatcherParameter param)
virtual

This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.

See within_region().

Reimplemented in PGMouseWatcherRegion.

Definition at line 74 of file mouseWatcherRegion.cxx.

Member Data Documentation

◆ get_active

bool MouseWatcherRegion::get_active
inline

Returns whether the region is active or not.

See set_active().

Definition at line 69 of file mouseWatcherRegion.h.

◆ get_area

PN_stdfloat MouseWatcherRegion::get_area
inline

Returns the area of the rectangular region.

Definition at line 66 of file mouseWatcherRegion.h.

◆ get_keyboard

bool MouseWatcherRegion::get_keyboard
inline

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

Definition at line 70 of file mouseWatcherRegion.h.

◆ get_sort

int MouseWatcherRegion::get_sort
inline

Returns the current sorting order of this region.

See set_sort().

Definition at line 68 of file mouseWatcherRegion.h.

◆ get_suppress_flags

int MouseWatcherRegion::get_suppress_flags
inline

Returns the current suppress_flags.

See set_suppress_flags().

Definition at line 71 of file mouseWatcherRegion.h.

◆ set_active

void MouseWatcherRegion::set_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 69 of file mouseWatcherRegion.h.

◆ set_keyboard

void MouseWatcherRegion::set_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 70 of file mouseWatcherRegion.h.

◆ set_sort

void MouseWatcherRegion::set_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 68 of file mouseWatcherRegion.h.

◆ set_suppress_flags

void MouseWatcherRegion::set_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 71 of file mouseWatcherRegion.h.


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