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

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.

It can be drawn at any size without scaling the entire image. Instead, the central patch is scaled in X & Y. The top-center and bottom-center patches are scaled in X only. The middle-left and middle-right patches are scaled in Y only. The corner patches are not scaled.

Used for button backgrounds, rectangular frames, speech bubbles.

Note, this is not an Appearance, see NinePatchAppearance.

Constructors

NinePatch

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

margins

var margins: Margins

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)

resourceType

open override val resourceType: ResourceType

Functions

add

open override fun add(child: Resource)

appearance

open override fun appearance(): NinePatchAppearance

Pose and Graphic return themselves. NinePatch returns a NinePatchAppearance.

appearanceForActor

open override fun appearanceForActor(actor: Actor): NinePatchAppearance

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)

resolveReferences

open override fun resolveReferences(): String?

walkTree

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