Gridarta Editor: net.sf.gridarta.model.anim.DefaultAnimationObject Class Reference

Public Member Functions | Private Attributes | Static Private Attributes | List of all members

net.sf.gridarta.model.anim.DefaultAnimationObject Class Reference

Abstract base implementation of AnimationObject. More...

Inheritance diagram for net.sf.gridarta.model.anim.DefaultAnimationObject:

Collaboration diagram for net.sf.gridarta.model.anim.DefaultAnimationObject:

Public Member Functions

DefaultAnimationObject (@NotNull final String animName, @NotNull final String animList, @NotNull final String path) Creates a new instance. More...
String getAnimList () Returns the animation list of this animation. More...
String getAnimName () String getDisplayIconName () Returns the face name of the display icon for this AbstractNamedObject. More...
int getFacings () Get the facings, which is the number of different sub-animations, for instance for different directions. More...
String getFirstFrame (final int facing) Get the first frame. More...
String getFrame (final int facing, final int frame) throws IndexOutOfBoundsException Get a specific frame. More...
int getFrameCount () Get the number of frames per facing. More...
String getName () String toString () The String representation of an AnimationObject is suitable for writing into the animations file. More...

Public Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObject int compareTo (@NotNull final NamedObject o) boolean equals (@Nullable final Object obj) String getPath () Get the path of this AbstractNamedObject. More...
int hashCode () void setPath (@NotNull final String path) Set the path of this AbstractNamedObject. More...
String toString ()

Private Attributes
final String	animList
	The animation list of this animation. More...

final String	animName
	The name of this animation. More...

final int	facings
	The number of facings, which is different sub animations, for instance for different directions. More...

final int	frameCount
	The number of frames per facing in the animation. More...

final List< String >	frames = new ArrayList<>()
	The names of the animation frames. More...

Static Private Attributes
static final Category	LOG = Logger.getLogger(DefaultAnimationObject.class)
	The Logger for printing log messages. More...

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

Additional Inherited Members
Protected Member Functions inherited from net.sf.gridarta.model.data.AbstractNamedObject
	AbstractNamedObject (@NotNull final String path)
	Create a AbstractNamedObject. More...

Detailed Description

Abstract base implementation of AnimationObject.

Author: Christian Hujer

Definition at line 34 of file DefaultAnimationObject.java.

Constructor & Destructor Documentation

◆ DefaultAnimationObject()

net.sf.gridarta.model.anim.DefaultAnimationObject.DefaultAnimationObject	(	@NotNull final String	animName,
		@NotNull final String	animList,
		@NotNull final String	path
	)

Creates a new instance.

Therefore animList is parsed. Do not invoke this constructor directly, use String, String) instead. If you invoke this constructor directly, the created AnimationObject will not be registered.

Parameters

animName	name of the animation
animList	list of animation as found between "anim" and "mina", separated with "\n", including "facings" but including neither "anim" nor "mina"
path	the path for this animation object

Definition at line 93 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.animList, net.sf.gridarta.model.anim.DefaultAnimationObject.animName, net.sf.gridarta.model.anim.DefaultAnimationObject.facings, and net.sf.gridarta.utils.StringUtils.PATTERN_NEWLINE.

Member Function Documentation

◆ getAnimList()

String net.sf.gridarta.model.anim.DefaultAnimationObject.getAnimList ( )

Returns the animation list of this animation.

The individual entries are all suffixed with '
'.

Returns: the animation list of this animation

Implements net.sf.gridarta.model.anim.AnimationObject.

Definition at line 156 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.animList.

◆ getAnimName()

String net.sf.gridarta.model.anim.DefaultAnimationObject.getAnimName ( )

See also: getName()

Implements net.sf.gridarta.model.anim.AnimationObject.

Definition at line 150 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.animName.

◆ getDisplayIconName()

String net.sf.gridarta.model.anim.DefaultAnimationObject.getDisplayIconName ( )

Returns the face name of the display icon for this AbstractNamedObject.

Returns: the face name

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 177 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.facings, and net.sf.gridarta.model.anim.DefaultAnimationObject.getFirstFrame().

Here is the call graph for this function:

◆ getFacings()

int net.sf.gridarta.model.anim.DefaultAnimationObject.getFacings ( )

Get the facings, which is the number of different sub-animations, for instance for different directions.

Returns: facings

Implements net.sf.gridarta.model.anim.AnimationObject.

Definition at line 141 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.facings.

◆ getFirstFrame()

String net.sf.gridarta.model.anim.DefaultAnimationObject.getFirstFrame ( final int facing )

Get the first frame.

Parameters

facing facing to get frame for, usually a direction

Returns: frame

Implements net.sf.gridarta.model.anim.AnimationObject.

Definition at line 189 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.getFrame().

Referenced by net.sf.gridarta.model.anim.DefaultAnimationObject.getDisplayIconName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFrame()

String net.sf.gridarta.model.anim.DefaultAnimationObject.getFrame	(	final int	facing,
		final int	frame
	)		throws IndexOutOfBoundsException

Get a specific frame.

Parameters

facing	facing to get frame for, usually a direction
frame	index within the sub-animation for facing

Returns: frame name of animation frame

Exceptions

IndexOutOfBoundsException in case the frame or facing is invalid

Definition at line 201 of file DefaultAnimationObject.java.

Referenced by net.sf.gridarta.model.anim.DefaultAnimationObject.getFirstFrame().

Here is the caller graph for this function:

◆ getFrameCount()

int net.sf.gridarta.model.anim.DefaultAnimationObject.getFrameCount ( )

Get the number of frames per facing.

Returns: number of frames per facing

Definition at line 215 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.frameCount.

◆ getName()

String net.sf.gridarta.model.anim.DefaultAnimationObject.getName ( )

Returns: the same String as
getAnimName()

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 136 of file DefaultAnimationObject.java.

References net.sf.gridarta.model.anim.DefaultAnimationObject.animName.

◆ toString()

String net.sf.gridarta.model.anim.DefaultAnimationObject.toString ( )

The String representation of an AnimationObject is suitable for writing into the animations file.

Implements net.sf.gridarta.model.data.NamedObject.

Definition at line 165 of file DefaultAnimationObject.java.

Member Data Documentation

◆ animList

final String net.sf.gridarta.model.anim.DefaultAnimationObject.animList

private

The animation list of this animation.

The individual entries are all suffixed with '
'.

Definition at line 80 of file DefaultAnimationObject.java.

Referenced by net.sf.gridarta.model.anim.DefaultAnimationObject.DefaultAnimationObject(), and net.sf.gridarta.model.anim.DefaultAnimationObject.getAnimList().

◆ animName

final String net.sf.gridarta.model.anim.DefaultAnimationObject.animName

private

The name of this animation.

Definition at line 72 of file DefaultAnimationObject.java.

Referenced by net.sf.gridarta.model.anim.DefaultAnimationObject.DefaultAnimationObject(), net.sf.gridarta.model.anim.DefaultAnimationObject.getAnimName(), and net.sf.gridarta.model.anim.DefaultAnimationObject.getName().

◆ facings

final int net.sf.gridarta.model.anim.DefaultAnimationObject.facings

private

The number of facings, which is different sub animations, for instance for different directions.

Definition at line 65 of file DefaultAnimationObject.java.

Referenced by net.sf.gridarta.model.anim.DefaultAnimationObject.DefaultAnimationObject(), net.sf.gridarta.model.anim.DefaultAnimationObject.getDisplayIconName(), and net.sf.gridarta.model.anim.DefaultAnimationObject.getFacings().

◆ frameCount

final int net.sf.gridarta.model.anim.DefaultAnimationObject.frameCount

private

The number of frames per facing in the animation.

Definition at line 58 of file DefaultAnimationObject.java.

Referenced by net.sf.gridarta.model.anim.DefaultAnimationObject.getFrameCount().

◆ frames

final List<String> net.sf.gridarta.model.anim.DefaultAnimationObject.frames = new ArrayList<>()

private

The names of the animation frames.

Definition at line 52 of file DefaultAnimationObject.java.

◆ LOG

final Category net.sf.gridarta.model.anim.DefaultAnimationObject.LOG = Logger.getLogger(DefaultAnimationObject.class)

staticprivate

The Logger for printing log messages.

Definition at line 45 of file DefaultAnimationObject.java.

◆ serialVersionUID

final long net.sf.gridarta.model.anim.DefaultAnimationObject.serialVersionUID = 1L

staticprivate

The serial version UID.

Definition at line 39 of file DefaultAnimationObject.java.

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

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/anim/DefaultAnimationObject.java

net
sf
gridarta
model
anim
DefaultAnimationObject
Generated by 1.8.13

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultAnimationObject()

Member Function Documentation

◆ getAnimList()

◆ getAnimName()

◆ getDisplayIconName()

◆ getFacings()

◆ getFirstFrame()

◆ getFrame()

◆ getFrameCount()

◆ getName()

◆ toString()

Member Data Documentation

◆ animList

◆ animName

◆ facings

◆ frameCount

◆ frames

◆ LOG

◆ serialVersionUID