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

FaceObjects is a container for FaceObjects. More...

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

Public Member Functions

void addFaceObject (String faceName, String originalFilename, int offset, int size) throws DuplicateFaceException, IllegalFaceException
 Adds a new face object. More...
 
boolean isIncludeFaceNumbers ()
 Returns whether the images file contains face numbers. More...
 
FaceProvider loadFacesCollection (@NotNull ErrorView errorView, @NotNull File collectedDirectory)
 Loads all faces from a png collection file. More...
 
- Public Member Functions inherited from net.sf.gridarta.model.data.NamedObjects< E extends NamedObject >
boolean containsKey (@NotNull String name)
 Check whether an object is defined. More...
 
get (@NotNull String objectName)
 Gets a AbstractNamedObject. More...
 
String getName ()
 Returns the tree name. More...
 
NamedTreeNode< E > getTreeRoot ()
 Get the object tree root. More...
 
Iterator< E > iterator ()
 NamedObjects are iterated in Unicode (=case sensitive ASCII) order. More...
 
int size ()
 Get the number of objects. More...
 

Detailed Description

FaceObjects is a container for FaceObjects.

Author
Christian Hujer

Definition at line 31 of file FaceObjects.java.

Member Function Documentation

◆ addFaceObject()

void net.sf.gridarta.model.face.FaceObjects.addFaceObject ( String  faceName,
String  originalFilename,
int  offset,
int  size 
) throws DuplicateFaceException, IllegalFaceException

Adds a new face object.

Parameters
faceNamethe name of the face, e.g. <samp>"robe.101"</samp>
originalFilenamethe original filename, e.g. <samp>"arch/objects/misc/robe.101.png"</samp>
offsetthe offset in the file denoted by
actualFilename
, e.g. <samp>148676</samp>
sizethe size in the file denoted by
actualFilename
, e.g. <samp>567</samp>,
Exceptions
DuplicateFaceExceptionin case the face was not unique
IllegalFaceExceptionif the face cannot be added

Referenced by net.sf.gridarta.model.resource.AbstractResourcesReader< G >.addPNGFace().

+ Here is the caller graph for this function:

◆ isIncludeFaceNumbers()

boolean net.sf.gridarta.model.face.FaceObjects.isIncludeFaceNumbers ( )

Returns whether the images file contains face numbers.

Returns
whether the images file contains face numbers

Implemented in net.sf.gridarta.model.face.DefaultFaceObjects, and net.sf.gridarta.model.face.TestFaceObjects.

◆ loadFacesCollection()

FaceProvider net.sf.gridarta.model.face.FaceObjects.loadFacesCollection ( @NotNull ErrorView  errorView,
@NotNull File  collectedDirectory 
)

Loads all faces from a png collection file.

Parameters
errorViewthe error view for reporting errors
collectedDirectorydirectory to load from
Returns
the face provider for accessing the read faces

Implemented in net.sf.gridarta.model.face.DefaultFaceObjects, and net.sf.gridarta.model.face.TestFaceObjects.

Referenced by net.sf.gridarta.model.resource.AbstractCollectedResourcesReader< GameObject, MapArchObject, Archetype >.loadFacesCollection().

+ Here is the caller graph for this function:

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