com.yworks.yfiles.view

Class GridInfo

java.lang.Object

com.yworks.yfiles.view.GridInfo

public class GridInfo
extends Object

This class describes a grid by providing the grid's origin as well as the horizontal and vertical spacing between the grid points.

It is used by the IGridConstraintProvider as well as by the GridSnapResultVisualCreator<T>

See Also:

IGridConstraintProvider

Constructor Summary

Constructors

Constructor and Description
GridInfo() Creates a new instance using "25" as the grid spacing.
GridInfo(double spacing) Creates a new instance using "25" as the grid spacing.
GridInfo(double horizontalSpacing, double verticalSpacing, PointD origin) Creates a new instance using the given horizontal and vertical grid spacing as well as the given origin.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getHorizontalSpacing() Gets the horizontal spacing between grid points in the world coordinate system.
PointD	getOrigin() Gets the canonic origin of the grid.
double	getVerticalSpacing() Gets the vertical spacing between grid points in the world coordinate system.
void	setHorizontalSpacing(double value) Sets the horizontal spacing between grid points in the world coordinate system.
void	setOrigin(PointD value) Sets the canonic origin of the grid.
void	setVerticalSpacing(double value) Sets the vertical spacing between grid points in the world coordinate system.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridInfo

public GridInfo()

Creates a new instance using "25" as the grid spacing.

GridInfo

public GridInfo(double spacing)

Creates a new instance using "25" as the grid spacing.

Parameters:

spacing - The horizontal and vertical spacing between the grid points.

GridInfo

public GridInfo(double horizontalSpacing,
                double verticalSpacing,
                PointD origin)

Creates a new instance using the given horizontal and vertical grid spacing as well as the given origin.

Parameters:

horizontalSpacing - The horizontal spacing between the grid points.

verticalSpacing - The vertical spacing between the grid points.

origin - The canonic origin of the grid.

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getHorizontalSpacing

public final double getHorizontalSpacing()

Gets the horizontal spacing between grid points in the world coordinate system.

Returns:

The HorizontalSpacing.

See Also:

setHorizontalSpacing(double)

getOrigin

public final PointD getOrigin()

Gets the canonic origin of the grid.

Returns:

The Origin.

See Also:

setOrigin(PointD)

getVerticalSpacing

public final double getVerticalSpacing()

Gets the vertical spacing between grid points in the world coordinate system.

Returns:

The VerticalSpacing.

See Also:

setVerticalSpacing(double)

setHorizontalSpacing

public final void setHorizontalSpacing(double value)

Sets the horizontal spacing between grid points in the world coordinate system.

Parameters:

value - The HorizontalSpacing to set.

See Also:

getHorizontalSpacing()

setOrigin

public final void setOrigin(PointD value)

Sets the canonic origin of the grid.

Parameters:

value - The Origin to set.

See Also:

getOrigin()

setVerticalSpacing

public final void setVerticalSpacing(double value)

Sets the vertical spacing between grid points in the world coordinate system.

Parameters:

value - The VerticalSpacing to set.

See Also:

getVerticalSpacing()