Package megamek.client.ui.dialogs.minimap

Class MinimapPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

megamek.client.ui.dialogs.minimap.MinimapPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, IPreferenceChangeListener

public final class MinimapPanel
extends JPanel
implements IPreferenceChangeListener

Obviously, displays the map in scaled-down size. TBD: -move the buttons from graphics to real Swing buttons -clean up listenercode.. -initializecolors is fugly -uses break-to-label -uses while-true

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MinimapPanel.Line

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DESTROYED_UNIT_ALPHA

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
MinimapPanel(MinimapDialog minimapDialog, Game game, BoardView boardView, IClientGUI clientGUI, File minimapTheme, int boardId)	Creates a minimap panel.

Method Summary

Modifier and Type	Method	Description
static Color	changeColorForDestroyedUnit(Color color, int alpha)
static BufferedImage	getMinimapImage(Board board, int zoom)	Returns a minimap image of the given board at the given zoom index.
static BufferedImage	getMinimapImage(Board board, int zoom, File minimapTheme)	Returns a minimap image of the given board at the given zoom index.
static BufferedImage	getMinimapImage(Game game, BoardView boardView, int zoom, File minimapTheme, int boardId)	Returns a minimap image of the given board at the given zoom index.
static BufferedImage	getMinimapImage(Game game, BoardView boardView, int zoom, IClientGUI clientGui, File minimapTheme, List<MinimapPanel.Line> movePathLines, int boardId)	Returns a minimap image of the given board at the given zoom index.
static BufferedImage	getMinimapImageMaxZoom(Board board)	Returns a minimap image of the given board at the maximum zoom index.
static BufferedImage	getMinimapImageMaxZoom(Board board, File minimapTheme)	Returns a minimap image of the given board at the maximum zoom index.
JCheckBoxMenuItem	menuItem(String text, String cmd, boolean enabled, ActionListener listener, boolean checked)
protected void	paintComponent(Graphics g)
void	preferenceChange(PreferenceChangeEvent e)
static void	promptForGifRecordingConsent(Game game, Component parent)	Prompts the local player, if necessary, whether to record this game's combat-summary GIF and stores the answer, so the per-phase recording never has to ask mid-game.
void	refreshMap()	Call this to schedule a minimap redraw.
void	resetZoom()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

DESTROYED_UNIT_ALPHA

public static final int DESTROYED_UNIT_ALPHA

See Also:

• Constant Field Values

Constructor Details

MinimapPanel

public MinimapPanel(@Nullable
 MinimapDialog minimapDialog,
 Game game,
 @Nullable
 BoardView boardView,
 @Nullable
 IClientGUI clientGUI,
 @Nullable
 File minimapTheme,
 int boardId)

Creates a minimap panel. The only required parameter is a game that contains the board to display. When the dialog is not null, it is assumed that this minimap will be visible for a while, and it will register itself to various objects as a listener to changes. When the dialog is null, it is assumed that the minimap is only used to create a snapshot image. When a BoardView is given, the visible area is shown.

Method Details

getMinimapImageMaxZoom

public static BufferedImage getMinimapImageMaxZoom(Board board)

Returns a minimap image of the given board at the maximum zoom index.

getMinimapImageMaxZoom

public static BufferedImage getMinimapImageMaxZoom(Board board,
 @Nullable
 File minimapTheme)

Returns a minimap image of the given board at the maximum zoom index.

getMinimapImage

public static BufferedImage getMinimapImage(Board board,
 int zoom)

Returns a minimap image of the given board at the given zoom index.

getMinimapImage

public static BufferedImage getMinimapImage(Board board,
 int zoom,
 @Nullable
 File minimapTheme)

Returns a minimap image of the given board at the given zoom index.

getMinimapImage

public static BufferedImage getMinimapImage(Game game,
 BoardView boardView,
 int zoom,
 @Nullable
 File minimapTheme,
 int boardId)

Returns a minimap image of the given board at the given zoom index. The game and BoardView object will be used to display additional information.

getMinimapImage

public static BufferedImage getMinimapImage(Game game,
 BoardView boardView,
 int zoom,
 IClientGUI clientGui,
 @Nullable
 File minimapTheme,
 List<MinimapPanel.Line> movePathLines,
 int boardId)

Returns a minimap image of the given board at the given zoom index. The game and BoardView object will be used to display additional information.

promptForGifRecordingConsent

public static void promptForGifRecordingConsent(Game game,
 @Nullable
 Component parent)

Prompts the local player, if necessary, whether to record this game's combat-summary GIF and stores the answer, so the per-phase recording never has to ask mid-game. This is the "at game start" entry point, intended to be called when the player readies up in the lobby.

No-op unless the preference is GifRecordingMode.ASK and no decision has been made for this game yet, so it is safe to call every time the player toggles ready. Must be called on the event dispatch thread.

Parameters:

game - The game about to start

parent - The parent component for the dialog, or null to center on screen

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

refreshMap

public void refreshMap()

Call this to schedule a minimap redraw.

changeColorForDestroyedUnit

public static Color changeColorForDestroyedUnit(Color color,
 int alpha)

resetZoom

public void resetZoom()

menuItem

public JCheckBoxMenuItem menuItem(String text,
 String cmd,
 boolean enabled,
 ActionListener listener,
 boolean checked)

preferenceChange

public void preferenceChange(PreferenceChangeEvent e)

Specified by:

preferenceChange in interface IPreferenceChangeListener