Gridarta Editor
net.sf.gridarta.model.face.AbstractFaceObjects Class Referenceabstract

Abstract base class for FaceObjects implementations. More...

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

Public Member Functions

void addFaceObject (@NotNull final String faceName, @NotNull final String originalFilename, final int offset, final int size) throws DuplicateFaceException, IllegalFaceException
 Adds a new face object. More...
 
- Public Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >
boolean containsKey (@NotNull final String name)
 
get (@NotNull final String objectName)
 
String getName ()
 
NamedTreeNode< E > getTreeRoot ()
 
Iterator< E > iterator ()
 
int size ()
 
- Public Member Functions inherited from net.sf.gridarta.model.data.NamedObjects< E >
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...
 
- Public Member Functions inherited from net.sf.gridarta.model.face.FaceObjects
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...
 

Protected Member Functions

 AbstractFaceObjects (@NotNull final String name)
 Creates a new instance. More...
 
- Protected Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >
 AbstractNamedObjects (final String name)
 Creates a new instance. More...
 
void put (@NotNull final E object) throws IllegalNamedObjectException
 Stores an AbstractNamedObject. More...
 

Static Private Attributes

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

Detailed Description

Abstract base class for FaceObjects implementations.

Author
Christian Hujer
Andreas Kirschbaum

Definition at line 31 of file AbstractFaceObjects.java.

Constructor & Destructor Documentation

◆ AbstractFaceObjects()

net.sf.gridarta.model.face.AbstractFaceObjects.AbstractFaceObjects ( @NotNull final String  name)
protected

Creates a new instance.

Parameters
namelocalized name of the object type, e.g. used in dialogs

Definition at line 42 of file AbstractFaceObjects.java.

References net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >.name.

Member Function Documentation

◆ addFaceObject()

void net.sf.gridarta.model.face.AbstractFaceObjects.addFaceObject ( @NotNull final String  faceName,
@NotNull final String  originalFilename,
final int  offset,
final 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

Implements net.sf.gridarta.model.face.FaceObjects.

Definition at line 47 of file AbstractFaceObjects.java.

References net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >.put(), and net.sf.gridarta.model.data.AbstractNamedObjects< E extends NamedObject >.size().

Referenced by net.sf.gridarta.model.face.DefaultFaceObjects.loadFacesCollection().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ serialVersionUID

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

The serial version UID.

Definition at line 36 of file AbstractFaceObjects.java.


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