Gridarta Editor
net.sf.gridarta.model.face.FaceObject Interface Reference

Common interface for FaceObject. More...

+ Inheritance diagram for net.sf.gridarta.model.face.FaceObject:
+ Collaboration diagram for net.sf.gridarta.model.face.FaceObject:

Public Member Functions

String getAlternativeFaceName ()
 Returns the alternative face name for image.a.nnn faces. More...
 
String getFaceName ()
 Get the faceName, which is the name of the face as usable by the "face" attribute. More...
 
String getOriginalFilename ()
 Get the original filename of this face. More...
 
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.NamedObject
String getDisplayIconName ()
 Returns the face name of the display icon for this AbstractNamedObject. More...
 
String getName ()
 Get the name of this AbstractNamedObject. More...
 
String getPath ()
 Get the path of this AbstractNamedObject. More...
 
void setPath (@NotNull String path)
 Set the path of this AbstractNamedObject. More...
 
String toString ()
 

Detailed Description

Common interface for FaceObject.

Author
Christian Hujer

Definition at line 30 of file FaceObject.java.

Member Function Documentation

◆ getAlternativeFaceName()

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

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

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

Implemented in net.sf.gridarta.model.face.DefaultFaceObject.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getFace().

+ Here is the caller graph for this function:

◆ getFaceName()

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

◆ getOriginalFilename()

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

Get the original filename of this face.

Returns
filename where this face was originally found

Implemented in net.sf.gridarta.model.face.DefaultFaceObject.

Referenced by net.sf.gridarta.model.resource.AbstractResourcesReader< G >.addPNGFace(), and net.sf.gridarta.model.face.DuplicateFaceException.DuplicateFaceException().

+ Here is the caller graph for this function:

◆ isDouble()

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

Return whether this face is a double face.

Returns
doubleFace

Implemented in net.sf.gridarta.model.face.DefaultFaceObject.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getFace().

+ Here is the caller graph for this function:

◆ isUp()

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

Return whether this face is an up face.

Returns
upFace

Implemented in net.sf.gridarta.model.face.DefaultFaceObject.


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