Panda3D
Public Member Functions | Static Public Member Functions | 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...

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

Public Member Functions

 __init__ (str name)
 
bool addGroup (MouseWatcherGroup group)
 Adds the indicated group of regions to the set of regions the MouseWatcher will monitor each frame. More...
 
 clearDisplayRegion ()
 Removes the display region constraint from the MouseWatcher, and restores it to the default behavior of watching the whole window. More...
 
 clearGeometry ()
 Stops the use of the software cursor set up via set_geometry(). More...
 
 clearInactivityTimeout ()
 Removes the inactivity timeout and restores the MouseWatcher to its default behavior of allowing a key to be held indefinitely. More...
 
 clearTrailLog ()
 Clears the mouse trail log. More...
 
 clearTrailNode ()
 If you have previously fetched the trail node using get_trail_node, then the MouseWatcher is continually updating the trail node every frame. More...
 
str getButtonDownPattern ()
 Returns the string that indicates how event names are generated when a button is depressed. More...
 
str getButtonRepeatPattern ()
 Returns the string that indicates how event names are names are generated when a button is continuously held and generates keyrepeat "down" events. More...
 
str getButtonUpPattern ()
 Returns the string that indicates how event names are generated when a button is released. More...
 
DisplayRegion getDisplayRegion ()
 Returns the display region the MouseWatcher is constrained to by set_display_region(), or NULL if it is not constrained. More...
 
str getEnterPattern ()
 Returns the string that indicates how event names are generated when the mouse enters a region. More...
 
EventHandler getExtraHandler ()
 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 getFrame ()
 Returns the frame of the MouseWatcher. More...
 
PandaNode getGeometry ()
 Returns the node that has been set as the software mouse pointer, or NULL if no node has been set. More...
 
MouseWatcherGroup getGroup (int n)
 Returns the nth group added to the MouseWatcher via add_group(). More...
 
list getGroups ()
 
double getInactivityTimeout ()
 Returns the inactivity timeout that has been set. More...
 
str getInactivityTimeoutEvent ()
 Returns the event string that will be generated when the inactivity timeout counter expires. More...
 
str getLeavePattern ()
 Returns the string that indicates how event names are generated when the mouse leaves a region. More...
 
ModifierButtons getModifierButtons ()
 Returns the set of buttons that are being monitored as modifier buttons, as well as their current state. More...
 
const LPoint2 getMouse ()
 It is only valid to call this if has_mouse() returns true. More...
 
float getMouseX ()
 It is only valid to call this if has_mouse() returns true. More...
 
float getMouseY ()
 It is only valid to call this if has_mouse() returns true. More...
 
int getNumGroups ()
 Returns the number of separate groups added to the MouseWatcher via add_group(). More...
 
MouseWatcherRegion getOverRegion ()
 Returns the smallest region the mouse is currently over, or NULL if it is over no region. More...
 
MouseWatcherRegion getOverRegion (const LPoint2 pos)
 Returns the preferred region the mouse is over. More...
 
MouseWatcherRegion getOverRegion (float x, float y)
 Returns the smallest region the indicated point is over, or NULL if it is over no region. More...
 
const PointerEventList getTrailLog ()
 Obtain the mouse trail log. More...
 
GeomNode getTrailNode ()
 Returns a GeomNode that represents the mouse trail. More...
 
str getWithinPattern ()
 Returns the string that indicates how event names are generated when the mouse wanders over a region. More...
 
str getWithoutPattern ()
 Returns the string that indicates how event names are generated when the mouse wanders out of a region. More...
 
bool hasDisplayRegion ()
 Returns true if the MouseWatcher has been constrained to a particular region of the screen via set_display_region(), or false otherwise. More...
 
bool hasGeometry ()
 Returns true if a software mouse pointer has been setup via set_geometry(), or false otherwise. More...
 
bool hasInactivityTimeout ()
 Returns true if an inactivity timeout has been set, false otherwise. More...
 
bool hasMouse ()
 Returns true if the mouse is anywhere within the window, false otherwise. More...
 
bool isButtonDown (ButtonHandle button)
 Returns true if the indicated button is currently being held down, false otherwise. More...
 
bool isMouseOpen ()
 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 isOverRegion ()
 Returns true if the mouse is over any rectangular region, false otherwise. More...
 
bool isOverRegion (const LPoint2 pos)
 Returns true if the mouse is over any rectangular region, false otherwise. More...
 
bool isOverRegion (float x, float y)
 Returns true if the mouse is over any rectangular region, false otherwise. More...
 
 noteActivity ()
 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...
 
int numTrailRecent ()
 This counter indicates how many events were added to the trail log this frame. More...
 
bool removeGroup (MouseWatcherGroup group)
 Removes the indicated group from the set of extra groups associated with the MouseWatcher. More...
 
bool removeRegion (MouseWatcherRegion region)
 Removes the indicated region from the group. More...
 
bool replaceGroup (MouseWatcherGroup old_group, MouseWatcherGroup new_group)
 Atomically removes old_group from the MouseWatcher, and replaces it with new_group. More...
 
 setButtonDownPattern (str pattern)
 Sets the pattern string that indicates how the event names are generated when a button is depressed. More...
 
 setButtonRepeatPattern (str 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...
 
 setButtonUpPattern (str pattern)
 Sets the pattern string that indicates how the event names are generated when a button is released. More...
 
 setDisplayRegion (DisplayRegion dr)
 Constrains the MouseWatcher to watching the mouse within a particular indicated region of the screen. More...
 
 setEnterPattern (str pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse enters a region. More...
 
 setExtraHandler (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...
 
 setFrame (const LVecBase4 frame)
 Sets the frame of the MouseWatcher. More...
 
 setFrame (float left, float right, float bottom, float top)
 Sets the frame of the MouseWatcher. More...
 
 setGeometry (PandaNode node)
 Sets the node that will be transformed each frame by the mouse's coordinates. More...
 
 setInactivityTimeout (double timeout)
 Sets an inactivity timeout on the mouse activity. More...
 
 setInactivityTimeoutEvent (str event)
 Specifies the event string that will be generated when the inactivity timeout counter expires. More...
 
 setLeavePattern (str pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse leaves a region. More...
 
 setModifierButtons (const ModifierButtons mods)
 Sets the buttons that should be monitored as modifier buttons for generating events to the MouseWatcherRegions. More...
 
 setTrailLogDuration (double duration)
 If the duration is nonzero, causes the MouseWatcher to log the mouse's trail. More...
 
 setWithinPattern (str pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse wanders over a region. More...
 
 setWithoutPattern (str pattern)
 Sets the pattern string that indicates how the event names are generated when the mouse wanders out of a region. More...
 
- Public Member Functions inherited from DataNode
 __init__ (str name)
 
 writeConnections (Ostream out)
 Writes to the indicated ostream a list of all the connections currently showing between this DataNode and its parent(s). More...
 
 writeInputs (Ostream out)
 Writes to the indicated ostream a list of all the inputs this DataNode might expect to receive. More...
 
 writeOutputs (Ostream out)
 Writes to the indicated ostream a list of all the outputs this DataNode might generate. More...
 
- Public Member Functions inherited from PandaNode
PandaNode __copy__ ()
 
object __deepcopy__ (object memo)
 
 __init__ (str name)
 
int __traverse__ (Visitproc visit, void arg)
 
 addChild (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node. More...
 
 addStashed (PandaNode child_node, int sort, Thread current_thread)
 Adds a new child to the node, directly as a stashed child. More...
 
 adjustDrawMask (DrawMask show_mask, DrawMask hide_mask, DrawMask clear_mask)
 Adjusts the hide/show bits of this particular node. More...
 
Light asLight ()
 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...
 
 clearAttrib (TypeHandle type)
 Removes the render attribute of the given type from this node. More...
 
 clearAttrib (int slot)
 Removes the render attribute of the given type from this node. More...
 
 clearBounds ()
 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...
 
 clearEffect (TypeHandle type)
 Removes the render effect of the given type from this node. More...
 
 clearEffects (Thread current_thread)
 Resets this node to have no render effects. More...
 
 clearPythonTag (object key)
 
 clearState (Thread current_thread)
 Resets this node to leave the render state alone. More...
 
 clearTag (str key, Thread current_thread)
 Removes the value defined for this key on this particular node. More...
 
 clearTransform (Thread current_thread)
 Resets the transform on this node to the identity transform. More...
 
 clearUnexpectedChange (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...
 
PandaNode combineWith (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 compareTags (const PandaNode other)
 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...
 
 copyAllProperties (PandaNode other)
 Copies the TransformState, RenderState, RenderEffects, tags, Python tags, and the show/hide state from the other node onto this one. More...
 
 copyChildren (PandaNode other, Thread current_thread)
 Makes another instance of all the children of the other node, copying them to this node. More...
 
PandaNode copySubgraph (Thread current_thread)
 Allocates and returns a complete copy of this PandaNode and the entire scene graph rooted at this PandaNode. More...
 
 copyTags (PandaNode other)
 Copies all of the tags stored on the other node onto this node. More...
 
int countNumDescendants ()
 Returns the number of nodes at and below this level. More...
 
int findChild (PandaNode node, Thread current_thread)
 Returns the index of the indicated child node, if it is a child, or -1 if it is not. More...
 
int findParent (PandaNode node, Thread current_thread)
 Returns the index of the indicated parent node, if it is a parent, or -1 if it is not. More...
 
int findStashed (PandaNode node, Thread current_thread)
 Returns the index of the indicated stashed node, if it is a stashed child, or -1 if it is not. More...
 
const RenderAttrib getAttrib (TypeHandle type)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderAttrib getAttrib (int slot)
 Returns the render attribute of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const BoundingVolume getBounds (Thread current_thread)
 Returns the external bounding volume of this node: a bounding volume that contains the user bounding volume, the internal bounding volume, and all of the children's bounding volumes. More...
 
const BoundingVolume getBounds (UpdateSeq seq, Thread current_thread)
 This flavor of get_bounds() return the external bounding volume, and also fills in seq with the bounding volume's current sequence number. More...
 
BoundingVolume::BoundsType getBoundsType ()
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode getChild (int n, Thread current_thread)
 Returns the nth child node of this node. More...
 
list getChildren ()
 
int getChildSort (int n, Thread current_thread)
 Returns the sort index of the nth child node of this node (that is, the number that was passed to add_child()). More...
 
DrawMask getDrawControlMask ()
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask getDrawShowMask ()
 Returns the hide/show bits of this particular node. More...
 
const RenderEffect getEffect (TypeHandle type)
 Returns the render effect of the indicated type, if it is defined on the node, or NULL if it is not. More...
 
const RenderEffects getEffects (Thread current_thread)
 Returns the complete RenderEffects that will be applied to this node. More...
 
int getFancyBits (Thread current_thread)
 Returns the union of all of the enum FancyBits values corresponding to the various "fancy" attributes that are set on the node. More...
 
const BoundingVolume getInternalBounds (Thread current_thread)
 Returns the node's internal bounding volume. More...
 
int getInternalVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask getIntoCollideMask ()
 Returns the "into" collide mask for this node. More...
 
CollideMask getLegalCollideMask ()
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int getNestedVertices (Thread current_thread)
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
CollideMask getNetCollideMask (Thread current_thread)
 Returns the union of all into_collide_mask() values set at CollisionNodes at this level and below. More...
 
DrawMask getNetDrawControlMask ()
 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 getNetDrawShowMask ()
 Returns the union of all draw_show_mask values–of renderable nodes only– at this level and below. More...
 
int getNumChildren (Thread current_thread)
 Returns the number of child nodes this node has. More...
 
int getNumParents (Thread current_thread)
 Returns the number of parent nodes this node has. More...
 
int getNumStashed (Thread current_thread)
 Returns the number of stashed nodes this node has. More...
 
const RenderAttrib getOffClipPlanes (Thread current_thread)
 Returns a ClipPlaneAttrib which represents the union of all of the clip planes that have been turned off at this level and below. More...
 
PandaNode getParent (int n, Thread current_thread)
 Returns the nth parent node of this node. More...
 
list getParents ()
 
const TransformState getPrevTransform (Thread current_thread)
 Returns the transform that has been set as this node's "previous" position. More...
 
object getPythonTag (object key)
 
object getPythonTagKeys ()
 
object getPythonTags ()
 
PandaNode::Stashed getStashed (Thread current_thread)
 Returns an object that can be used to walk through the list of children of the node. More...
 
PandaNode getStashed (int n, Thread current_thread)
 Returns the nth stashed child of this node. More...
 
list getStashed ()
 
int getStashedSort (int n, Thread current_thread)
 Returns the sort index of the nth stashed node of this node (that is, the number that was passed to add_child()). More...
 
const RenderState getState (Thread current_thread)
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
str getTag (str key, Thread current_thread)
 Retrieves the user-defined value that was previously set on this node for the particular key, if any. More...
 
object getTagKeys ()
 
const TransformState getTransform (Thread current_thread)
 Returns the transform that has been set on this particular node. More...
 
unsigned int getUnexpectedChange (unsigned int flags)
 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...
 
bool hasAttrib (TypeHandle type)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasAttrib (int slot)
 Returns true if there is a render attribute of the indicated type defined on this node, or false if there is not. More...
 
bool hasDirtyPrevTransform ()
 Returns true if this node has the _dirty_prev_transform flag set, which indicates its _prev_transform is different from its _transform value (in pipeline stage 0). More...
 
bool hasEffect (TypeHandle type)
 Returns true if there is a render effect of the indicated type defined on this node, or false if there is not. More...
 
bool hasPythonTag (object key)
 
bool hasTag (str key, Thread current_thread)
 Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set. More...
 
bool hasTags ()
 Returns true if the node has any tags (or any Python tags) at all, false if it has none. More...
 
bool isAmbientLight ()
 Returns true if this is an AmbientLight, false if it is not a light, or it is some other kind of light. More...
 
bool isBoundsStale ()
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
bool isCollisionNode ()
 A simple downcast check. More...
 
bool isFinal (Thread current_thread)
 Returns the current state of the "final" flag. More...
 
bool isGeomNode ()
 A simple downcast check. More...
 
bool isLodNode ()
 A simple downcast check. More...
 
bool isOverallHidden ()
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
bool isSceneRoot ()
 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 isUnderSceneRoot ()
 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...
 
 listTags (Ostream out, str separator)
 Writes a list of all the tag keys assigned to the node to the indicated stream. More...
 
 ls (Ostream out, int indent_level)
 Lists all the nodes at and below the current path hierarchically. More...
 
PandaNode makeCopy ()
 Returns a newly-allocated PandaNode that is a shallow copy of this one. More...
 
 markBoundsStale (Thread current_thread)
 Indicates that the bounding volume, or something that influences the bounding volume (or any of the other things stored in CData, like net_collide_mask), may have changed for this node, and that it must be recomputed. More...
 
 markInternalBoundsStale (Thread current_thread)
 Should be called by a derived class to mark the internal bounding volume stale, so that compute_internal_bounds() will be called when the bounding volume is next requested. More...
 
 output (Ostream out)
 
 prepareScene (GraphicsStateGuardianBase gsg, const RenderState node_state)
 Walks through the scene graph beginning at this node, and does whatever initialization is required to render the scene properly with the indicated GSG. More...
 
 removeAllChildren (Thread current_thread)
 Removes all the children from the node at once, including stashed children. More...
 
bool removeChild (PandaNode child_node, Thread current_thread)
 Removes the indicated child from the node. More...
 
 removeChild (int child_index, Thread current_thread)
 Removes the nth child from the node. More...
 
 removeStashed (int child_index, Thread current_thread)
 Removes the nth stashed child from the node. More...
 
bool replaceChild (PandaNode orig_child, PandaNode new_child, Thread current_thread)
 Searches for the orig_child node in the node's list of children, and replaces it with the new_child instead. More...
 
 replaceNode (PandaNode other)
 Inserts this node into the scene graph in place of the other one, and removes the other node. More...
 
 resetPrevTransform (Thread current_thread)
 Resets the transform that represents this node's "previous" position to the same as the current transform. More...
 
 setAttrib (const RenderAttrib attrib, int override)
 Adds the indicated render attribute to the scene graph on this node. More...
 
 setBound (const BoundingVolume volume)
 Deprecated. More...
 
 setBounds (const BoundingVolume volume)
 Resets the bounding volume so that it is the indicated volume. More...
 
 setBoundsType (BoundingVolume::BoundsType bounds_type)
 Specifies the desired type of bounding volume that will be created for this node. More...
 
 setEffect (const RenderEffect effect)
 Adds the indicated render effect to the scene graph on this node. More...
 
 setEffects (const RenderEffects effects, Thread current_thread)
 Sets the complete RenderEffects that will be applied this node. More...
 
 setFinal (bool flag)
 Sets the "final" flag on this PandaNode. More...
 
 setIntoCollideMask (CollideMask mask)
 Sets the "into" CollideMask. More...
 
 setOverallHidden (bool overall_hidden)
 Sets or clears the hidden flag. More...
 
 setPrevTransform (const TransformState transform, Thread 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...
 
 setPythonTag (object key, object value)
 
 setState (const RenderState state, Thread current_thread)
 Sets the complete RenderState that will be applied to all nodes at this level and below. More...
 
 setTag (str key, str value, Thread current_thread)
 Associates a user-defined value with a user-defined key which is stored on the node. More...
 
 setTransform (const TransformState transform, Thread current_thread)
 Sets the transform that will be applied to this node and below. More...
 
 setUnexpectedChange (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 stashChild (PandaNode child_node, Thread current_thread)
 Stashes the indicated child node. More...
 
 stashChild (int child_index, Thread current_thread)
 Stashes the indicated child node. More...
 
 stealChildren (PandaNode other, Thread current_thread)
 Moves all the children from the other node onto this node. More...
 
bool unstashChild (PandaNode child_node, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 unstashChild (int stashed_index, Thread current_thread)
 Returns the indicated stashed node to normal child status. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 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...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 
- Public Member Functions inherited from MouseWatcherBase
 addRegion (MouseWatcherRegion region)
 Adds the indicated region to the set of regions in the group. More...
 
 clearRegions ()
 Removes all the regions from the group. More...
 
MouseWatcherRegion findRegion (str name)
 Returns a pointer to the first region found with the indicated name. More...
 
int getNumRegions ()
 Returns the number of regions in the group. More...
 
MouseWatcherRegion getRegion (int n)
 Returns the nth region of the group; returns NULL if there is no nth region. More...
 
list getRegions ()
 
bool hasRegion (MouseWatcherRegion region)
 Returns true if the indicated region has already been added to the MouseWatcherBase, false otherwise. More...
 
 hideRegions ()
 Stops the visualization created by a previous call to show_regions(). More...
 
bool isSorted ()
 Returns true if the group has already been sorted, false otherwise. More...
 
 output (Ostream out)
 
bool removeRegion (MouseWatcherRegion region)
 Removes the indicated region from the group. More...
 
 setColor (const LColor color)
 Specifies the color used to draw the region rectangles for the regions visualized by show_regions(). More...
 
 showRegions (const NodePath render2d, str bin_name, int draw_order)
 Enables the visualization of all of the regions handled by this MouseWatcherBase. More...
 
 sortRegions ()
 Sorts all the regions in this group into pointer order. More...
 
 updateRegions ()
 Refreshes the visualization created by show_regions(). More...
 
 write (Ostream out, int indent_level)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from DataNode
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from PandaNode
static PandaNode decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static DrawMask getAllCameraMask ()
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
static TypeHandle getClassType ()
 
static DrawMask getOverallBit ()
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
static resetAllPrevTransform (Thread 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 Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from MouseWatcherBase
static TypeHandle getClassType ()
 

Additional Inherited Members

- Public Types inherited from PandaNode
enum  FancyBits {
  FB_transform = 1, FB_state = 2, FB_effects = 4, FB_tag = 16,
  FB_draw_mask = 32, FB_cull_callback = 64
}
 
enum  UnexpectedChange {
  UC_parents = 1, UC_children = 2, UC_transform = 4, UC_state = 8,
  UC_draw_mask = 16
}
 
- Public Attributes inherited from PandaNode
DrawMask all_camera_mask
 Returns a DrawMask that is appropriate for rendering to all cameras. More...
 
bool bounds_stale
 Returns true if the bounding volume of this node is stale and will be implicitly recomputed at the next call to get_bounds(), or false if it is fresh and need not be recomputed. More...
 
BoundingVolume::BoundsType bounds_type
 Returns the bounding volume type set with set_bounds_type(). More...
 
PandaNode::Children children
 Returns an object that can be used to walk through the list of children of the node. More...
 
DrawMask draw_control_mask
 Returns the set of bits in draw_show_mask that are considered meaningful. More...
 
DrawMask draw_show_mask
 Returns the hide/show bits of this particular node. More...
 
ConstPointerToRenderEffects effects
 Returns the complete RenderEffects that will be applied to this node. More...
 
bool final
 Returns the current state of the "final" flag. More...
 
ConstPointerToBoundingVolume internal_bounds
 Returns the node's internal bounding volume. More...
 
int internal_vertices
 Returns the total number of vertices that will be rendered by this particular node alone, not accounting for its children. More...
 
CollideMask into_collide_mask
 Returns the "into" collide mask for this node. More...
 
CollideMask legal_collide_mask
 Returns the subset of CollideMask bits that may be set for this particular type of PandaNode. More...
 
int nested_vertices
 Returns the total number of vertices that will be rendered by this node and all of its descendents. More...
 
DrawMask overall_bit
 Returns the special bit that, when specifically cleared in the node's DrawMask, indicates that the node is hidden to all cameras, regardless of the remaining DrawMask bits. More...
 
bool overall_hidden
 Returns true if the node has been hidden to all cameras by clearing its overall bit. More...
 
PandaNode::Parents 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...
 
ConstPointerToTransformState prev_transform
 Returns the transform that has been set as this node's "previous" position. More...
 
object python_tags
 
PandaNode::Stashed stashed
 Returns the nth stashed child of this node. More...
 
ConstPointerToRenderState state
 Returns the complete RenderState that will be applied to all nodes at this level and below, as set on this node. More...
 
String tags []
 
ConstPointerToTransformState transform
 Returns the transform that has been set on this particular node. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 
- Public Attributes inherited from Namable
const String name
 
- Public Attributes inherited from MouseWatcherBase
MouseWatcherRegion regions []
 
bool sorted
 Returns true if the group has already been sorted, false otherwise. More...
 

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.

Member Function Documentation

◆ __init__()

__init__ ( str  name)

◆ addGroup()

bool addGroup ( 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.

◆ clearDisplayRegion()

clearDisplayRegion ( )

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

◆ clearGeometry()

clearGeometry ( )

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

◆ clearInactivityTimeout()

clearInactivityTimeout ( )

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

◆ clearTrailLog()

clearTrailLog ( )

Clears the mouse trail log.

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

◆ clearTrailNode()

clearTrailNode ( )

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.

◆ getButtonDownPattern()

str getButtonDownPattern ( )

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

See set_button_down_pattern().

◆ getButtonRepeatPattern()

str getButtonRepeatPattern ( )

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().

◆ getButtonUpPattern()

str getButtonUpPattern ( )

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

See set_button_down_pattern().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDisplayRegion()

DisplayRegion getDisplayRegion ( )

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

◆ getEnterPattern()

str getEnterPattern ( )

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.

◆ getExtraHandler()

EventHandler getExtraHandler ( )

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.

◆ getFrame()

const LVecBase4 getFrame ( )

Returns the frame of the MouseWatcher.

See set_frame().

◆ getGeometry()

PandaNode getGeometry ( )

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().

◆ getGroup()

MouseWatcherGroup getGroup ( int  n)

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

◆ getGroups()

list getGroups ( )

◆ getInactivityTimeout()

double getInactivityTimeout ( )

Returns the inactivity timeout that has been set.

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

◆ getInactivityTimeoutEvent()

str getInactivityTimeoutEvent ( )

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

See set_inactivity_timeout().

◆ getLeavePattern()

str getLeavePattern ( )

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.

◆ getModifierButtons()

ModifierButtons getModifierButtons ( )

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

◆ getMouse()

const LPoint2 getMouse ( )

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.

◆ getMouseX()

float getMouseX ( )

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.

◆ getMouseY()

float getMouseY ( )

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.

◆ getNumGroups()

int getNumGroups ( )

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

◆ getOverRegion() [1/3]

MouseWatcherRegion getOverRegion ( )

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

◆ getOverRegion() [2/3]

MouseWatcherRegion getOverRegion ( const LPoint2  pos)

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.

◆ getOverRegion() [3/3]

MouseWatcherRegion getOverRegion ( float  x,
float  y 
)

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

◆ getTrailLog()

const PointerEventList getTrailLog ( )

Obtain the mouse trail log.

This is a PointerEventList. Does not make a copy, therefore, this PointerEventList will be updated each time process_events gets called.

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.

◆ getTrailNode()

GeomNode getTrailNode ( )

Returns a GeomNode that represents the mouse trail.

The intent is that you should reparent this GeomNode to Render2D, and then forget about it. The MouseWatcher will continually update the trail node. There is only one trail node, it does not create a new one each time you call get_trail_node.

This is not a particularly beautiful way to render a mouse trail. It is intended more for debugging purposes than for finished applications. Even so, It is suggested that you might want to apply a line thickness and antialias mode to the line — doing so makes it look a lot better.

◆ getWithinPattern()

str getWithinPattern ( )

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.

◆ getWithoutPattern()

str getWithoutPattern ( )

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.

◆ hasDisplayRegion()

bool hasDisplayRegion ( )

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.

◆ hasGeometry()

bool hasGeometry ( )

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

See set_geometry().

◆ hasInactivityTimeout()

bool hasInactivityTimeout ( )

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

◆ hasMouse()

bool hasMouse ( )

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

Also see is_mouse_open().

◆ isButtonDown()

bool isButtonDown ( ButtonHandle  button)

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

◆ isMouseOpen()

bool isMouseOpen ( )

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.

◆ isOverRegion() [1/3]

bool isOverRegion ( )

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

◆ isOverRegion() [2/3]

bool isOverRegion ( const LPoint2  pos)

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

◆ isOverRegion() [3/3]

bool isOverRegion ( float  x,
float  y 
)

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

◆ noteActivity()

noteActivity ( )

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.

◆ numTrailRecent()

int numTrailRecent ( )

This counter indicates how many events were added to the trail log this frame.

The trail log is updated once per frame, during the process_events operation.

◆ removeGroup()

bool removeGroup ( 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().

◆ removeRegion()

bool removeRegion ( 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.

◆ replaceGroup()

bool replaceGroup ( 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.

◆ setButtonDownPattern()

setButtonDownPattern ( str  pattern)

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.

◆ setButtonRepeatPattern()

setButtonRepeatPattern ( str  pattern)

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.

◆ setButtonUpPattern()

setButtonUpPattern ( str  pattern)

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

See set_button_down_pattern().

◆ setDisplayRegion()

setDisplayRegion ( DisplayRegion  dr)

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.

◆ setEnterPattern()

setEnterPattern ( str  pattern)

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.

◆ setExtraHandler()

setExtraHandler ( 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.

◆ setFrame() [1/2]

setFrame ( const LVecBase4  frame)

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.

◆ setFrame() [2/2]

setFrame ( float  left,
float  right,
float  bottom,
float  top 
)

Sets the frame of the MouseWatcher.

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

◆ setGeometry()

setGeometry ( PandaNode  node)

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.

◆ setInactivityTimeout()

setInactivityTimeout ( double  timeout)

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.

◆ setInactivityTimeoutEvent()

setInactivityTimeoutEvent ( str  event)

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

See set_inactivity_timeout().

◆ setLeavePattern()

setLeavePattern ( str  pattern)

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.

◆ setModifierButtons()

setModifierButtons ( const ModifierButtons  mods)

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

◆ setTrailLogDuration()

setTrailLogDuration ( 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.

◆ setWithinPattern()

setWithinPattern ( str  pattern)

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.

◆ setWithoutPattern()

setWithoutPattern ( str  pattern)

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.