panda3d.core.MouseWatcherBase

from panda3d.core import MouseWatcherBase
class MouseWatcherBase

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

Inheritance diagram of MouseWatcherBase

addRegion(region: MouseWatcherRegion) → None

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.

hasRegion(region: MouseWatcherRegion) → bool

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

removeRegion(region: MouseWatcherRegion) → bool

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.

findRegion(name: str) → MouseWatcherRegion

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.

Return type

MouseWatcherRegion

clearRegions() → None

Removes all the regions from the group.

sortRegions() → None

Sorts all the regions in this group into pointer order.

isSorted() → bool

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

getNumRegions() → size_t

Returns the number of regions in the group.

Return type

size_t

getRegion(n: size_t) → 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.

Return type

MouseWatcherRegion

output(out: ostream) → None
write(out: ostream, indent_level: int) → None
showRegions(render2d: NodePath, bin_name: str, draw_order: int) → None

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.

setColor(color: LColor) → None

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

hideRegions() → None

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

updateRegions() → None

Refreshes the visualization created by showRegions().

static getClassType() → TypeHandle
Return type

TypeHandle

getRegions() → list
property sorted

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

Return type

bool

property regions

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.

Return type

Sequence[MouseWatcherRegion]