Package com.realtime.crossfire.jxclient.faces

Class Face

java.lang.Object

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

Fields

Modifier and Type	Field	Description
static int	SQUARE_SIZE	The size of one square in pixels.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable java.lang.Object obj)
int	getFaceChecksum()	Returns the face checksum.
@Nullable FaceImages	getFaceImages()	Returns the images.
@NotNull 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(@NotNull FaceImages faceImages)	Sets the images.
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SQUARE_SIZE

public static final int SQUARE_SIZE

The size of one square in pixels.

See Also:

Constant Field Values

Constructor Detail

Face

public Face(int faceNum,
            @NotNull
            @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

setFaceImages

public void setFaceImages(@NotNull
                          @NotNull FaceImages faceImages)

Sets the images.

Parameters:

faceImages - the images

getFaceNum

public int getFaceNum()

Returns the unique face id.

Returns:

the face id

getFaceImages

@Nullable
public @Nullable 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 @NotNull java.lang.String getFaceName()

Returns the face name.

Returns:

the face name

getFaceChecksum

public int getFaceChecksum()

Returns the face checksum.

Returns:

the face checksum

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTileWidth

public int getTileWidth()

Returns the face width in tiles.

Returns:

the tile width

getTileHeight

public int getTileHeight()

Returns the face height in tiles.

Returns:

the tile height

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

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

Overrides:

equals in class java.lang.Object