MouseWatcherBase

from acron.core import MouseWatcherBase

class MouseWatcherBase

Bases:

This represents a collection of MouseWatcherRegions that may be managed as a group. This is the base class for both MouseWatcherGroup and MouseWatcher, and exists so that we don’t have to make MouseWatcher inherit from ReferenceCount more than once.

Inheritance diagram

digraph inheritancebb7fd8327c { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "MouseWatcherBase" [URL="acron.core.MouseWatcherBase.html#acron.core.MouseWatcherBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "MouseWatcherBase" [arrowsize=0.75,style=""]; }

add_region()

Adds the indicated region to the set of regions in the group. It is no longer an error to call this for the same region more than once.

clear_regions()

Removes all the regions from the group.

find_region()

Returns a pointer to the first region found with the indicated name. If multiple regions share the same name, the one that is returned is indeterminate.

static get_class_type()

get_num_regions()

Returns the number of regions in the group.

get_region()

Returns the nth region of the group; returns NULL if there is no nth region. Note that this is not thread-safe; another thread might have removed the nth region before you called this method.

get_regions() → list

has_region()

Returns true if the indicated region has already been added to the MouseWatcherBase, false otherwise.

hide_regions()

Stops the visualization created by a previous call to show_regions().

is_sorted()

Returns true if the group has already been sorted, false otherwise.

output()

property regions → Sequence[MouseWatcherRegion]

Returns the nth region of the group; returns NULL if there is no nth region. Note that this is not thread-safe; another thread might have removed the nth region before you called this method.

remove_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.

set_color()

Specifies the color used to draw the region rectangles for the regions visualized by show_regions().

show_regions()

Enables the visualization of all of the regions handled by this MouseWatcherBase. The supplied NodePath should be the root of the 2-d scene graph for the window.

sort_regions()

Sorts all the regions in this group into pointer order.

property sorted → bool

Returns true if the group has already been sorted, false otherwise.

update_regions()

Refreshes the visualization created by show_regions().

write()