com.yworks.yfiles.view.input

Class GridConstraintProvider<T>

java.lang.Object

com.yworks.yfiles.view.input.GridConstraintProvider<T>

Type Parameters:

T - The type of the items.

All Implemented Interfaces:

IGridConstraintProvider<T>

public class GridConstraintProvider<T>
extends Object
implements IGridConstraintProvider<T>

A simple integer based implementation of IGridConstraintProvider.

Constructor Summary

Constructors

Constructor and Description
GridConstraintProvider(double gridSize) Creates a new instance using the given grid distances.
GridConstraintProvider(double gridWidth, double gridHeight) Creates a new instance using the given grid specification.
GridConstraintProvider(GridInfo gridInfo) Creates a new instance using the given grid info.

Method Summary

Modifier and Type	Method and Description
GridInfo	getGridInfo() Gets the grid info that describes the geometry of the grid.
PointD	getGridOrigin() Gets the grid origin.
double	getHorizontalGridWidth() Gets the grid height.
double	getVerticalGridWidth() Gets the grid width.
void	setGridInfo(GridInfo value) Sets the grid info that describes the geometry of the grid.
boolean	snapToGrid(IInputModeContext context, T item, IMutablePoint location, SnapPolicy xSnapPolicy, SnapPolicy ySnapPolicy) Performs the actual snapping to grid coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridConstraintProvider

public GridConstraintProvider(double gridSize)

Creates a new instance using the given grid distances.

GridConstraintProvider

public GridConstraintProvider(double gridWidth,
                              double gridHeight)

Creates a new instance using the given grid specification.

Parameters:

gridWidth - Width of the grid.

gridHeight - Height of the grid.

GridConstraintProvider

public GridConstraintProvider(GridInfo gridInfo)

Creates a new instance using the given grid info.

Parameters:

gridInfo - The grid info object.

Method Detail

getGridInfo

public final GridInfo getGridInfo()

Gets the grid info that describes the geometry of the grid.

Returns:

The grid info.

See Also:

setGridInfo(GridInfo)

getGridOrigin

public final PointD getGridOrigin()

Gets the grid origin.

This implementation delegates to the GridInfo

Specified by:

getGridOrigin in interface IGridConstraintProvider<T>

Returns:

The GridOrigin.

getHorizontalGridWidth

public final double getHorizontalGridWidth()

Gets the grid height.

This implementation delegates to the GridInfo

Specified by:

getHorizontalGridWidth in interface IGridConstraintProvider<T>

Returns:

The HorizontalGridWidth.

getVerticalGridWidth

public final double getVerticalGridWidth()

Gets the grid width.

This implementation delegates to the GridInfo

Specified by:

getVerticalGridWidth in interface IGridConstraintProvider<T>

Returns:

The VerticalGridWidth.

setGridInfo

public final void setGridInfo(GridInfo value)

Sets the grid info that describes the geometry of the grid.

Parameters:

value - The grid info.

See Also:

getGridInfo()

snapToGrid

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

Description copied from interface: IGridConstraintProvider

Performs the actual snapping to grid coordinates.

Specified by:

snapToGrid in interface IGridConstraintProvider<T>

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.