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

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.

For example, suppose our game contains an animal that can walk left and right. We will have a Pose for each frame of the animation as it walks. The names of these Poses might be left0, left1, left2, right0 etc. We might also have poses for when it isn't moving called idle0, idle1 etc.

Rather than creating a .png for each of these, we create a single Graphic and declare rectangular regions within it for each Pose.

Constructors

Pose

constructor(parent: ParentResource, name: String, graphicPath: String)

Properties

children

open override val children: MutableObservableMap<String, Resource>

graphic

lateinit var graphic: Graphic

The graphic which contains the pose. This is lazily evaluated using graphicPath, so that we can load an entire .kyd file without caring if the definition of the Pose is found BEFORE the definition of its corresponding Graphic.

graphicHeight

var graphicHeight: Int

Together with graphicTop, graphicLeft and graphicWidth, determines the rectangular region within the graphic.

graphicLeft

var graphicLeft: Int

Together with graphicTop, graphicWidth, graphicHeight, determines the rectangular region within the graphic. Measured in pixels, with (0,0) being at the top left of the image.

graphicPath

var graphicPath: String

Only valid while the .kyd file is being loaded. Once loaded, resolveReferences is called, and afterward, graphicPath is reset to blank and no longer used.

graphicTop

var graphicTop: Int

Together with graphicLeft, graphicWidth, graphicHeight, determines the rectangular region within the graphic. Measured in pixels, with (0,0) being at the top left of the image. NOTE. Almost all other coordinates have the Y axis pointing upwards, whereas here, the Y axis points downwards.

graphicWidth

var graphicWidth: Int

Together with graphicTop, graphicLeft and graphicHeight, determines the rectangular region within the graphic.

image

open override val image: Image

name

override var name: String

parent

override var parent: ParentResource

open override var pin: Vector2

When we animate an Actor, we change the actor's position (Actor.position)

repeating

var repeating: Boolean

resourceType

open override val resourceType: ResourceType

Functions

add

open override fun add(child: Resource)

appearance

open override fun appearance(): Appearance

Pose and Graphic return themselves. NinePatch returns a NinePatchAppearance.

appearanceForActor

open override fun appearanceForActor(actor: Actor): Appearance

Creates an Appearance with the same tint. Also, if the new appearances is StretchableAppearance then it will have the same bounds as the previous appearance.

applyToActor

open fun applyToActor(actor: Actor)

Set the actor's appearance.

dangerousRename

open override fun dangerousRename(newName: String)

find

open fun find(path: String): Resource?

findAppearance

open fun findAppearance(path: String): AppearanceResource?

findChild

open override fun findChild(name: String): Resource?

findUnresolved

open fun findUnresolved(path: String): Resource?

game

override fun game(): Game

path

override fun path(): String

pathWithTrailingSlash

override fun pathWithTrailingSlash(): String

Similar to path, but it also includes a trailing path. This is useful when building descendant paths as there is no special case needed for the root Game.

remove

open override fun remove(child: Resource)

rename

open override fun rename(child: Resource, newName: String)

repeatingTexture

fun repeatingTexture(): Texture?

resolveReferences

open override fun resolveReferences(): String?

toString

open override fun toString(): String

walkTree

open override fun walkTree(onVisit: (Resource) -> Unit)