com.yworks.yfiles.graph.styles

Class PathBasedEdgeStyleRenderer<TStyle extends IEdgeStyle>

java.lang.Object

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

Type Parameters:

TStyle - The exact type of style to use for this instance.

All Implemented Interfaces:

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

Direct Known Subclasses:

ArcEdgeStyleRenderer, PolylineEdgeStyleRenderer

public abstract class PathBasedEdgeStyleRenderer<TStyle extends IEdgeStyle>
extends Object
implements IEdgeStyleRenderer, IPathGeometry, IBoundsProvider, IVisibilityTestable, IMarqueeTestable, IHitTestable, ILookup, IVisualCreator, IObstacleProvider

An abstract base class for IEdgeStyleRenderer implementations that are based on the calculation of a GeneralPath.

Field Summary

Fields

Modifier and Type	Field and Description
protected GeneralPath	path The path instance that this instance is working with.

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
PathBasedEdgeStyleRenderer(Class<TStyle> edgeStyleType)

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 abstract GeneralPath	createPath() This method should create the basic uncropped path given the control points.
protected static GeneralPath	createRectangleSelfLoop(double sx, double sy, double oppositeX, double oppositeY, double tx, double ty) Static utility method that creates a rectangular self loop path.
protected static GeneralPath	createRoundSelfLoop(double sx, double sy, double oppositeX, double oppositeY, double tx, double ty) Static utility method that creates a round self loop path.
protected GeneralPath	createSelfLoopPath(boolean roundSelfLoop) Special implementation that will create a self loop path.
Node	createVisual(IRenderContext context) This method is called by the framework to create a Node that will be included into the IRenderContext.
protected GeneralPath	cropPath(GeneralPath path) Crops the edge's path at the nodes.
RectD	getBounds(ICanvasContext context) Returns a tight rectangular area where the whole rendering would fit into.
IBoundsProvider	getBoundsProvider(IEdge edge, IEdgeStyle style) Configures the style and edge parameters, calls configure() and returns this.
protected IBridgeCreator	getBridgeCreator() Yields the IBridgeCreator to use for adding bridges to the created path.
ILookup	getContext(IEdge edge, IEdgeStyle style) Configures the style and edge parameters, does not call configure() and returns this.
protected IEdge	getEdge() Gets the currently configured edge.
IHitTestable	getHitTestable(IEdge edge, IEdgeStyle style) Configures the style and edge parameters and returns this.
IMarqueeTestable	getMarqueeTestable(IEdge edge, IEdgeStyle style) Configures the style and edge parameters, calls configure() and returns this.
GeneralPath	getObstacles(IRenderContext context) Returns createPath() unless isVisible(ICanvasContext, RectD) yields false for the provided context and Clip.
GeneralPath	getPath() Returns a representation of the visible path of the edge in form of a GeneralPath.
IPathGeometry	getPathGeometry(IEdge edge, IEdgeStyle style) Gets an implementation of the IPathGeometry interface that can handle the provided edge and its associated style.
protected abstract Pen	getPen() Gets the pen to use to render the path.
abstract int	getSegmentCount() Returns the number of "segments" this edge's path consists of.
double	getSelfLoopDistance() Gets the distance between the node's layout and its self loop control points.
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 abstract IArrow	getSourceArrow() Gets the source arrow from the style.
protected Tangent	getSourceArrowAnchor(IArrow arrow) Calculate and update the anchor and the source arrow's direction vector.
protected TStyle	getStyle() Gets the currently configured style.
abstract Tangent	getTangent(double ratio) Calculates the tangent on the edge's path at the given ratio point.
abstract Tangent	getTangent(int segmentIndex, double ratio) Calculates the tangent on the edge's path at the given ratio point for the given segment.
protected abstract IArrow	getTargetArrow() Gets the target arrow from the style.
protected Tangent	getTargetArrowAnchor(IArrow arrow) Calculate and update the anchor and the target arrow's direction vector.
IVisibilityTestable	getVisibilityTestable(IEdge edge, IEdgeStyle style) Configures the style and edge parameters, does not call configure() and returns this.
IVisualCreator	getVisualCreator(IEdge edge, IEdgeStyle style) Configures the style and edge parameters, calls configure() and returns this.
protected boolean	isAddingBridgesEnabled() Determines whether the rendered path should use the BridgeManager to add bridges to it..
boolean	isHit(IInputModeContext context, PointD location) This method is overridden for performance reasons.
boolean	isInBox(IInputModeContext context, RectD rectangle) This callback returns true if the corresponding item is considered to intersect the given rectangular box.
boolean	isVisible(ICanvasContext context, RectD rectangle) Calls configure() and test the Edge using the Style for a visible intersection with the clip bounds.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.
protected void	setEdge(IEdge value) Sets the currently configured edge.
void	setSelfLoopDistance(double value) Sets the distance between the node's layout and its self loop control points.
protected void	setStyle(TStyle value) Sets the currently configured style.
Node	updateVisual(IRenderContext context, Node oldVisual) This method updates or replaces a previously created Node for inclusion in the IRenderContext.

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

Field Detail

path

protected GeneralPath path

The path instance that this instance is working with.

Constructor Detail

PathBasedEdgeStyleRenderer

public PathBasedEdgeStyleRenderer(Class<TStyle> edgeStyleType)

Parameters:

edgeStyleType - The exact type of style to use for this instance.

Method Detail

configure

protected void configure()

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 getVisualCreator(IEdge, IEdgeStyle), getBoundsProvider(IEdge, IEdgeStyle), getHitTestable(IEdge, IEdgeStyle), or getMarqueeTestable(IEdge, IEdgeStyle) methods.

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

createPath

protected abstract GeneralPath createPath()

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

Returns:

A path that has to be cropped, yet.

createRectangleSelfLoop

protected static final GeneralPath createRectangleSelfLoop(double sx,
                                                           double sy,
                                                           double oppositeX,
                                                           double oppositeY,
                                                           double tx,
                                                           double ty)

Static utility method that creates a rectangular self loop path.

Parameters:

sx - The x coordinate of the source port.

sy - The y coordinate of the source port.

oppositeX - The x coordinate of the single control point.

oppositeY - The y coordinate of the single control point.

tx - The x coordinate of the target port.

ty - The y coordinate of the target port.

Returns:

A path that describes a rectangular self loop.

See Also:

createSelfLoopPath(boolean)

createRoundSelfLoop

protected static final GeneralPath createRoundSelfLoop(double sx,
                                                       double sy,
                                                       double oppositeX,
                                                       double oppositeY,
                                                       double tx,
                                                       double ty)

Static utility method that creates a round self loop path.

Parameters:

sx - The x coordinate of the source port.

sy - The y coordinate of the source port.

oppositeX - The x coordinate of the single control point.

oppositeY - The y coordinate of the single control point.

tx - The x coordinate of the target port.

ty - The y coordinate of the target port.

Returns:

A path that describes a round self loop.

See Also:

createSelfLoopPath(boolean)

createSelfLoopPath

protected GeneralPath createSelfLoopPath(boolean roundSelfLoop)

Special implementation that will create a self loop path.

createVisual

public Node createVisual(IRenderContext context)

Description copied from interface: IVisualCreator

This method is called by the framework to create a Node that will be included into the IRenderContext.

CanvasControl uses this interface through the ICanvasObjectDescriptor to populate the visual canvas object tree.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used.

Returns:

The visual to include in the canvas object visual tree. This may be null.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

cropPath

protected GeneralPath cropPath(GeneralPath path)

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.

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.

getBounds

public RectD getBounds(ICanvasContext context)

Description copied from interface: IBoundsProvider

Returns a tight rectangular area where the whole rendering would fit into.

If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return RectD.INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or RectD.EMPTY.

Specified by:

getBounds in interface IBoundsProvider

Parameters:

context - the context to calculate the bounds for

Returns:

the bounds or RectD.EMPTY to indicate an unbound area

getBoundsProvider

public IBoundsProvider getBoundsProvider(IEdge edge,
                                         IEdgeStyle style)

Configures the style and edge parameters, calls configure() and returns this.

Specified by:

getBoundsProvider in interface IEdgeStyleRenderer

Parameters:

edge - The edge to retrieve the bounds provider for. The value will be stored in the Edge property.

style - The style to associate with the edge. The value will be stored in the Style property.

Returns:

this

See Also:

getBounds(ICanvasContext)

getBridgeCreator

protected IBridgeCreator getBridgeCreator()

Yields the IBridgeCreator to use for adding bridges to the created path.

The return value of this method (which may be null) will be passed to the BridgeManager's BridgeManager.addBridges(IRenderContext, GeneralPath, IBridgeCreator) method.

Returns:

This implementation returns null.

getContext

public ILookup getContext(IEdge edge,
                          IEdgeStyle style)

Configures the style and edge parameters, does not call configure() and returns this.

As this method may be called often it will not automatically call configure(), instead subclasses should ensure that in the lookup(Class) method call they should call configure() only if needed, i.e. if they decide to return this or an instance that depends on a correctly configured this.

Specified by:

getContext in interface IEdgeStyleRenderer

Parameters:

edge - The edge to query the context for. The value will be stored in the Edge property.

style - The style to associate with the edge. The value will be stored in the Style property.

Returns:

this

See Also:

lookup(Class)

getEdge

protected final IEdge getEdge()

Gets the currently configured edge.

Returns:

The Edge.

See Also:

setEdge(IEdge)

getHitTestable

public IHitTestable getHitTestable(IEdge edge,
                                   IEdgeStyle style)

Configures the style and edge parameters and returns this.

This implementation does not call configure(). If subclasses depend on a configured instance in an override of isHit(IInputModeContext, PointD), they need to override this method, too and call configure() if the base call returns a non-null value.

Specified by:

getHitTestable in interface IEdgeStyleRenderer

Parameters:

edge - The edge to provide an instance for

style - The style to use for the querying hit tests

Returns:

An implementation that may be used to subsequently perform hit tests. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may return null to indicate that the edge cannot be hit tested.

See Also:

isHit(IInputModeContext, PointD), configure(), IEdgeStyleRenderer.getHitTestable(IEdge, IEdgeStyle)

getMarqueeTestable

public IMarqueeTestable getMarqueeTestable(IEdge edge,
                                           IEdgeStyle style)

Configures the style and edge parameters, calls configure() and returns this.

Specified by:

getMarqueeTestable in interface IEdgeStyleRenderer

Parameters:

edge - The edge to query marquee intersection tests. The value will be stored in the Edge property.

style - The style to associate with the edge. The value will be stored in the Style property.

Returns:

this

See Also:

isInBox(IInputModeContext, RectD)

getObstacles

public GeneralPath getObstacles(IRenderContext context)

Returns createPath() unless isVisible(ICanvasContext, RectD) yields false for the provided context and Clip.

Specified by:

getObstacles in interface IObstacleProvider

Parameters:

context - The context to yield the obstacles for.

Returns:

Either null or the result of createPath().

See Also:

IObstacleProvider

getPath

public 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.

getPathGeometry

public final IPathGeometry getPathGeometry(IEdge edge,
                                           IEdgeStyle style)

Gets an implementation of the IPathGeometry interface that can handle the provided edge and its associated style.

Specified by:

getPathGeometry in interface IEdgeStyleRenderer

Parameters:

edge - The edge to provide an instance for

style - The style to use for the painting

Returns:

this

See Also:

configure(), getTangent(double), getTangent(int, double), getSegmentCount(), getPath()

getPen

protected abstract Pen getPen()

Gets the pen to use to render the path.

Returns:

The pen or null.

getSegmentCount

public abstract int getSegmentCount()

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 getPathGeometry(IEdge, IEdgeStyle).

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.

See Also:

getPathGeometry(IEdge, IEdgeStyle)

getSelfLoopDistance

public final double getSelfLoopDistance()

Gets the distance between the node's layout and its self loop control points.

Returns:

The SelfLoopDistance.

See Also:

setSelfLoopDistance(double)

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 0.0d, which effectively turns off path smoothing.

Returns:

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

getSourceArrow

protected abstract IArrow getSourceArrow()

Gets the source arrow from the style.

Returns:

The arrow to use.

getSourceArrowAnchor

protected Tangent getSourceArrowAnchor(IArrow arrow)

Calculate and update the anchor and the source arrow's direction vector.

Parameters:

arrow - The arrow to calculate the anchor for.

Returns:

The anchor and directional vector of the arrow, if any exist.

getStyle

protected final TStyle getStyle()

Gets the currently configured style.

Returns:

The Style.

See Also:

setStyle(IEdgeStyle)

getTangent

public abstract Tangent getTangent(double ratio)

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 getPathGeometry(IEdge, IEdgeStyle).

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.

See Also:

getPathGeometry(IEdge, IEdgeStyle)

getTangent

public abstract Tangent getTangent(int segmentIndex,
                                   double ratio)

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 getPathGeometry(IEdge, IEdgeStyle).

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:

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

getTargetArrow

protected abstract IArrow getTargetArrow()

Gets the target arrow from the style.

Returns:

The arrow to use.

getTargetArrowAnchor

protected Tangent getTargetArrowAnchor(IArrow arrow)

Calculate and update the anchor and the target arrow's direction vector.

Parameters:

arrow - The arrow to calculate the anchor for.

Returns:

The anchor and directional vector of the arrow, if any exist.

getVisibilityTestable

public IVisibilityTestable getVisibilityTestable(IEdge edge,
                                                 IEdgeStyle style)

Configures the style and edge parameters, does not call configure() and returns this.

Unlike most of the other methods this implementation does not call configure(). If the subclass implementation depends on this instance to be configured, it needs to call Configure in isVisible(ICanvasContext, RectD).

Specified by:

getVisibilityTestable in interface IEdgeStyleRenderer

Parameters:

edge - The edge to query visibility tests. The value will be stored in the Edge property.

style - The style to associate with the edge. The value will be stored in the Style property.

Returns:

this

See Also:

isVisible(ICanvasContext, RectD)

getVisualCreator

public IVisualCreator getVisualCreator(IEdge edge,
                                       IEdgeStyle style)

Configures the style and edge parameters, calls configure() and returns this.

Specified by:

getVisualCreator in interface IEdgeStyleRenderer

Parameters:

edge - The edge to retrieve the IVisualCreator for. The value will be stored in the Edge property.

style - The style to associate with the edge. The value will be stored in the Style property.

Returns:

this

See Also:

createVisual(IRenderContext), updateVisual(IRenderContext, Node)

isAddingBridgesEnabled

protected boolean isAddingBridgesEnabled()

Determines whether the rendered path should use the BridgeManager to add bridges to it..

Returns:

The AddingBridgesEnabled.

See Also:

getBridgeCreator()

isHit

public boolean isHit(IInputModeContext context,
                     PointD location)

This method is overridden for performance reasons.

This implementation uses isVisible(ICanvasContext, RectD) as an early exit indicator. If IsVisible returns false for a certain rectangle, the instance will not be configured but a non-hit will be assumed. Otherwise this instance will be configured and the standard path based hit test routine
Subclasses should not depend on the fact that configure() has already been called. This may not be the case. If your subclass depends on Configure being called, override getHitTestable(IEdge, IEdgeStyle) and call configure() after the base class call.

Specified by:

isHit in interface IHitTestable

Parameters:

context - the context the hit test is performed in

location - the coordinates in world coordinate system

Returns:

whether something has been hit

See Also:

getHitTestable(IEdge, IEdgeStyle), configure()

isInBox

public boolean isInBox(IInputModeContext context,
                       RectD rectangle)

Description copied from interface: IMarqueeTestable

This callback returns true if the corresponding item is considered to intersect the given rectangular box.

This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.

Implementations should respect the HitTestRadius if marquee selections should behave differently on different zoom levels.

Specified by:

isInBox in interface IMarqueeTestable

Parameters:

context - the current input mode context

rectangle - the box describing the marquee's bounds

Returns:

true if the item is considered to be captured by the marquee

isVisible

public boolean isVisible(ICanvasContext context,
                         RectD rectangle)

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

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

Specified by:

isVisible in interface IVisibilityTestable

Parameters:

context - the current canvas context

rectangle - the clip bounds

Returns:

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

See Also:

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

Parameters:

type - the type for which an instance shall be returned

Returns:

an instance that is assignable to type or null

setEdge

protected final void setEdge(IEdge value)

Sets the currently configured edge.

Parameters:

value - The Edge to set.

See Also:

getEdge()

setSelfLoopDistance

public final void setSelfLoopDistance(double value)

Sets the distance between the node's layout and its self loop control points.

Parameters:

value - The SelfLoopDistance to set.

See Also:

getSelfLoopDistance()

setStyle

protected final void setStyle(TStyle value)

Sets the currently configured style.

Parameters:

value - The Style to set.

See Also:

getStyle()

updateVisual

public Node updateVisual(IRenderContext context,
                         Node oldVisual)

Description copied from interface: IVisualCreator

This method updates or replaces a previously created Node for inclusion in the IRenderContext.

The CanvasControl uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to IVisualCreator.createVisual(IRenderContext). Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used in.

oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.

Returns:

oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl