A Collectable that creates the atrinik.0/crossfire.0/daimonin.0 files which contains all defined faces. More...

Inheritance diagram for net.sf.gridarta.model.collectable.FaceObjectsCollectable:

Collaboration diagram for net.sf.gridarta.model.collectable.FaceObjectsCollectable:

Public Member Functions

void collect (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException

Collects information.

Parameters

progress	the progress to report progress to
collectedDirectory	the destination directory to collect data to

Exceptions

IOException in case of I/O problems during collection

Collects the faces. More...

FaceObjectsCollectable (@NotNull final FaceObjects faceObjects, @NotNull final ArchFaceProvider archFaceProvider)

Creates a new instance. More...

Private Member Functions
void	collectBmapsFile (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
	Creates the bmaps file. More...

void	collectFile (@NotNull final Progress progress, @NotNull final File file, @NotNull final String label, @NotNull final String format) throws IOException
	Creates an output file containing all faces. More...

void	collectImageFile (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
	Creates the image file. More...

void	collectTreeFile (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
	Creates the tree file. More...

Private Attributes
final ArchFaceProvider	archFaceProvider
	The ArchFaceProvider to use for collection. More...

final FaceObjects	faceObjects
	The FaceObjects being collected. More...

Static Private Attributes
static final ActionBuilder	ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
	The ActionBuilder instance. More...

Detailed Description

A Collectable that creates the atrinik.0/crossfire.0/daimonin.0 files which contains all defined faces.

It also creates index or editor helper files such as bmaps or bmaps.paths.

Author: Christian Hujer; Andreas Kirschbaum

Definition at line 50 of file FaceObjectsCollectable.java.

Constructor & Destructor Documentation

◆ FaceObjectsCollectable()

net.sf.gridarta.model.collectable.FaceObjectsCollectable.FaceObjectsCollectable	(	@NotNull final FaceObjects	faceObjects,
		@NotNull final ArchFaceProvider	archFaceProvider
	)

Creates a new instance.

Parameters

faceObjects	the face objects to collect
archFaceProvider	the arch face provider to use

Definition at line 75 of file FaceObjectsCollectable.java.

References net.sf.gridarta.model.collectable.FaceObjectsCollectable.archFaceProvider, and net.sf.gridarta.model.collectable.FaceObjectsCollectable.faceObjects.

Member Function Documentation

◆ collect()

void net.sf.gridarta.model.collectable.FaceObjectsCollectable.collect	(	@NotNull final Progress	progress,
		@NotNull final File	collectedDirectory
	)		throws IOException

Collects information.

Parameters

progress	the progress to report progress to
collectedDirectory	the destination directory to collect data to

Exceptions

IOException in case of I/O problems during collection

Collects the faces.

The graphics information is written to "crossfire.0" resp. "daimonin.0". The meta information (offsets etc.) is written to "bmaps". The tree information for the editor is written to "bmaps.paths" resp. "facetree".

Theoretically it would also be possible to recode the images. But the Java image encoder isn't as good as that of gimp in many cases (yet much better as the old visualtek's).

Implements net.sf.gridarta.model.collectable.Collectable.

Definition at line 91 of file FaceObjectsCollectable.java.

References net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectBmapsFile(), net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectImageFile(), and net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectTreeFile().

Here is the call graph for this function:

◆ collectBmapsFile()

void net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectBmapsFile	(	@NotNull final Progress	progress,
		@NotNull final File	collectedDirectory
	)		throws IOException

private

Creates the bmaps file.

Parameters

progress	the progress to report progress to
collectedDirectory	the destination directory to collect data to

Exceptions

IOException in case of I/O problems during collection

Definition at line 158 of file FaceObjectsCollectable.java.

References net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectFile(), and net.sf.gridarta.utils.ActionBuilderUtils.getString().

Referenced by net.sf.gridarta.model.collectable.FaceObjectsCollectable.collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectFile()

void net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectFile	(	@NotNull final Progress	progress,
		@NotNull final File	file,
		@NotNull final String	label,
		@NotNull final String	format
	)		throws IOException

private

Creates an output file containing all faces.

Parameters

progress	the process to report progress to
file	the output file to write
label	the progress label
format	the format string for writing the output file

Exceptions

IOException if an I/O error occurs

Definition at line 170 of file FaceObjectsCollectable.java.

References net.sf.gridarta.model.data.NamedObjects< E extends NamedObject >.size().

Referenced by net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectBmapsFile(), and net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectTreeFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectImageFile()

void net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectImageFile	(	@NotNull final Progress	progress,
		@NotNull final File	collectedDirectory
	)		throws IOException

private

Creates the image file.

Parameters

progress	the progress to report progress to
collectedDirectory	the destination directory to collect data to

Exceptions

IOException in case of I/O problems during collection

Definition at line 103 of file FaceObjectsCollectable.java.

References net.sf.gridarta.model.face.ArchFaceProvider.getFilename(), net.sf.gridarta.utils.ActionBuilderUtils.getString(), and net.sf.gridarta.model.data.NamedObjects< E extends NamedObject >.size().

Referenced by net.sf.gridarta.model.collectable.FaceObjectsCollectable.collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectTreeFile()

void net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectTreeFile	(	@NotNull final Progress	progress,
		@NotNull final File	collectedDirectory
	)		throws IOException

private

Creates the tree file.

Parameters

progress	the progress to report progress to
collectedDirectory	the destination directory to collect data to

Exceptions

IOException in case of I/O problems during collection

Definition at line 148 of file FaceObjectsCollectable.java.

References net.sf.gridarta.model.collectable.FaceObjectsCollectable.collectFile(), and net.sf.gridarta.utils.ActionBuilderUtils.getString().

Referenced by net.sf.gridarta.model.collectable.FaceObjectsCollectable.collect().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ACTION_BUILDER

final ActionBuilder net.sf.gridarta.model.collectable.FaceObjectsCollectable.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")

staticprivate

The ActionBuilder instance.

Definition at line 56 of file FaceObjectsCollectable.java.

◆ archFaceProvider

final ArchFaceProvider net.sf.gridarta.model.collectable.FaceObjectsCollectable.archFaceProvider

private

The ArchFaceProvider to use for collection.

Definition at line 68 of file FaceObjectsCollectable.java.

Referenced by net.sf.gridarta.model.collectable.FaceObjectsCollectable.FaceObjectsCollectable().

◆ faceObjects

final FaceObjects net.sf.gridarta.model.collectable.FaceObjectsCollectable.faceObjects

private

The FaceObjects being collected.

Definition at line 62 of file FaceObjectsCollectable.java.

Referenced by net.sf.gridarta.model.collectable.FaceObjectsCollectable.FaceObjectsCollectable().

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

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/collectable/FaceObjectsCollectable.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FaceObjectsCollectable()

Member Function Documentation

◆ collect()

◆ collectBmapsFile()

◆ collectFile()

◆ collectImageFile()

◆ collectTreeFile()

Member Data Documentation

◆ ACTION_BUILDER

◆ archFaceProvider

◆ faceObjects