org.osbot.rs07.input.mouse

Class WidgetDestination

java.lang.Object

org.osbot.rs07.input.mouse.MouseDestination

org.osbot.rs07.input.mouse.WidgetDestination

public class WidgetDestination
extends MouseDestination

Constructor Summary

Constructors

Constructor and Description
WidgetDestination(Bot bot, RS2Widget widget) Creates an instance of this mouse destination for a widget.
WidgetDestination(Bot bot, RS2Widget widget, boolean ignoreIsHidden) Creates an instance of this mouse destination for a widget.
WidgetDestination(Bot bot, RS2Widget widget, int margin) Creates an instance of this mouse destination for a widget.
WidgetDestination(Bot bot, RS2Widget widget, int marginX, int marginY) Creates an instance of this mouse destination for a widget with margins.

Method Summary

Modifier and Type	Method and Description
boolean	evaluate() Evaluates whether an interaction for this mouse destination is allowed to be performed.
java.awt.geom.Area	getArea() Gets the destination area specified by a Area object.
java.awt.Rectangle	getBoundingBox() Gets the bounding box rectangle of this mouse destination.
boolean	isVisible() Determines whether this destination is visible.
boolean	isVisible(java.awt.Rectangle boundingBox)

Methods inherited from class org.osbot.rs07.input.mouse.MouseDestination

getBot, getShape, isHover, setHover

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WidgetDestination

public WidgetDestination(Bot bot,
                         RS2Widget widget)

Creates an instance of this mouse destination for a widget.

Parameters:

bot - The bot instance.

widget - The widget that is the destination.

WidgetDestination

public WidgetDestination(Bot bot,
                         RS2Widget widget,
                         boolean ignoreIsHidden)

Creates an instance of this mouse destination for a widget.

Parameters:

bot - The bot instance.

widget - The widget that is the destination.

ignoreIsHidden - Ignores the isHidden() value for the widget.

WidgetDestination

public WidgetDestination(Bot bot,
                         RS2Widget widget,
                         int margin)

Creates an instance of this mouse destination for a widget.

Parameters:

bot - The bot instance.

widget - The widget that is the destination.

margin - The margin around the widget

WidgetDestination

public WidgetDestination(Bot bot,
                         RS2Widget widget,
                         int marginX,
                         int marginY)

Creates an instance of this mouse destination for a widget with margins.

Parameters:

bot - The bot instance.

widget - The widget that is the destination.

marginX - The margin around the widget in the x orientation

marginY - The margin around the widget in the y orientation

Method Detail

getArea

public java.awt.geom.Area getArea()

Description copied from class: MouseDestination

Gets the destination area specified by a Area object.

Specified by:

getArea in class MouseDestination

Returns:

The destination Area.

evaluate

public boolean evaluate()

Description copied from class: MouseDestination

Evaluates whether an interaction for this mouse destination is allowed to be performed.

Specified by:

evaluate in class MouseDestination

Returns:

True if an interaction is allowed to be performed.

getBoundingBox

public java.awt.Rectangle getBoundingBox()

Description copied from class: MouseDestination

Gets the bounding box rectangle of this mouse destination.

Specified by:

getBoundingBox in class MouseDestination

Returns:

The bounding box rectangle of this mouse destination.

isVisible

public boolean isVisible()

Description copied from class: MouseDestination

Determines whether this destination is visible.

Specified by:

isVisible in class MouseDestination

Returns:

Whether this destination is visible.

isVisible

public boolean isVisible(java.awt.Rectangle boundingBox)