ilog.views.linkconnector

Class IlvClippingUtil

java.lang.Object

ilog.views.linkconnector.IlvClippingUtil

public class IlvClippingUtil
extends Object

Utility class for clipping lines and links. These functions are used inside IlvClippingLinkConnector.

Since:

JViews 6.0

Method Summary

Modifier and Type	Method and Description
static IlvPoint	ArcEndPoint(IlvRect rect, double startAngle, double deltaAngle) Returns the end point of an arc (a partial ellipse).
static IlvPoint	ArcStartPoint(IlvRect rect, double startAngle) Returns the starting point of an arc (a partial ellipse).
static IlvPoint	BestClipPointOnRay(IlvPoint startPoint, IlvPoint controlPoint, IlvPoint[] intersectionPoints, int numIntersections) Selects the "best" of n intersection points of a ray for clipping.
static void	ConnectLinksToPoint(IlvGrapher grapher, IlvGraphic node, IlvPoint point, IlvTransformer t, boolean redraw) Tries to connect all links of the input node to the input point.
static void	ConnectToNodeCenters(IlvLinkImage link, boolean fromSide, boolean toSide, IlvTransformer t, boolean redraw) Tries to connect the link to the node centers.
static void	ConnectToPoint(IlvLinkImage link, IlvPoint fromPoint, IlvPoint toPoint, IlvTransformer t, boolean redraw) Tries to connect the link to the given points.
static void	ConnectToViewPoint(IlvLinkImage link, IlvPoint fromPoint, IlvPoint toPoint, IlvTransformer t, boolean redraw) Tries to connect the link to the given points.
static IlvPoint	getClippedPoint(IlvGraphic node, IlvTransformer t, IlvPoint attachPoint, IlvPoint controlPoint) Returns the clipped point, assuming that the attach point is inside the node and the control point is outside the node.
static IlvPoint	getClippedPoint(IlvRect bbox, IlvPoint attachPoint, IlvPoint controlPoint) Returns the clipped point at the bounding box, assuming that the attach point is inside the bounding box, and the control point is outside that bounding box.
static IlvPoint	getClippedPoint(PathIterator pi, IlvTransformer t, double lineWidth, IlvPoint attachPoint, IlvPoint controlPoint) Returns the clipped point, assuming that the attach point is inside the shape described by a shape iterator, and the control point is outside that shape.
static int	LineIntersectsArc(IlvPoint p1, IlvPoint p2, IlvRect rect, double startAngle, double deltaAngle, IlvPoint[] res) Calculates both intersections between a line and an arc (a partial ellipse).
static int	LineIntersectsCubicSpline(IlvPoint p1, IlvPoint p2, IlvPoint[] c, int startIndex, IlvPoint[] res) Calculates all three intersections between a line and a cubic Bezier spline.
static int	LineIntersectsEllipse(IlvPoint p1, IlvPoint p2, IlvRect rect, IlvPoint[] res) Calculates both intersections between a line and an ellipse.
static int	LineIntersectsPolyPoints(IlvPoint p1, IlvPoint p2, IlvPoint[] points, boolean closed, IlvPoint[] res) Calculates the intersections between a line and a polyline or polygon.
static int	LineIntersectsQuadSpline(IlvPoint p1, IlvPoint p2, IlvPoint[] c, int startIndex, IlvPoint[] res) Calculates the two intersections between a line and a quadratic Bezier spline.
static boolean	LineIntersectsSegment(IlvPoint p1, IlvPoint p2, IlvPoint p3, IlvPoint p4, IlvPoint res) Calculates the intersection between a line and a line segment.

Methods inherited from class java.lang.Object

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

Method Detail

ConnectLinksToPoint

public static void ConnectLinksToPoint(IlvGrapher grapher,
                                       IlvGraphic node,
                                       IlvPoint point,
                                       IlvTransformer t,
                                       boolean redraw)

Tries to connect all links of the input node to the input point. The result depends on the behavior of the link connector of the node. This convenience method updates all internal data structures of the grapher, including the quadtree.

Parameters:

grapher - The grapher that contains the node.

node - The node whose links are connected.

point - The untransformed connection point (in manager coordinates).

t - The transformer by which the node is drawn.

redraw - true if the links are redrawn.

ConnectToPoint

public static void ConnectToPoint(IlvLinkImage link,
                                  IlvPoint fromPoint,
                                  IlvPoint toPoint,
                                  IlvTransformer t,
                                  boolean redraw)

Tries to connect the link to the given points. The result depends on the behavior of the link connectors that control the end points of the link. This convenience method updates all internal data structures of the grapher, including the quadtree. The points are given in untransformed manager coordinates of the link.

Parameters:

link - The link to be connected.

fromPoint - The untransformed origin point. If null, the link is not connected at the origin side.

toPoint - The untransformed destination point. If null, the link is not connected at the destination side.

t - The transformer by which the link is drawn.

redraw - true if the link is redrawn.

Since:

JViews 8.8

ConnectToViewPoint

public static void ConnectToViewPoint(IlvLinkImage link,
                                      IlvPoint fromPoint,
                                      IlvPoint toPoint,
                                      IlvTransformer t,
                                      boolean redraw)

Tries to connect the link to the given points. The result depends on the behavior of the link connectors that control the end points of the link. This convenience method updates all internal data structures of the grapher, including the quadtree. The points are given in view coordinates.

Parameters:

link - The link to be connected.

fromPoint - The origin point, in view coordinates. If null, the link is not connected at the origin side.

toPoint - The destination point, in view coordinates. If null, the link is not connected at the destination side.

t - The transformer by which the link is drawn.

redraw - true if the link is redrawn.

Since:

JViews 8.8

ConnectToNodeCenters

public static void ConnectToNodeCenters(IlvLinkImage link,
                                        boolean fromSide,
                                        boolean toSide,
                                        IlvTransformer t,
                                        boolean redraw)

Tries to connect the link to the node centers. The result depends on the behavior of the link connectors that control the end points of the link. This convenience method updates all internal data structures of the grapher, including the quadtree.

Parameters:

link - The link to be connected.

fromSide - Whether the from side gets connected.

toSide - Whether the to side gets connected.

t - The transformer by which the link is drawn.

redraw - true if the link is redrawn.

Since:

JViews 8.8

BestClipPointOnRay

public static IlvPoint BestClipPointOnRay(IlvPoint startPoint,
                                          IlvPoint controlPoint,
                                          IlvPoint[] intersectionPoints,
                                          int numIntersections)

Selects the "best" of n intersection points of a ray for clipping. If any intersection point is on the ray, it returns the one that is farthest from the start of the ray, but before the control point. If no intersection point is on the ray, it returns the one that is closest to the starting point of the ray. If no point is found at all, it returns the start point.

Parameters:

startPoint - The starting point of the ray.

controlPoint - Another point of the ray.

intersectionPoints - An array of intersection points. Typically, these are the intersection points of a line through starting and control points and the border shape of a node.

numIntersections - The number of valid intersections in the array.

Returns:

The best of the intersection points.

LineIntersectsSegment

public static boolean LineIntersectsSegment(IlvPoint p1,
                                            IlvPoint p2,
                                            IlvPoint p3,
                                            IlvPoint p4,
                                            IlvPoint res)

Calculates the intersection between a line and a line segment.

Parameters:

p1 - A point on the line.

p2 - Another point on the line.

p3 - The first end point of the line segment.

p4 - The second end point of the line segment.

res - Container for the resulting intersection point.

Returns:

true if the line intersects the segment at a unique point.

LineIntersectsPolyPoints

public static int LineIntersectsPolyPoints(IlvPoint p1,
                                           IlvPoint p2,
                                           IlvPoint[] points,
                                           boolean closed,
                                           IlvPoint[] res)

Calculates the intersections between a line and a polyline or polygon.

Parameters:

p1 - One point of the line.

p2 - Another point on the line.

points - The points of the polyline or polygon.

closed - true if it is a polygon, false if it is a polyline.

res - Container for the resulting intersection points. This container must must be large enough to get all intersection points.

Returns:

The number of intersections.

LineIntersectsEllipse

public static int LineIntersectsEllipse(IlvPoint p1,
                                        IlvPoint p2,
                                        IlvRect rect,
                                        IlvPoint[] res)

Calculates both intersections between a line and an ellipse.

Parameters:

p1 - One point of the line.

p2 - Another point on the line.

rect - The bounding box of the ellipse.

res - Container of two for the resulting intersection points.

Returns:

The number of intersections.

LineIntersectsArc

public static int LineIntersectsArc(IlvPoint p1,
                                    IlvPoint p2,
                                    IlvRect rect,
                                    double startAngle,
                                    double deltaAngle,
                                    IlvPoint[] res)

Calculates both intersections between a line and an arc (a partial ellipse).

Parameters:

p1 - One point of the line.

p2 - Another point on the line.

rect - The bounding box of the complete ellipse.

startAngle - The angle of the starting point in degrees (0 .. 360).

deltaAngle - The angle range of the arc from the starting point to the end point in degrees (0 .. 360).

res - Container of two for the resulting intersection points.

Returns:

The number of intersections.

LineIntersectsQuadSpline

public static int LineIntersectsQuadSpline(IlvPoint p1,
                                           IlvPoint p2,
                                           IlvPoint[] c,
                                           int startIndex,
                                           IlvPoint[] res)

Calculates the two intersections between a line and a quadratic Bezier spline.

Parameters:

p1 - One point of the line.

p2 - Another point on the line.

c - An array of control points of the spline.

startIndex - The index of the first valid control point in the array c. There must be three valid control points of the spline in the array.

res - Container of two for the resulting intersection points.

Returns:

The number of intersections.

LineIntersectsCubicSpline

public static int LineIntersectsCubicSpline(IlvPoint p1,
                                            IlvPoint p2,
                                            IlvPoint[] c,
                                            int startIndex,
                                            IlvPoint[] res)

Calculates all three intersections between a line and a cubic Bezier spline.

Parameters:

p1 - One point of the line.

p2 - Another point on the line.

c - An array of control points of the spline.

startIndex - The index of the first valid control point in the array c. There must be four valid control points of the spline in the array.

res - Container of three for the resulting intersection points.

Returns:

The number of intersections.

ArcStartPoint

public static IlvPoint ArcStartPoint(IlvRect rect,
                                     double startAngle)

Returns the starting point of an arc (a partial ellipse).

Parameters:

rect - The bounding box of the complete ellipse.

startAngle - The angle of the starting point in degrees (0 .. 360).

Returns:

The starting point.

ArcEndPoint

public static IlvPoint ArcEndPoint(IlvRect rect,
                                   double startAngle,
                                   double deltaAngle)

Returns the end point of an arc (a partial ellipse).

Parameters:

rect - The bounding box of the complete ellipse.

startAngle - The angle of the starting point in degrees (0 .. 360).

deltaAngle - The angle range of the arc from the starting point to the end point in degrees (0 .. 360).

Returns:

The end point.

getClippedPoint

public static IlvPoint getClippedPoint(IlvGraphic node,
                                       IlvTransformer t,
                                       IlvPoint attachPoint,
                                       IlvPoint controlPoint)

Returns the clipped point, assuming that the attach point is inside the node and the control point is outside the node. The attach point, control point and returned point are in view coordinates. If attachPoint and controlPoint are equal, the attachPoint is returned.
It can clip at the border of the following node objects:

• All rectangular objects that fill the bounding box completely.
• All objects that implement the IlvShapePath interface.
• IlvPolygon
• IlvEllipse
• IlvArc
• IlvRectangle
• IlvSpline with a small border line width and smoothness larger than zero. It does not work with IlvGraphicUtil.COMPATIBLE_SMOOTHNESS. If the line width is very large, rounding errors will become visible.
• IlvGeneralPath with a stroke width of 0.

All other objects are clipped against their bounding box.

Parameters:

node - The node to clip against its border.

t - The transformer that is used to draw the node.

attachPoint - The point to which the unclipped link is attached.

controlPoint - The auxiliary control point. For the purpose of clipping, the link can be considered as a ray that starts at the attach point and goes through the control point.

Returns:

The clipped point.

Since:

JViews 8.0

getClippedPoint

public static IlvPoint getClippedPoint(IlvRect bbox,
                                       IlvPoint attachPoint,
                                       IlvPoint controlPoint)

Returns the clipped point at the bounding box, assuming that the attach point is inside the bounding box, and the control point is outside that bounding box. The attach point, control point and returned point are in view coordinates.

Parameters:

bbox - The bounding box in view coordinates.

attachPoint - The point to which the unclipped link is attached.

controlPoint - The auxiliary control point. For the purpose of clipping, the link can be considered as a ray that starts at the attach point and goes through the control point.

Returns:

The clipped point.

Since:

JViews 8.1

getClippedPoint

public static IlvPoint getClippedPoint(PathIterator pi,
                                       IlvTransformer t,
                                       double lineWidth,
                                       IlvPoint attachPoint,
                                       IlvPoint controlPoint)

Returns the clipped point, assuming that the attach point is inside the shape described by a shape iterator, and the control point is outside that shape. The attach point, control point and returned point are in view coordinates.

Parameters:

pi - The iterator of the shape path.

t - The transformer that is used to draw the node.

lineWidth - The line width in transformed coordinates.

attachPoint - The point to which the unclipped link is attached.

controlPoint - The auxiliary control point. For the purpose of clipping, the link can be considered as a ray that starts at the attach point and goes through the control point.

Returns:

The clipped point.

Since:

JViews 8.1