com.yworks.yfiles.view

Class GridVisualCreator

java.lang.Object

com.yworks.yfiles.view.GridVisualCreator

All Implemented Interfaces:

IVisualCreator

public class GridVisualCreator
extends Object
implements IVisualCreator

Renders a grid using various different styles.

See Also:

GridInfo, getGridStyle()

Constructor Summary

Constructors

Constructor and Description
GridVisualCreator() Initializes a new instance of the GridVisualCreator class.
GridVisualCreator(double horizontalSpacing, double verticalSpacing) Initializes a new instance of the GridVisualCreator class.
GridVisualCreator(GridInfo gridInfo) Initializes a new instance of the GridVisualCreator class.

Method Summary

Modifier and Type	Method and Description
Node	createVisual(IRenderContext context) This method is called by the framework to create a Node that will be included into the IRenderContext.
GridInfo	getGridInfo() Gets the grid info that describes the geometry of the grid.
GridStyle	getGridStyle() Gets the grid style that this implementation uses.
Pen	getPen() Gets the pen to use for painting the grid points.
double	getVisibilityThreshold() Gets the visibility threshold.
boolean	isVisible() Gets a value indicating whether this GridVisualCreator is visible.
void	setGridInfo(GridInfo value) Sets the grid info that describes the geometry of the grid.
void	setGridStyle(GridStyle value) Sets the grid style that this implementation uses.
void	setPen(Pen value) Sets the pen to use for painting the grid points.
void	setVisibilityThreshold(double value) Sets the visibility threshold.
void	setVisible(boolean value) Sets a value indicating whether this GridVisualCreator is visible.
Node	updateVisual(IRenderContext context, Node oldVisual) This method updates or replaces a previously created Node for inclusion in the IRenderContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridVisualCreator

public GridVisualCreator()

Initializes a new instance of the GridVisualCreator class.

The spacing is initialized to 25 units.

GridVisualCreator

public GridVisualCreator(double horizontalSpacing,
                         double verticalSpacing)

Initializes a new instance of the GridVisualCreator class.

This initializes the GridInfo field using the given values.

Parameters:

horizontalSpacing - The x spacing.

verticalSpacing - The y spacing.

GridVisualCreator

public GridVisualCreator(GridInfo gridInfo)

Initializes a new instance of the GridVisualCreator class.

Parameters:

gridInfo - The grid info.

Method Detail

createVisual

public final Node createVisual(IRenderContext context)

Description copied from interface: IVisualCreator

This method is called by the framework to create a Node that will be included into the IRenderContext.

CanvasControl uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used.

Returns:

The visual to include in the canvas object visual tree. This may be null.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

getGridInfo

public final GridInfo getGridInfo()

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

Returns:

The grid info.

See Also:

setGridInfo(GridInfo)

getGridStyle

public final GridStyle getGridStyle()

Gets the grid style that this implementation uses.

Returns:

The grid style.

See Also:

setGridStyle(GridStyle)

getPen

public final Pen getPen()

Gets the pen to use for painting the grid points.

Returns:

The pen.

See Also:

setPen(Pen)

getVisibilityThreshold

public final double getVisibilityThreshold()

Gets the visibility threshold.

This indicates the minimum distance in the view coordinate system between two grid points. If the distance becomes smaller, the grid will not be rendered. The default value is 20.0d.

Returns:

The visibility threshold.

See Also:

setVisibilityThreshold(double)

isVisible

public final boolean isVisible()

Gets a value indicating whether this GridVisualCreator is visible.

Returns:

true if visible; false otherwise.

See Also:

setVisible(boolean)

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()

setGridStyle

public final void setGridStyle(GridStyle value)

Sets the grid style that this implementation uses.

Parameters:

value - The grid style.

See Also:

getGridStyle()

setPen

public final void setPen(Pen value)

Sets the pen to use for painting the grid points.

Parameters:

value - The pen.

See Also:

getPen()

setVisibilityThreshold

public final void setVisibilityThreshold(double value)

Sets the visibility threshold.

This indicates the minimum distance in the view coordinate system between two grid points. If the distance becomes smaller, the grid will not be rendered. The default value is 20.0d.

Parameters:

value - The visibility threshold.

See Also:

getVisibilityThreshold()

setVisible

public final void setVisible(boolean value)

Sets a value indicating whether this GridVisualCreator is visible.

Parameters:

value - true if visible; false otherwise.

See Also:

isVisible()

updateVisual

public final Node updateVisual(IRenderContext context,
                               Node oldVisual)

Description copied from interface: IVisualCreator

This method updates or replaces a previously created Node for inclusion in the IRenderContext.

The CanvasControl uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to IVisualCreator.createVisual(IRenderContext). Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used in.

oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.

Returns:

oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl