Crossfire JXClient, Trunk
Public Member Functions | Protected Member Functions | Private Attributes | Static Private Attributes | List of all members
com.realtime.crossfire.jxclient.gui.map.GUIMap Class Reference
Inheritance diagram for com.realtime.crossfire.jxclient.gui.map.GUIMap:
Inheritance graph
Collaboration diagram for com.realtime.crossfire.jxclient.gui.map.GUIMap:
Collaboration graph

Public Member Functions

int getPreferredMapHeight ()
 
int getPreferredMapWidth ()
 
Dimension getPreferredSize ()
 
TooltipText getTooltip ()
 
 GUIMap (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 CrossfireServerConnection crossfireServerConnection, @NotNull final SmoothFaces smoothFaces, @NotNull final DarknessColors darknessColors, @NotNull final GuiFactory guiFactory)
 
void mouseClicked (@NotNull final MouseEvent e)
 
void notifyOpen ()
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap
void dispose ()
 
Dimension getMinimumSize ()
 
int getOffsetX ()
 
int getOffsetY ()
 
int getPlayerX ()
 
int getPlayerY ()
 
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 ()
 
int getDialogBorderLeft ()
 
int getDialogBorderRight ()
 
int getDialogBorderTop ()
 
String getName ()
 
void inhibitListeners ()
 
boolean isDefault ()
 
boolean isIgnore ()
 
void mouseDragged (@NotNull final MouseEvent e)
 
void mouseEntered (@NotNull final MouseEvent e)
 
void mouseExited (@NotNull final MouseEvent e)
 
void mouseMoved (@NotNull final MouseEvent e)
 
void mousePressed (@NotNull final MouseEvent e)
 
void mouseReleased (@NotNull final MouseEvent e)
 
void mouseWheelMoved (final int wheelRotation)
 
void setChanged ()
 
void setChangedListener (@Nullable final GUIElementChangedListener changedListener)
 
void setDefault (final boolean isDefault)
 
void setIgnore ()
 
String toString ()
 

Protected Member Functions

void markPlayer (@NotNull final Graphics g, final int dx, final int dy)
 
void paintSquareBackground (@NotNull final Graphics g, final int px, final int py, final boolean hasImage, @NotNull final CfMapSquare mapSquare)
 
- 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)
 
int getMapHeight ()
 
int getMapWidth ()
 
void paintColoredSquare (@NotNull final Graphics g, @NotNull final Color color, final int x, final int y)
 
void redrawSquare (@NotNull final Graphics g, @NotNull final CfMapSquare mapSquare, @NotNull final CfMap map, final int x, final int y)
 
- 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)
 
TooltipText newTooltipText (@Nullable final String tooltipText)
 
void tooltipChanged ()
 

Private Attributes

final CrossfireServerConnection crossfireServerConnection
 
final int tileSize
 

Static Private Attributes

static final long serialVersionUID = 1
 

Detailed Description

Display the map view. It supports both normal-sized (32x32 pixel) and double sized (64x64 pixel) sized tiles.

Author
Lauwenmark
Andreas Kirschbaum

Definition at line 48 of file GUIMap.java.

Constructor & Destructor Documentation

◆ GUIMap()

com.realtime.crossfire.jxclient.gui.map.GUIMap.GUIMap ( 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 CrossfireServerConnection  crossfireServerConnection,
@NotNull final SmoothFaces  smoothFaces,
@NotNull final DarknessColors  darknessColors,
@NotNull final GuiFactory  guiFactory 
)

Creates a new instance.

Parameters
avoidCopyAreawhether map scrolling is done by copying pixel areas; if unset, always repaint all map squares
tooltipManagerthe tooltip manager to update
elementListenerthe element listener to notify
namethe name of this element
mapUpdaterStatethe map updater state instance to use
facesProviderthe faces provider for looking up faces
crossfireServerConnectionthe server connection to monitor
smoothFacesthe smooth faces to use
darknessColorsthe darkness colors instance for converting darkness values into colors
guiFactorythe global GUI factory instance

Definition at line 81 of file GUIMap.java.

References com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.avoidCopyArea, com.realtime.crossfire.jxclient.gui.map.GUIMap.crossfireServerConnection, com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.darknessColors, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener, com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.facesProvider, com.realtime.crossfire.jxclient.faces.FacesProvider.getSize(), com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory, com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.mapUpdaterState, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name, com.realtime.crossfire.jxclient.gui.map.GUIMap.tileSize, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Here is the call graph for this function:

Member Function Documentation

◆ getPreferredMapHeight()

int com.realtime.crossfire.jxclient.gui.map.GUIMap.getPreferredMapHeight ( )

Returns the minimal map height in squares needed to fill the map area.

Returns
the map height in squares

Definition at line 154 of file GUIMap.java.

References com.realtime.crossfire.jxclient.util.MathUtils.divRoundUp(), and com.realtime.crossfire.jxclient.gui.map.GUIMap.tileSize.

Here is the call graph for this function:

◆ getPreferredMapWidth()

int com.realtime.crossfire.jxclient.gui.map.GUIMap.getPreferredMapWidth ( )

Returns the minimal map width in squares needed to fill the map area.

Returns
the map width in squares

Definition at line 146 of file GUIMap.java.

References com.realtime.crossfire.jxclient.util.MathUtils.divRoundUp(), and com.realtime.crossfire.jxclient.gui.map.GUIMap.tileSize.

Here is the call graph for this function:

◆ getPreferredSize()

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

◆ getTooltip()

TooltipText com.realtime.crossfire.jxclient.gui.map.GUIMap.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 127 of file GUIMap.java.

◆ markPlayer()

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

Paints the player location.

Parameters
gthe graphics to paint to
dxthe x distance to map has just scrolled
dythe y distance to map has just scrolled

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

Definition at line 93 of file GUIMap.java.

◆ mouseClicked()

void com.realtime.crossfire.jxclient.gui.map.GUIMap.mouseClicked ( @NotNull final MouseEvent  e)

◆ notifyOpen()

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

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

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

Definition at line 132 of file GUIMap.java.

◆ paintSquareBackground()

void com.realtime.crossfire.jxclient.gui.map.GUIMap.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
gthe graphics to paint into
pxthe x-offset for painting
pythe y-offset for painting
hasImagewhether the square contains at least one image
mapSquarethe map square

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

Definition at line 88 of file GUIMap.java.

References com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap.paintColoredSquare().

Here is the call graph for this function:

Member Data Documentation

◆ crossfireServerConnection

final CrossfireServerConnection com.realtime.crossfire.jxclient.gui.map.GUIMap.crossfireServerConnection
private

◆ serialVersionUID

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

The serial version UID.

Definition at line 53 of file GUIMap.java.

◆ tileSize

final int com.realtime.crossfire.jxclient.gui.map.GUIMap.tileSize
private

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