com.yworks.yfiles.view.input

Interface IHitTestable

All Known Implementing Classes:

ArcEdgeStyleRenderer, BevelNodeStyleRenderer, CollapsibleNodeStyleDecoratorRenderer, DefaultLabelStyleRenderer, DefaultPortCandidateDescriptor, GeneralPathNodeStyleRenderer, IconLabelStyleRenderer, ImageNodeStyleRenderer, MemoryImageNodeStyleRenderer, PanelNodeStyleRenderer, PathBasedEdgeStyleRenderer, PolylineEdgeStyleRenderer, ShapeNodeStyleRenderer, ShinyPlateNodeStyleRenderer, TableNodeStyleRenderer, TemplateLabelStyleRenderer, TemplateNodeStyleRenderer, TemplatePortStyleRenderer

public interface IHitTestable

Interface that is implemented for elements that can be hit or picked in a coordinate system.

See Also:

CanvasControl, ICanvasObjectDescriptor, ICanvasObject

Field Summary

Fields

Modifier and Type	Field and Description
static IHitTestable	ALWAYS An IHitTestable that always returns true.
static IHitTestable	NEVER An IHitTestable that always returns false.

Method Summary

Modifier and Type	Method and Description
static IHitTestable	create(IHitTestableHandler handler) Wrap a handler into an interface.
boolean	isHit(IInputModeContext context, PointD location) Determines if something has been hit at the given coordinates in the world coordinate system.

Field Detail

ALWAYS

static final IHitTestable ALWAYS

An IHitTestable that always returns true.

NEVER

static final IHitTestable NEVER

An IHitTestable that always returns false.

Method Detail

create

static IHitTestable create(IHitTestableHandler handler)

Wrap a handler into an interface.

isHit

boolean isHit(IInputModeContext context,
              PointD location)

Determines if something has been hit at the given coordinates in the world coordinate system.

Implementations should inspect the HitTestRadius and take the value into account when performing hit tests. This allows the user to hit elements even if the zoom level is very small and allows for accurate hit tests at greater zoom levels.

Parameters:

context - the context the hit test is performed in

location - the coordinates in world coordinate system

Returns:

whether something has been hit