com.yworks.yfiles.view

Interface IVisibilityTestable

All Known Implementing Classes:

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

public interface IVisibilityTestable

Interface that is implemented for elements that can determine whether they might be visible in a given clipping rectangle.

See Also:

IVisualCreator, CanvasControl, ICanvasObjectDescriptor, ICanvasObject, VisibilityTestables

Field Summary

Fields

Modifier and Type	Field and Description
static IVisibilityTestable	ALWAYS An implementation of a IVisibilityTestable that always yields true.
static IVisibilityTestable	NEVER An implementation of a IVisibilityTestable that always yields false.

Method Summary

Modifier and Type	Method and Description
boolean	isVisible(ICanvasContext context, RectD rectangle) Determines whether an element might intersect the visible region for a given context.

Field Detail

ALWAYS

static final IVisibilityTestable ALWAYS

An implementation of a IVisibilityTestable that always yields true.

NEVER

static final IVisibilityTestable NEVER

An implementation of a IVisibilityTestable that always yields false.

Method Detail

isVisible

boolean isVisible(ICanvasContext context,
                  RectD rectangle)

Determines whether an element might intersect the visible region for a given context.

Conservative implementations can always return true.

Parameters:

context - The context to determine the visibility for.

rectangle - The visible region clip.

Returns:

false if and only if it is safe not to paint the element because it would not affect the given clipping region.