Views
Grapher Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvOneSplineLinkImage Class Reference

Implementation of links drawn with a spline defined by 2 orthogonal segments. More...

#include <ilviews/grapher/links.h>

Inheritance diagram for IlvOneSplineLinkImage:
IlvOneLinkImage IlvLinkImage IlvSimpleGraphic IlvGraphic IlvValueInterface

Public Member Functions

 IlvOneSplineLinkImage (IlvDisplay *display, IlvLinkOrientation orientation, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
 Constructor. More...
 
virtual IlvPointgetLinkPoints (IlUInt &nPoints, const IlvTransformer *t=0) const
 Returns the points defining the shape of the link. More...
 
void setControlPoint (const IlvPoint &p, const IlvTransformer *t=0)
 Sets the coordinates of the double control point. More...
 
- Public Member Functions inherited from IlvOneLinkImage
 IlvOneLinkImage (IlvDisplay *display, IlvLinkOrientation orientation, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
 Constructor. More...
 
IlvLinkOrientation getOrientation () const
 Returns the orientation of the link. More...
 
void setOrientation (IlvLinkOrientation orient)
 Changes the orientation of the link. More...
 
- Public Member Functions inherited from IlvLinkImage
 IlvLinkImage (IlvDisplay *display, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
 Constructor. More...
 
virtual void computePoints (IlvPoint &src, IlvPoint &dst, const IlvTransformer *t=0) const
 Computes the endpoints of the link when it is drawn as a straight line. More...
 
IlvGraphicgetFrom () const
 Returns the start node. More...
 
IlvGraphicgetTo () const
 Returns the end node. More...
 
IlBoolean isOriented () const
 Indicates whether the link is oriented. More...
 
void setFrom (IlvGraphic *f)
 Sets the start node. More...
 
void setOriented (IlBoolean oriented)
 Changes the oriented mode. More...
 
void setTo (IlvGraphic *t)
 Sets the end node. More...
 
virtual IlBoolean zoomable () const
 Returns the zoomable property of the link. More...
 

Detailed Description

Implementation of links drawn with a spline defined by 2 orthogonal segments.

Library: ilvgrapher

A link of the IlvOneSplineLinkImage class is drawn as a spline, as shown in the figure below. It inherits its orientation from the IlvOneLinkImage class.
The start and end points both depend on the relative positions of the start and end nodes. The two control points of the drawn spline are both at the crossing coordinate of the start and end tangents of the link. You are given the opportunity to modify the position of the double control point with the setControlPoint member function.

- IlvOneSplineLinkImage -

See also
IlvMakeOneSplineLinkImageInteractor.

Constructor & Destructor Documentation

◆ IlvOneSplineLinkImage()

IlvOneSplineLinkImage::IlvOneSplineLinkImage ( IlvDisplay display,
IlvLinkOrientation  orientation,
IlBoolean  oriented,
IlvGraphic from,
IlvGraphic to,
IlvPalette palette = 0 
)

Constructor.

Initializes a new instance of the IlvOneSplineLinkImage class. The orientation parameter specifies the direction (horizontal or vertical) the link takes upon leaving the from node.

Parameters
displayThe display connection that handles the drawing of this object.
orientationThe orientation for the link.
orientedA Boolean indicating whether an arrowhead is to be drawn at the end of the link.
fromThe IlvGraphic object representing the start node of the link.
toThe IlvGraphic object representing the end node of the link.
paletteThe palette used to draw the link.

Member Function Documentation

◆ getLinkPoints()

virtual IlvPoint* IlvOneSplineLinkImage::getLinkPoints ( IlUInt nPoints,
const IlvTransformer t = 0 
) const
virtual

Returns the points defining the shape of the link.

Returns an array of points defining the shape of the link when it is drawn with the transformer t. The size of the resulting array of points is returned in the nPoints parameter. The array is stored in an IlPoolOf(IlvPoint) and should not be deleted or modified.
This method is internally used by the methods draw, contains, and boundingBox. It is meant to replace various methods defined in subclasses in previous releases of Rogue Wave Views; like the obsolete IlvOneLinkImage::getPoints.
This function is overloaded by subclasses defining a specific shape for links. The default implementation returns an array of two points computed with the IlvLinkImage::computePoints method.

Parameters
nPointsThe number of points in the returned array.
tThe transformer applied to the link.
Returns
The points defining the shape of the link.

Reimplemented from IlvOneLinkImage.

◆ setControlPoint()

void IlvOneSplineLinkImage::setControlPoint ( const IlvPoint p,
const IlvTransformer t = 0 
)

Sets the coordinates of the double control point.

Parameters
pThe new position for the double control point.
tThe transformer applied to the link.