melonjs 20.12.0 → 20.13.0

package/build/renderable/ui/uipanel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uipanel.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uipanel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAEpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IACzB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAC3B,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,aAAa;IACjD,iEAAiE;IACjE,SAAS,EAAE,KAAK,GAAG,IAAI,CAAC;IACxB,6CAA6C;IAC7C,WAAW,EAAE,KAAK,GAAG,IAAI,CAAC;IAC1B,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,SAAS,EAAE,MAAM,CAAC;IAmClB;;;;OAIG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe;IA8D3D;;;;OAIG;IACM,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAmBpC;;;;OAIG;IACM,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ;IA6CrD;;;;;;;;;;;;;;;;;;OAkBG;IACM,mBAAmB,IAAI,QAAQ;IAMxC;;;;;;;;OAQG;cACgB,iBAAiB,CAAC,GAAG,EAAE,QAAQ,GAAG,QAAQ;IAS7D;;;;;;;;;;;;;;;;;;OAkBG;IACM,YAAY,CAAC,QAAQ,UAAO;IAQrC;;;;;;;;OAQG;IACM,OAAO,IAAI,OAAO;IAI3B;;;;;;;;;OASG;IACM,SAAS,IAAI,OAAO;IAI7B;;;;;;OAMG;IACM,MAAM,IAAI,OAAO;IAI1B;;;OAGG;IACM,cAAc;CAIvB"}
+{"version":3,"file":"uipanel.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uipanel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAC;AAKrD,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAC;AAElD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAEpD,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,aAA0C,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAI1C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAY,SAAQ,MAAM;IAC1C,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;AAE/D;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,GAAG,MAAM,CAAC;AAExE;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACvD,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAC3B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAC3B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACtE;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC;CACvB;AAyBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoMG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,aAAa;IACjD,0DAA0D;IAC1D,SAAS,EAAE,KAAK,GAAG,IAAI,CAAC;IACxB,gEAAgE;IAChE,WAAW,EAAE,KAAK,GAAG,IAAI,CAAC;IAC1B,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,WAAW,EAAE,KAAK,GAAG,IAAI,CAAC;IAC1B,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,aAAa,EAAE,MAAM,CAAC;IACtB,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;;;OAYG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,oDAAoD;IACpD,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IACvC,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,+GAA+G;IAC/G,MAAM,EAAE,aAAa,CAAC;IACtB,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,KAAK,EAAE,YAAY,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,EAAE,OAAO,CAAC;IAClB,gEAAgE;IAChE,MAAM,EAAE,aAAa,CAAC;IACtB;;;;;;;OAOG;IACH,QAAQ,EACL,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,GAC5D,SAAS,CAAC;IACb,wEAAwE;IACxE,cAAc,EAAE,KAAK,CAAC;IAEtB,cAAc;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAC/C,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,sCAAsC;IACtC,OAAO,CAAC,QAAQ,CAAK;IACrB,OAAO,CAAC,QAAQ,CAAK;IACrB,wBAAwB;IACxB,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,WAAW,CAAK;IACxB,kFAAkF;IAClF,OAAO,CAAC,UAAU,CAAS;IAC3B,sDAAsD;IACtD,OAAO,CAAC,MAAM,CAcD;IACb,iDAAiD;IACjD,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAK;IACvB,gDAAgD;IAChD,OAAO,CAAC,OAAO,CAAS;IAmCxB;;;;OAIG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe;IAoG3D;;;;OAIG;IACM,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAsDpC;;;;OAIG;IACM,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ;IA+HrD;;;;OAIG;IACM,mBAAmB,IAAI,QAAQ;IAMxC;;;;;OAKG;cACgB,iBAAiB,CAAC,GAAG,EAAE,QAAQ,GAAG,QAAQ;IAS7D;;;;;;OAMG;IACM,YAAY,CAAC,QAAQ,UAAO;IA2GrC;;;;;;;;;;;OAWG;IACH,QAAQ,IAAI,IAAI;IA2LhB;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED;;;;;;;OAOG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,MAAM,EAExB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAKpC;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;IAkBnB;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,SAAI,GAAG,IAAI;IAyBlD;;;;;;OAMG;IACM,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAiGpD,OAAO,CAAC,QAAQ,CAAC,YAAY,CA+B3B;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAW1B;IAeF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAuBvB;IAEF;;;;OAIG;IACM,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAqDhD;;;;OAIG;IACM,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAM1C,uEAAuE;IACvE,OAAO,CAAC,SAAS,CAAS;IAE1B;;;;;;;;;OASG;IACM,aAAa,IAAI,IAAI;IAW9B;;;OAGG;IACM,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU;IAM5D;;;OAGG;IACM,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU;IAMjE;;;OAGG;IACM,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI;IAsCrE;;;;;OAKG;IACM,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IASpC;;;OAGG;IACM,eAAe,IAAI,IAAI;IAUhC;;;OAGG;IACM,iBAAiB,IAAI,IAAI;IAQlC;;;;;;;;OAQG;IACM,OAAO,IAAI,OAAO;IAI3B;;;;;;;;;OASG;IACM,SAAS,IAAI,OAAO;IAI7B;;;;;;OAMG;IACM,MAAM,IAAI,OAAO;IAI1B;;;OAGG;IACM,cAAc;CAOvB"}

package/build/renderable/ui/uiskin.d.ts

@@ -0,0 +1,25 @@
+import type { TextureAtlas } from "../../video/texture/atlas.js";
+/**
+ * What every widget skin shares: the atlas its regions come from, and how
+ * much of each region's edge is kept unscaled when it is stretched.
+ *
+ * A region drawn bigger than its art is drawn as a nine-slice: the corners
+ * keep their size and the edges and middle stretch, so a 190 pixel wide
+ * button image makes a button of any width.
+ * @category UI
+ */
+export interface UISkin {
+    /** the atlas the regions are read from */
+    atlas: TextureAtlas;
+    /**
+     * the width of a corner kept unscaled, in pixels; a quarter of the
+     * region's width by default
+     */
+    insetx?: number;
+    /**
+     * the height of a corner kept unscaled, in pixels; a quarter of the
+     * region's height by default
+     */
+    insety?: number;
+}
+//# sourceMappingURL=uiskin.d.ts.map

package/build/renderable/ui/uiskin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uiskin.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uiskin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAGjE;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM;IACtB,0CAA0C;IAC1C,KAAK,EAAE,YAAY,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/build/renderable/ui/uislider.d.ts

@@ -0,0 +1,518 @@
+import type Camera2d from "../../camera/camera2d.ts";
+import type Pointer from "../../input/pointer.ts";
+import type Renderer from "../../video/renderer.js";
+import type { Paint } from "./panelpaint.ts";
+import type { UIJuiceSettings } from "./uibaseelement.ts";
+import UIBaseElement from "./uibaseelement.ts";
+import type { UINavAction } from "./uifocus.ts";
+import type { UILabel } from "./uilabel.ts";
+import type { UISkin } from "./uiskin.ts";
+/**
+ * The art of a skinned {@link UISlider}: atlas regions for the track, the
+ * filled part of the track and the thumb.
+ *
+ * The track and the fill are stretched as nine-slices along the slider's
+ * {@link UISliderSettings#length}, and keep the region's thickness across
+ * it unless `trackThickness` is set. The thumb is drawn at its region's
+ * size. A disabled slider is drawn at half opacity. Every region named is
+ * looked up when the slider is built, so a misspelt name throws there.
+ * @category UI
+ * @example
+ * // a track and a thumb; no fill
+ * const skin = { atlas, track: "grey_sliderHorizontal", thumb: "blue_sliderDown" };
+ */
+export interface UISliderSkin extends UISkin {
+    /** the region for the whole track */
+    track: string;
+    /**
+     * the region for the part of the track from the low end to the thumb;
+     * not drawn if left out
+     */
+    fill?: string;
+    /** the region for the thumb */
+    thumb: string;
+    /**
+     * the region for the thumb under the pointer or while dragged; `thumb`
+     * if left out
+     */
+    thumbHover?: string;
+}
+/**
+ * The settings {@link UISlider} takes. All are optional.
+ *
+ * The colour settings are for the drawn look and are ignored when a `skin`
+ * is given.
+ * @category UI
+ */
+export interface UISliderSettings extends UIJuiceSettings {
+    /**
+     * the lowest value; `min` and `max` are swapped if given the wrong way
+     * round
+     * @default 0
+     */
+    min?: number;
+    /**
+     * the highest value
+     * @default 1
+     */
+    max?: number;
+    /**
+     * the interval values snap to, counted from `min`; `0` for no snapping
+     * @default 0
+     */
+    step?: number;
+    /**
+     * the starting value, snapped to `step` and clamped to the range; `min`
+     * by default
+     */
+    value?: number;
+    /**
+     * which way it slides; a vertical slider has its highest value at the
+     * top. Fixed once built.
+     * @default "horizontal"
+     */
+    orientation?: "horizontal" | "vertical";
+    /**
+     * the length of the track, in pixels: its width on a horizontal slider,
+     * its height on a vertical one
+     * @default 200
+     */
+    length?: number;
+    /**
+     * the thickness of the track, in pixels; with a skin, the track region's
+     * thickness by default
+     * @default 6
+     */
+    trackThickness?: number;
+    /**
+     * the diameter of the round thumb, in pixels (drawn look; a skin's thumb
+     * keeps its region's size)
+     * @default 20
+     */
+    thumbSize?: number;
+    /**
+     * Called with the new value on every change the user makes, while
+     * dragging too. Never called when `value` is set from code. See
+     * {@link UISlider#onChange}.
+     */
+    onChange?: (value: number, slider: UISlider) => void;
+    /**
+     * Called with the final value once the user lets go, and after each
+     * wheel or key step. Never called when `value` is set from code. See
+     * {@link UISlider#onChangeEnd}.
+     */
+    onChangeEnd?: (value: number, slider: UISlider) => void;
+    /**
+     * whether it answers input; a disabled slider is drawn at half opacity
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * a caption drawn above the track: at the left on a horizontal slider,
+     * centred on a vertical one
+     */
+    label?: string;
+    /**
+     * show the value as text: at the right end of the caption row on a
+     * horizontal slider, below the track on a vertical one
+     * @default false
+     */
+    showValue?: boolean;
+    /**
+     * How the value text is written, given the value and the ratio (where
+     * the value is between `min` and `max`, 0 to 1). By default, the value
+     * with as many decimals as `step` has, or 2 decimals with no step.
+     * @example
+     * valueFormat: (value, ratio) => `${Math.round(ratio * 100)}%`
+     */
+    valueFormat?: (value: number, ratio: number) => string;
+    /**
+     * a CSS font family, or the name of a loaded bitmap font
+     * @default "sans-serif"
+     */
+    font?: string;
+    /**
+     * the text height of the caption and the value, in pixels
+     * @default 16
+     */
+    fontSize?: number;
+    /**
+     * the colour of the caption and the value
+     * @default "#000000"
+     */
+    labelFillStyle?: string;
+    /**
+     * the track (drawn look)
+     * @default "#00000033"
+     */
+    trackColor?: Paint;
+    /**
+     * the part of the track from the low end to the thumb (drawn look)
+     * @default "#2a7de1"
+     */
+    fillColor?: Paint;
+    /**
+     * the thumb (drawn look)
+     * @default "#ffffff"
+     */
+    thumbColor?: Paint;
+    /**
+     * the thumb under the pointer or while dragged (drawn look)
+     * @default "#e4eefb"
+     */
+    thumbHoverColor?: Paint;
+    /**
+     * the thumb's outline (drawn look)
+     * @default "#2a7de1"
+     */
+    thumbBorderColor?: Paint;
+    /**
+     * the thickness of the thumb's outline, in pixels (drawn look); `0` for
+     * none
+     * @default 2
+     */
+    thumbBorderWidth?: number;
+    /** draw it from atlas regions instead of the drawn look */
+    skin?: UISliderSkin;
+}
+/**
+ * A slider: the player picks a number by moving a thumb along a track. Use
+ * it for settings with a range, such as volume, mouse sensitivity or
+ * brightness.
+ *
+ * ## Range and value
+ * The value is {@link UISlider#value}, between {@link UISlider#min} and
+ * {@link UISlider#max} (0 and 1 by default). With a {@link UISlider#step}
+ * it snaps to that interval; `step: 1` gives whole numbers. `min`, `max`
+ * and `step` can be changed later: the value is clamped and snapped again,
+ * silently. {@link UISlider#ratio} is where the value is in the range, from
+ * 0 to 1.
+ *
+ * ## Input
+ * - Drag the thumb. The drag keeps following the pointer when it leaves
+ *   the slider, until the button or finger is released.
+ * - Click or tap the track: the thumb jumps there, and can be dragged on.
+ * - The mouse wheel over the slider moves it one step (a hundredth of the
+ *   range with no `step`).
+ * - With the focus ({@link UIBaseElement#focus}), the arrow keys or the
+ *   D-pad step it: left and right on a horizontal slider, up and down on a
+ *   vertical one. A step is `step`, or a twentieth of the range without
+ *   one.
+ *
+ * ## onChange and onChangeEnd
+ * `onChange` is called on every change the user makes, many times during a
+ * drag: use it for live feedback, such as setting the volume. `onChangeEnd`
+ * is called once when the user lets go, and after each wheel or key step:
+ * use it for work that should not run on every frame of a drag, such as
+ * saving settings or playing a test sound. Neither is called when `value`
+ * is set from code, so restoring saved settings does not trigger them.
+ *
+ * ## Text
+ * `label` is a caption drawn above the track. `showValue` adds the value as
+ * text, written by `valueFormat(value, ratio)`. The default format shows
+ * as many decimals as `step` has: `step: 1` shows "7", `step: 0.1` shows
+ * "0.7", and no step shows "0.70". On a horizontal slider the caption and
+ * the value share the row above the track, and the value moves below the
+ * track when the two would run into each other. `labelText` changes the
+ * caption later; the slider resizes to fit its texts.
+ *
+ * ## Look
+ * Drawn with shapes by default: a rounded track, a filled part up to the
+ * thumb, and a round thumb, coloured by `trackColor`, `fillColor`,
+ * `thumbColor`, `thumbHoverColor` and `thumbBorderColor`. Or pass a
+ * {@link UISliderSkin} of atlas regions (`track`, `fill`, `thumb`,
+ * `thumbHover`).
+ *
+ * ## In a scrolling panel
+ * Inside a scrolling {@link UIPanel}, a drag that starts on the slider
+ * moves the slider, not the panel.
+ * @category UI
+ * @example
+ * // a volume slider wired to the audio, saved when the user lets go
+ * save.add({ volume: 1 });
+ * const volume = new UISlider(40, 80, {
+ *     label: "Volume",
+ *     value: save.volume,
+ *     onChange: (v) => audio.setVolume(v),
+ *     onChangeEnd: (v) => {
+ *         save.volume = v;
+ *     },
+ * });
+ * panel.addChild(volume);
+ * @example
+ * // a whole number from 1 to 10, shown as "1" ... "10"
+ * const sensitivity = new UISlider(40, 140, {
+ *     label: "Sensitivity",
+ *     min: 1,
+ *     max: 10,
+ *     step: 1,
+ *     value: 5,
+ *     showValue: true,
+ * });
+ * @example
+ * // vertical: highest value at the top
+ * const brightness = new UISlider(300, 40, {
+ *     orientation: "vertical",
+ *     length: 150,
+ *     label: "Light",
+ *     showValue: true,
+ *     value: 0.8,
+ * });
+ * @example
+ * // skinned from an atlas
+ * const music = new UISlider(40, 200, {
+ *     length: 320,
+ *     skin: { atlas, track: "grey_sliderHorizontal", thumb: "blue_sliderDown" },
+ * });
+ * @example
+ * // the value shown as a percentage
+ * const sfx = new UISlider(40, 260, {
+ *     label: "Effects",
+ *     showValue: true,
+ *     valueFormat: (value, ratio) => `${Math.round(ratio * 100)}%`,
+ * });
+ * @example
+ * // in a scrolling panel: dragging the thumb does not scroll the panel
+ * const options = new UIPanel(20, 20, {
+ *     width: 360,
+ *     height: 200,
+ *     layout: "column",
+ *     padding: 12,
+ *     scroll: "vertical",
+ * });
+ * options.addChild(new UISlider(0, 0, { label: "Music", length: 300 }));
+ * options.addChild(new UISlider(0, 0, { label: "Effects", length: 300 }));
+ */
+export default class UISlider extends UIBaseElement {
+    /**
+     * Called with the new value on every change the user makes: each move
+     * of a drag, a click on the track, a wheel or key step. Use it for live
+     * feedback. Not called when {@link UISlider#value} is set from code, nor
+     * when a move leaves the value unchanged.
+     * @example
+     * volume.onChange = (v) => audio.setVolume(v);
+     */
+    onChange: ((value: number, slider: UISlider) => void) | undefined;
+    /**
+     * Called with the final value once the user lets go after changing it,
+     * and after each wheel or key step. Use it for work that should not run
+     * on every move of a drag: saving settings, playing a test sound. Not
+     * called when {@link UISlider#value} is set from code, nor when a drag
+     * ends where it began.
+     * @example
+     * sfx.onChangeEnd = (v) => {
+     *     save.sfxVolume = v;
+     *     audio.play("coin", { volume: v });
+     * };
+     */
+    onChangeEnd: ((value: number, slider: UISlider) => void) | undefined;
+    /** the track (drawn look) */
+    trackColor: Paint;
+    /** the part of the track from the low end to the thumb (drawn look) */
+    fillColor: Paint;
+    /** the thumb (drawn look) */
+    thumbColor: Paint;
+    /** the thumb under the pointer or while dragged (drawn look) */
+    thumbHoverColor: Paint;
+    /** the thumb's outline (drawn look) */
+    thumbBorderColor: Paint;
+    /** the thickness of the thumb's outline, in pixels (drawn look) */
+    thumbBorderWidth: number;
+    /** which way it slides; set when it is built */
+    readonly orientation: "horizontal" | "vertical";
+    /** the atlas regions it is drawn from, or `undefined` for the drawn look */
+    readonly skin: UISliderSkin | undefined;
+    /**
+     * the caption's text object, or `undefined` without one; change the
+     * text through {@link UISlider#labelText}
+     */
+    readonly label: UILabel | undefined;
+    /**
+     * the value's text object, or `undefined` without `showValue`; kept up
+     * to date by the slider
+     */
+    readonly valueText: UILabel | undefined;
+    /** @ignore */
+    private _valueFormat;
+    /** whether the format is the default one, which follows the step */
+    private _defaultFormat;
+    /** @ignore */
+    private _min;
+    /** @ignore */
+    private _max;
+    /** @ignore */
+    private _step;
+    /** @ignore */
+    private _value;
+    /** @ignore */
+    private readonly _painter;
+    /** @ignore */
+    private readonly _skin;
+    /** the track, in the slider's coordinates */
+    private readonly _track;
+    /** where the thumb's centre can go, along the slider */
+    private _travelStart;
+    private readonly _travelLength;
+    /** the length along the slider, the track's thickness, and the band the thumb slides in */
+    private readonly _length;
+    private readonly _thickness;
+    private readonly _band;
+    /** the caption's text */
+    private _labelText;
+    /** the style of the caption and the value text */
+    private readonly _textStyle;
+    /** the thumb's size across and along the slider */
+    private readonly _thumbW;
+    private readonly _thumbH;
+    /** where the value text and the caption go, in the slider's coordinates */
+    private readonly _valueAt;
+    private readonly _labelAt;
+    /** whether a drag is going on */
+    private _dragging;
+    /** the pointer's distance from the thumb's centre when it was grabbed */
+    private _grab;
+    /** the value when the drag began */
+    private _dragFrom;
+    /** the pointer the drag follows */
+    private _dragPointer;
+    private readonly _onDragMove;
+    private readonly _onDragEnd;
+    private readonly _onWheel;
+    /**
+     * @param x - left edge
+     * @param y - top edge
+     * @param settings - see {@link UISliderSettings}
+     */
+    constructor(x: number, y: number, settings?: UISliderSettings);
+    /**
+     * The lowest value. Setting it clamps and snaps the value into the new
+     * range without calling `onChange`; a `min` above `max` raises `max` to
+     * it.
+     */
+    get min(): number;
+    set min(v: number);
+    /**
+     * The highest value. Setting it clamps and snaps the value into the new
+     * range without calling `onChange`; a `max` below `min` lowers `min` to
+     * it.
+     * @example
+     * // unlock more levels: the value keeps its place
+     * levelSelect.max = unlockedLevels;
+     */
+    get max(): number;
+    set max(v: number);
+    /**
+     * The interval values snap to, counted from `min`; `0` for none.
+     * Setting it snaps the value to it without calling `onChange`, and, with
+     * the default `valueFormat`, changes the decimals shown to match.
+     */
+    get step(): number;
+    set step(v: number);
+    /**
+     * Where the value is between {@link UISlider#min} and
+     * {@link UISlider#max}, from 0 to 1 (0 when the range is empty).
+     * Read only.
+     * @example
+     * // a 50..150 slider at 125 has a ratio of 0.75
+     * const percent = Math.round(slider.ratio * 100);
+     */
+    get ratio(): number;
+    /**
+     * How the value text is written, given the value and the ratio (0 to
+     * 1). Setting it rewrites the value text and lays the slider out again
+     * for the widest text it can now show.
+     * @example
+     * slider.valueFormat = (value) => `${value} px`;
+     */
+    get valueFormat(): (value: number, ratio: number) => string;
+    set valueFormat(format: (value: number, ratio: number) => string);
+    /**
+     * The caption's text, or `""` without one. Setting it makes a caption if
+     * there was none, and lays the slider out again for its width; a
+     * {@link UIPanel} holding it needs `relayout()` if the slider's size
+     * changes.
+     * @example
+     * volume.labelText = muted ? "Music (muted)" : "Music";
+     */
+    get labelText(): string;
+    set labelText(value: string);
+    /**
+     * build the caption's text object
+     * @param text - the caption
+     * @returns the label
+     * @ignore
+     */
+    private makeCaption;
+    /**
+     * Measure the caption and the widest value text, and place them, the
+     * track and the thumb's travel; resize the slider to fit. A horizontal
+     * slider puts the caption and the value on one row above the track, or
+     * the value below the track when the two do not fit side by side.
+     * @ignore
+     */
+    private layoutText;
+    /**
+     * The current value, between {@link UISlider#min} and
+     * {@link UISlider#max}.
+     *
+     * Setting it snaps it to the step and clamps it to the range, and does
+     * NOT call `onChange` or `onChangeEnd`: restoring saved settings does not
+     * run the code a user's change would. A value that is not a finite
+     * number is ignored.
+     * @example
+     * // show the saved volume when the menu opens
+     * volume.value = save.volume;
+     */
+    get value(): number;
+    set value(v: number);
+    /**
+     * Step with the arrow keys or the D-pad while it has the focus: left and
+     * right on a horizontal slider, up and down on a vertical one. A step is
+     * `step`, or a twentieth of the range without one, and calls `onChange`
+     * and `onChangeEnd`. The other two directions move the focus away.
+     * @param action - the direction pressed
+     * @returns true for the directions along the slider
+     */
+    onNavigate(action: UINavAction): boolean;
+    /**
+     * Call off a press, and a drag in progress, without calling
+     * `onChangeEnd` or `onRelease`: `onCancel` runs instead. The value stays
+     * where the drag left it. Setting `enabled` to `false` mid-drag, or
+     * removing the slider, calls it.
+     */
+    cancelPress(): void;
+    /**
+     * Whether the thumb is being dragged right now.
+     */
+    get dragging(): boolean;
+    /** where the thumb's centre is, along the slider, in its coordinates */
+    private thumbCenter;
+    /**
+     * The pointer leaving does not end a drag; letting go does.
+     * @ignore
+     */
+    release(event: Pointer): boolean | void;
+    /**
+     * Listen to the wheel while in the scene.
+     * @ignore
+     */
+    onActivateEvent(): void;
+    /**
+     * Stop listening; the base class calls off a drag in progress, through
+     * {@link UISlider#cancelPress}.
+     * @ignore
+     */
+    onDeactivateEvent(): void;
+    /**
+     * Draw the track, the fill, the thumb, then the text.
+     * @param renderer - the renderer to draw with
+     * @param viewport - the camera being drawn through
+     */
+    draw(renderer: Renderer, viewport?: Camera2d): void;
+    /**
+     * Hand back what it borrowed.
+     * @ignore
+     */
+    onDestroyEvent(): void;
+}
+//# sourceMappingURL=uislider.d.ts.map

package/build/renderable/ui/uislider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uislider.d.ts","sourceRoot":"","sources":["../../../src/renderable/ui/uislider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAC;AAKrD,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAC;AAGlD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,aAIN,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM;IAC3C,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACxD;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;IACxC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC;IACrD;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC;IACxD;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IACvD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC;IACnB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC;IACzB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,IAAI,CAAC,EAAE,YAAY,CAAC;CACpB;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2GG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,aAAa;IAClD;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAElE;;;;;;;;;;;OAWG;IACH,WAAW,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAErE,6BAA6B;IAC7B,UAAU,EAAE,KAAK,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,KAAK,CAAC;IACjB,6BAA6B;IAC7B,UAAU,EAAE,KAAK,CAAC;IAClB,gEAAgE;IAChE,eAAe,EAAE,KAAK,CAAC;IACvB,uCAAuC;IACvC,gBAAgB,EAAE,KAAK,CAAC;IACxB,mEAAmE;IACnE,gBAAgB,EAAE,MAAM,CAAC;IAEzB,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,YAAY,GAAG,UAAU,CAAC;IAChD,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,GAAG,SAAS,CAAC;IAExC,cAAc;IACd,OAAO,CAAC,YAAY,CAA2C;IAC/D,oEAAoE;IACpE,OAAO,CAAC,cAAc,CAAU;IAChC,cAAc;IACd,OAAO,CAAC,IAAI,CAAS;IACrB,cAAc;IACd,OAAO,CAAC,IAAI,CAAS;IACrB,cAAc;IACd,OAAO,CAAC,KAAK,CAAS;IACtB,cAAc;IACd,OAAO,CAAC,MAAM,CAAS;IACvB,cAAc;IACd,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAsB;IAC/C,cAAc;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAC/C,6CAA6C;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmC;IAC1D,wDAAwD;IACxD,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,2FAA2F;IAC3F,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,yBAAyB;IACzB,OAAO,CAAC,UAAU,CAAM;IACxB,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAKzB;IACF,mDAAmD;IACnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,2EAA2E;IAC3E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IACrD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4B;IAErD,iCAAiC;IACjC,OAAO,CAAC,SAAS,CAAS;IAC1B,yEAAyE;IACzE,OAAO,CAAC,KAAK,CAAK;IAClB,oCAAoC;IACpC,OAAO,CAAC,SAAS,CAAK;IACtB,mCAAmC;IACnC,OAAO,CAAC,YAAY,CAAqB;IAEzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAI1B;IAEF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAIzB;IAEF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAmBvB;IAEF;;;;OAIG;gBACS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAE,gBAAqB;IAmFjE;;;;OAIG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAIhB;IAED;;;;;;;OAOG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAIhB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,EAOjB;IAED;;;;;;;OAOG;IACH,IAAI,KAAK,IAAI,MAAM,CAGlB;IAED;;;;;;OAMG;IACH,IAAI,WAAW,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAE1D;IAED,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,EAK/D;IAcD;;;;;;;OAOG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAS1B;IAED;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAQnB;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAoElB;;;;;;;;;;;OAWG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,KAAK,CAAC,CAAC,EAAE,MAAM,EAOlB;IAED;;;;;;;OAOG;IACM,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO;IAoBjD;;;;;OAKG;IACM,WAAW,IAAI,IAAI;IAK5B;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IA8CD,wEAAwE;IACxE,OAAO,CAAC,WAAW;IA+HnB;;;OAGG;IACM,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAYhD;;;OAGG;IACM,eAAe,IAAI,IAAI;IAKhC;;;;OAIG;IACM,iBAAiB,IAAI,IAAI;IAKlC;;;;OAIG;IACM,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ;IA8ErD;;;OAGG;IACM,cAAc;CAQvB"}