IlvOneLinkImage Class Reference

Implementation of links drawn with 2 orthogonal segments. More...

#include <ilviews/grapher/links.h>

Inheritance diagram for IlvOneLinkImage:

List of all members.

Public Member Functions
	IlvOneLinkImage (IlvDisplay *display, IlvLinkOrientation orientation, IlBoolean oriented, IlvGraphic *from, IlvGraphic *to, IlvPalette *palette=0)
	Constructor.
virtual IlvPoint *	getLinkPoints (IlUInt &nPoints, const IlvTransformer *t=0) const
	Returns the points defining the shape of the link.
IlvLinkOrientation	getOrientation () const
	Returns the orientation of the link.
void	setOrientation (IlvLinkOrientation orient)
	Changes the orientation of the link.

---

Detailed Description

Implementation of links drawn with 2 orthogonal segments.

Library: ilvgrapher

Links of the IlvOneLinkImage class are made of two lines forming a right angle, as shown in the following figure:

- IlvOneLinkImage -

See also:

IlvLinkOrientation, IlvMakeLinkImageInteractor.

---

Constructor & Destructor Documentation

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

Constructor.

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

Parameters:

	display	The display connection that handles the drawing of this object.
	orientation	The orientation for the link.
	oriented	A Boolean indicating whether an arrowhead is to be drawn at the end of the link.
	from	The IlvGraphic object representing the start node of the link.
	to	The IlvGraphic object representing the end node of the link.
	palette	The palette used to draw the link.

---

Member Function Documentation

virtual IlvPoint* IlvOneLinkImage::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:

	nPoints	The number of points in the returned array.
	t	The transformer applied to the link.

Returns:

The points defining the shape of the link.

Reimplemented from IlvLinkImage.

Reimplemented in IlvOneSplineLinkImage.

IlvLinkOrientation IlvOneLinkImage::getOrientation

(

)

const

Returns the orientation of the link.

Returns:

The orientation of the link (IlvHorizontalLink or IlvVerticalLink).

void IlvOneLinkImage::setOrientation

(

IlvLinkOrientation

orient

)

Changes the orientation of the link.

Sets the orientation of the link (IlvHorizontalLink or IlvVerticalLink).

Parameters:

orient

The new orientation.