gumbo.graphic.content
Interface LinkableGraphic

All Superinterfaces:

Graphic

All Known Implementing Classes:

SwingGraphVertex

public interface LinkableGraphic

extends Graphic

A graphic capability allowing a graphic entity to be (or appear to be) linked by another graphic entity, such as a linking graphic (see LinkingGraphic). Typically, the linking graphic geometry appears to start at some "center" point, but only becomes visiable at an "edge" point. Typically, as their names imply (but do not require), the center point is at the geometric center of the graphic, and the edge point is on or just outside its edge.

Version:

$Revision: 1.6 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Method Summary

Point3	getGraphicLinkCenter(Point3 retVal) Gets the "center" point to be used by a linking graphic's shape.
Point3	getGraphicLinkEdge(Point3 point, Point3 retVal) Gets the "edge" point to be used by a linking graphic's shape in linking the center point (returned by getGraphicLinkCenter()) to some other point in space.

Methods inherited from interface gumbo.graphic.Graphic

getGraphic

Method Detail

getGraphicLinkCenter

public Point3 getGraphicLinkCenter(Point3 retVal)

Gets the "center" point to be used by a linking graphic's shape. May not be the actual geometric center of this graphic's shape.

Parameters:

retVal - Return value object. Never null.

Returns:

Reference to retVal. Never null.

getGraphicLinkEdge

public Point3 getGraphicLinkEdge(Point3 point,
                                 Point3 retVal)

Gets the "edge" point to be used by a linking graphic's shape in linking the center point (returned by getGraphicLinkCenter()) to some other point in space. Typically, the edge point is the straightline intersection of the line segment defined by the center and other point, and the graphic shape's surface.

Parameters:

point - Some point in space (inside, on, or outside this graphic's shape). Never null.

retVal - Return value object. Never null.

Returns:

Reference to retVal. Never null.