Animate

Documentation

type Seconds = Float

Avoided newtype wrapper for convenience

type DeltaSeconds = Seconds

Type aliased seconds

type Color = (Word8, Word8, Word8)

Alias for RGB (8bit, 8bit, 8bit)

type FrameIndex = Int

data Frame loc

Constructors

Frame loc Seconds

Instances

Eq loc => Eq (Frame loc)

Methods

(==) :: Frame loc -> Frame loc -> Bool

(/=) :: Frame loc -> Frame loc -> Bool

Show loc => Show (Frame loc)

Methods

showsPrec :: Int -> Frame loc -> ShowS

show :: Frame loc -> String

showList :: [Frame loc] -> ShowS

data Animations key loc

Type safe animation set. Use an sum type with an Enum and Bounded instance for the animation, a.

Instances

Eq loc => Eq (Animations key loc)

Methods

(==) :: Animations key loc -> Animations key loc -> Bool

(/=) :: Animations key loc -> Animations key loc -> Bool

Show loc => Show (Animations key loc)

Methods

showsPrec :: Int -> Animations key loc -> ShowS

show :: Animations key loc -> String

showList :: [Animations key loc] -> ShowS

data Loop

Constructors

Loop'Always

Never stop looping. Animation can never be completed.

Loop'Count Int

Count down loops to below zero. 0 = no loop. 1 = one loop. 2 = two loops. etc.

Instances

Eq Loop

Methods

(==) :: Loop -> Loop -> Bool

(/=) :: Loop -> Loop -> Bool

Show Loop

Methods

showsPrec :: Int -> Loop -> ShowS

show :: Loop -> String

showList :: [Loop] -> ShowS

data Position key

State for progression through an animation | `example = Position minBound 0 0 LoopAlways

Constructors

Position key FrameIndex Seconds Loop

Instances

Eq key => Eq (Position key)

Methods

(==) :: Position key -> Position key -> Bool

(/=) :: Position key -> Position key -> Bool

Show key => Show (Position key)

Methods

showsPrec :: Int -> Position key -> ShowS

show :: Position key -> String

showList :: [Position key] -> ShowS

data FrameStep

You can ignore. An intermediate type for stepPosition to judge how to increment the current frame.

Constructors

FrameStep'Counter Seconds

New counter to compare against the frame's delay.

FrameStep'Delta DeltaSeconds

How much delta to carry over into the next frame.

Instances

Eq FrameStep

Methods

(==) :: FrameStep -> FrameStep -> Bool

(/=) :: FrameStep -> FrameStep -> Bool

Show FrameStep

Methods

showsPrec :: Int -> FrameStep -> ShowS

show :: FrameStep -> String

showList :: [FrameStep] -> ShowS

class (Ord key, Bounded key, Enum key) => Key key

Sematically for an animation key constraint

class Key key => KeyName key where

Animation Keyframe. keyName is used for JSON parsing.

Minimal complete definition

keyName

Methods

keyName :: key -> Text

data SpriteClip

Describe the boxed area of the 2d sprite inside a sprite sheet

Constructors

SpriteClip Int Int Int Int (Maybe (Int, Int))

Instances

Eq SpriteClip

Methods

(==) :: SpriteClip -> SpriteClip -> Bool

(/=) :: SpriteClip -> SpriteClip -> Bool

Show SpriteClip

Methods

showsPrec :: Int -> SpriteClip -> ShowS

show :: SpriteClip -> String

showList :: [SpriteClip] -> ShowS

FromJSON SpriteClip

Methods

parseJSON :: Value -> Parser SpriteClip

parseJSONList :: Value -> Parser [SpriteClip]

ToJSON SpriteClip

Methods

toJSON :: SpriteClip -> Value

toEncoding :: SpriteClip -> Encoding

toJSONList :: [SpriteClip] -> Value

toEncodingList :: [SpriteClip] -> Encoding

data SpriteSheet key img

Generalized sprite sheet data structure

Constructors

SpriteSheet (Animations key SpriteClip) img

data SpriteSheetInfo

One way to represent sprite sheet information. | JSON loading is included.

Constructors

SpriteSheetInfo FilePath (Maybe Color) [SpriteClip] (Map Text [(FrameIndex, Seconds)])

Instances

Eq SpriteSheetInfo

Methods

(==) :: SpriteSheetInfo -> SpriteSheetInfo -> Bool

(/=) :: SpriteSheetInfo -> SpriteSheetInfo -> Bool

Show SpriteSheetInfo

Methods

showsPrec :: Int -> SpriteSheetInfo -> ShowS

show :: SpriteSheetInfo -> String

showList :: [SpriteSheetInfo] -> ShowS

FromJSON SpriteSheetInfo

Methods

parseJSON :: Value -> Parser SpriteSheetInfo

parseJSONList :: Value -> Parser [SpriteSheetInfo]

ToJSON SpriteSheetInfo

Methods

toJSON :: SpriteSheetInfo -> Value

toEncoding :: SpriteSheetInfo -> Encoding

toJSONList :: [SpriteSheetInfo] -> Value

toEncodingList :: [SpriteSheetInfo] -> Encoding

animations :: Key key => (key -> [Frame loc]) -> Animations key loc

Generate animations given each constructor

framesByAnimation :: Key key => Animations key loc -> key -> Vector (Frame loc)

Lookup the frames of an animation

initPosition :: Key key => key -> Position key

New Position with its animation key to loop forever

initPositionLoops :: Key key => key -> Int -> Position key

New Position with its animation key with a limited loop

initPositionWithLoop :: Key key => key -> Loop -> Position key

New Position

stepFrame :: Frame loc -> Position key -> DeltaSeconds -> FrameStep

Intermediate function for how a frame should be step through.

stepPosition :: Key key => Animations key loc -> Position key -> DeltaSeconds -> Position key

Step through the animation resulting a new position.

isAnimationComplete :: Key key => Animations key loc -> Position key -> Bool

The animation has finished all its frames. Useful for signalling into switching to another animation. With a Loop'Always, the animation will never be completed.

positionHasLooped

Arguments

:: Position key

Previous

-> Position key

Next

-> Bool

Simple function diff'ing the position for loop change

currentFrame :: Key key => Animations key loc -> Position key -> Frame loc

Use the position to find the current frame of the animation.

currentLocation :: Key key => Animations key loc -> Position key -> loc

Use the position to find the current location, lik a sprite sheet clip, of the animation.

nextKey :: Key key => key -> key

Cycle through the next animation key

prevKey :: Key key => key -> key

Cycle through the previous animation key

readSpriteSheetInfoJSON

Arguments

:: FilePath

Path of the sprite sheet info JSON file

-> IO SpriteSheetInfo

Quick function for loading SpriteSheetInfo. | Check the example.

readSpriteSheetJSON

Arguments

:: KeyName key

=> (FilePath -> Maybe Color -> IO img)

Inject animage loading function

-> FilePath

Path of the sprite sheet info JSON file

-> IO (SpriteSheet key img)

Quick function for loading SpriteSheetInfo, then using it to load its image for a SpriteSheet | Check the example.