MouseWatcherRegion

from panda3d.core import MouseWatcherRegion

class MouseWatcherRegion

Bases:

Bases: TypedWritableReferenceCount, Namable

This is the class that defines a rectangular region on the screen for the MouseWatcher.

Inheritance diagram

enum SuppressFlags

enumerator SF_mouse_button = 1

enumerator SF_other_button = 2

enumerator SF_any_button = 3

enumerator SF_mouse_position = 4

__init__(param0: MouseWatcherRegion)

__init__(name: str, frame: LVecBase4)

__init__(name: str, left: float, right: float, bottom: float, top: float)

property active → bool

Getter: Returns whether the region is active or not. See set_active().
Setter: Sets whether the region is active or not. If it is not active, the MouseWatcher will never consider the mouse to be over the region. The region might still receive keypress events if its set_keyboard() flag is true.

property area → float: Returns the area of the rectangular region.

property frame → LVecBase4: Getter Setter

get_active() → bool: Returns whether the region is active or not. See set_active().

get_area() → float: Returns the area of the rectangular region.

static get_class_type() → TypeHandle

get_frame() → LVecBase4

get_keyboard() → bool: Returns whether the region is interested in global keyboard events; see set_keyboard().

get_sort() → int: Returns the current sorting order of this region. See set_sort().

get_suppress_flags() → int: Returns the current suppress_flags. See set_suppress_flags().

property keyboard → bool

Getter: Returns whether the region is interested in global keyboard events; see set_keyboard().
Setter: Sets whether the region is interested in global keyboard events. If this is true, then any keyboard button events will be passed to press() and release() regardless of the position of the mouse onscreen; otherwise, these events will only be passed if the mouse is over the region.

output(out: ostream)

set_active(active: bool): Sets whether the region is active or not. If it is not active, the MouseWatcher will never consider the mouse to be over the region. The region might still receive keypress events if its set_keyboard() flag is true.

set_frame(frame: LVecBase4)

set_frame(left: float, right: float, bottom: float, top: float)

set_keyboard(keyboard: bool): Sets whether the region is interested in global keyboard events. If this is true, then any keyboard button events will be passed to press() and release() regardless of the position of the mouse onscreen; otherwise, these events will only be passed if the mouse is over the region.

set_sort(sort: int): Changes the sorting order of this particular region. The sorting order is used to resolve conflicts in the case of overlapping region; the region with the highest sort value will be preferred, and between regions of the same sort value, the smallest region will be preferred. The default sorting order, if none is explicitly specified, is 0.

set_suppress_flags(suppress_flags: int)

Sets which events are suppressed when the mouse is over the region. This is the union of zero or more various SF_* values. Normally, this is 0, indicating that no events are suppressed.

If you set this to a non-zero value, for instance SF_mouse_position, then the mouse position will not be sent along the data graph when the mouse is over this particular region.

property sort → int

Getter: Returns the current sorting order of this region. See set_sort().
Setter: Changes the sorting order of this particular region. The sorting order is used to resolve conflicts in the case of overlapping region; the region with the highest sort value will be preferred, and between regions of the same sort value, the smallest region will be preferred. The default sorting order, if none is explicitly specified, is 0.

property suppress_flags → int

Getter

Returns the current suppress_flags. See set_suppress_flags().

Setter

Sets which events are suppressed when the mouse is over the region. This is the union of zero or more various SF_* values. Normally, this is 0, indicating that no events are suppressed.

If you set this to a non-zero value, for instance SF_mouse_position, then the mouse position will not be sent along the data graph when the mouse is over this particular region.

write(out: ostream, indent_level: int)