MissionPoint (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.mission.MissionPoint

Direct Known Subclasses:

MissionPointCompositeWaypoint, MissionPointHover, MissionPointMine, MissionPointPosition, MissionPointWaypoint
```
public class MissionPoint
extends Object
```
Description : Represents position information for display in the 2D view of the mission planner. 2D mission planner objects (mines, waypoints, and other objects that are to be drawn on the 2D graphical display will be represented as MissionPoints. Also includes functionality to draw a point as well as detect when a point is selected.
Rewritten to support AVCL schema through the avcl and avcl.jaxb packages

Since:

11 May 2004

Version:

$Id: MissionPoint.java 9109 2015-07-29 22:39:46Z brutzman $

Author:

Chin Siong Daryl Lee, Duane Davis

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`color`
`static Color`	`COLORMINE`
`static Color`	`COLORMINESELECTED`
`static Color`	`COLORPOINT`
`static Color`	`COLORPOINT2`
`static Color`	`COLORPOINTSELECTED`
`static Color`	`COLORTEXT`
`static Color`	`COLORTEXTBGD`
`static Color`	`COLORWATCHRADIUS`
`protected Object`	`commnd` Mission command to which this point applies
`protected double`	`depth` Depth below the surface of the represented point
`protected int`	`index` Index of the mission command to which this point applies
`protected NumberFormat`	`nf` To print point positions
`static int`	`POINTHEIGHT`
`static float`	`POINTHIGHLIGHWIDTH`
`static float`	`POINTLINEWIDTH`
`protected String`	`pointType` Type of point a this object represents
`static String`	`POINTTYPE_COMPOSITEWAYPOINT`
`static String`	`POINTTYPE_HOVER`
`static String[]`	`POINTTYPE_LIST`
`static String`	`POINTTYPE_MINE`
`static String`	`POINTTYPE_POSITION`
`static String`	`POINTTYPE_WAYPOINT`
`static int`	`POINTWIDTH`
`protected int`	`standoff` Standoff distance from point, used in waypoint nodes
`static int`	`TEXTOFFSETX`
`static int`	`TEXTOFFSETY`
`protected Point2D`	`xyPosit` 2D representation of the point's horizontal (x, y) position

Constructor Summary

Constructors
Constructor and Description
`MissionPoint()` Creates a new instance of MissionPoint
`MissionPoint(Point2D p)` Creates a new instance of MissionPoint
`MissionPoint(Point2D p, double z)` Creates a new instance of MissionPoint

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(Graphics2D gArea, MissionToJava2DCoord m2j, boolean flagSelected, boolean showText, boolean showWatchRadius)` draws the point in the 2D mission viewer
`void`	`draw(Graphics2D gArea, MissionToJava2DCoord m2j, boolean flagSelected, boolean showText, boolean showWatchRadius, boolean showRealTime)`
`void`	`draw(Graphics2D gArea, MissionToJava2DCoord m2j, boolean flagSelected, boolean showText, boolean showWatchRadius, boolean showRealTime, boolean inFocus)`
`void`	`draw(Graphics2D gArea, MissionToJava2DCoord m2j, boolean flagSelected, boolean showTextLabels, boolean showWatchRadius, boolean showRealTime, boolean inFocus, boolean isFirst)`
`double`	`getDepth()` gets the depth of the represented position
`String`	`getDescription()`
`double`	`getMaxEasting(MissionToJava2DCoord m2j)`
`double`	`getMaxNorthing(MissionToJava2DCoord m2j)` For zooming the map
`double`	`getMinEasting(MissionToJava2DCoord m2j)`
`double`	`getMinNorthing(MissionToJava2DCoord m2j)`
`Point2D`	`getPos()` Returns the (x, y) position represented
`int`	`getWatchStandOff()`
`boolean`	`isSelected(double mouseX, double mouseY, MissionToJava2DCoord m2j)` Check whether a user mouse click is close enough to a point to consider it selected
`void`	`setDepth(int aDep)` set depth
`void`	`setDescription(String description)`
`void`	`setImage2D(String image)` Provides a method that inheriting classes can over-ride to provide an icon for use in drawing.
`void`	`setPos(int x, int y)` Moves the point to a new location
`void`	`setPos(int x, int y, double z)` Moves the point to a new location
`void`	`setPos(Point2D p)` Moves the point to a new location
`void`	`setPos(Point2D p, double z)` Moves the point to a new location
`void`	`setValue(MissionPoint mp)` Overwrites all fields with those of another MissionPoint (makes a copy)
`void`	`setWatchStandOff(int i)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

POINTTYPE_HOVER

public static final String POINTTYPE_HOVER

See Also:: Constant Field Values

POINTTYPE_POSITION

public static final String POINTTYPE_POSITION

See Also:: Constant Field Values

POINTTYPE_WAYPOINT

public static final String POINTTYPE_WAYPOINT

See Also:: Constant Field Values

POINTTYPE_COMPOSITEWAYPOINT

public static final String POINTTYPE_COMPOSITEWAYPOINT

See Also:: Constant Field Values

POINTTYPE_MINE

public static final String POINTTYPE_MINE

See Also:: Constant Field Values

POINTTYPE_LIST

public static final String[] POINTTYPE_LIST

POINTWIDTH
```
public static final int POINTWIDTH
```
See Also:

Constant Field Values

POINTHEIGHT
```
public static final int POINTHEIGHT
```
See Also:

Constant Field Values

POINTLINEWIDTH
```
public static final float POINTLINEWIDTH
```
See Also:

Constant Field Values

POINTHIGHLIGHWIDTH
```
public static final float POINTHIGHLIGHWIDTH
```
See Also:

Constant Field Values

COLORMINE
```
public static final Color COLORMINE
```

COLORMINESELECTED

public static final Color COLORMINESELECTED

COLORPOINT
```
public static final Color COLORPOINT
```

COLORPOINT2
```
public static final Color COLORPOINT2
```

COLORPOINTSELECTED

public static final Color COLORPOINTSELECTED

COLORTEXT
```
public static final Color COLORTEXT
```

COLORTEXTBGD
```
public static final Color COLORTEXTBGD
```

COLORWATCHRADIUS

public static final Color COLORWATCHRADIUS

TEXTOFFSETX
```
public static int TEXTOFFSETX
```

TEXTOFFSETY
```
public static int TEXTOFFSETY
```

xyPosit
```
protected Point2D xyPosit
```
2D representation of the point's horizontal (x, y) position

depth
```
protected double depth
```
Depth below the surface of the represented point

index
```
protected int index
```
Index of the mission command to which this point applies

commnd
```
protected Object commnd
```
Mission command to which this point applies

standoff
```
protected int standoff
```
Standoff distance from point, used in waypoint nodes

pointType
```
protected String pointType
```
Type of point a this object represents

nf
```
protected NumberFormat nf
```
To print point positions

color
```
protected Color color
```

Constructor Detail
- MissionPoint
```
public MissionPoint()
```
  Creates a new instance of MissionPoint
- MissionPoint
```
public MissionPoint(Point2D p)
```
  Creates a new instance of MissionPoint
  
  Parameters:
  
  p - 2D (x, y) position of this MissionPoint
- MissionPoint
```
public MissionPoint(Point2D p,
                    double z)
```
  Creates a new instance of MissionPoint
  
  Parameters:
  
  p - 2D (x, y) position of this MissionPoint
  
  z - depth to be assigned to this point

Method Detail

setPos
```
public final void setPos(Point2D p)
```
Moves the point to a new location

Parameters:

p - representing the new (x, y) position

setPos
```
public void setPos(Point2D p,
                   double z)
```
Moves the point to a new location

Parameters:

p - representing the new (x, y) position

setPos
```
public void setPos(int x,
                   int y,
                   double z)
```
Moves the point to a new location

Parameters:

x - x position of new (x, y, z) position

y - y position of new (x, y, z) position

z - z position of new (x, y, z) position

setPos
```
public void setPos(int x,
                   int y)
```
Moves the point to a new location

Parameters:

x - x position of new (x, y, z) position

y - y position of new (x, y, z) position

getMaxNorthing

public double getMaxNorthing(MissionToJava2DCoord m2j)

For zooming the map

getMinNorthing

public double getMinNorthing(MissionToJava2DCoord m2j)

getMaxEasting

public double getMaxEasting(MissionToJava2DCoord m2j)

getMinEasting

public double getMinEasting(MissionToJava2DCoord m2j)

setValue
```
public void setValue(MissionPoint mp)
```
Overwrites all fields with those of another MissionPoint (makes a copy)

Parameters:

mp - to be copied

getPos
```
public Point2D getPos()
```
Returns the (x, y) position represented

setDepth
```
public void setDepth(int aDep)
```
set depth

Parameters:

aDep - numeric value

getDepth
```
public double getDepth()
```
gets the depth of the represented position

setWatchStandOff
```
public void setWatchStandOff(int i)
```

getWatchStandOff
```
public int getWatchStandOff()
```

setImage2D
```
public void setImage2D(String image)
```
Provides a method that inheriting classes can over-ride to provide an icon for use in drawing. This method does nothing, since generic mission points are drawn as an Xed box.

draw

public void draw(Graphics2D gArea,
                 MissionToJava2DCoord m2j,
                 boolean flagSelected,
                 boolean showText,
                 boolean showWatchRadius)

draws the point in the 2D mission viewer

Parameters:: gArea - drawing canvas; m2j - coordinate translator; flagSelected - is it selected; showText - to draw text?; showWatchRadius - to draw StandOff distance?

draw

public void draw(Graphics2D gArea,
                 MissionToJava2DCoord m2j,
                 boolean flagSelected,
                 boolean showText,
                 boolean showWatchRadius,
                 boolean showRealTime)

draw

public void draw(Graphics2D gArea,
                 MissionToJava2DCoord m2j,
                 boolean flagSelected,
                 boolean showText,
                 boolean showWatchRadius,
                 boolean showRealTime,
                 boolean inFocus)

draw

public void draw(Graphics2D gArea,
                 MissionToJava2DCoord m2j,
                 boolean flagSelected,
                 boolean showTextLabels,
                 boolean showWatchRadius,
                 boolean showRealTime,
                 boolean inFocus,
                 boolean isFirst)

isSelected
```
public boolean isSelected(double mouseX,
                          double mouseY,
                          MissionToJava2DCoord m2j)
```
Check whether a user mouse click is close enough to a point to consider it selected

Parameters:

mouseX - mouse cursor X coordinates

mouseY - mouse cursor Y coordinates

m2j - coordinate translator

Returns:

true if selected, else false

getDescription
```
public String getDescription()
```
Returns:

the description

setDescription
```
public void setDescription(String description)
```
Parameters:

description - the description to set

Class MissionPoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POINTTYPE_HOVER

POINTTYPE_POSITION

POINTTYPE_WAYPOINT

POINTTYPE_COMPOSITEWAYPOINT

POINTTYPE_MINE

POINTTYPE_LIST

POINTWIDTH

POINTHEIGHT

POINTLINEWIDTH

POINTHIGHLIGHWIDTH

COLORMINE

COLORMINESELECTED

COLORPOINT

COLORPOINT2

COLORPOINTSELECTED

COLORTEXT

COLORTEXTBGD

COLORWATCHRADIUS

TEXTOFFSETX

TEXTOFFSETY

xyPosit

depth

index

commnd

standoff

pointType

nf

color

Constructor Detail

MissionPoint

MissionPoint

MissionPoint

Method Detail

setPos

setPos

setPos

setPos

getMaxNorthing

getMinNorthing

getMaxEasting

getMinEasting

setValue

getPos

setDepth

getDepth

setWatchStandOff

getWatchStandOff

setImage2D

draw

draw

draw

draw

isSelected

getDescription

setDescription