MouseWatcherParameter

from panda3d.core import MouseWatcherParameter
class MouseWatcherParameter

Bases: DTOOL_SUPER_BASE

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

Inheritance diagram of MouseWatcherParameter

__init__(*args, **kwargs)
getButton()

C++ Interface: get_button(MouseWatcherParameter self)

/**

  • Returns the mouse or keyboard button associated with this event. If

  • has_button(), above, returns false, this returns ButtonHandle::none().

*/

getCandidateStringEncoded()

C++ Interface: get_candidate_string_encoded(MouseWatcherParameter self) get_candidate_string_encoded(MouseWatcherParameter self, int encoding)

/**

  • Returns the candidate string associated with this event. If

  • has_candidate(), above, returns false, this returns the empty string.

*/

/**

  • Returns the candidate string associated with this event. If

  • has_candidate(), above, returns false, this returns the empty string.

*/

getCursorPos()

C++ Interface: get_cursor_pos(MouseWatcherParameter self)

/**

  • Returns the position of the user’s edit cursor within the candidate string.

*/

getHighlightEnd()

C++ Interface: get_highlight_end(MouseWatcherParameter self)

/**

  • Returns one more than the last highlighted character in the candidate

  • string.

*/

getHighlightStart()

C++ Interface: get_highlight_start(MouseWatcherParameter self)

/**

  • Returns the first highlighted character in the candidate string.

*/

getKeycode()

C++ Interface: get_keycode(MouseWatcherParameter self)

/**

  • Returns the keycode associated with this event. If has_keycode(), above,

  • returns false, this returns 0.

*/

getModifierButtons()

C++ Interface: get_modifier_buttons(MouseWatcherParameter self)

/**

  • Returns the set of modifier buttons that were being held down while the

  • event was generated.

*/

getMouse()

C++ Interface: get_mouse(MouseWatcherParameter self)

/**

  • 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 has_mouse()

  • returned true.

*/

get_button()

C++ Interface: get_button(MouseWatcherParameter self)

/**

  • Returns the mouse or keyboard button associated with this event. If

  • has_button(), above, returns false, this returns ButtonHandle::none().

*/

get_candidate_string_encoded()

C++ Interface: get_candidate_string_encoded(MouseWatcherParameter self) get_candidate_string_encoded(MouseWatcherParameter self, int encoding)

/**

  • Returns the candidate string associated with this event. If

  • has_candidate(), above, returns false, this returns the empty string.

*/

/**

  • Returns the candidate string associated with this event. If

  • has_candidate(), above, returns false, this returns the empty string.

*/

get_cursor_pos()

C++ Interface: get_cursor_pos(MouseWatcherParameter self)

/**

  • Returns the position of the user’s edit cursor within the candidate string.

*/

get_highlight_end()

C++ Interface: get_highlight_end(MouseWatcherParameter self)

/**

  • Returns one more than the last highlighted character in the candidate

  • string.

*/

get_highlight_start()

C++ Interface: get_highlight_start(MouseWatcherParameter self)

/**

  • Returns the first highlighted character in the candidate string.

*/

get_keycode()

C++ Interface: get_keycode(MouseWatcherParameter self)

/**

  • Returns the keycode associated with this event. If has_keycode(), above,

  • returns false, this returns 0.

*/

get_modifier_buttons()

C++ Interface: get_modifier_buttons(MouseWatcherParameter self)

/**

  • Returns the set of modifier buttons that were being held down while the

  • event was generated.

*/

get_mouse()

C++ Interface: get_mouse(MouseWatcherParameter self)

/**

  • 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 has_mouse()

  • returned true.

*/

hasButton()

C++ Interface: has_button(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated mouse or keyboard button,

  • false otherwise.

*/

hasCandidate()

C++ Interface: has_candidate(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated candidate string, false

  • otherwise.

*/

hasKeycode()

C++ Interface: has_keycode(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated keycode, false otherwise.

*/

hasMouse()

C++ Interface: has_mouse(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated mouse position, false

  • otherwise.

*/

has_button()

C++ Interface: has_button(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated mouse or keyboard button,

  • false otherwise.

*/

has_candidate()

C++ Interface: has_candidate(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated candidate string, false

  • otherwise.

*/

has_keycode()

C++ Interface: has_keycode(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated keycode, false otherwise.

*/

has_mouse()

C++ Interface: has_mouse(MouseWatcherParameter self)

/**

  • Returns true if this parameter has an associated mouse position, false

  • otherwise.

*/

isKeyrepeat()

C++ Interface: is_keyrepeat(MouseWatcherParameter self)

/**

  • Returns true if the button-down even was generated due to keyrepeat, or

  • false if it was an original button down.

*/

isOutside()

C++ Interface: is_outside(MouseWatcherParameter self)

/**

  • Returns true if the mouse was outside the region at the time the event was

  • generated, false otherwise. This is only valid for “release” type events.

*/

is_keyrepeat()

C++ Interface: is_keyrepeat(MouseWatcherParameter self)

/**

  • Returns true if the button-down even was generated due to keyrepeat, or

  • false if it was an original button down.

*/

is_outside()

C++ Interface: is_outside(MouseWatcherParameter self)

/**

  • Returns true if the mouse was outside the region at the time the event was

  • generated, false otherwise. This is only valid for “release” type events.

*/

output()

C++ Interface: output(MouseWatcherParameter self, ostream out)

/**

*/