com.yworks.yfiles.graph.styles

Class ArcEdgeStyleRenderer

java.lang.Object

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

com.yworks.yfiles.graph.styles.ArcEdgeStyleRenderer

All Implemented Interfaces:

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

public class ArcEdgeStyleRenderer
extends PathBasedEdgeStyleRenderer<ArcEdgeStyle>

Default renderer implementation for ArcEdgeStyle.

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
ArcEdgeStyleRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Prepares this instance for subsequent calls after the style and edge have been initialized.
protected GeneralPath	createPath() This method should create the basic uncropped path given the control points.
protected GeneralPath	cropPath(GeneralPath path) Crops the edge's path at the nodes.
double	getHeight() Retrieves the Height of the style.
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 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.
protected boolean	isAddingBridgesEnabled() Overridden to return false since the flattening interferes with its own obstacles.
boolean	isFixedHeightEnabled() Gets a value indicating whether this getHeight() should be interpreted as an absolute or relative value.
boolean	isVisible(ICanvasContext context, RectD rectangle) Overridden for performance reasons.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.

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

createRectangleSelfLoop, createRoundSelfLoop, createSelfLoopPath, createVisual, getBounds, getBoundsProvider, getBridgeCreator, getContext, getEdge, getHitTestable, getMarqueeTestable, getObstacles, getPath, getPathGeometry, getSelfLoopDistance, getSmoothingLength, getSourceArrowAnchor, getStyle, getTargetArrowAnchor, getVisibilityTestable, getVisualCreator, isHit, isInBox, 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

ArcEdgeStyleRenderer

public ArcEdgeStyleRenderer()

Method Detail

configure

protected void configure()

Description copied from class: PathBasedEdgeStyleRenderer

Prepares this instance for subsequent calls after the style and edge have been initialized.

Upon invocation the Style and Edge properties have been populated by the PathBasedEdgeStyleRenderer.getVisualCreator(IEdge, IEdgeStyle), PathBasedEdgeStyleRenderer.getBoundsProvider(IEdge, IEdgeStyle), PathBasedEdgeStyleRenderer.getHitTestable(IEdge, IEdgeStyle), or PathBasedEdgeStyleRenderer.getMarqueeTestable(IEdge, IEdgeStyle) methods.

Subclasses which override this method have to call the base implementation, first.

Overrides:

configure in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

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<ArcEdgeStyle>

Returns:

A path that has to be cropped, yet.

cropPath

protected GeneralPath cropPath(GeneralPath path)

Description copied from class: PathBasedEdgeStyleRenderer

Crops the edge's path at the nodes.

This implementation uses the IEdgePathCropper instances found in the ILookup.lookup(Class) of the source and target port of the edge to perform the actual cropping.

Overrides:

cropPath in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

Parameters:

path - The path that should be cropped.

Returns:

The cropped path. This is can be either the same instance of the given path or a newly created instance.

getHeight

public double getHeight()

Retrieves the Height of the style.

Returns:

the height.

getPen

protected Pen getPen()

Description copied from class: PathBasedEdgeStyleRenderer

Gets the pen to use to render the path.

Specified by:

getPen in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

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<ArcEdgeStyle>

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)

getSourceArrow

protected IArrow getSourceArrow()

Gets the source arrow from the style via SourceArrow.

Specified by:

getSourceArrow in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

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<ArcEdgeStyle>

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<ArcEdgeStyle>

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<ArcEdgeStyle>

Returns:

The arrow to use.

isAddingBridgesEnabled

protected boolean isAddingBridgesEnabled()

Overridden to return false since the flattening interferes with its own obstacles.

Overrides:

isAddingBridgesEnabled in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

Returns:

The AddingBridgesEnabled.

See Also:

PathBasedEdgeStyleRenderer.getBridgeCreator()

isFixedHeightEnabled

public boolean isFixedHeightEnabled()

Gets a value indicating whether this getHeight() should be interpreted as an absolute or relative value.

Returns:

true if the height value should be interpreted as a fixed value, otherwise, false.

See Also:

getHeight()

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

Overridden for performance reasons.

Specified by:

isVisible in interface IVisibilityTestable

Overrides:

isVisible in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

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)

lookup

public <TLookup> TLookup lookup(Class<TLookup> type)

Description copied from interface: ILookup

Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.

Specified by:

lookup in interface ILookup

Overrides:

lookup in class PathBasedEdgeStyleRenderer<ArcEdgeStyle>

Parameters:

type - the type for which an instance shall be returned

Returns:

an instance that is assignable to type or null