Displays a small map view. More...

Inheritance diagram for com.realtime.crossfire.jxclient.gui.map.GUIMiniMap:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.map.GUIMiniMap:

Public Member Functions
Dimension	getPreferredSize ()

TooltipText	getTooltip ()
	Returns the current tooltip text. More...

	GUIMiniMap (final boolean avoidCopyArea, @NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final MapUpdaterState mapUpdaterState, @NotNull final FacesProvider facesProvider, @NotNull final DarknessColors darknessColors, final int width, final int height, @NotNull final GuiFactory guiFactory)
	Creates a new instance. More...

void	notifyOpen ()
	Called each time the enclosing dialog is opened (or raised). More...

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap
void	dispose ()
	Releases all allocated resources. More...

Dimension	getMinimumSize ()

int	getOffsetX ()
	Returns the x offset for drawing the square at coordinate 0 of the map. More...

int	getOffsetY ()
	Returns the y offset for drawing the square at coordinate 0 of the map. More...

int	getPlayerX ()
	Returns the x offset of the tile representing the player. More...

int	getPlayerY ()
	Returns the y offset of the tile representing the player. More...

void	paintComponent (@NotNull final Graphics g)

void	setBounds (final int x, final int y, final int width, final int height)

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
int	getDialogBorderBottom ()
	Returns the size of the dialog's bottom border. More...

int	getDialogBorderLeft ()
	Returns the size of the dialog's left border. More...

int	getDialogBorderRight ()
	Returns the size of the dialog's right border. More...

int	getDialogBorderTop ()
	Returns the size of the dialog's top border. More...

String	getName ()
	Returns the internal name of this gui element. More...

void	inhibitListeners ()
	Prevents change listeners to be notified. More...

boolean	isDefault ()
	Returns whether this element is the default element. More...

boolean	isIgnore ()
	Returns whether this gui element is to be ignored for user interaction. More...

void	mouseClicked (@NotNull final MouseEvent e)
	Will be called when the user has clicked (pressed+released) this element. More...

void	mouseDragged (@NotNull final MouseEvent e)
	Will be called when the mouse moves within this component while the button is pressed. More...

void	mouseEntered (@NotNull final MouseEvent e)
	Will be called when the mouse has entered the bounding box of this element. More...

void	mouseExited (@NotNull final MouseEvent e)
	Will be called when the mouse has left the bounding box of this element. More...

void	mouseMoved (@NotNull final MouseEvent e)
	Will be called when the mouse moves within this component. More...

void	mousePressed (@NotNull final MouseEvent e)
	Will be called when the user has pressed the mouse inside this element. More...

void	mouseReleased (@NotNull final MouseEvent e)
	Will be called when the user has released the mouse. More...

void	mouseWheelMoved (final int wheelRotation)
	Will be called when the mouse wheel has been moved. More...

void	setChanged ()
	Records that the contents have changed and must be repainted. More...

void	setChangedListener (@Nullable final GUIElementChangedListener changedListener)
	Sets the GUIElementChangedListener to be notified. More...

void	setDefault (final boolean isDefault)
	Sets whether this element is the default element. More...

void	setIgnore ()
	Marks this gui element to be ignored for user interaction. More...

String	toString ()

Protected Member Functions
void	markPlayer (@NotNull final Graphics g, final int dx, final int dy)
	Paints the player location. More...

void	paintSquareBackground (@NotNull final Graphics g, final int px, final int py, final boolean hasImage, @NotNull final CfMapSquare mapSquare)
	Paints the background of a map square. More...

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap
	AbstractGUIMap (final boolean avoidCopyArea, @NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final MapUpdaterState mapUpdaterState, @NotNull final FacesProvider facesProvider, @Nullable final SmoothingRenderer smoothingRenderer, @NotNull final DarknessColors darknessColors, @NotNull final GuiFactory guiFactory)
	Creates a new instance. More...

int	getMapHeight ()
	Returns the map height in squares. More...

int	getMapWidth ()
	Returns the map width in squares. More...

void	paintColoredSquare (@NotNull final Graphics g, @NotNull final Color color, final int x, final int y)
	Fills a square with one Color. More...

void	redrawSquare (@NotNull final Graphics g, @NotNull final CfMapSquare mapSquare, @NotNull final CfMap map, final int x, final int y)
	Redraws one square. More...

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
	AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)
	Creates a new instance. More...

TooltipText	newTooltipText (@Nullable final String tooltipText)
	Creates a TooltipText instance relative to this instance. More...

void	tooltipChanged ()
	Must be called whenever the tooltip may have changed. More...

Private Attributes
final int	height
	The map height in squares. More...

final MapUpdaterState	mapUpdaterState
	The MapUpdaterState instance to use. More...

final int	tileSize
	The size of one tile. More...

final int	width
	The map width in squares. More...

Static Private Attributes
static final long	serialVersionUID = 1
	The serial version UID. More...

static final Color[]	TILE_COLORS
	The colors for displaying magic map data. More...

Detailed Description

Displays a small map view.

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 44 of file GUIMiniMap.java.

Constructor & Destructor Documentation

◆ GUIMiniMap()

com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.GUIMiniMap	(	final boolean	avoidCopyArea,
		@NotNull final TooltipManager	tooltipManager,
		@NotNull final GUIElementListener	elementListener,
		@NotNull final String	name,
		@NotNull final MapUpdaterState	mapUpdaterState,
		@NotNull final FacesProvider	facesProvider,
		@NotNull final DarknessColors	darknessColors,
		final int	width,
		final int	height,
		@NotNull final GuiFactory	guiFactory
	)

Creates a new instance.

Parameters

avoidCopyArea	whether map scrolling is done by copying pixel areas; if unset, always repaint all map squares
tooltipManager	the tooltip manager to update
elementListener	the element listener to notify
name	the name of this element
mapUpdaterState	the map updater state instance to use
facesProvider	the faces provider for looking up faces
darknessColors	the darkness colors instance for converting darkness values into colors
width	the map width in squares
height	the map height in squares
guiFactory	the global GUI factory instance

Definition at line 110 of file GUIMiniMap.java.

Here is the call graph for this function:

Member Function Documentation

◆ getPreferredSize()

Dimension com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.getPreferredSize ( )

Definition at line 148 of file GUIMiniMap.java.

References com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.height, com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.tileSize, and com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.width.

◆ getTooltip()

TooltipText com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.getTooltip ( )

Returns the current tooltip text.

Returns: the tooltip text or
null

to not show a tooltip

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

Definition at line 158 of file GUIMiniMap.java.

◆ markPlayer()

void com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.markPlayer	(	@NotNull final Graphics	g,
		final int	dx,
		final int	dy
	)

protected

Paints the player location.

Parameters

g	the graphics to paint to
dx	the x distance to map has just scrolled
dy	the y distance to map has just scrolled

Reimplemented from com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.

Definition at line 131 of file GUIMiniMap.java.

Here is the call graph for this function:

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.notifyOpen ( )

Called each time the enclosing dialog is opened (or raised).

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 153 of file GUIMiniMap.java.

◆ paintSquareBackground()

void com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.paintSquareBackground	(	@NotNull final Graphics	g,
		final int	px,
		final int	py,
		final boolean	hasImage,
		@NotNull final CfMapSquare	mapSquare
	)

protected

Paints the background of a map square.

Parameters

g	the graphics to paint into
px	the x-offset for painting
py	the y-offset for painting
hasImage	whether the square contains at least one image
mapSquare	the map square

Reimplemented from com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.

Definition at line 119 of file GUIMiniMap.java.

References com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.paintColoredSquare(), and com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.TILE_COLORS.

Here is the call graph for this function:

Member Data Documentation

◆ height

final int com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.height

private

The map height in squares.

Definition at line 65 of file GUIMiniMap.java.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.getPreferredSize(), and com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.GUIMiniMap().

◆ mapUpdaterState

final MapUpdaterState com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.mapUpdaterState

private

The MapUpdaterState instance to use.

Definition at line 55 of file GUIMiniMap.java.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.GUIMiniMap(), and com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.markPlayer().

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.serialVersionUID = 1

staticprivate

The serial version UID.

Definition at line 49 of file GUIMiniMap.java.

◆ TILE_COLORS

final Color [] com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.TILE_COLORS

staticprivate

Initial value:

= { 
        Color.BLACK, 
        Color.WHITE, 
        Color.BLUE, 
        Color.RED, 
        Color.GREEN, 
        Color.YELLOW, 
        Color.PINK, 
        Color.GRAY, 
        Color.ORANGE, 
        Color.CYAN, 
        Color.MAGENTA, 
        Color.DARK_GRAY, 
        Color.DARK_GRAY, 
        Color.DARK_GRAY, 
        Color.DARK_GRAY, 
        Color.DARK_GRAY, 
    }

The colors for displaying magic map data.

Definition at line 76 of file GUIMiniMap.java.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.paintSquareBackground().

◆ tileSize

final int com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.tileSize

private

The size of one tile.

Definition at line 70 of file GUIMiniMap.java.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.getPreferredSize(), com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.GUIMiniMap(), and com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.markPlayer().

◆ width

final int com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.width

private

The map width in squares.

Definition at line 60 of file GUIMiniMap.java.

Referenced by com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.getPreferredSize(), and com.realtime.crossfire.jxclient.gui.map.GUIMiniMap.GUIMiniMap().

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/map/GUIMiniMap.java

Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GUIMiniMap()

Member Function Documentation

◆ getPreferredSize()

◆ getTooltip()

◆ markPlayer()

◆ notifyOpen()

◆ paintSquareBackground()

Member Data Documentation

◆ height

◆ mapUpdaterState

◆ serialVersionUID

◆ TILE_COLORS

◆ tileSize

◆ width