Crossfire JXClient, Trunk  R20561
com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider Class Reference

A FacesProvider that returns faces scaled to 4x4 pixels. More...

+ Inheritance diagram for com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider:
+ Collaboration diagram for com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider:

Public Member Functions

ImageIcon getImageIcon (final int faceNum, @Nullable final boolean[] isUnknownImage)
 Returns the face for a face ID.This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters
faceNumthe face ID
isUnknownImagereturns whether the returned face is the "unknown" face; ignored if
null
Returns
the face, or the "unknown" face if the face is not loaded
More...
 
int getSize ()
 Returns the size of faces in pixels.
Returns
the size in pixels
More...
 
 MagicMapFacesProvider (@NotNull final FacesManager facesManager)
 Creates a new instance. More...
 

Private Attributes

final FacesManager facesManager
 The FacesManager to query. More...
 

Static Private Attributes

static final int SIZE = 4
 The size of faces in pixels. More...
 

Detailed Description

A FacesProvider that returns faces scaled to 4x4 pixels.

Author
Andreas Kirschbaum

Definition at line 32 of file MagicMapFacesProvider.java.

Constructor & Destructor Documentation

◆ MagicMapFacesProvider()

com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.MagicMapFacesProvider ( @NotNull final FacesManager  facesManager)

Creates a new instance.

Parameters
facesManagerthe faces manager to query

Definition at line 49 of file MagicMapFacesProvider.java.

References com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.facesManager.

Member Function Documentation

◆ getImageIcon()

ImageIcon com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.getImageIcon ( final int  faceNum,
@Nullable final boolean []  isUnknownImage 
)

Returns the face for a face ID.This function returns immediately even if the face is not loaded. A not loaded face will be updated as soon as loading has finished.

Parameters
faceNumthe face ID
isUnknownImagereturns whether the returned face is the "unknown" face; ignored if
null
Returns
the face, or the "unknown" face if the face is not loaded

Implements com.realtime.crossfire.jxclient.faces.FacesProvider.

Definition at line 66 of file MagicMapFacesProvider.java.

References com.realtime.crossfire.jxclient.faces.FacesManager.getMagicMapImageIcon().

+ Here is the call graph for this function:

◆ getSize()

int com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.getSize ( )

Returns the size of faces in pixels.

Returns
the size in pixels

Implements com.realtime.crossfire.jxclient.faces.FacesProvider.

Definition at line 57 of file MagicMapFacesProvider.java.

References com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.SIZE.

Member Data Documentation

◆ facesManager

final FacesManager com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.facesManager
private

◆ SIZE

final int com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.SIZE = 4
staticprivate

The size of faces in pixels.

Definition at line 37 of file MagicMapFacesProvider.java.

Referenced by com.realtime.crossfire.jxclient.faces.MagicMapFacesProvider.getSize().


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