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

addRegion(region: MouseWatcherRegion)

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.

clearRegions()

Removes all the regions from the group.

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.

static getClassType() → TypeHandle

getNumRegions() → int

Returns the number of regions in the group.

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

getRegions() → list

hasRegion(region: MouseWatcherRegion) → bool

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

hideRegions()

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

isSorted() → bool

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

output(out: ostream)

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.

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.

setColor(color: LColor)

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

showRegions(render2d: NodePath, bin_name: str, draw_order: int)

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.

sortRegions()

Sorts all the regions in this group into pointer order.

property sorted → bool

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

updateRegions()

Refreshes the visualization created by showRegions().

write(out: ostream, indent_level: int)