com.realtime.crossfire.jxclient.faces
Class Face

java.lang.Object
  extended by com.realtime.crossfire.jxclient.faces.Face

public class Face
extends java.lang.Object

A Face represents one image received from a Crossfire server. The face is uniquely identified by a face id; it has a face name and three images (original as sent by the server, scaled for use in map view, scaled for use in magic map view) attached.

Field Summary
private  int faceChecksum
          The image checksum as sent by the server.
private  FaceImages faceImages
          The images for this face.
private  java.lang.String faceName
          The face name as sent by the server.
private  int faceNum
          The face id as sent by the server.
static int SQUARE_SIZE
          The size of one square in pixels.
private  int tileHeight
          The face height in tiles.
private  int tileWidth
          The face width in tiles.
 
Constructor Summary
Face(int faceNum, java.lang.String faceName, int faceChecksum)
          Creates a new instance.
 
Method Summary
 boolean equals(java.lang.Object obj)
          
 int getFaceChecksum()
          Returns the face checksum.
 FaceImages getFaceImages()
          Returns the images.
 java.lang.String getFaceName()
          Returns the face name.
 int getFaceNum()
          Returns the unique face id.
 int getTileHeight()
          Returns the face height in tiles.
 int getTileWidth()
          Returns the face width in tiles.
 int hashCode()
          
 void setFaceImages(FaceImages faceImages)
          Sets the images.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

faceChecksum

private final int faceChecksum
The image checksum as sent by the server.

faceImages

@Nullable
private FaceImages faceImages
The images for this face. Set to null if unknown.

faceName

@NotNull
private final java.lang.String faceName
The face name as sent by the server.

faceNum

private final int faceNum
The face id as sent by the server.

SQUARE_SIZE

public static final int SQUARE_SIZE
The size of one square in pixels.

See Also:
Constant Field Values

tileHeight

private int tileHeight
The face height in tiles.

tileWidth

private int tileWidth
The face width in tiles.

Constructor Detail

Face

public Face(int faceNum,
            @NotNull
            java.lang.String faceName,
            int faceChecksum)
Creates a new instance.

Parameters:
faceNum - the unique face id
faceName - the face name
faceChecksum - the image checksum as sent by the server
Method Detail

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:
equals in class java.lang.Object

getFaceChecksum

public int getFaceChecksum()
Returns the face checksum.

Returns:
the face checksum

getFaceImages

@Nullable
public FaceImages getFaceImages()
Returns the images. May return null if the images are not yet known, or if they have been dropped from the cache.

Returns:
the images or null

getFaceName

@NotNull
public java.lang.String getFaceName()
Returns the face name.

Returns:
the face name

getFaceNum

public int getFaceNum()
Returns the unique face id.

Returns:
the face id

getTileHeight

public int getTileHeight()
Returns the face height in tiles.

Returns:
the tile height

getTileWidth

public int getTileWidth()
Returns the face width in tiles.

Returns:
the tile width

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

setFaceImages

public void setFaceImages(@NotNull
                          FaceImages faceImages)
Sets the images.

Parameters:
faceImages - the images

toString

@NotNull
public java.lang.String toString()

Overrides:
toString in class java.lang.Object