com.yworks.yfiles.view

Interface IBoundsProvider

All Known Implementing Classes:

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

public interface IBoundsProvider

Interface that is implemented for elements that can provide rendering bounds in the world coordinate system.

This information can be used by the rendering engine to increase rendering performance significantly.

See Also:

IVisualCreator, CanvasControl, ICanvasObjectDescriptor, ICanvasObject, BoundsProviders

Field Summary

Fields

Modifier and Type	Field and Description
static IBoundsProvider	EMPTY An implementation that returns an IBoundsProvider that yields an "Empty" bounds.
static IBoundsProvider	UNBOUNDED An implementation that returns an IBoundsProvider that yields "infinite" bounds.

Method Summary

Modifier and Type	Method and Description
static IBoundsProvider	fromRectangle(IRectangle bounds) Creates an instance that returns the given model as the bounds.
RectD	getBounds(ICanvasContext context) Returns a tight rectangular area where the whole rendering would fit into.

Field Detail

EMPTY

static final IBoundsProvider EMPTY

An implementation that returns an IBoundsProvider that yields an "Empty" bounds.

UNBOUNDED

static final IBoundsProvider UNBOUNDED

An implementation that returns an IBoundsProvider that yields "infinite" bounds.

Method Detail

fromRectangle

static IBoundsProvider fromRectangle(IRectangle bounds)

Creates an instance that returns the given model as the bounds.

Parameters:

bounds - the rectangle

getBounds

RectD getBounds(ICanvasContext context)

Returns a tight rectangular area where the whole rendering would fit into.

If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return RectD.INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or RectD.EMPTY.

Parameters:

context - the context to calculate the bounds for

Returns:

the bounds or RectD.EMPTY to indicate an unbound area