com.almasb.fxgl.texture

Interface AnimationChannel

public interface AnimationChannel

Represents one of the animation channels from sprite sheet.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Method Summary

Modifier and Type	Method and Description
javafx.geometry.Rectangle2D	area() Area to be used to select a sub-texture from a sprite sheet.
default double	computeFrameHeight() Computes frame height based on the area height.
default double	computeFrameTime() Computes time per each frame in this animation channel by dividing the duration by number of frames.
default double	computeFrameWidth() Computes frame width based on the area width and number of frames.
default javafx.geometry.Rectangle2D	computeViewport(int frame) Computes the viewport for given frame.
javafx.util.Duration	duration()
int	frames()
String	name()

Method Detail

area

javafx.geometry.Rectangle2D area()

Area to be used to select a sub-texture from a sprite sheet.

Returns:

area

frames

int frames()

Returns:

number of frames in this animation

duration

javafx.util.Duration duration()

Returns:

total duration of the animation

name

String name()

Returns:

name of the animation

computeFrameWidth

default double computeFrameWidth()

Computes frame width based on the area width and number of frames.

Returns:

frame width

computeFrameHeight

default double computeFrameHeight()

Computes frame height based on the area height.

Returns:

frame height

computeFrameTime

default double computeFrameTime()

Computes time per each frame in this animation channel by dividing the duration by number of frames.

Returns:

time per each animation frame

computeViewport

default javafx.geometry.Rectangle2D computeViewport(int frame)

Computes the viewport for given frame. Frames start from 0.

Parameters:

frame - frame number

Returns:

viewport area for frame