org.mars_sim.msp.ui.swing.unit_display_info
Interface UnitDisplayInfo

All Known Implementing Classes:

LUVDisplayInfoBean, RoverDisplayInfoBean

public interface UnitDisplayInfo

Provides display information about a unit.

Method Summary

Icon	getButtonIcon() Gets icon for unit button.
double	getMapClickRange() Gets the range (km) for clicking on unit on navigator map.
Font	getMapLabelFont() Gets the label font for navigator map.
String	getSound(Unit unit) Gets a sound appropriate for this unit.
Color	getSurfGlobeColor() Gets display color for surface globe.
Icon	getSurfMapIcon(Unit unit) Gets display icon for the surface navigator map.
Color	getSurfMapLabelColor() Gets the label color for surface navigator map.
Color	getTopoGlobeColor() Gets display color for topo globe.
Icon	getTopoMapIcon(Unit unit) Gets display icon for topo navigator map.
Color	getTopoMapLabelColor() Gets the label color for topo navigator map.
boolean	isGlobeDisplayed(Unit unit) Checks if the unit is to be displayed on the navigator tool globe.
boolean	isMapBlink(Unit unit) Checks if the map icon should blink on and off.
boolean	isMapDisplayed(Unit unit) Checks if unit is to be displayed on the navigator tool map.

Method Detail

isMapDisplayed

boolean isMapDisplayed(Unit unit)

Checks if unit is to be displayed on the navigator tool map.

Parameters:

unit - the unit to display

Returns:

true if unit is to be displayed on navigator map.

getSurfMapIcon

Icon getSurfMapIcon(Unit unit)

Gets display icon for the surface navigator map.

Parameters:

unit - the unit to display

Returns:

icon

getTopoMapIcon

Icon getTopoMapIcon(Unit unit)

Gets display icon for topo navigator map.

Parameters:

unit - the unit to display

Returns:

icon

isMapBlink

boolean isMapBlink(Unit unit)

Checks if the map icon should blink on and off.

Parameters:

unit - the unit to display

Returns:

true if blink

getSurfMapLabelColor

Color getSurfMapLabelColor()

Gets the label color for surface navigator map.

Returns:

color

getTopoMapLabelColor

Color getTopoMapLabelColor()

Gets the label color for topo navigator map.

Returns:

color

getMapLabelFont

Font getMapLabelFont()

Gets the label font for navigator map.

Returns:

font

getMapClickRange

double getMapClickRange()

Gets the range (km) for clicking on unit on navigator map.

Returns:

clicking range

isGlobeDisplayed

boolean isGlobeDisplayed(Unit unit)

Checks if the unit is to be displayed on the navigator tool globe.

Parameters:

unit - the unit to display.

Returns:

true if unit is to be displayed on globe

getSurfGlobeColor

Color getSurfGlobeColor()

Gets display color for surface globe.

Returns:

color

getTopoGlobeColor

Color getTopoGlobeColor()

Gets display color for topo globe.

Returns:

color

getButtonIcon

Icon getButtonIcon()

Gets icon for unit button.

Returns:

icon

getSound

String getSound(Unit unit)

Gets a sound appropriate for this unit.

Parameters:

unit - the unit to display.

Returns:

sound filepath for unit or empty string if none.