ilog.views.sdm.graphic

Class IlvGeneralLinkTunnelCrossings

java.lang.Object

ilog.views.IlvGraphic

ilog.views.graphic.linkpolicy.IlvAbstractCrossingGraphic

ilog.views.sdm.graphic.IlvGeneralLinkTunnelCrossings

All Implemented Interfaces:

IlvCrossingGraphic, IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable

public class IlvGeneralLinkTunnelCrossings
extends IlvAbstractCrossingGraphic

An IlvGeneralLinkTunnelCrossings instance is an auxiliary graphic that is used in combination with an IlvGeneralLink. The tunnel crossing graphic draws the tunnel shapes for link crossings. It must be in a manager layer that is above all layers that contain links. Normally, the crossing link shape policy takes care of this automatically.

Notice that each link needs its own crossing graphic. Crossing graphics cannot be shared by several links. A new tunnel crossing graphic together with a crossing link shape policy are automatically installed at a general link when the tunnel crossing mode is set, by link.setCrossingMode(IlvGeneralLink.TUNNEL_CROSSINGS).

Usually, it is not necessary to install the tunnel graphic explicitly, because the crossing mode of IlvGeneralLink handles it automatically. The following example illustrates how to install a tunnel crossing graphic that is updated by the crossing link shape policy explicitly:

 IlvCrossingLinkShapePolicy policy = new IlvCrossingLinkShapePolicy();
 // the policy can be shared by links, but each link needs its own
 // tunnel crossing object
 IlvGeneralLink link = new IlvGeneralLink(node1, node2, true, null);
 link.setCrossingGraphic(new IlvGeneralLinkTunnelCrossings(link));
 link.setLinkShapePolicy(policy);
 ...
 

Since:

JViews 6.0

See Also:

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

Constructor Summary

Constructors

Constructor and Description
IlvGeneralLinkTunnelCrossings(IlvCrossingAwareLinkImage link) Creates a new IlvGeneralLinkTunnelCrossings instance.
IlvGeneralLinkTunnelCrossings(IlvGeneralLinkTunnelCrossings source) Creates a new IlvGeneralLinkTunnelCrossings instance by copying an existing one.
IlvGeneralLinkTunnelCrossings(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	contains(IlvPoint p, IlvPoint tp, IlvTransformer t) Tests whether a point lies within the outline of this object.
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 whether a point lies within the drawing of a crossing.
IlvGraphic	copy() Copies the crossing graphic.
void	draw(Graphics dst, IlvTransformer t) Draws the object.
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 of 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.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.
boolean	zoomable() Returns true if the object is zoomable; otherwise returns false.

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

applyTransform, boundingBox, calcBoundingBox, calcBoundingBoxOfLink, crossingChanged, getBoundingBoxCacheSize, getRelatedLinkImage, setBoundingBoxCacheSize, setGraphicBag, setRelatedLinkImage

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

IlvGeneralLinkTunnelCrossings

public IlvGeneralLinkTunnelCrossings(IlvCrossingAwareLinkImage link)

Creates a new IlvGeneralLinkTunnelCrossings instance.

Parameters:

link - The link to which this object belongs.

IlvGeneralLinkTunnelCrossings

public IlvGeneralLinkTunnelCrossings(IlvGeneralLinkTunnelCrossings source)

Creates a new IlvGeneralLinkTunnelCrossings instance by copying an existing one. The reference to the link to which this object belongs is not copied.

Parameters:

source - The object to be copied.

IlvGeneralLinkTunnelCrossings

public IlvGeneralLinkTunnelCrossings(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. The reference to the link to which this object belongs is not copied.

Specified by:

copy in class IlvGraphic

Returns:

A copy of the object.

See Also:

IlvGraphic

draw

public void draw(Graphics dst,
                 IlvTransformer t)

Draws the object. This method delegates to the related link image.

Overrides:

draw in class IlvAbstractCrossingGraphic

Parameters:

dst - The destination Graphics object.

t - The transformation used to draw the object.

See Also:

IlvCrossingAwareLinkImage.drawCrossingGraphic(java.awt.Graphics, ilog.views.IlvTransformer)

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 of the input links. The input points and gaps are transformed by the input transformer.

Parameters:

dst - The destination Graphics object.

t - The transformation used to draw the first link.

link1 - The first link, which is the link containing the 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 the start point and the link crossing.

endGap - The real gap between the 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.

contains

public boolean contains(IlvPoint p,
                        IlvPoint tp,
                        IlvTransformer t)

Tests whether a point lies within the outline of this object.

Overrides:

contains in class IlvAbstractCrossingGraphic

Parameters:

p - The point to be tested.

tp - The point p transformed by the transformer t.

t - The transformation used to draw the object.

Returns:

true if the point lies inside this graphic object.

See Also:

IlvCrossingAwareLinkImage.containsAtCrossingGraphic(ilog.views.IlvPoint, ilog.views.IlvPoint, ilog.views.IlvTransformer)

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 whether 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 the 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 the start point and the link crossing.

endGap - The real gap between the 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 the 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 the start point and the link crossing.

endGap - The real gap between the 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.

zoomable

public boolean zoomable()

Returns true if the object is zoomable; otherwise returns false.

Overrides:

zoomable in class IlvAbstractCrossingGraphic

See Also:

IlvCrossingAwareLinkImage.isGapZoomable()

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.