net.sf.gridarta.model.face

Interface FaceObjects

All Superinterfaces:

java.lang.Iterable<FaceObject>, NamedObjects<FaceObject>, java.io.Serializable

All Known Implementing Classes:

AbstractFaceObjects, DefaultFaceObjects

public interface FaceObjects
extends NamedObjects<FaceObject>

FaceObjects is a container for FaceObjects.

Method Summary

Modifier and Type	Method and Description
void	addFaceObject(@NotNull java.lang.String faceName, @NotNull java.lang.String originalFilename, int offset, int size) Adds a new face object.
boolean	isIncludeFaceNumbers() Returns whether the images file contains face numbers.
@NotNull FaceProvider	loadFacesCollection(@NotNull ErrorView errorView, @NotNull java.io.File collectedDirectory) Loads all faces from a png collection file.

Methods inherited from interface net.sf.gridarta.model.data.NamedObjects

containsKey, get, getName, getTreeRoot, iterator, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

loadFacesCollection

@NotNull
@NotNull FaceProvider loadFacesCollection(@NotNull
                                                   @NotNull ErrorView errorView,
                                                   @NotNull
                                                   @NotNull java.io.File collectedDirectory)

Loads all faces from a png collection file.

Parameters:

errorView - the error view for reporting errors

collectedDirectory - directory to load from

Returns:

the face provider for accessing the read faces

addFaceObject

void addFaceObject(@NotNull
                   @NotNull java.lang.String faceName,
                   @NotNull
                   @NotNull java.lang.String originalFilename,
                   int offset,
                   int size)
            throws DuplicateFaceException,
                   IllegalFaceException

Adds a new face object.

Parameters:

faceName - the name of the face, e.g. "robe.101"

originalFilename - the original filename, e.g. "arch/objects/misc/robe.101.png"

offset - the offset in the file denoted by actualFilename, e.g. 148676

size - the size in the file denoted by actualFilename, e.g. 567,

Throws:

DuplicateFaceException - in case the face was not unique

IllegalFaceException - if the face cannot be added

isIncludeFaceNumbers

boolean isIncludeFaceNumbers()

Returns whether the images file contains face numbers.

Returns:

whether the images file contains face numbers