Gridarta Editor
FaceObjects.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.face;
21 
22 import java.io.File;
25 import org.jetbrains.annotations.NotNull;
26 
31 public interface FaceObjects extends NamedObjects<FaceObject> {
32 
39  @NotNull
40  FaceProvider loadFacesCollection(@NotNull ErrorView errorView, @NotNull File collectedDirectory);
41 
54  void addFaceObject(@NotNull String faceName, @NotNull String originalFilename, int offset, int size) throws DuplicateFaceException, IllegalFaceException;
55 
60  boolean isIncludeFaceNumbers();
61 
62 }
net.sf.gridarta.model.face.FaceProvider
This interface represents a lazy loader that provides images on demand.
Definition: FaceProvider.java:30
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.model.data.NamedObjects.size
int size()
Get the number of objects.
net.sf.gridarta.model.errorview.ErrorView
Interface for classes displaying error messages.
Definition: ErrorView.java:28
net.sf.gridarta.model.face.IllegalFaceException
Exception thrown to indicate that a face object is not acceptable.
Definition: IllegalFaceException.java:28
net
net.sf.gridarta.model.errorview
Definition: ErrorView.java:20
net.sf.gridarta.model.face.FaceObjects
FaceObjects is a container for FaceObjects.
Definition: FaceObjects.java:31
net.sf.gridarta.model.face.FaceObjects.isIncludeFaceNumbers
boolean isIncludeFaceNumbers()
Returns whether the images file contains face numbers.
net.sf.gridarta.model.data
Classes for handling data that is organized in a tree.
Definition: AbstractNamedObject.java:20
net.sf.gridarta.model
net.sf.gridarta.model.face.FaceObjects.addFaceObject
void addFaceObject(@NotNull String faceName, @NotNull String originalFilename, int offset, int size)
Adds a new face object.
net.sf.gridarta.model.face.DuplicateFaceException
Exception that's thrown in case a face name was not unique.
Definition: DuplicateFaceException.java:26
net.sf.gridarta.model.face.FaceObjects.loadFacesCollection
FaceProvider loadFacesCollection(@NotNull ErrorView errorView, @NotNull File collectedDirectory)
Loads all faces from a png collection file.
net.sf.gridarta.model.data.NamedObjects
This class manages NamedObjects, managing their tree as well as providing a method for showing a dial...
Definition: NamedObjects.java:33