A FaceObject stores information and meta information about a face and provides methods for accessing these. More...

Inheritance diagram for net.sf.gridarta.model.face.DefaultFaceObject:

Collaboration diagram for net.sf.gridarta.model.face.DefaultFaceObject:

Public Member Functions
int	compareTo (@NotNull final NamedObject o)
	Overridden to sort bug.101 and bug.111 before all other faces. More...

	DefaultFaceObject (@NotNull final String faceName, @NotNull final String originalFilename, final int offset, final int size)
	Create a FaceObject. More...

boolean	equals (@Nullable final Object obj)

String	getAlternativeFaceName ()
	Returns the alternative face name for image.a.nnn faces. More...

String	getDisplayIconName ()
	Returns the face name of the display icon for this AbstractNamedObject. More...

String	getFaceName ()

String	getName ()

int	getOffset ()
	Get the offset of this face in the actualFilename. More...

String	getOriginalFilename ()
	Get the original filename of this face. More...

int	getSize ()
	Get the size of this face in the actualFilename. More...

int	hashCode ()

boolean	isDouble ()
	Return whether this face is a double face. More...

boolean	isUp ()
	Return whether this face is an up face. More...

Public Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObject
int	compareTo (@NotNull final NamedObject o)

boolean	equals (@Nullable final Object obj)

String	getPath ()
	Get the path of this AbstractNamedObject. More...

int	hashCode ()

void	setPath (@NotNull final String path)
	Set the path of this AbstractNamedObject. More...

String	toString ()

Private Attributes
final String	alternativeFaceName
	The alternative face name for image.a.nnn faces. More...

final String	faceName
	The face name. More...

final boolean	isDouble
	Whether this face is a "double" face. More...

final boolean	isUp
	Whether this face is an "up" face. More...

final int	offset
	The offset in the file the face was loaded from. More...

final String	originalFilename
	The filename the face originally came from (origin location). More...

final int	size
	The size in the file the face was loaded from. More...

Static Private Attributes
static final Pattern	ALTERNATIVE_FACE_NAME_PATTERN = Pattern.compile("\\.a\\.")
	A Pattern matching face names having alternative face names. More...

static final long	serialVersionUID = 1L
	The serial version UID. More...

Additional Inherited Members
Protected Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObject
	AbstractNamedObject (@NotNull final String path)
	Create a AbstractNamedObject. More...

Detailed Description

A FaceObject stores information and meta information about a face and provides methods for accessing these.

Mainly this is:

Face name
Weakly referenced Image Icon for different appearances of the face
File name of file where the face originally came from
File name where the face actually was loaded from (may be the same or different from the previous one)
File offset in the file name
File size

Author: Christian Hujer

Todo:: think how this class could be serialized because size, offset etc. are not serializable.

Definition at line 45 of file DefaultFaceObject.java.

Constructor & Destructor Documentation

◆ DefaultFaceObject()

net.sf.gridarta.model.face.DefaultFaceObject.DefaultFaceObject	(	@NotNull final String	faceName,
		@NotNull final String	originalFilename,
		final int	offset,
		final int	size
	)

Create a FaceObject.

Parameters

faceName	name of face, e.g. <samp>"bug.111"</samp>
originalFilename	original filename without .png extension, e.g. <samp>"/system/bug.111"</samp>
offset	offset in the file denoted by actualFilename , e.g. <samp>148676</samp>
size	size in the file denoted by actualFilename , e.g. <samp>567</samp>,

Definition at line 117 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.faceName, net.sf.gridarta.model.face.DefaultFaceObject.offset, net.sf.gridarta.model.face.DefaultFaceObject.originalFilename, and net.sf.gridarta.model.face.DefaultFaceObject.size.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.equals().

Here is the caller graph for this function:

Member Function Documentation

◆ compareTo()

int net.sf.gridarta.model.face.DefaultFaceObject.compareTo ( @NotNull final NamedObject o )

Overridden to sort bug.101 and bug.111 before all other faces.

Definition at line 196 of file DefaultFaceObject.java.

◆ equals()

boolean net.sf.gridarta.model.face.DefaultFaceObject.equals ( @Nullable final Object obj )

Definition at line 217 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.DefaultFaceObject(), net.sf.gridarta.model.face.DefaultFaceObject.equals(), and net.sf.gridarta.model.face.DefaultFaceObject.faceName.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAlternativeFaceName()

String net.sf.gridarta.model.face.DefaultFaceObject.getAlternativeFaceName ( )

Returns the alternative face name for image.a.nnn faces.

Returns: the alternative face name (image.b.nnn) or
null

Implements net.sf.gridarta.model.face.FaceObject.

Definition at line 181 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.alternativeFaceName.

◆ getDisplayIconName()

String net.sf.gridarta.model.face.DefaultFaceObject.getDisplayIconName ( )

Returns the face name of the display icon for this AbstractNamedObject.

Returns: the face name

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 187 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.faceName.

◆ getFaceName()

String net.sf.gridarta.model.face.DefaultFaceObject.getFaceName ( )

See also: getName()

Implements net.sf.gridarta.model.face.FaceObject.

Definition at line 143 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.faceName.

◆ getName()

String net.sf.gridarta.model.face.DefaultFaceObject.getName ( )

Returns: the same String as
getFaceName()

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 134 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.faceName.

◆ getOffset()

int net.sf.gridarta.model.face.DefaultFaceObject.getOffset ( )

Get the offset of this face in the actualFilename.

Returns: offset of this face in the actual file

Definition at line 157 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.offset.

◆ getOriginalFilename()

String net.sf.gridarta.model.face.DefaultFaceObject.getOriginalFilename ( )

Get the original filename of this face.

Returns: filename where this face was originally found

Implements net.sf.gridarta.model.face.FaceObject.

Definition at line 149 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.originalFilename.

◆ getSize()

int net.sf.gridarta.model.face.DefaultFaceObject.getSize ( )

Get the size of this face in the actualFilename.

Returns: size of this face in the actual file

Definition at line 165 of file DefaultFaceObject.java.

References net.sf.gridarta.model.face.DefaultFaceObject.size.

◆ hashCode()

int net.sf.gridarta.model.face.DefaultFaceObject.hashCode ( )

Definition at line 212 of file DefaultFaceObject.java.

◆ isDouble()

boolean net.sf.gridarta.model.face.DefaultFaceObject.isDouble ( )

Return whether this face is a double face.

Returns: doubleFace

Implements net.sf.gridarta.model.face.FaceObject.

Definition at line 175 of file DefaultFaceObject.java.

◆ isUp()

boolean net.sf.gridarta.model.face.DefaultFaceObject.isUp ( )

Return whether this face is an up face.

Returns: upFace

Implements net.sf.gridarta.model.face.FaceObject.

Definition at line 170 of file DefaultFaceObject.java.

Member Data Documentation

◆ ALTERNATIVE_FACE_NAME_PATTERN

final Pattern net.sf.gridarta.model.face.DefaultFaceObject.ALTERNATIVE_FACE_NAME_PATTERN = Pattern.compile("\\.a\\.")

staticprivate

A Pattern matching face names having alternative face names.

Definition at line 56 of file DefaultFaceObject.java.

◆ alternativeFaceName

final String net.sf.gridarta.model.face.DefaultFaceObject.alternativeFaceName

private

The alternative face name for image.a.nnn faces.

Definition at line 105 of file DefaultFaceObject.java.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.getAlternativeFaceName().

◆ faceName

final String net.sf.gridarta.model.face.DefaultFaceObject.faceName

private

The face name.

Definition at line 63 of file DefaultFaceObject.java.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.DefaultFaceObject(), net.sf.gridarta.model.face.DefaultFaceObject.equals(), net.sf.gridarta.model.face.DefaultFaceObject.getDisplayIconName(), net.sf.gridarta.model.face.DefaultFaceObject.getFaceName(), and net.sf.gridarta.model.face.DefaultFaceObject.getName().

◆ isDouble

final boolean net.sf.gridarta.model.face.DefaultFaceObject.isDouble

private

Whether this face is a "double" face.

See also: "Usage FACE_FLAG_DOUBLE in client/src/client.c, client/src/map.c defined by client/src/include/main.h"

Definition at line 90 of file DefaultFaceObject.java.

◆ isUp

final boolean net.sf.gridarta.model.face.DefaultFaceObject.isUp

private

Whether this face is an "up" face.

See also: "Usage FACE_FLAG_UP in client/src/client.c, client/src/map.c defined by client/src/include/main.h"

Definition at line 98 of file DefaultFaceObject.java.

◆ offset

final int net.sf.gridarta.model.face.DefaultFaceObject.offset

private

The offset in the file the face was loaded from.

Definition at line 76 of file DefaultFaceObject.java.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.DefaultFaceObject(), and net.sf.gridarta.model.face.DefaultFaceObject.getOffset().

◆ originalFilename

final String net.sf.gridarta.model.face.DefaultFaceObject.originalFilename

private

The filename the face originally came from (origin location).

Definition at line 70 of file DefaultFaceObject.java.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.DefaultFaceObject(), and net.sf.gridarta.model.face.DefaultFaceObject.getOriginalFilename().

◆ serialVersionUID

final long net.sf.gridarta.model.face.DefaultFaceObject.serialVersionUID = 1L

staticprivate

The serial version UID.

Definition at line 50 of file DefaultFaceObject.java.

◆ size

final int net.sf.gridarta.model.face.DefaultFaceObject.size

private

The size in the file the face was loaded from.

Definition at line 82 of file DefaultFaceObject.java.

Referenced by net.sf.gridarta.model.face.DefaultFaceObject.DefaultFaceObject(), and net.sf.gridarta.model.face.DefaultFaceObject.getSize().

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

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/face/DefaultFaceObject.java

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultFaceObject()

Member Function Documentation

◆ compareTo()

◆ equals()

◆ getAlternativeFaceName()

◆ getDisplayIconName()

◆ getFaceName()

◆ getName()

◆ getOffset()

◆ getOriginalFilename()

◆ getSize()

◆ hashCode()

◆ isDouble()

◆ isUp()

Member Data Documentation

◆ ALTERNATIVE_FACE_NAME_PATTERN

◆ alternativeFaceName

◆ faceName

◆ isDouble

◆ isUp

◆ offset

◆ originalFilename

◆ serialVersionUID

◆ size