com.bbn.openmap.omGraphics
Class OMLine

java.lang.Object
  com.bbn.openmap.omGraphics.geom.BasicGeometry
      com.bbn.openmap.omGraphics.OMGraphicAdapter
          com.bbn.openmap.omGraphics.OMAbstractLine
              com.bbn.openmap.omGraphics.OMLine

All Implemented Interfaces:

NonRegional, OMGeometry, OMGraphic, OMGraphicConstants, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

Line, RoadFinder.BlueLine, RoadFinder.YellowLine, RoadLine.Graphic, TimelineLayer.EventMarkerLine

public class OMLine
extends OMAbstractLine
implements java.io.Serializable, NonRegional

Graphic object that represents a simple line.

The OMLine is used to create simple lines, from one point on the window to the other. If you want to have a line with several parts, use OMPoly as a polyline with no fillColor.

NOTE:

See the RESTRICTIONS on Lat/Lon lines. Not following the guidelines listed may result in ambiguous/undefined shapes! Similar assumptions apply to the other vector graphics that we define: circles, ellipses, rects, polys.

See Also:

OMPoly, Serialized Form

Field Summary

protected ArcCalc	arc For x-y and offset lines, there is the ability to put a curve in the line.
static int	CURVED_LINE
protected boolean	isPolyline Figured out after generation, based on what's going on with the map.
protected double[]	latlons latlons is a array of 4 doubles - lat1, lon1, lat2, lon2.
protected int[]	pts pts is an array of 4 ints - px1, py1, px2, py2.
static int	STRAIGHT_LINE

Fields inherited from class com.bbn.openmap.omGraphics.OMAbstractLine

arrowhead, nsegs, xpoints, ypoints

Fields inherited from class com.bbn.openmap.omGraphics.OMGraphicAdapter

declutterType, displayPaint, edgeMatchesFill, fillPaint, hasLabel, linePaint, matted, mattingPaint, renderType, selected, selectPaint, showEditablePalette, stroke, textureMask

Fields inherited from class com.bbn.openmap.omGraphics.geom.BasicGeometry

attributes, lineType, needToRegenerate, shape, visible

Fields inherited from interface com.bbn.openmap.omGraphics.OMGraphicConstants

ADD_GRAPHIC_MASK, APP_OBJECT, BASIC_STROKE, CHANGE_APPEARANCE, clear, DECIMAL_DEGREES, DECLUTTERTYPE_LINE, DECLUTTERTYPE_MOVE, DECLUTTERTYPE_NONE, DECLUTTERTYPE_SPACE, DEFAULT_ROTATIONANGLE, DELETE_GRAPHIC_MASK, DESELECT_GRAPHIC_MASK, DESELECTALL_GRAPHIC_MASK, GRAPHICTYPE_ARC, GRAPHICTYPE_BITMAP, GRAPHICTYPE_CIRCLE, GRAPHICTYPE_ELLIPSE, GRAPHICTYPE_GRAPHIC, GRAPHICTYPE_GRID, GRAPHICTYPE_LINE, GRAPHICTYPE_POINT, GRAPHICTYPE_POLY, GRAPHICTYPE_RASTER, GRAPHICTYPE_RECTANGLE, GRAPHICTYPE_TEXT, INDEX, INFOLINE, LABEL, LINETYPE_GREATCIRCLE, LINETYPE_RHUMB, LINETYPE_STRAIGHT, LINETYPE_UNKNOWN, LOWER_GRAPHIC_MASK, LOWER_TO_BOTTOM_GRAPHIC_MASK, NO_ROTATE, OMGRAPHIC_ELT, OMGRAPHIC_TYPE_ATTR, RADIANS, RAISE_GRAPHIC_MASK, RAISE_TO_TOP_GRAPHIC_MASK, REMOVABLE, RENDERTYPE_LATLON, RENDERTYPE_OFFSET, RENDERTYPE_UNKNOWN, RENDERTYPE_XY, SELECT_GRAPHIC_MASK, SORT_GRAPHICS_MASK, TOOLTIP, UPDATE_GRAPHIC_MASK, UPDATED

Constructor Summary

OMLine()
Generic constructor, attributes need to filled later.

OMLine(double lat_1, double lon_1, double lat_2, double lon_2, int lineType)
Create a line from lat lon points.

OMLine(double lat_1, double lon_1, double lat_2, double lon_2, int lineType, int nsegs)
Create a line from lat lon points.

OMLine(double lat_1, double lon_1, int x1, int y1, int x2, int y2)
Create a line between two x-y points on the window, where the x-y points are offsets from a lat-lon point.

OMLine(int x1, int y1, int x2, int y2)
Create a line between two xy points on the window.

Method Summary

boolean	contains(double x, double y) This takes the area out of OMLines that may look like they have area, depending on their shape.
boolean	generate(Projection proj) Prepare the line for rendering.
ArcCalc	getArc() Return the arc angle set for this line.
double[]	getLL() Get the lat lon values of the end points of the line in an array of doubles - lat1, lon1, lat2, lon2.
int	getNumSegs() Get the number of segments of the lat/lon line.
int[]	getPts() Get the xy values of the end points of the line in an array of ints - x1, y1, x2, y2 .
boolean	isPolyline() Check to see if this line is a polyline.
void	render(java.awt.Graphics g) Paint the line.
void	restore(OMGeometry source) Takes the generic OMGraphic settings from another OMGraphic and pushes them to this one.
void	setArc(ArcCalc ac) Set the arc that is drawn between the points of a x-y or offset line.
void	setLL(double[] lls) Set the lat lon values of the end points of the line from an array of doubles - lat1, lon1, lat2, lon2.
void	setNumSegs(int nsegs) Set the number of segments of the lat/lon line.
void	setPts(int[] xys) Set the xy values of the end points of the line from an array of ints - x1, y1, x2, y2 .
boolean	shouldRenderFill() The OMLine should never render fill.

Methods inherited from class com.bbn.openmap.omGraphics.OMAbstractLine

addArrowHead, addArrowHead, addArrowHead, addArrowHead, createArrowHeads, getArrowDirectionType, getArrowHead, getArrowLocation, getWingLength, getWingTip, hasArrowHead, restore, setArrowHead

Methods inherited from class com.bbn.openmap.omGraphics.OMGraphicAdapter

clone, deselect, distance, getDeclutterType, getDisplayColor, getDisplayPaint, getEdgeMatchesFill, getFillColor, getFillPaint, getHasLabel, getLineColor, getLinePaint, getMattingPaint, getRenderType, getSelectColor, getSelectPaint, getShowEditablePalette, getStroke, getTextureMask, hasLineTypeChoice, initLabelingDuringGenerate, isClear, isMatted, isSelected, normalizeDistanceForLineWidth, readStroke, readTextureMask, regenerate, renderLabel, renderShape, select, setDeclutterType, setEdgeMatchesFill, setFillColor, setFillPaint, setGraphicsColor, setGraphicsForEdge, setGraphicsForFill, setHasLabel, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLineColor, setLinePaint, setMatted, setMattingPaint, setRenderType, setSelectColor, setSelected, setSelectPaint, setShowEditablePalette, setStroke, setTextureMask, shouldRenderEdge, writeStroke, writeTextureMask

Methods inherited from class com.bbn.openmap.omGraphics.geom.BasicGeometry

_distance, appendShapeEdge, appendShapeEdge, appendShapeEdge, appendShapeEdge, clearAttributes, createAttributeMap, createBoxShape, createShape, createShape, describeShapeDetail, describeShapeDetail, distanceToEdge, distanceToEdge, draw, draw, fill, fill, getAppObject, getAttribute, getAttributes, getDescription, getLineType, getNeedToRegenerate, getShape, isRenderable, isRenderable, isVisible, putAttribute, removeAttribute, setAppObject, setAttributes, setLineType, setNeedToRegenerate, setShape, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bbn.openmap.omGraphics.OMGraphic

clone, deselect, getDeclutterType, getDisplayColor, getDisplayPaint, getFillColor, getFillPaint, getLineColor, getLinePaint, getMattingPaint, getRenderType, getSelectColor, getSelectPaint, getShowEditablePalette, getStroke, getTextureMask, hasLineTypeChoice, isMatted, isSelected, normalizeDistanceForLineWidth, regenerate, renderLabel, select, setDeclutterType, setFillPaint, setGraphicsColor, setGraphicsForEdge, setGraphicsForFill, setLabelLocation, setLabelLocation, setLabelLocation, setLinePaint, setMatted, setMattingPaint, setRenderType, setSelected, setSelectPaint, setShowEditablePalette, setStroke, setTextureMask, shouldRenderEdge

Methods inherited from interface com.bbn.openmap.omGraphics.OMGeometry

clearAttributes, distance, distanceToEdge, draw, draw, fill, fill, getAppObject, getAttribute, getAttributes, getDescription, getLineType, getNeedToRegenerate, getShape, isRenderable, isRenderable, isVisible, putAttribute, removeAttribute, setAppObject, setAttributes, setLineType, setNeedToRegenerate, setShape, setVisible

Field Detail

isPolyline

protected transient boolean isPolyline

Figured out after generation, based on what's going on with the map.

latlons

protected double[] latlons

latlons is a array of 4 doubles - lat1, lon1, lat2, lon2.

pts

protected int[] pts

pts is an array of 4 ints - px1, py1, px2, py2.

arc

protected ArcCalc arc

For x-y and offset lines, there is the ability to put a curve in the line. This setting is the amount of an angle, limited to a semi-circle (PI) that the curve will represent. In other words, the arc between the two end points is going to look like a 0 degrees of a circle (straight line, which is the default), or 180 degrees of a circle (full semi-circle). Given in radians, though, not degrees. The ArcCalc object handles all the details.

STRAIGHT_LINE

public static final int STRAIGHT_LINE

See Also:

Constant Field Values

CURVED_LINE

public static final int CURVED_LINE

See Also:

Constant Field Values

Constructor Detail

OMLine

public OMLine()

Generic constructor, attributes need to filled later.

OMLine

public OMLine(double lat_1,
              double lon_1,
              double lat_2,
              double lon_2,
              int lineType)

Create a line from lat lon points.

Parameters:

lat_1 - latitude of first point, decimal degrees.

lon_1 - longitude of first point, decimal degrees.

lat_2 - latitude of second point, decimal degrees.

lon_2 - longitude of second point, decimal degrees.

lineType - a choice between LINETYPE_STRAIGHT, LINETYPE_GREATCIRCLE or LINETYPE_RHUMB.

OMLine

public OMLine(double lat_1,
              double lon_1,
              double lat_2,
              double lon_2,
              int lineType,
              int nsegs)

Create a line from lat lon points.

Parameters:

lat_1 - latitude of first point, decimal degrees.

lon_1 - longitude of first point, decimal degrees.

lat_2 - latitude of second point, decimal degrees.

lon_2 - longitude of second point, decimal degrees.

lineType - a choice between LINETYPE_STRAIGHT, LINETYPE_GREATCIRCLE or LINETYPE_RHUMB.

nsegs - number of segment points (only for LINETYPE_GREATCIRCLE or LINETYPE_RHUMB line types, and if < 1, this value is generated internally)

OMLine

public OMLine(int x1,
              int y1,
              int x2,
              int y2)

Create a line between two xy points on the window.

Parameters:

x1 - the x location of the first point, in pixels from the left of the window.

y1 - the y location of the first point, in pixels from the top of the window.

x2 - the x location of the second point, in pixels from the left of the window.

y2 - the y location of the second point, in pixels from the top of the window.

OMLine

public OMLine(double lat_1,
              double lon_1,
              int x1,
              int y1,
              int x2,
              int y2)

Create a line between two x-y points on the window, where the x-y points are offsets from a lat-lon point. It assumes that you'll want a straight window line between the points, so if you don't, use the setLineType() method to change it.

Parameters:

lat_1 - the latitude of the reference point of the line, in decimal degrees.

lon_1 - the longitude of the reference point of the line, in decimal degrees.

x1 - the x location of the first point, in pixels from the longitude point.

y1 - the y location of the first point, in pixels from the latitude point.

x2 - the x location of the second point, in pixels from the longitude point.

y2 - the y location of the second point, in pixels from the latitude point.

Method Detail

setLL

public void setLL(double[] lls)

Set the lat lon values of the end points of the line from an array of doubles - lat1, lon1, lat2, lon2. This does not look at the line render type, so it acts accordingly. LL1 is only used in RENDERTYPE_LATLON, RENDERTYPE_OFFSET, and LL2 is only used in RENDERTYPE_LATLON.

Parameters:

lls - array of doubles - lat1, lon1, lat2, lon2

getLL

public double[] getLL()

Get the lat lon values of the end points of the line in an array of doubles - lat1, lon1, lat2, lon2. Again, this does not look at the line render type, so it acts accordingly. LL1 is only used in RENDERTYPE_LATLON, RENDERTYPE_OFFSET, and LL2 is only used in RENDERTYPE_LATLON.

Returns:

the lat lon array, and all are decimal degrees.

setPts

public void setPts(int[] xys)

Set the xy values of the end points of the line from an array of ints - x1, y1, x2, y2 . This does not look at the line render type, so it acts accordingly. p1 and p2 are only used in RENDERTYPE_XY, RENDERTYPE_OFFSET.

Parameters:

xys - array of ints for the points - x1, y1, x2, y2

getPts

public int[] getPts()

Get the xy values of the end points of the line in an array of ints - x1, y1, x2, y2 . This does not look at the line render type, so it acts accordingly. p1 and p2 are only used in RENDERTYPE_XY, RENDERTYPE_OFFSET.

Returns:

the array of x-y points, and all are pixel values

isPolyline

public boolean isPolyline()

Check to see if this line is a polyline. This is a polyline if it is LINETYPE_GREATCIRCLE or LINETYPE_RHUMB for RENDERTYPE_LATLON polys.

Returns:

true if polyline false if not

setNumSegs

public void setNumSegs(int nsegs)

Set the number of segments of the lat/lon line. (This is only for LINETYPE_GREATCIRCLE or LINETYPE_RHUMB line types, and if < 1, this value is generated internally).

Parameters:

nsegs - number of segment points

getNumSegs

public int getNumSegs()

Get the number of segments of the lat/lon line. (This is only for LINETYPE_GREATCIRCLE or LINETYPE_RHUMB line types).

Returns:

int number of segment points

setArc

public void setArc(ArcCalc ac)

Set the arc that is drawn between the points of a x-y or offset line.

getArc

public ArcCalc getArc()

Return the arc angle set for this line. Will only be set if it was set externally.

Returns:

arc angle in radians.

generate

public boolean generate(Projection proj)

Prepare the line for rendering.

Specified by:

generate in interface OMGeometry

Specified by:

generate in class OMGraphicAdapter

Parameters:

proj - Projection

Returns:

true if generate was successful

See Also:

OMGraphicAdapter.regenerate(com.bbn.openmap.proj.Projection)

render

public void render(java.awt.Graphics g)

Paint the line.

Specified by:

render in interface OMGeometry

Overrides:

render in class OMGraphicAdapter

Parameters:

g - Graphics context to render into

shouldRenderFill

public boolean shouldRenderFill()

The OMLine should never render fill. It can think it does, if the geometry turns out to be curved. Returning false affects distance() and contains() methods.

Specified by:

shouldRenderFill in interface OMGraphic

Overrides:

shouldRenderFill in class OMGraphicAdapter

contains

public boolean contains(double x,
                        double y)

This takes the area out of OMLines that may look like they have area, depending on their shape. Checks to see what shouldRenderFill() returns (false by default) to decide how to measure this. If shouldRenderFill == true, the super.contains() method is returned, which assumes the line shape has area if it is curved. Otherwise, it returns true if the point is on the line.

Specified by:

contains in interface OMGeometry

Overrides:

contains in class BasicGeometry

Parameters:

x - X pixel coordinate of the point.

y - Y pixel coordinate of the point.

Returns:

getShape().contains(x, y), false if the OMGraphic hasn't been generated yet.

restore

public void restore(OMGeometry source)

Description copied from class: OMGraphicAdapter

Takes the generic OMGraphic settings from another OMGraphic and pushes them to this one.

Specified by:

restore in interface OMGeometry

Overrides:

restore in class OMGraphicAdapter