com.yworks.yfiles.graph.styles

Class VoidPathGeometry

java.lang.Object

com.yworks.yfiles.graph.styles.VoidPathGeometry

All Implemented Interfaces:

IPathGeometry

public final class VoidPathGeometry
extends Object
implements IPathGeometry

A void implementation of the IPathGeometry interface that does nothing and behaves like an empty path.

This class implements the singleton pattern. Use the shared static INSTANCE of this class instead of null were null is not allowed. The VoidEdgeStyleRenderer does so for example.

Field Summary

Fields

Modifier and Type	Field and Description
static VoidPathGeometry	INSTANCE The VoidPathGeometry singleton.

Method Summary

Modifier and Type	Method and Description
static VoidPathGeometry	getInstance() Returns the com.yworks.yfiles.common.drawing.VoidPathGeometry singleton.
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.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final VoidPathGeometry INSTANCE

The VoidPathGeometry singleton.

Method Detail

getInstance

public static VoidPathGeometry getInstance()

Returns the com.yworks.yfiles.common.drawing.VoidPathGeometry singleton.

Returns:

the com.yworks.yfiles.common.drawing.VoidPathGeometry singleton.

getPath

public final GeneralPath getPath()

Description copied from interface: IPathGeometry

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

Specified by:

getPath in interface IPathGeometry

Returns:

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

getSegmentCount

public final int getSegmentCount()

Description copied from interface: IPathGeometry

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

Specified by:

getSegmentCount in interface IPathGeometry

Returns:

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

getTangent

public final Tangent getTangent(double ratio)

Description copied from interface: IPathGeometry

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

Specified by:

getTangent in interface IPathGeometry

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

public final Tangent getTangent(int segmentIndex,
                                double ratio)

Description copied from interface: IPathGeometry

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

Specified by:

getTangent in interface IPathGeometry

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:

IPathGeometry.getTangent(double), IPathGeometry.getSegmentCount()