com.yworks.yfiles.view.input

Interface IGridConstraintProvider<T>

Type Parameters:

T - The type of the items this class can snap

All Known Implementing Classes:

GridConstraintProvider

public interface IGridConstraintProvider<T>

Interface for classes that can snap coordinates of items of a specific type to a grid.

See Also:

GridConstraintProvider

Method Summary

Modifier and Type	Method and Description
PointD	getGridOrigin() Gets the canonic origin of the grid.
double	getHorizontalGridWidth() Gets the canonic grid width in horizontal direction.
double	getVerticalGridWidth() Gets the canonic grid width in vertical direction.
boolean	snapToGrid(IInputModeContext context, T item, IMutablePoint location, SnapPolicy xSnapPolicy, SnapPolicy ySnapPolicy) Performs the actual snapping to grid coordinates.

Method Detail

getGridOrigin

PointD getGridOrigin()

Gets the canonic origin of the grid.

Returns:

The GridOrigin.

getHorizontalGridWidth

double getHorizontalGridWidth()

Gets the canonic grid width in horizontal direction.

Returns:

The HorizontalGridWidth.

getVerticalGridWidth

double getVerticalGridWidth()

Gets the canonic grid width in vertical direction.

Returns:

The VerticalGridWidth.

snapToGrid

boolean snapToGrid(IInputModeContext context,
                   T item,
                   IMutablePoint location,
                   SnapPolicy xSnapPolicy,
                   SnapPolicy ySnapPolicy)

Performs the actual snapping to grid coordinates.

Parameters:

context - The context in which the snapping should occur.

item - The item of which the coordinates should be snapped.

location - The coordinates to snap.

xSnapPolicy - The policy for the x coordinate.

ySnapPolicy - The policy for the y coordinate.

Returns:

Whether the point has been snapped.