Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MouseWatcher Class Reference

This TFormer maintains a list of rectangular regions on the screen that are considered special mouse regions; typically these will be click buttons. More...

#include "mouseWatcher.h"

Inheritance diagram for MouseWatcher:
DataNode MouseWatcherBase PandaNode TypedWritableReferenceCount Namable LinkedListNode TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase

Public Member Functions

 MouseWatcher (const std::string &name="")
 
bool add_group (MouseWatcherGroup *group)
 Adds the indicated group of regions to the set of regions the MouseWatcher will monitor each frame. More...
 
void clear_display_region ()
 Removes the display region constraint from the MouseWatcher, and restores it to the default behavior of watching the whole window. More...
 
void clear_geometry ()
 Stops the use of the software cursor set up via set_geometry(). More...
 
void clear_inactivity_timeout ()
 Removes the inactivity timeout and restores the MouseWatcher to its default behavior of allowing a key to be held indefinitely. More...
 
void clear_trail_log ()
 Clears the mouse trail log. More...
 
void clear_trail_node ()
 If you have previously fetched the trail node using get_trail_node, then the MouseWatcher is continually updating the trail node every frame. More...
 
 CPT (PointerEventList) get_trail_log() const
 
virtual TypeHandle force_init_type ()
 
const std::string & get_button_down_pattern () const
 Returns the string that indicates how event names are generated when a button is depressed. More...
 
const std::string & get_button_repeat_pattern () const
 Returns the string that indicates how event names are names are generated when a button is continuously held and generates keyrepeat "down" events. More...
 
const std::string & get_button_up_pattern () const
 Returns the string that indicates how event names are generated when a button is released. More...
 
DisplayRegionget_display_region () const
 Returns the display region the MouseWatcher is constrained to by set_display_region(), or NULL if it is not constrained. More...
 
const std::string & get_enter_pattern () const
 Returns the string that indicates how event names are generated when the mouse enters a region. More...
 
EventHandlerget_extra_handler () const
 As an optimization for the C++ Gui, an extra handler can be registered with a mouseWatcher so that events can be dealt with much sooner. More...
 
const LVecBase4 & get_frame () const
 Returns the frame of the MouseWatcher. More...
 
PandaNodeget_geometry () const
 Returns the node that has been set as the software mouse pointer, or NULL if no node has been set. More...
 
MouseWatcherGroupget_group (int n) const
 
double get_inactivity_timeout () const
 Returns the inactivity timeout that has been set. More...
 
const std::string & get_inactivity_timeout_event () const
 Returns the event string that will be generated when the inactivity timeout counter expires. More...
 
const std::string & get_leave_pattern () const
 Returns the string that indicates how event names are generated when the mouse leaves a region. More...
 
ModifierButtons get_modifier_buttons () const
 Returns the set of buttons that are being monitored as modifier buttons, as well as their current state. More...
 
const LPoint2 & get_mouse () const
 It is only valid to call this if has_mouse() returns true. More...
 
PN_stdfloat get_mouse_x () const
 It is only valid to call this if has_mouse() returns true. More...
 
PN_stdfloat get_mouse_y () const
 It is only valid to call this if has_mouse() returns true. More...
 
int get_num_groups () const
 
MouseWatcherRegionget_over_region () const
 Returns the smallest region the mouse is currently over, or NULL if it is over no region. More...
 
MouseWatcherRegionget_over_region (PN_stdfloat x, PN_stdfloat y) const
 Returns the smallest region the indicated point is over, or NULL if it is over no region. More...
 
MouseWatcherRegionget_over_region (const LPoint2 &pos) const
 Returns the preferred region the mouse is over. More...
 
virtual TypeHandle get_type () const
 
const std::string & get_within_pattern () const
 Returns the string that indicates how event names are generated when the mouse wanders over a region. More...
 
const std::string & get_without_pattern () const
 Returns the string that indicates how event names are generated when the mouse wanders out of a region. More...
 
bool has_display_region () const
 Returns true if the MouseWatcher has been constrained to a particular region of the screen via set_display_region(), or false otherwise. More...
 
bool has_geometry () const
 Returns true if a software mouse pointer has been setup via set_geometry(), or false otherwise. More...
 
bool has_inactivity_timeout () const
 Returns true if an inactivity timeout has been set, false otherwise. More...
 
bool has_mouse () const
 Returns true if the mouse is anywhere within the window, false otherwise. More...
 
bool is_button_down (ButtonHandle button) const
 Returns true if the indicated button is currently being held down, false otherwise. More...
 
bool is_mouse_open () const
 Returns true if the mouse is within the window and not over some particular MouseWatcherRegion that is marked to suppress mouse events; that is, that the mouse is in open space within the window. More...
 
bool is_over_region () const
 Returns true if the mouse is over any rectangular region, false otherwise. More...
 
bool is_over_region (PN_stdfloat x, PN_stdfloat y) const
 Returns true if the mouse is over any rectangular region, false otherwise. More...
 
bool is_over_region (const LPoint2 &pos) const
 Returns true if the mouse is over any rectangular region, false otherwise. More...
 
void note_activity ()
 Can be used in conjunction with the inactivity timeout to inform the MouseWatcher that the user has just performed some action which proves he/she is present. More...
 
size_t num_trail_recent () const
 
virtual void output (std::ostream &out) const
 
 PT (GeomNode) get_trail_node()
 
bool remove_group (MouseWatcherGroup *group)
 Removes the indicated group from the set of extra groups associated with the MouseWatcher. More...
 
bool remove_region (MouseWatcherRegion *region)
 Removes the indicated region from the group. More...
 
bool replace_group (MouseWatcherGroup *old_group, MouseWatcherGroup *new_group)
 Atomically removes old_group from the MouseWatcher, and replaces it with new_group. More...
 
void set_button_down_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when a button is depressed. More...
 
void set_button_repeat_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when a button is continuously held and generates keyrepeat "down" events. More...
 
void set_button_up_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when a button is released. More...
 
void set_display_region (DisplayRegion *dr)
 Constrains the MouseWatcher to watching the mouse within a particular indicated region of the screen. More...
 
void set_enter_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse enters a region. More...
 
void set_extra_handler (EventHandler *eh)
 As an optimization for the C++ Gui, an extra handler can be registered with a mouseWatcher so that events can be dealt with much sooner. More...
 
void set_frame (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
 Sets the frame of the MouseWatcher. More...
 
void set_frame (const LVecBase4 &frame)
 Sets the frame of the MouseWatcher. More...
 
void set_geometry (PandaNode *node)
 Sets the node that will be transformed each frame by the mouse's coordinates. More...
 
void set_inactivity_timeout (double timeout)
 Sets an inactivity timeout on the mouse activity. More...
 
void set_inactivity_timeout_event (const std::string &event)
 Specifies the event string that will be generated when the inactivity timeout counter expires. More...
 
void set_leave_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse leaves a region. More...
 
void set_modifier_buttons (const ModifierButtons &mods)
 Sets the buttons that should be monitored as modifier buttons for generating events to the MouseWatcherRegions. More...
 
void set_trail_log_duration (double duration)
 If the duration is nonzero, causes the MouseWatcher to log the mouse's trail. More...
 
void set_within_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse wanders over a region. More...
 
void set_without_pattern (const std::string &pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse wanders out of a region. More...
 
virtual void write (std::ostream &out, int indent_level=0) const
 
- Public Member Functions inherited from DataNode
 DataNode (const std::string &name)
 
int get_num_inputs () const
 Returns the number of different inputs that have been defined for this node using define_input(). More...
 
int get_num_outputs () const
 Returns the number of different outputs that have been defined for this node using define_output(). More...
 
virtual PandaNodemake_copy () const
 Returns a newly-allocated Node that is a shallow copy of this one. More...
 
void transmit_data (DataGraphTraverser *trav, const DataNodeTransmit inputs[], DataNodeTransmit &output)
 Collects the data from all of the parent nodes and puts it into one DataNodeTransmit object, for processing; calls do_transmit_data() to read all the inputs and put the result into the indicated output. More...
 
void write_connections (std::ostream &out) const
 Writes to the indicated ostream a list of all the connections currently showing between this DataNode and its parent(s). 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...
 
void write_inputs (std::ostream &out) const
 Writes to the indicated ostream a list of all the inputs this DataNode might expect to receive. More...
 
void write_outputs (std::ostream &out) const
 Writes to the indicated ostream a list of all the outputs this DataNode might generate. More...
 
- Public Member Functions inherited from PandaNode
 PandaNode (const std::string &name)
 
void add_child (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 
virtual void add_for_draw (CullTraverser *trav, CullTraverserData &data)
 Adds the node's contents to the CullResult we are building up during the cull traversal, so that it will be drawn at render time. More...
 
void add_stashed (PandaNode *child_node, int sort=0, Thread *current_thread=Thread::get_current_thread())
 Adds a new child to the node, directly as a stashed child. More...
 
void adjust_draw_mask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
virtual void apply_attribs_to_vertices (const AccumulatedAttribs &attribs, int attrib_types, GeomTransformer &transformer)
 Applies whatever attributes are specified in the AccumulatedAttribs object (and by the attrib_types bitmask) to the vertices on this node, if appropriate. More...
 
virtual Lightas_light ()
 Cross-casts the node to a Light pointer, if it is one of the four kinds of Light nodes, or returns NULL if it is not. More...
 
void clear_attrib (TypeHandle type)
 
void clear_attrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
void clear_bounds ()
 Reverses the effect of a previous call to set_bounds(), and allows the node's bounding volume to be automatically computed once more based on the contents of the node. More...
 
void clear_effect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
void clear_effects (Thread *current_thread=Thread::get_current_thread())
 
void clear_state (Thread *current_thread=Thread::get_current_thread())
 
void clear_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread())
 
void clear_transform (Thread *current_thread=Thread::get_current_thread())
 
void clear_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits off, indicating that the corresponding property may once again change on this node. More...
 
virtual PandaNodecombine_with (PandaNode *other)
 Collapses this PandaNode with the other PandaNode, if possible, and returns a pointer to the combined PandaNode, or NULL if the two PandaNodes cannot safely be combined. More...
 
int compare_tags (const PandaNode *other) const
 Returns a number less than 0, 0, or greater than 0, to indicate the similarity of tags between this node and the other one. More...
 
void copy_all_properties (PandaNode *other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
void copy_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Makes another instance of all the children of the other node, copying them to this node. More...
 
void copy_tags (PandaNode *other)
 Copies all of the tags stored on the other node onto this node. More...
 
int count_num_descendants () const
 
virtual CPT (TransformState) calc_tight_bounds(LPoint3 &min_point
 
 CPT (RenderAttrib) get_attrib(TypeHandle type) const
 
 CPT (RenderAttrib) get_attrib(int slot) const
 
 CPT (RenderEffect) get_effect(TypeHandle type) const
 
 CPT (RenderState) get_state(Thread *current_thread
 
 CPT (RenderEffects) get_effects(Thread *current_thread
 
 CPT (TransformState) get_transform(Thread *current_thread
 
 CPT (TransformState) get_prev_transform(Thread *current_thread
 
 CPT (RenderAttrib) get_off_clip_planes(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(Thread *current_thread
 
 CPT (BoundingVolume) get_bounds(UpdateSeq &seq
 
 CPT (BoundingVolume) get_internal_bounds(Thread *current_thread
 
virtual bool cull_callback (CullTraverser *trav, CullTraverserData &data)
 
virtual PandaNodedupe_for_flatten () const
 This is similar to make_copy(), but it makes a copy for the specific purpose of flatten. More...
 
int find_child (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int find_parent (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int find_stashed (PandaNode *node, Thread *current_thread=Thread::get_current_thread()) const
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
BoundingVolume::BoundsType get_bounds_type () const
 
PandaNodeget_child (int n, Thread *current_thread=Thread::get_current_thread()) const
 
int get_child_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
Children get_children (Thread *current_thread=Thread::get_current_thread()) const
 
DrawMask get_draw_control_mask () const
 
DrawMask get_draw_show_mask () const
 
int get_fancy_bits (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
virtual int get_first_visible_child () const
 Returns the index number of the first visible child of this node, or a number >= get_num_children() if there are no visible children of this node. More...
 
int get_internal_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_into_collide_mask () const
 
virtual CollideMask get_legal_collide_mask () const
 
int get_nested_vertices (Thread *current_thread=Thread::get_current_thread()) const
 
CollideMask get_net_collide_mask (Thread *current_thread=Thread::get_current_thread()) const
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask get_net_draw_control_mask () const
 Returns the set of bits in get_net_draw_show_mask() that have been explicitly set via adjust_draw_mask(), rather than implicitly inherited. More...
 
DrawMask get_net_draw_show_mask () const
 Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below. More...
 
virtual int get_next_visible_child (int n) const
 Returns the index number of the next visible child of this node following the indicated child, or a number >= get_num_children() if there are no more visible children of this node. More...
 
int get_num_children (Thread *current_thread=Thread::get_current_thread()) const
 
int get_num_parents (Thread *current_thread=Thread::get_current_thread()) const
 
int get_num_stashed (Thread *current_thread=Thread::get_current_thread()) const
 
size_t get_num_tags () const
 
PandaNodeget_parent (int n, Thread *current_thread=Thread::get_current_thread()) const
 
Parents get_parents (Thread *current_thread=Thread::get_current_thread()) const
 
PandaNodeget_stashed (int n, Thread *current_thread=Thread::get_current_thread()) const
 
Stashed get_stashed (Thread *current_thread=Thread::get_current_thread()) const
 
int get_stashed_sort (int n, Thread *current_thread=Thread::get_current_thread()) const
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
std::string get_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread()) const
 
std::string get_tag_key (size_t i) const
 
void get_tag_keys (vector_string &keys) const
 Fills the given vector up with the list of tags on this PandaNode. More...
 
unsigned int get_unexpected_change (unsigned int flags) const
 Returns nonzero if any of the bits in the input parameter are set on this node, or zero if none of them are set. More...
 
virtual int get_unsafe_to_apply_attribs () const
 Returns the union of all attributes from SceneGraphReducer::AttribTypes that may not safely be applied to the vertices of this node. More...
 
virtual int get_visible_child () const
 Returns the index number of the currently visible child of this node. More...
 
bool has_attrib (TypeHandle type) const
 
bool has_attrib (int slot) const
 
bool has_dirty_prev_transform () const
 
bool has_effect (TypeHandle type) const
 
virtual bool has_selective_visibility () const
 Should be overridden by derived classes to return true if this kind of node has some restrictions on the set of children that should be rendered. More...
 
virtual bool has_single_child_visibility () const
 Should be overridden by derived classes to return true if this kind of node has the special property that just one of its children is visible at any given time, and furthermore that the particular visible child can be determined without reference to any external information (such as a camera). More...
 
bool has_tag (const std::string &key, Thread *current_thread=Thread::get_current_thread()) const
 
bool has_tags () const
 
virtual bool is_ambient_light () const
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool is_bounds_stale () const
 
virtual bool is_collision_node () const
 A simple downcast check. More...
 
bool is_final (Thread *current_thread=Thread::get_current_thread()) const
 
virtual bool is_geom_node () const
 A simple downcast check. More...
 
virtual bool is_lod_node () const
 A simple downcast check. More...
 
bool is_overall_hidden () const
 
virtual bool is_renderable () const
 Returns true if there is some value to visiting this particular node during the cull traversal for any camera, false otherwise. More...
 
bool is_scene_root () const
 Returns true if this particular node is known to be the render root of some active DisplayRegion associated with the global GraphicsEngine, false otherwise. More...
 
bool is_under_scene_root () const
 Returns true if this particular node is in a live scene graph: that is, it is a child or descendent of a node that is itself a scene root. More...
 
void list_tags (std::ostream &out, const std::string &separator="\n") const
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
void ls (std::ostream &out, int indent_level) const
 
void mark_bounds_stale (Thread *current_thread=Thread::get_current_thread()) const
 
void mark_internal_bounds_stale (Thread *current_thread=Thread::get_current_thread())
 
void prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state)
 
virtual bool preserve_name () const
 Returns true if the node's name has extrinsic meaning and must be preserved across a flatten operation, false otherwise. More...
 
 PT (PandaNode) copy_subgraph(Thread *current_thread
 
virtual void r_prepare_scene (GraphicsStateGuardianBase *gsg, const RenderState *node_state, GeomTransformer &transformer, Thread *current_thread)
 The recursive implementation of prepare_scene(). More...
 
void remove_all_children (Thread *current_thread=Thread::get_current_thread())
 Removes all the children from the node at once, including stashed children. More...
 
void remove_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth child from the node. More...
 
bool remove_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Removes the indicated child from the node. More...
 
void remove_stashed (int child_index, Thread *current_thread=Thread::get_current_thread())
 Removes the nth stashed child from the node. More...
 
bool replace_child (PandaNode *orig_child, PandaNode *new_child, Thread *current_thread=Thread::get_current_thread())
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
void replace_node (PandaNode *other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
void reset_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
virtual bool safe_to_combine () const
 Returns true if it is generally safe to combine this particular kind of PandaNode with other kinds of PandaNodes of compatible type, adding children or whatever. More...
 
virtual bool safe_to_combine_children () const
 Returns true if it is generally safe to combine the children of this PandaNode with each other. More...
 
virtual bool safe_to_flatten () const
 Returns true if it is generally safe to flatten out this particular kind of PandaNode by duplicating instances (by calling dupe_for_flatten()), false otherwise (for instance, a Camera cannot be safely flattened, because the Camera pointer itself is meaningful). More...
 
virtual bool safe_to_flatten_below () const
 Returns true if a flatten operation may safely continue past this node, or false if nodes below this node may not be molested. More...
 
virtual bool safe_to_modify_transform () const
 Returns true if it is safe to automatically adjust the transform on this kind of node. More...
 
virtual bool safe_to_transform () const
 Returns true if it is generally safe to transform this particular kind of PandaNode by calling the xform() method, false otherwise. More...
 
void set_attrib (const RenderAttrib *attrib, int override=0)
 Adds the indicated render attribute to the scene graph on this node. More...
 
void set_bound (const BoundingVolume *volume)
 Deprecated. More...
 
void set_bounds (const BoundingVolume *volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
void set_bounds_type (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
void set_effect (const RenderEffect *effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
void set_effects (const RenderEffects *effects, Thread *current_thread=Thread::get_current_thread())
 
void set_final (bool flag)
 
void set_into_collide_mask (CollideMask mask)
 
void set_overall_hidden (bool overall_hidden)
 
void set_prev_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 Sets the transform that represents this node's "previous" position, one frame ago, for the purposes of detecting motion for accurate collision calculations. More...
 
void set_state (const RenderState *state, Thread *current_thread=Thread::get_current_thread())
 
void set_tag (const std::string &key, const std::string &value, Thread *current_thread=Thread::get_current_thread())
 
void set_transform (const TransformState *transform, Thread *current_thread=Thread::get_current_thread())
 
void set_unexpected_change (unsigned int flags)
 Sets one or more of the PandaNode::UnexpectedChange bits on, indicating that the corresponding property should not change again on this node. More...
 
bool stash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void stash_child (int child_index, Thread *current_thread=Thread::get_current_thread())
 Stashes the indicated child node. More...
 
void steal_children (PandaNode *other, Thread *current_thread=Thread::get_current_thread())
 Moves all the children from the other node onto this node. More...
 
bool unstash_child (PandaNode *child_node, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. More...
 
void unstash_child (int stashed_index, Thread *current_thread=Thread::get_current_thread())
 Returns the indicated stashed node to normal child status. 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...
 
void write_recorder (BamWriter *manager, Datagram &dg)
 This method is provided for the benefit of classes (like MouseRecorder) that inherit from PandaMode and also RecorderBase. More...
 
virtual void xform (const LMatrix4 &mat)
 Transforms the contents of this PandaNode by the indicated matrix, if it means anything to do so. More...
 
- 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 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...
 
- 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)
 
- Public Member Functions inherited from MouseWatcherBase
void add_region (PT(MouseWatcherRegion) region)
 Adds the indicated region to the set of regions in the group. More...
 
void clear_regions ()
 Removes all the regions from the group. More...
 
MouseWatcherRegionfind_region (const std::string &name) const
 Returns a pointer to the first region found with the indicated name. More...
 
size_t get_num_regions () const
 
MouseWatcherRegionget_region (size_t n) const
 
bool has_region (MouseWatcherRegion *region) const
 Returns true if the indicated region has already been added to the MouseWatcherBase, false otherwise. More...
 
void hide_regions ()
 Stops the visualization created by a previous call to show_regions(). More...
 
bool is_sorted () const
 
void output (std::ostream &out) const
 
bool remove_region (MouseWatcherRegion *region)
 Removes the indicated region from the group. More...
 
void set_color (const LColor &color)
 Specifies the color used to draw the region rectangles for the regions visualized by show_regions(). More...
 
void show_regions (const NodePath &render2d, const std::string &bin_name, int draw_order)
 Enables the visualization of all of the regions handled by this MouseWatcherBase. More...
 
void sort_regions ()
 Sorts all the regions in this group into pointer order. More...
 
void update_regions ()
 Refreshes the visualization created by show_regions(). More...
 
void write (std::ostream &out, int indent_level=0) const
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from DataNode
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from PandaNode
static DrawMask get_all_camera_mask ()
 
static TypeHandle get_class_type ()
 
static DrawMask get_overall_bit ()
 
static void init_type ()
 
static PT (PandaNode) decode_from_bam_stream(vector_uchar data
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type PandaNode. More...
 
static void reset_all_prev_transform (Thread *current_thread=Thread::get_current_thread())
 Visits all nodes in the world with the _dirty_prev_transform flag–that is, all nodes whose _prev_transform is different from the _transform in pipeline stage 0–and resets the _prev_transform to be the same as _transform. More...
 
static void set_scene_root_func (SceneRootFunc *func)
 This is used by the GraphicsEngine to hook in a pointer to the scene_root_func(), the function to determine whether the node is an active scene root. More...
 
- 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 ()
 
- Static Public Member Functions inherited from MouseWatcherBase
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_group
 Returns the nth group added to the MouseWatcher via add_group(). More...
 
 get_num_groups
 Returns the number of separate groups added to the MouseWatcher via add_group(). More...
 
- Public Attributes inherited from PandaNode
 clear_tag
 Removes the value defined for this key on this particular node. More...
 
virtual LPoint3 bool const TransformState Threadcurrent_thread = Thread::get_current_thread()) const
 
Threadcurrent_thread = Thread::get_current_thread()) const
 
virtual LPoint3 bool & found_any
 
 get_all_camera_mask
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
 get_bounds_type
 Returns the bounding volume type set with set_bounds_type(). More...
 
 get_child
 Returns the nth child node of this node. More...
 
 get_children
 Returns an object that can be used to walk through the list of children of the node. More...
 
 get_draw_control_mask
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
 get_draw_show_mask
 Returns the hide/show bits of this particular node. More...
 
 get_effects
 
 get_internal_bounds
 
 get_internal_vertices
 
 get_into_collide_mask
 Returns the "into" collide mask for this node. More...
 
 get_legal_collide_mask
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
 get_nested_vertices
 
 get_num_children
 Returns the number of child nodes this node has. More...
 
 get_num_parents
 Returns the number of parent nodes this node has. More...
 
 get_num_stashed
 Returns the number of stashed nodes this node has. More...
 
 get_num_tags
 
 get_overall_bit
 
 get_parent
 Returns the nth parent node of this node. More...
 
 get_parents
 Returns an object that can be used to walk through the list of parents of the node, similar to get_children() and get_stashed(). More...
 
 get_prev_transform
 
 get_python_tags
 
 get_stashed
 Returns the nth stashed child of this node. More...
 
 get_state
 
 get_tag
 
 get_tag_key
 
 get_transform
 
 has_tag
 
 is_bounds_stale
 
 is_final
 Returns the current state of the "final" flag. More...
 
 is_overall_hidden
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
virtual LPoint3 & max_point
 
static BamReaderreader = nullptr)
 
 set_effects
 Sets the complete RenderEffects that will be applied this node. More...
 
 set_final
 
 set_into_collide_mask
 Sets the "into" CollideMask. More...
 
 set_overall_hidden
 Sets or clears the hidden flag. More...
 
 set_state
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
 set_tag
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
 set_transform
 Sets the transform that will be applied to this node and below. More...
 
virtual LPoint3 bool const TransformStatetransform
 
- 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
 
- Public Attributes inherited from MouseWatcherBase
 get_num_regions
 Returns the number of regions in the group. More...
 
 get_region
 Returns the nth region of the group; returns NULL if there is no nth region. More...
 
 is_sorted
 Returns true if the group has already been sorted, false otherwise. More...
 

Additional Inherited Members

- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 0x0001, FB_state = 0x0002, FB_effects = 0x0004, FB_tag = 0x0010,
  FB_draw_mask = 0x0020, FB_cull_callback = 0x0040
}
 
typedef bool SceneRootFunc(const PandaNode *)
 
enum  UnexpectedChange {
  UC_parents = 0x001, UC_children = 0x002, UC_transform = 0x004, UC_state = 0x008,
  UC_draw_mask = 0x010
}
 
- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

This TFormer maintains a list of rectangular regions on the screen that are considered special mouse regions; typically these will be click buttons.

When the mouse passes in or out of one of these regions, or when a button is clicked while the mouse is in one of these regions, an event is thrown.

Mouse events may also be suppressed from the rest of the datagraph in these special regions.

This class can also implement a software mouse pointer by automatically generating a transform to apply to a piece of geometry placed under the 2-d scene graph. It will move the geometry around according to the mouse's known position.

Finally, this class can keep a record of the mouse trail. This is useful if you want to know, not just where the mouse is, but the exact sequence of movements it took to get there. This information is mainly useful for gesture-recognition code. To use trail logging, you need to enable the generation of pointer events in the GraphicsWindowInputDevice and set the trail log duration in the MouseWatcher. Otherwise, the trail log will be empty.

Definition at line 61 of file mouseWatcher.h.

Member Function Documentation

◆ add_group()

bool MouseWatcher::add_group ( MouseWatcherGroup group)

Adds the indicated group of regions to the set of regions the MouseWatcher will monitor each frame.

Since the MouseWatcher itself inherits from MouseWatcherBase, this operation is normally not necessary–you can simply add the Regions you care about one at a time. Adding a complete group is useful when you may want to explicitly remove the regions as a group later.

Returns true if the group was successfully added, or false if it was already on the list.

Definition at line 153 of file mouseWatcher.cxx.

References NodePath::is_empty(), and MouseWatcherBase::show_regions().

◆ clear_display_region()

void MouseWatcher::clear_display_region ( )
inline

Removes the display region constraint from the MouseWatcher, and restores it to the default behavior of watching the whole window.

Definition at line 402 of file mouseWatcher.I.

◆ clear_geometry()

void MouseWatcher::clear_geometry ( )
inline

Stops the use of the software cursor set up via set_geometry().

Definition at line 342 of file mouseWatcher.I.

◆ clear_inactivity_timeout()

void MouseWatcher::clear_inactivity_timeout ( )
inline

Removes the inactivity timeout and restores the MouseWatcher to its default behavior of allowing a key to be held indefinitely.

Definition at line 467 of file mouseWatcher.I.

References note_activity().

◆ clear_trail_log()

void MouseWatcher::clear_trail_log ( )
inline

Clears the mouse trail log.

This does not prevent further accumulation of the log given future events.

Definition at line 522 of file mouseWatcher.I.

◆ clear_trail_node()

void MouseWatcher::clear_trail_node ( )

If you have previously fetched the trail node using get_trail_node, then the MouseWatcher is continually updating the trail node every frame.

Using clear_trail_node causes the MouseWatcher to forget the trail node and stop updating it.

Definition at line 416 of file mouseWatcher.cxx.

◆ get_button_down_pattern()

const std::string & MouseWatcher::get_button_down_pattern ( ) const
inline

Returns the string that indicates how event names are generated when a button is depressed.

See set_button_down_pattern().

Definition at line 172 of file mouseWatcher.I.

◆ get_button_repeat_pattern()

const std::string & MouseWatcher::get_button_repeat_pattern ( ) const
inline

Returns the string that indicates how event names are names are generated when a button is continuously held and generates keyrepeat "down" events.

See set_button_repeat_pattern().

Definition at line 217 of file mouseWatcher.I.

◆ get_button_up_pattern()

const std::string & MouseWatcher::get_button_up_pattern ( ) const
inline

Returns the string that indicates how event names are generated when a button is released.

See set_button_down_pattern().

Definition at line 190 of file mouseWatcher.I.

◆ get_display_region()

DisplayRegion * MouseWatcher::get_display_region ( ) const
inline

Returns the display region the MouseWatcher is constrained to by set_display_region(), or NULL if it is not constrained.

Definition at line 412 of file mouseWatcher.I.

◆ get_enter_pattern()

const std::string & MouseWatcher::get_enter_pattern ( ) const
inline

Returns the string that indicates how event names are generated when the mouse enters a region.

This is different from within_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 239 of file mouseWatcher.I.

◆ get_extra_handler()

EventHandler * MouseWatcher::get_extra_handler ( ) const
inline

As an optimization for the C++ Gui, an extra handler can be registered with a mouseWatcher so that events can be dealt with much sooner.

Definition at line 360 of file mouseWatcher.I.

◆ get_frame()

const LVecBase4 & MouseWatcher::get_frame ( ) const
inline

Returns the frame of the MouseWatcher.

See set_frame().

Definition at line 95 of file mouseWatcher.I.

◆ get_geometry()

PandaNode * MouseWatcher::get_geometry ( ) const
inline

Returns the node that has been set as the software mouse pointer, or NULL if no node has been set.

See has_geometry() and set_geometry().

Definition at line 334 of file mouseWatcher.I.

◆ get_inactivity_timeout()

double MouseWatcher::get_inactivity_timeout ( ) const
inline

Returns the inactivity timeout that has been set.

It is an error to call this if has_inactivity_timeout() returns false.

Definition at line 457 of file mouseWatcher.I.

◆ get_inactivity_timeout_event()

const std::string & MouseWatcher::get_inactivity_timeout_event ( ) const
inline

Returns the event string that will be generated when the inactivity timeout counter expires.

See set_inactivity_timeout().

Definition at line 487 of file mouseWatcher.I.

◆ get_leave_pattern()

const std::string & MouseWatcher::get_leave_pattern ( ) const
inline

Returns the string that indicates how event names are generated when the mouse leaves a region.

This is different from without_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 261 of file mouseWatcher.I.

◆ get_modifier_buttons()

ModifierButtons MouseWatcher::get_modifier_buttons ( ) const
inline

Returns the set of buttons that are being monitored as modifier buttons, as well as their current state.

Definition at line 378 of file mouseWatcher.I.

◆ get_mouse()

const LPoint2 & MouseWatcher::get_mouse ( ) const
inline

It is only valid to call this if has_mouse() returns true.

If so, this returns the current position of the mouse within the window.

Definition at line 38 of file mouseWatcher.I.

◆ get_mouse_x()

PN_stdfloat MouseWatcher::get_mouse_x ( ) const
inline

It is only valid to call this if has_mouse() returns true.

If so, this returns the current X position of the mouse within the window.

Definition at line 51 of file mouseWatcher.I.

◆ get_mouse_y()

PN_stdfloat MouseWatcher::get_mouse_y ( ) const
inline

It is only valid to call this if has_mouse() returns true.

If so, this returns the current Y position of the mouse within the window.

Definition at line 61 of file mouseWatcher.I.

◆ get_over_region() [1/3]

MouseWatcherRegion * MouseWatcher::get_over_region ( ) const
inline

Returns the smallest region the mouse is currently over, or NULL if it is over no region.

Definition at line 128 of file mouseWatcher.I.

Referenced by get_over_region(), and is_over_region().

◆ get_over_region() [2/3]

MouseWatcherRegion * MouseWatcher::get_over_region ( PN_stdfloat  x,
PN_stdfloat  y 
) const
inline

Returns the smallest region the indicated point is over, or NULL if it is over no region.

Definition at line 137 of file mouseWatcher.I.

References get_over_region().

◆ get_over_region() [3/3]

MouseWatcherRegion * MouseWatcher::get_over_region ( const LPoint2 &  pos) const

Returns the preferred region the mouse is over.

In the case of overlapping regions, the region with the largest sort order is preferred; if two regions have the same sort order, then the smaller region is preferred.

Definition at line 132 of file mouseWatcher.cxx.

◆ get_within_pattern()

const std::string & MouseWatcher::get_within_pattern ( ) const
inline

Returns the string that indicates how event names are generated when the mouse wanders over a region.

This is different from enter_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 283 of file mouseWatcher.I.

◆ get_without_pattern()

const std::string & MouseWatcher::get_without_pattern ( ) const
inline

Returns the string that indicates how event names are generated when the mouse wanders out of a region.

This is different from leave_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 305 of file mouseWatcher.I.

◆ has_display_region()

bool MouseWatcher::has_display_region ( ) const
inline

Returns true if the MouseWatcher has been constrained to a particular region of the screen via set_display_region(), or false otherwise.

If this returns true, get_display_region() may be used to return the particular region.

Definition at line 423 of file mouseWatcher.I.

◆ has_geometry()

bool MouseWatcher::has_geometry ( ) const
inline

Returns true if a software mouse pointer has been setup via set_geometry(), or false otherwise.

See set_geometry().

Definition at line 325 of file mouseWatcher.I.

◆ has_inactivity_timeout()

bool MouseWatcher::has_inactivity_timeout ( ) const
inline

Returns true if an inactivity timeout has been set, false otherwise.

Definition at line 448 of file mouseWatcher.I.

◆ has_mouse()

bool MouseWatcher::has_mouse ( ) const
inline

Returns true if the mouse is anywhere within the window, false otherwise.

Also see is_mouse_open().

Definition at line 19 of file mouseWatcher.I.

◆ is_button_down()

bool MouseWatcher::is_button_down ( ButtonHandle  button) const
inline

Returns true if the indicated button is currently being held down, false otherwise.

Definition at line 146 of file mouseWatcher.I.

References BitArray::get_bit(), and ButtonHandle::get_index.

◆ is_mouse_open()

bool MouseWatcher::is_mouse_open ( ) const
inline

Returns true if the mouse is within the window and not over some particular MouseWatcherRegion that is marked to suppress mouse events; that is, that the mouse is in open space within the window.

Definition at line 29 of file mouseWatcher.I.

◆ is_over_region() [1/3]

bool MouseWatcher::is_over_region ( ) const
inline

Returns true if the mouse is over any rectangular region, false otherwise.

Definition at line 103 of file mouseWatcher.I.

References get_over_region().

◆ is_over_region() [2/3]

bool MouseWatcher::is_over_region ( PN_stdfloat  x,
PN_stdfloat  y 
) const
inline

Returns true if the mouse is over any rectangular region, false otherwise.

Definition at line 111 of file mouseWatcher.I.

References get_over_region().

◆ is_over_region() [3/3]

bool MouseWatcher::is_over_region ( const LPoint2 &  pos) const
inline

Returns true if the mouse is over any rectangular region, false otherwise.

Definition at line 119 of file mouseWatcher.I.

References get_over_region().

◆ note_activity()

void MouseWatcher::note_activity ( )

Can be used in conjunction with the inactivity timeout to inform the MouseWatcher that the user has just performed some action which proves he/she is present.

It may be necessary to call this for external events, such as joystick action, that the MouseWatcher might otherwise not know about. This will reset the current inactivity timer. When the inactivity timer reaches the length of time specified by set_inactivity_timeout(), with no keyboard or mouse activity and no calls to note_activity(), then any buttons held will be automatically released.

Definition at line 468 of file mouseWatcher.cxx.

References ClockObject::get_frame_time, and ClockObject::get_global_clock().

Referenced by clear_inactivity_timeout(), and set_inactivity_timeout().

◆ remove_group()

bool MouseWatcher::remove_group ( MouseWatcherGroup group)

Removes the indicated group from the set of extra groups associated with the MouseWatcher.

Returns true if successful, or false if the group was already removed or was never added via add_group().

Definition at line 183 of file mouseWatcher.cxx.

References NodePath::is_empty().

◆ remove_region()

bool MouseWatcher::remove_region ( MouseWatcherRegion region)

Removes the indicated region from the group.

Returns true if it was successfully removed, or false if it wasn't there in the first place.

Definition at line 109 of file mouseWatcher.cxx.

◆ replace_group()

bool MouseWatcher::replace_group ( MouseWatcherGroup old_group,
MouseWatcherGroup new_group 
)

Atomically removes old_group from the MouseWatcher, and replaces it with new_group.

Presumably old_group and new_group might have some regions in common; these are handled properly.

If old_group is not already present, simply adds new_group and returns false. Otherwise, removes old_group and adds new_group, and then returns true.

Definition at line 234 of file mouseWatcher.cxx.

References ordered_vector< Key, Compare, Vector >::empty(), NodePath::is_empty(), and ordered_vector< Key, Compare, Vector >::swap().

◆ set_button_down_pattern()

void MouseWatcher::set_button_down_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when a button is depressed.

This is a string that may contain any of the following:

r - the name of the region the mouse is over b - the name of the button pressed.

The event name will be based on the in_pattern string specified here, with all occurrences of the above strings replaced with the corresponding values.

Definition at line 163 of file mouseWatcher.I.

◆ set_button_repeat_pattern()

void MouseWatcher::set_button_repeat_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when a button is continuously held and generates keyrepeat "down" events.

This is a string that may contain any of the following:

r - the name of the region the mouse is over b - the name of the button pressed.

The event name will be based on the in_pattern string specified here, with all occurrences of the above strings replaced with the corresponding values.

Definition at line 207 of file mouseWatcher.I.

◆ set_button_up_pattern()

void MouseWatcher::set_button_up_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when a button is released.

See set_button_down_pattern().

Definition at line 181 of file mouseWatcher.I.

◆ set_display_region()

void MouseWatcher::set_display_region ( DisplayRegion dr)
inline

Constrains the MouseWatcher to watching the mouse within a particular indicated region of the screen.

DataNodes parented under the MouseWatcher will observe the mouse and keyboard events only when the mouse is within the indicated region, and the observed range will be from -1 .. 1 across the region.

Do not delete the DisplayRegion while it is owned by the MouseWatcher.

Definition at line 392 of file mouseWatcher.I.

◆ set_enter_pattern()

void MouseWatcher::set_enter_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when the mouse enters a region.

This is different from within_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 228 of file mouseWatcher.I.

◆ set_extra_handler()

void MouseWatcher::set_extra_handler ( EventHandler eh)
inline

As an optimization for the C++ Gui, an extra handler can be registered with a mouseWatcher so that events can be dealt with much sooner.

Definition at line 351 of file mouseWatcher.I.

◆ set_frame() [1/2]

void MouseWatcher::set_frame ( PN_stdfloat  left,
PN_stdfloat  right,
PN_stdfloat  bottom,
PN_stdfloat  top 
)
inline

Sets the frame of the MouseWatcher.

See the next flavor of this method for a more verbose explanation.

Definition at line 71 of file mouseWatcher.I.

◆ set_frame() [2/2]

void MouseWatcher::set_frame ( const LVecBase4 &  frame)
inline

Sets the frame of the MouseWatcher.

This determines the coordinate space in which the MouseWatcherRegions should be expected to live. Normally, this is left at -1, 1, -1, 1, which is the default setting, and matches the mouse coordinate range.

Whatever values you specify here indicate the shape of the full screen, and the MouseWatcherRegions will be given in coordinate space matching it. For instance, if you specify (0, 1, 0, 1), then a MouseWatcherRegion with the frame (0, 1, 0, .5) will cover the lower half of the screen.

Definition at line 87 of file mouseWatcher.I.

◆ set_geometry()

void MouseWatcher::set_geometry ( PandaNode node)
inline

Sets the node that will be transformed each frame by the mouse's coordinates.

It will also be hidden when the mouse goes outside the window. This can be used to implement a software mouse pointer for when a hardware (or system) mouse pointer is unavailable.

Definition at line 316 of file mouseWatcher.I.

◆ set_inactivity_timeout()

void MouseWatcher::set_inactivity_timeout ( double  timeout)
inline

Sets an inactivity timeout on the mouse activity.

When this timeout (in seconds) is exceeded with no keyboard or mouse activity, all currently-held buttons are automatically released. This is intended to help protect against people who inadvertently (or intentionally) leave a keyboard key stuck down and then wander away from the keyboard.

Also, when this timeout expires, the event specified by set_inactivity_timeout_event() will be generated.

Definition at line 438 of file mouseWatcher.I.

References note_activity().

◆ set_inactivity_timeout_event()

void MouseWatcher::set_inactivity_timeout_event ( const std::string &  event)
inline

Specifies the event string that will be generated when the inactivity timeout counter expires.

See set_inactivity_timeout().

Definition at line 478 of file mouseWatcher.I.

◆ set_leave_pattern()

void MouseWatcher::set_leave_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when the mouse leaves a region.

This is different from without_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 250 of file mouseWatcher.I.

◆ set_modifier_buttons()

void MouseWatcher::set_modifier_buttons ( const ModifierButtons mods)
inline

Sets the buttons that should be monitored as modifier buttons for generating events to the MouseWatcherRegions.

Definition at line 369 of file mouseWatcher.I.

◆ set_trail_log_duration()

void MouseWatcher::set_trail_log_duration ( double  duration)

If the duration is nonzero, causes the MouseWatcher to log the mouse's trail.

Events older than the specified duration are discarded. If the duration is zero, logging is disabled.

Definition at line 358 of file mouseWatcher.cxx.

◆ set_within_pattern()

void MouseWatcher::set_within_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when the mouse wanders over a region.

This is different from enter_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 272 of file mouseWatcher.I.

◆ set_without_pattern()

void MouseWatcher::set_without_pattern ( const std::string &  pattern)
inline

Sets the pattern string that indicates how the event names are generated when the mouse wanders out of a region.

This is different from leave_pattern, in that a mouse is only "entered" in the topmost region at a given time, while it might be "within" multiple nested regions.

Definition at line 294 of file mouseWatcher.I.

Member Data Documentation

◆ get_group

MouseWatcherGroup * MouseWatcher::get_group

Returns the nth group added to the MouseWatcher via add_group().

Definition at line 130 of file mouseWatcher.h.

◆ get_num_groups

int MouseWatcher::get_num_groups

Returns the number of separate groups added to the MouseWatcher via add_group().

Definition at line 130 of file mouseWatcher.h.


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