ilog.views.graphic.linkpolicy

Class IlvBridgeCrossings

java.lang.Object

ilog.views.IlvGraphic

ilog.views.graphic.linkpolicy.IlvAbstractCrossingGraphic

ilog.views.graphic.linkpolicy.IlvBridgeCrossings

All Implemented Interfaces:

IlvCrossingGraphic, IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable

public class IlvBridgeCrossings
extends IlvAbstractCrossingGraphic

An IlvBridgeCrossings is an auxiliary graphic object that is used in combination with an IlvCrossingAwareLinkImage or IlvEnhancedPolylineLinkImage. The bridge crossing graphic draws the bridge shapes of the link crossings. It must be in a manager layer that is above all layers that contain links. Normally, the crossing link shape policy take care of this automatically.
Notice that each link needs its own crossing graphic. It cannot be shared among links. A new bridge crossing graphic together with a crossing link shape policy is automatically installed at an enhanced link image when the bridge crossing mode is used, via link.setCrossingMode(IlvEnhancedPolylineLinkImage.BRIDGE_CROSSINGS);.
Usually, it is not necessary to install the bridge graphic explicitly. The following example illustrates how to install a bridge crossing graphic explicitly that is updated by the crossing link shape policy:

 IlvCrossingLinkShapePolicy policy = new IlvCrossingLinkShapePolicy();
 // the policy can be shared among links, but each link needs its own
 // bridge crossing object
 IlvCrossingAwareLinkImage link = new IlvCrossingAwareLinkImage(node1, node2, true, null);
 link.setCrossingGraphic(new IlvBridgeCrossings(link));
 link.setLinkShapePolicy(policy);
 ...
 

Since:

JViews 6.0

See Also:

IlvEnhancedPolylineLinkImage, IlvCrossingAwareLinkImage.getCrossingGraphic(), IlvPolicyAwareLinkImage.getLinkShapePolicy(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvBridgeCrossings(IlvBridgeCrossings source) Creates a new IlvBridgeCrossings by copying an existing one.
IlvBridgeCrossings(IlvCrossingAwareLinkImage link) Creates a new IlvBridgeCrossings.
IlvBridgeCrossings(IlvInputStream stream) Reads the object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
void	addCrossingBound(IlvRect boundingRect, IlvTransformer t, IlvLinkImage link1, IlvLinkImage link2, IlvPoint p0, IlvPoint p1, IlvPoint p2, IlvPoint p3, double startGap, double endGap, double normalGap) Adds the bound of the crossing to the input bounding rectangle.
boolean	containsAtCrossing(IlvPoint p, IlvPoint tp, IlvTransformer t, IlvLinkImage link1, IlvLinkImage link2, IlvPoint p0, IlvPoint p1, IlvPoint p2, IlvPoint p3, double startGap, double endGap, double normalGap) Tests if a point lies within the drawing of a crossing.
IlvGraphic	copy() Copies the crossing graphic.
void	drawCrossing(Graphics dst, IlvTransformer t, IlvLinkImage link1, IlvLinkImage link2, IlvPoint p0, IlvPoint p1, IlvPoint p2, IlvPoint p3, double startGap, double endGap, double normalGap) Draws the crossing between the input links.
IlvRect	expandLinkBoundingBox(IlvRect linkBounds, IlvTransformer t) Expands the input bounding box, which is the bounds of the link without crossing shape, by a margin that is large enough to contain all drawings of crossings displayed by this crossing graphic.
double	getBridgeLengthFactor() Returns the bridge length factor.
void	setBridgeLengthFactor(double factor) Sets the bridge length factor.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class ilog.views.graphic.linkpolicy.IlvAbstractCrossingGraphic

applyTransform, boundingBox, calcBoundingBox, calcBoundingBoxOfLink, contains, crossingChanged, draw, getBoundingBoxCacheSize, getRelatedLinkImage, setBoundingBoxCacheSize, setGraphicBag, setRelatedLinkImage, zoomable

Methods inherited from class ilog.views.IlvGraphic

addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, getAndAssociateObjectInteractor, getBaseTextDirection, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getComponentOrientation, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getResolvedBaseTextDirection, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getULocale, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, invalidateBidiCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, makeSelection, move, move, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBackground, setBaseTextDirection, setBaseTextDirectionDuringConstruction, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setForeground, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, translate, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBridgeCrossings

public IlvBridgeCrossings(IlvCrossingAwareLinkImage link)

Creates a new IlvBridgeCrossings.

Parameters:

link - The link this object belongs to.

IlvBridgeCrossings

public IlvBridgeCrossings(IlvBridgeCrossings source)

Creates a new IlvBridgeCrossings by copying an existing one. It does not copy the reference to the link this object belongs to.

Parameters:

source - The origin object for the copy.

IlvBridgeCrossings

public IlvBridgeCrossings(IlvInputStream stream)
                   throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

copy

public IlvGraphic copy()

Copies the crossing graphic. It does not copy the reference to the link this object belongs to.

Specified by:

copy in class IlvGraphic

Returns:

A copy of the object.

See Also:

IlvGraphic

setBridgeLengthFactor

public void setBridgeLengthFactor(double factor)

Sets the bridge length factor. The length of the bridge is calculated from the link width multiplied by the bridge length factor. The default factor is 3.

See Also:

getBridgeLengthFactor()

getBridgeLengthFactor

public final double getBridgeLengthFactor()

Returns the bridge length factor.

See Also:

setBridgeLengthFactor(double)

drawCrossing

public void drawCrossing(Graphics dst,
                         IlvTransformer t,
                         IlvLinkImage link1,
                         IlvLinkImage link2,
                         IlvPoint p0,
                         IlvPoint p1,
                         IlvPoint p2,
                         IlvPoint p3,
                         double startGap,
                         double endGap,
                         double normalGap)

Draws the crossing between the input links. The input points and gaps are transformed by the input transformer.

Parameters:

dst - The destination Graphics.

t - The transformation used to draw the first link.

link1 - The first link, which is the link containing this crossing graphic.

link2 - The second link.

p0 - The point before the start point of the crossing picture inside the first link.

p1 - The start point of the crossing picture inside the first link.

p2 - The end point of the crossing picture inside the first link.

p3 - The point after the end point of the crossing picture inside the first link.

startGap - The real gap between start point and the link crossing.

endGap - The real gap between end point and the link crossing.

normalGap - The desired normal gap at the link crossing. The start gap and end gap may be smaller than the normal gap.

containsAtCrossing

public boolean containsAtCrossing(IlvPoint p,
                                  IlvPoint tp,
                                  IlvTransformer t,
                                  IlvLinkImage link1,
                                  IlvLinkImage link2,
                                  IlvPoint p0,
                                  IlvPoint p1,
                                  IlvPoint p2,
                                  IlvPoint p3,
                                  double startGap,
                                  double endGap,
                                  double normalGap)

Tests if a point lies within the drawing of a crossing. The input points and gaps are transformed by the input transformer.

Specified by:

containsAtCrossing in interface IlvCrossingGraphic

Overrides:

containsAtCrossing in class IlvAbstractCrossingGraphic

Parameters:

p - The point to be tested. This point is untransformed.

tp - The point p transformed by the transformer t.

t - The transformation used to draw the first link.

link1 - The first link, which is the link containing this crossing graphic.

link2 - The second link.

p0 - The point before the start point of the crossing picture inside the first link.

p1 - The start point of the crossing picture inside the first link.

p2 - The end point of the crossing picture inside the first link.

p3 - The point after the end point of the crossing picture inside the first link.

startGap - The real gap between start point and the link crossing.

endGap - The real gap between end point and the link crossing.

normalGap - The desired normal gap at the link crossing. The start gap and end gap may be smaller than the normal gap.

expandLinkBoundingBox

public IlvRect expandLinkBoundingBox(IlvRect linkBounds,
                                     IlvTransformer t)

Expands the input bounding box, which is the bounds of the link without crossing shape, by a margin that is large enough to contain all drawings of crossings displayed by this crossing graphic.

Parameters:

linkBounds - The bounds of the link

t - The transformer to draw the link

Since:

JViews 8.5

addCrossingBound

public void addCrossingBound(IlvRect boundingRect,
                             IlvTransformer t,
                             IlvLinkImage link1,
                             IlvLinkImage link2,
                             IlvPoint p0,
                             IlvPoint p1,
                             IlvPoint p2,
                             IlvPoint p3,
                             double startGap,
                             double endGap,
                             double normalGap)

Adds the bound of the crossing to the input bounding rectangle. The input points and gaps are transformed by the input transformer.

Parameters:

boundingRect - The bounding rectangle containing the result.

t - The transformation used to draw the first link.

link1 - The first link, which is the link containing this crossing graphic.

link2 - The second link.

p0 - The point before the start point of the crossing picture inside the first link.

p1 - The start point of the crossing picture inside the first link.

p2 - The end point of the crossing picture inside the first link.

p3 - The point after the end point of the crossing picture inside the first link.

startGap - The real gap between start point and the link crossing.

endGap - The real gap between end point and the link crossing.

normalGap - The desired normal gap at the link crossing. The start gap and end gap may be smaller than the normal gap.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvAbstractCrossingGraphic

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.