net.sf.gridarta.model.collectable.SmoothFacesCollectable Class Reference

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

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

Public Member Functions
void	collect (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
	SmoothFacesCollectable (@NotNull final SmoothFaces smoothFaces, @NotNull final String smoothFile)

Private Attributes
final SmoothFaces	smoothFaces
final String	smoothFile

Detailed Description

A Collectable that creates the Crossfire specific smooth faces file. This file contains information needed for smoothing faces between adjacent map squares.

Author

Andreas Kirschbaum

Definition at line 41 of file SmoothFacesCollectable.java.

Constructor & Destructor Documentation

SmoothFacesCollectable()

net.sf.gridarta.model.collectable.SmoothFacesCollectable.SmoothFacesCollectable	(	@NotNull final SmoothFaces	smoothFaces,
		@NotNull final String	smoothFile
	)

Creates a new instance.

Parameters

smoothFaces	the smooth faces to collect
smoothFile	the smooth file to write to

Definition at line 60 of file SmoothFacesCollectable.java.

References net.sf.gridarta.model.collectable.SmoothFacesCollectable.smoothFaces, and net.sf.gridarta.model.collectable.SmoothFacesCollectable.smoothFile.

Member Function Documentation

collect()

void net.sf.gridarta.model.collectable.SmoothFacesCollectable.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

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

Definition at line 66 of file SmoothFacesCollectable.java.

References net.sf.gridarta.model.smoothface.SmoothFace.getFace(), net.sf.gridarta.model.smoothface.SmoothFace.getValue(), net.sf.gridarta.utils.IOUtils.MAP_ENCODING, net.sf.gridarta.model.collectable.SmoothFacesCollectable.smoothFaces, and net.sf.gridarta.model.collectable.SmoothFacesCollectable.smoothFile.

Here is the call graph for this function:

Member Data Documentation

smoothFaces

final SmoothFaces net.sf.gridarta.model.collectable.SmoothFacesCollectable.smoothFaces

private

The SmoothFaces being collected.

Definition at line 47 of file SmoothFacesCollectable.java.

Referenced by net.sf.gridarta.model.collectable.SmoothFacesCollectable.collect(), and net.sf.gridarta.model.collectable.SmoothFacesCollectable.SmoothFacesCollectable().

smoothFile

final String net.sf.gridarta.model.collectable.SmoothFacesCollectable.smoothFile

private

The smooth file to write to.

Definition at line 53 of file SmoothFacesCollectable.java.

Referenced by net.sf.gridarta.model.collectable.SmoothFacesCollectable.collect(), and net.sf.gridarta.model.collectable.SmoothFacesCollectable.SmoothFacesCollectable().

---

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

• src/model/src/main/java/net/sf/gridarta/model/collectable/SmoothFacesCollectable.java