Gridarta Editor
net.sf.gridarta.model.collectable.AnimationObjectsCollectable Class Reference

a Collectable that creates the "animations" file. More...

+ Inheritance diagram for net.sf.gridarta.model.collectable.AnimationObjectsCollectable:
+ Collaboration diagram for net.sf.gridarta.model.collectable.AnimationObjectsCollectable:

Public Member Functions

 AnimationObjectsCollectable (@NotNull final AnimationObjects animationObjects, @NotNull final String animTreeFile)
 Creates a new instance. More...
 
void collect (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
 Collects information.
Parameters
progressthe progress to report progress to
collectedDirectorythe destination directory to collect data to
Exceptions
IOExceptionin case of I/O problems during collection
Collects the Animations. More...
 

Private Member Functions

void collectAnimations (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
 Collects the animation data into the file "animations". More...
 
void collectAnimTree (@NotNull final Progress progress, @NotNull final File collectedDirectory) throws IOException
 Collects the animation data into the file "animations". More...
 

Private Attributes

final AnimationObjects animationObjects
 The AnimationObjects being collected. More...
 
final String animTreeFile
 The collected animation tree file. 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 "animations" file.

It also creates the editor helper file "animtree".

Author
Christian Hujer
Andreas Kirschbaum

Definition at line 44 of file AnimationObjectsCollectable.java.

Constructor & Destructor Documentation

◆ AnimationObjectsCollectable()

net.sf.gridarta.model.collectable.AnimationObjectsCollectable.AnimationObjectsCollectable ( @NotNull final AnimationObjects  animationObjects,
@NotNull final String  animTreeFile 
)

Creates a new instance.

Parameters
animationObjectsthe animation objects to be collected
animTreeFilethe collected animation tree file

Definition at line 69 of file AnimationObjectsCollectable.java.

References net.sf.gridarta.model.collectable.AnimationObjectsCollectable.animationObjects, and net.sf.gridarta.model.collectable.AnimationObjectsCollectable.animTreeFile.

Member Function Documentation

◆ collect()

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

Collects information.

Parameters
progressthe progress to report progress to
collectedDirectorythe destination directory to collect data to
Exceptions
IOExceptionin case of I/O problems during collection
Collects the Animations.

The animation data is written to "animations". The tree information for the editor is written to "animtree".

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

Definition at line 80 of file AnimationObjectsCollectable.java.

References net.sf.gridarta.model.collectable.AnimationObjectsCollectable.collectAnimations(), and net.sf.gridarta.model.collectable.AnimationObjectsCollectable.collectAnimTree().

+ Here is the call graph for this function:

◆ collectAnimations()

void net.sf.gridarta.model.collectable.AnimationObjectsCollectable.collectAnimations ( @NotNull final Progress  progress,
@NotNull final File  collectedDirectory 
) throws IOException
private

Collects the animation data into the file "animations".

Parameters
progressthe progress to report progress to
collectedDirectorythe destination directory to collect data to
Exceptions
IOExceptionin case of I/O problems during collection

Definition at line 91 of file AnimationObjectsCollectable.java.

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

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

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

◆ collectAnimTree()

void net.sf.gridarta.model.collectable.AnimationObjectsCollectable.collectAnimTree ( @NotNull final Progress  progress,
@NotNull final File  collectedDirectory 
) throws IOException
private

Collects the animation data into the file "animations".

Parameters
progressthe progress to report progress to
collectedDirectorythe destination directory to collect data to
Exceptions
IOExceptionin case of I/O problems during collection

Definition at line 111 of file AnimationObjectsCollectable.java.

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

Referenced by net.sf.gridarta.model.collectable.AnimationObjectsCollectable.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.AnimationObjectsCollectable.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
staticprivate

The ActionBuilder instance.

Definition at line 50 of file AnimationObjectsCollectable.java.

◆ animationObjects

final AnimationObjects net.sf.gridarta.model.collectable.AnimationObjectsCollectable.animationObjects
private

◆ animTreeFile

final String net.sf.gridarta.model.collectable.AnimationObjectsCollectable.animTreeFile
private

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