com.yworks.yfiles.graph.styles

Class PolylineEdgeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

com.yworks.yfiles.graph.styles.PolylineEdgeStyleRenderer

All Implemented Interfaces:

ILookup, IEdgeStyleRenderer, IPathGeometry, IBoundsProvider, IHitTestable, IMarqueeTestable, IObstacleProvider, IVisibilityTestable, IVisualCreator

public class PolylineEdgeStyleRenderer
extends PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

An IEdgeStyleRenderer that will render PolylineEdgeStyle instances.

Field Summary

Fields inherited from class com.yworks.yfiles.graph.styles.PathBasedEdgeStyleRenderer

path

Fields inherited from interface com.yworks.yfiles.view.IBoundsProvider

EMPTY, UNBOUNDED

Fields inherited from interface com.yworks.yfiles.view.IVisibilityTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.input.IMarqueeTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.view.input.IHitTestable

ALWAYS, NEVER

Fields inherited from interface com.yworks.yfiles.graph.ILookup

EMPTY

Constructor Summary

Constructors

Constructor and Description
PolylineEdgeStyleRenderer()

Method Summary

Modifier and Type	Method and Description
protected GeneralPath	createPath() This method should create the basic uncropped path given the control points.
protected Pen	getPen() Gets the pen to use to render the path.
int	getSegmentCount() Returns the number of "segments" this edge's path consists of.
protected double	getSmoothingLength() Gets the value that determines the radius of the smoothing arcs that can be added to the path at the bends.
protected IArrow	getSourceArrow() Gets the source arrow from the style via SourceArrow.
Tangent	getTangent(double ratio) Calculates the tangent on the edge's path at the given ratio point.
Tangent	getTangent(int segmentIndex, double ratio) Calculates the tangent on the edge's path at the given ratio point for the given segment.
protected IArrow	getTargetArrow() Gets the target arrow from the style via TargetArrow.
boolean	isVisible(ICanvasContext context, RectD rectangle) Calls PathBasedEdgeStyleRenderer.configure() and test the Edge using the Style for a visible intersection with the clip bounds.

Methods inherited from class com.yworks.yfiles.graph.styles.PathBasedEdgeStyleRenderer

configure, createRectangleSelfLoop, createRoundSelfLoop, createSelfLoopPath, createVisual, cropPath, getBounds, getBoundsProvider, getBridgeCreator, getContext, getEdge, getHitTestable, getMarqueeTestable, getObstacles, getPath, getPathGeometry, getSelfLoopDistance, getSourceArrowAnchor, getStyle, getTargetArrowAnchor, getVisibilityTestable, getVisualCreator, isAddingBridgesEnabled, isHit, isInBox, lookup, setEdge, setSelfLoopDistance, setStyle, updateVisual

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yworks.yfiles.view.IBoundsProvider

fromRectangle

Methods inherited from interface com.yworks.yfiles.view.input.IHitTestable

create

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

Constructor Detail

PolylineEdgeStyleRenderer

public PolylineEdgeStyleRenderer()

Method Detail

createPath

protected GeneralPath createPath()

Description copied from class: PathBasedEdgeStyleRenderer

This method should create the basic uncropped path given the control points.

Specified by:

createPath in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Returns:

A path that has to be cropped, yet.

getPen

protected Pen getPen()

Description copied from class: PathBasedEdgeStyleRenderer

Gets the pen to use to render the path.

Specified by:

getPen in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Returns:

The pen or null.

getSegmentCount

public int getSegmentCount()

Description copied from class: PathBasedEdgeStyleRenderer

Returns the number of "segments" this edge's path consists of.

This method is part of the IPathGeometry interface, that is implemented by this class. This interface will be returned by PathBasedEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle).

Specified by:

getSegmentCount in interface IPathGeometry

Specified by:

getSegmentCount in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Returns:

the number of segments or -1 if there is no such thing as a segment for this edge.

See Also:

PathBasedEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle)

getSmoothingLength

protected double getSmoothingLength()

Gets the value that determines the radius of the smoothing arcs that can be added to the path at the bends.

This implementation returns SmoothingLength.

Overrides:

getSmoothingLength in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Returns:

The radius of the arcs to use at the bends of the path.

getSourceArrow

protected IArrow getSourceArrow()

Gets the source arrow from the style via SourceArrow.

Specified by:

getSourceArrow in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Returns:

The arrow to use.

getTangent

public Tangent getTangent(double ratio)

Description copied from class: PathBasedEdgeStyleRenderer

Calculates the tangent on the edge's path at the given ratio point.

This method is part of the IPathGeometry interface, that is implemented by this class. This interface will be returned by PathBasedEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle).

Specified by:

getTangent in interface IPathGeometry

Specified by:

getTangent in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Parameters:

ratio - a value in [0,1] where 0 is the source's end and 1 is at the target's end of the visible edge path

Returns:

The tangential line, if any exists.

See Also:

PathBasedEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle)

getTangent

public Tangent getTangent(int segmentIndex,
                          double ratio)

Description copied from class: PathBasedEdgeStyleRenderer

Calculates the tangent on the edge's path at the given ratio point for the given segment.

This method is part of the IPathGeometry interface, that is implemented by this class. This interface will be returned by PathBasedEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle).

Specified by:

getTangent in interface IPathGeometry

Specified by:

getTangent in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Parameters:

segmentIndex - the segment to use for the calculation

ratio - a value in [0,1] where 0 is the source's end and 1 is at the target's end of the segment

Returns:

The tangential line, if any exists.

See Also:

PathBasedEdgeStyleRenderer.getTangent(double), PathBasedEdgeStyleRenderer.getSegmentCount(), PathBasedEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle)

getTargetArrow

protected IArrow getTargetArrow()

Gets the target arrow from the style via TargetArrow.

Specified by:

getTargetArrow in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Returns:

The arrow to use.

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Description copied from class: PathBasedEdgeStyleRenderer

Calls PathBasedEdgeStyleRenderer.configure() and test the Edge using the Style for a visible intersection with the clip bounds.

This simple implementation uses PathBasedEdgeStyleRenderer.getBounds(ICanvasContext) to determine the visibility. Subclasses may choose to override this behavior for improved performance but need to make sure to call PathBasedEdgeStyleRenderer.configure() if they depend on a configured instance.

Specified by:

isVisible in interface IVisibilityTestable

Overrides:

isVisible in class PathBasedEdgeStyleRenderer<PolylineEdgeStyle>

Parameters:

context - the current canvas context

rectangle - the clip bounds

Returns:

true if the edge may be painted within the clip bounds.

See Also:

PathBasedEdgeStyleRenderer.getVisibilityTestable(IEdge, IEdgeStyle)