MouseWatcherParameter¶
from panda3d.core import MouseWatcherParameter
-
class
MouseWatcherParameter
¶ This is sent along as a parameter to most events generated for a region to indicate the mouse and button state for the event.
Inheritance diagram
-
getButton
() → ButtonHandle¶ Returns the mouse or keyboard button associated with this event. If
hasButton()
, above, returns false, this returnsButtonHandle.none()
.
-
getCandidateStringEncoded
() → str¶ Returns the candidate string associated with this event. If
hasCandidate()
, above, returns false, this returns the empty string.
-
getCandidateStringEncoded
(encoding: Encoding) → str Returns the candidate string associated with this event. If
hasCandidate()
, above, returns false, this returns the empty string.
-
getHighlightEnd
() → int¶ Returns one more than the last highlighted character in the candidate string.
-
getKeycode
() → int¶ Returns the keycode associated with this event. If
hasKeycode()
, above, returns false, this returns 0.
-
getModifierButtons
() → ModifierButtons¶ Returns the set of modifier buttons that were being held down while the event was generated.
-
getMouse
() → LPoint2¶ Returns the mouse position at the time the event was generated, in the normalized range (-1 .. 1). It is valid to call this only if
hasMouse()
returned true.
-
hasButton
() → bool¶ Returns true if this parameter has an associated mouse or keyboard button, false otherwise.
-
hasCandidate
() → bool¶ Returns true if this parameter has an associated candidate string, false otherwise.
-
hasMouse
() → bool¶ Returns true if this parameter has an associated mouse position, false otherwise.
-
isKeyrepeat
() → bool¶ Returns true if the button-down even was generated due to keyrepeat, or false if it was an original button down.
-