Panda3D
|
This is the class that defines a rectangular region on the screen for the MouseWatcher. More...
#include "mouseWatcherRegion.h"
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, PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top) | |
MouseWatcherRegion (const string &name, const LVecBase4 &frame) | |
virtual void | candidate (const MouseWatcherParameter ¶m) |
This is a callback hook function, called whenever an IME candidate is highlighted by the user. More... | |
virtual void | enter_region (const MouseWatcherParameter ¶m) |
This is a callback hook function, called whenever the mouse enters the region. More... | |
virtual void | exit_region (const MouseWatcherParameter ¶m) |
This is a callback hook function, called whenever the mouse exits the region. More... | |
virtual TypeHandle | force_init_type () |
bool | get_active () const |
Returns whether the region is active or not. More... | |
PN_stdfloat | get_area () const |
Returns the area of the rectangular region. More... | |
const LVecBase4 & | get_frame () const |
bool | get_keyboard () const |
Returns whether the region is interested in global keyboard events; see set_keyboard(). More... | |
int | get_sort () const |
Returns the current sorting order of this region. More... | |
int | get_suppress_flags () const |
Returns the current suppress_flags. More... | |
virtual TypeHandle | get_type () const |
virtual void | keystroke (const MouseWatcherParameter ¶m) |
This is a callback hook function, called whenever a keystroke is generated by the user. More... | |
virtual void | move (const MouseWatcherParameter ¶m) |
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 (ostream &out) const |
virtual void | press (const MouseWatcherParameter ¶m) |
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 ¶m) |
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) |
Sets whether the region is active or not. More... | |
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) |
Sets whether the region is interested in global keyboard events. More... | |
void | set_sort (int sort) |
Changes the sorting order of this particular region. More... | |
void | set_suppress_flags (int suppress_flags) |
Sets which events are suppressed when the mouse is over the region. More... | |
virtual void | within_region (const MouseWatcherParameter ¶m) |
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 ¶m) |
This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region. More... | |
void | write (ostream &out, int indent_level=0) const |
![]() | |
TypedWritableReferenceCount (const TypedWritableReferenceCount ©) | |
virtual ReferenceCount * | as_reference_count () |
Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More... | |
void | operator= (const TypedWritableReferenceCount ©) |
![]() | |
TypedWritable (const TypedWritable ©) | |
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... | |
string | encode_to_bam_stream () const |
Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. More... | |
bool | encode_to_bam_stream (string &data, BamWriter *writer=NULL) 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 ©) |
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... | |
![]() | |
TypedObject (const TypedObject ©) | |
TypedObject * | as_typed_object () |
Returns the object, upcast (if necessary) to a TypedObject pointer. More... | |
const TypedObject * | as_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... | |
void | operator= (const TypedObject ©) |
![]() | |
int | get_ref_count () const |
Returns the current reference count. More... | |
WeakReferenceList * | get_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 | 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... | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. More... | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. More... | |
![]() | |
Namable (const string &initial_name="") | |
Namable (const Namable ©) | |
void | clear_name () |
Resets the Namable's name to empty. More... | |
const 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... | |
Namable & | operator= (const Namable &other) |
void | output (ostream &out) const |
Outputs the Namable. More... | |
void | set_name (const string &name) |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(const string &data |
![]() | |
static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, const string &data, BamReader *reader=NULL) |
Reads the string created by a previous call to encode_to_bam_stream(), and extracts the single object on that string. More... | |
static TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
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 TypeHandle | get_class_type () |
static void | init_type () |
![]() | |
static TypeHandle | get_class_type () |
static void | init_type () |
Additional Inherited Members | |
![]() | |
static BamReader * | reader = NULL) |
![]() | |
static TypedWritable *const | Null = (TypedWritable*)0L |
This is the class that defines a rectangular region on the screen for the MouseWatcher.
Definition at line 33 of file mouseWatcherRegion.h.
|
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 134 of file mouseWatcherRegion.cxx.
References move().
Referenced by keystroke(), and MouseWatcher::note_activity().
|
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 54 of file mouseWatcherRegion.cxx.
References exit_region().
Referenced by MouseWatcher::note_activity().
|
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 67 of file mouseWatcherRegion.cxx.
References within_region().
Referenced by enter_region(), and MouseWatcher::note_activity().
|
inline |
Returns whether the region is active or not.
See set_active().
Definition at line 138 of file mouseWatcherRegion.I.
References set_keyboard().
Referenced by MouseWatcher::note_activity(), and set_active().
|
inline |
Returns the area of the rectangular region.
Definition at line 82 of file mouseWatcherRegion.I.
References set_sort().
|
inline |
Returns whether the region is interested in global keyboard events; see set_keyboard().
Definition at line 168 of file mouseWatcherRegion.I.
References set_suppress_flags().
Referenced by MouseWatcher::note_activity(), and set_keyboard().
|
inline |
Returns the current sorting order of this region.
See set_sort().
Definition at line 109 of file mouseWatcherRegion.I.
References set_active().
Referenced by set_sort().
|
inline |
Returns the current suppress_flags.
See set_suppress_flags().
Definition at line 197 of file mouseWatcherRegion.I.
References operator<().
Referenced by MouseWatcher::note_activity(), and set_suppress_flags().
|
virtual |
This is a callback hook function, called whenever a keystroke is generated by the user.
Reimplemented in PGMouseWatcherRegion, and PGMouseWatcherBackground.
Definition at line 124 of file mouseWatcherRegion.cxx.
References candidate().
Referenced by MouseWatcher::note_activity(), and release().
|
virtual |
This is a callback hook function, called whenever a mouse is moved within the region.
Reimplemented in PGMouseWatcherRegion.
Definition at line 144 of file mouseWatcherRegion.cxx.
Referenced by candidate().
|
inline |
Returns true if this region should be preferred over the other region when they overlap, false otherwise.
Definition at line 208 of file mouseWatcherRegion.I.
Referenced by get_suppress_flags().
|
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 103 of file mouseWatcherRegion.cxx.
References release().
Referenced by MouseWatcher::note_activity(), and without_region().
|
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 114 of file mouseWatcherRegion.cxx.
References keystroke().
Referenced by MouseWatcher::note_activity(), and press().
|
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 123 of file mouseWatcherRegion.I.
References get_active().
Referenced by get_sort().
|
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 153 of file mouseWatcherRegion.I.
References get_keyboard().
Referenced by get_active().
|
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 98 of file mouseWatcherRegion.I.
References get_sort().
Referenced by get_area().
|
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 186 of file mouseWatcherRegion.I.
References get_suppress_flags().
Referenced by get_keyboard().
|
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 81 of file mouseWatcherRegion.cxx.
References without_region().
Referenced by exit_region(), and MouseWatcher::get_inactivity_timeout_event().
|
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 92 of file mouseWatcherRegion.cxx.
References press().
Referenced by MouseWatcher::get_inactivity_timeout_event(), and within_region().