kyd-core/uk.co.nickthecoder.kyd.appearance

Package-level declarations

Types

Responsible for drawing an Actor.

interface AppearanceResource : Resource, WithAppearance

Any resource which can be used to create an Appearance. At time of writing, this includes : Role, Graphic, Pose, NinePatch.

AtlasGrid

class AtlasGrid

FlipBook

class FlipBook : WithAppearance

An animation consisting of a number of still-images. By quickly viewing each of the still-images in sequence an animation appears. The duration of each page is not constant (i.e. on FlipBookPage can be visible longer than others).

FlipBookAnimation

class FlipBookAnimation(flipBook: FlipBook) : Appearance, Ticks

NOTE. tick is NOT called automatically, therefore call this from the Actor's Behaviour. This is a deliberate deign choice (not an oversight, or laziness). For example, suppose an actor can be frozen, then your behaviour will contain something like this :

FlipBookPage

class FlipBookPage(val withAppearance: WithAppearance?, val seconds: Float, val tick: (Actor, Float) -> Unit? = null, val progress: (Actor, Float) -> Unit? = null, val onPageStarted: (Actor) -> Unit? = null, val onPageFinished: (Actor) -> Unit? = null)

A page within a FlipBook. It has an appearance (withAppearance) and a duration in seconds.

FlipBookPageBuilder

class FlipBookPageBuilder(val appearance: WithAppearance?, val seconds: Float)

FlipBookPage is immutable, so all attributes must be passed to the constructor, which is very awkward. This makes it much more pleasant.

Font

class Font(var parent: ParentResource, name: String) : AbstractParentResource, FileResource, AppearanceResource

Graphic

class Graphic(var parent: ParentResource, name: String, val filename: String) : AbstractParentResource, FileResource, AppearanceResource, PinnedImage

A Resource corresponding to a .png or .jpeg file.

GraphicAppearance

class GraphicAppearance(val graphic: Graphic) : TintedAppearance

Label

class Label(val font: Font, text: String) : TintedAppearance

Margins

class Margins(val top: Float = 0.0f, val right: Float = 0.0f, val bottom: Float = 0.0f, val left: Float = 0.0f)

Used by NinePatch to determine where the central patch is.

NinePatch

class NinePatch(var parent: ParentResource, name: String, graphicPath: String) : PartialGraphic, AppearanceResource

A rectangular region of a Graphic (which may be the graphic's entire area) which is divided into 9 patches in a grid pattern.

NinePatchAppearance

class NinePatchAppearance(ninePatch: NinePatch) : StretchableAppearance, TintedAppearance

Draws a NinePatch to fill a rectangular region defined by 2 opposite corners of a rectangle (corner0 and corner2).

NoAppearance

object NoAppearance : Appearance

Draws nothing (invisible).

PartialGraphic

abstract class PartialGraphic(var parent: ParentResource, name: String, graphicPath: String) : AbstractParentResource, PinnedImage, ResolvableResource

Common features shared by Pose and NinePatch.

PinnedImage

interface PinnedImage

A Pose or Graphic, both have a pin which determines which point in the image refers to Actor.position.

Pose

open class Pose(var parent: ParentResource, name: String, graphicPath: String) : PartialGraphic, AppearanceResource

A small rectangular region of a Graphic that can be used as an Actor's Appearance.

PoseAppearance

class PoseAppearance(val pose: Pose) : TintedAppearance

RepeatingGraphic

class RepeatingGraphic(val graphic: Graphic) : StretchableAppearance, TintedAppearance

RepeatingPose

class RepeatingPose(val pose: Pose) : StretchableAppearance, TintedAppearance

StretchableAppearance

interface StretchableAppearance : Appearance

Appearances whose bounds can be defined by two opposite corners of a rectangle, both of which can be moved anywhere.

TintedAppearance

interface TintedAppearance : Appearance

WithAppearance

interface WithAppearance

Implemented by anything that can provide an Appearance.

Functions

flipBook

fun flipBook(block: FlipBook.() -> Unit): FlipBook

Syntactic sugar for creating FlipBooks.

flipBookAnimation

fun flipBookAnimation(block: FlipBook.() -> Unit): FlipBookAnimation

fun flipBookAnimation(actor: Actor, block: FlipBook.() -> Unit): FlipBookAnimation

Syntactic sugar for creating FlipBookAnimations.

page

fun FlipBook.page(appearance: WithAppearance?, seconds: Float, block: FlipBookPageBuilder.() -> Unit? = null)

Syntactic sugar for adding a FlipBookPage to a FlipBook.