com.yworks.yfiles.graph.styles

Interface IPathGeometry

All Known Implementing Classes:

ArcEdgeStyleRenderer, PathBasedEdgeStyleRenderer, PolylineEdgeStyleRenderer, VoidPathGeometry

public interface IPathGeometry

Interface that is used mainly by IEdgeStyleRenderer implementations to reveal geometric details about the visualization of an edge's path.

Method Summary

Modifier and Type	Method and Description
GeneralPath	getPath() Returns a representation of the visible path of the edge in form of a GeneralPath.
int	getSegmentCount() Returns the number of "segments" this edge's path consists of.
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.

Method Detail

getPath

GeneralPath getPath()

Returns a representation of the visible path of the edge in form of a GeneralPath.

Returns:

An instance that describes the visible path or null if this is not applicable for the current geometry.

getSegmentCount

int getSegmentCount()

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

Returns:

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

getTangent

Tangent getTangent(double ratio)

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

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.

getTangent

Tangent getTangent(int segmentIndex,
                   double ratio)

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

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:

getTangent(double), getSegmentCount()