@fps-games/editor 0.2.0-beta.3 → 0.2.1-beta.1

package/node_modules/@playcanvas/pcui/types/components/ArrayInput/index.d.ts

@@ -0,0 +1,140 @@
+import { Observer } from '@playcanvas/observer';
+import { Container } from '../Container';
+import { Element, ElementArgs, IBindable, IBindableArgs, IFocusable } from '../Element';
+import { NumericInput } from '../NumericInput';
+/**
+ * The arguments for the {@link ArrayInput} constructor.
+ */
+interface ArrayInputArgs extends ElementArgs, IBindableArgs {
+    /**
+     * The type of values that the array can hold. Can be one of the following:
+     *
+     * - `boolean`
+     * - `number`
+     * - `string`
+     * - `vec2`
+     * - `vec3`
+     * - `vec4`
+     *
+     * Defaults to `string`.
+     */
+    type?: 'boolean' | 'number' | 'string' | 'vec2' | 'vec3' | 'vec4';
+    /**
+     * Arguments for each array Element.
+     */
+    elementArgs?: Array<any>;
+    /**
+     * If `true` then editing the number of elements that the array has will not be allowed.
+     */
+    fixedSize?: boolean;
+    /**
+     * If `true` then the array will be rendered using panels. Defaults to `false`.
+     */
+    usePanels?: boolean;
+    /**
+     * Used to specify the default values for each element in the array. Defaults to `null`.
+     */
+    getDefaultFn?: () => any;
+}
+/**
+ * Element that allows editing an array of values.
+ */
+declare class ArrayInput extends Element implements IFocusable, IBindable {
+    /**
+     * Fired when an array element is linked to observers.
+     *
+     * @event
+     * @example
+     * ```ts
+     * arrayInput.on('linkElement', (element: Element, index: number, path: string) => {
+     *     console.log(`Element ${index} is now linked to ${path}`);
+     * });
+     * ```
+     */
+    static readonly EVENT_LINK_ELEMENT = "linkElement";
+    /**
+     * Fired when an array element is unlinked from observers.
+     *
+     * @event
+     * @example
+     * ```ts
+     * arrayInput.on('unlinkElement', (element: Element, index: number) => {
+     *     console.log(`Element ${index} is now unlinked`);
+     * });
+     * ```
+     */
+    static readonly EVENT_UNLINK_ELEMENT = "unlinkElement";
+    static DEFAULTS: {
+        boolean: boolean;
+        number: number;
+        string: string;
+        vec2: number[];
+        vec3: number[];
+        vec4: number[];
+    };
+    protected _container: Container;
+    protected _usePanels: boolean;
+    protected _fixedSize: boolean;
+    protected _inputSize: NumericInput;
+    protected _suspendSizeChangeEvt: boolean;
+    protected _containerArray: Container;
+    protected _arrayElements: any;
+    protected _suspendArrayElementEvts: boolean;
+    protected _arrayElementChangeTimeout: number;
+    protected _getDefaultFn: any;
+    protected _valueType: string;
+    protected _elementType: string;
+    protected _elementArgs: any;
+    protected _values: any[];
+    protected _renderChanges: boolean;
+    /**
+     * Creates a new ArrayInput.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<ArrayInputArgs>);
+    destroy(): void;
+    protected _onSizeChange(size: number): void;
+    protected _createArrayElement(): {
+        container: Container;
+        element: any;
+    };
+    protected _removeArrayElement(entry: any): void;
+    protected _onArrayElementChange(entry: any, value: any): void;
+    protected _linkArrayElement(element: any, index: number): void;
+    protected _updateValues(values: any, applyToBinding: boolean): void;
+    focus(): void;
+    blur(): void;
+    unlink(): void;
+    link(observers: Observer | Observer[], paths: string | string[]): void;
+    /**
+     * Executes the specified function for each array element.
+     *
+     * @param fn - The function with signature (element, index) => bool to execute. If the function
+     * returns `false` then the iteration will early out.
+     */
+    forEachArrayElement(fn: (element: Element, index: number) => false | void): void;
+    set binding(value: import("../..").BindingBase);
+    get binding(): import("../..").BindingBase;
+    /**
+     * Sets the value of the ArrayInput. Must be an array.
+     */
+    set value(value: any);
+    /**
+     * Gets the value of the ArrayInput as an array.
+     */
+    get value(): any;
+    /**
+     * Sets multiple array values on the ArrayInput.
+     */
+    set values(values: any);
+    /**
+     * Sets whether array elements should flash when their values change.
+     */
+    set renderChanges(value: boolean);
+    /**
+     * Gets whether array elements should flash when their values change.
+     */
+    get renderChanges(): boolean;
+}
+export { ArrayInput, ArrayInputArgs };

package/node_modules/@playcanvas/pcui/types/components/BooleanInput/index.d.ts

@@ -0,0 +1,41 @@
+import { Element, ElementArgs, IBindable, IBindableArgs, IFocusable } from '../Element';
+/**
+ * The arguments for the {@link BooleanInput} constructor.
+ */
+interface BooleanInputArgs extends ElementArgs, IBindableArgs {
+    /**
+     * Sets the tabIndex of the {@link BooleanInput}. Defaults to 0.
+     */
+    tabIndex?: number;
+    /**
+     * The type of checkbox. Currently can be `null` or 'toggle'.
+     */
+    type?: string;
+}
+/**
+ * A checkbox element.
+ */
+declare class BooleanInput extends Element implements IBindable, IFocusable {
+    protected _value: boolean;
+    protected _renderChanges: boolean;
+    /**
+     * Creates a new BooleanInput.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<BooleanInputArgs>);
+    destroy(): void;
+    protected _onClick(evt: MouseEvent): void;
+    protected _onKeyDown: (evt: KeyboardEvent) => void;
+    protected _onFocus: () => void;
+    protected _onBlur: () => void;
+    protected _updateValue(value: boolean): boolean;
+    focus(): void;
+    blur(): void;
+    set value(value: boolean);
+    get value(): boolean;
+    set values(values: boolean[]);
+    set renderChanges(value: boolean);
+    get renderChanges(): boolean;
+}
+export { BooleanInput, BooleanInputArgs };

package/node_modules/@playcanvas/pcui/types/components/Button/index.d.ts

@@ -0,0 +1,75 @@
+import { Element, ElementArgs } from '../Element';
+/**
+ * The arguments for the {@link Button} constructor.
+ */
+interface ButtonArgs extends ElementArgs {
+    /**
+     * If `true`, the {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML innerHTML} property will be
+     * used to set the text. Otherwise, {@link https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent textContent}
+     * will be used instead. Defaults to `false`.
+     */
+    unsafe?: boolean;
+    /**
+     * Sets the text of the button. Defaults to ''.
+     */
+    text?: string;
+    /**
+     * The CSS code for an icon for the button. e.g. 'E401' (notice we omit the '\\' character). Defaults to ''.
+     */
+    icon?: string;
+    /**
+     * Sets the 'size' type of the button. Can be 'small' or `null`. Defaults to `null`.
+     */
+    size?: 'small';
+}
+/**
+ * User input with click interaction.
+ */
+declare class Button extends Element {
+    protected _unsafe: boolean;
+    protected _text: string;
+    protected _icon: string;
+    protected _size: string | null;
+    /**
+     * Creates a new Button.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<ButtonArgs>);
+    destroy(): void;
+    protected _onKeyDown: (evt: KeyboardEvent) => void;
+    protected _onClick(evt: Event): void;
+    /**
+     * Focuses the button.
+     */
+    focus(): void;
+    /**
+     * Unfocuses (blurs) the button.
+     */
+    blur(): void;
+    /**
+     * Sets the text of the button.
+     */
+    set text(value: string);
+    /**
+     * Gets the text of the button.
+     */
+    get text(): string;
+    /**
+     * Sets the CSS code for an icon for the button. e.g. 'E401' (notice we omit the '\\' character).
+     */
+    set icon(value: string);
+    /**
+     * Gets the CSS code for an icon for the button.
+     */
+    get icon(): string;
+    /**
+     * Sets the 'size' type of the button. Can be null or 'small'.
+     */
+    set size(value: string);
+    /**
+     * Gets the 'size' type of the button.
+     */
+    get size(): string;
+}
+export { Button, ButtonArgs };

package/node_modules/@playcanvas/pcui/types/components/Canvas/index.d.ts

@@ -0,0 +1,61 @@
+import { Element, ElementArgs } from '../Element';
+/**
+ * The arguments for the {@link Canvas} constructor.
+ */
+interface CanvasArgs extends ElementArgs {
+    /**
+     * Whether the canvas should use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio devicePixelRatio}.
+     * Defaults to `false`.
+     */
+    useDevicePixelRatio?: boolean;
+}
+/**
+ * Represents a Canvas.
+ */
+declare class Canvas extends Element {
+    protected _width: number;
+    protected _height: number;
+    protected _ratio: number;
+    /**
+     * Creates a new Canvas.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<CanvasArgs>);
+    /**
+     * Resize the canvas using the given width and height parameters.
+     *
+     * @param width - The new width of the canvas.
+     * @param height - The new height of the canvas.
+     */
+    resize(width: number, height: number): void;
+    /**
+     * Sets the width of the canvas.
+     */
+    set width(value: number);
+    /**
+     * Gets the width of the canvas.
+     */
+    get width(): number;
+    /**
+     * Sets the height of the canvas.
+     */
+    set height(value: number);
+    /**
+     * Gets the height of the canvas.
+     */
+    get height(): number;
+    /**
+     * Gets the pixel height of the canvas.
+     */
+    get pixelWidth(): number;
+    /**
+     * Gets the pixel height of the canvas.
+     */
+    get pixelHeight(): number;
+    /**
+     * Gets the pixel ratio of the canvas.
+     */
+    get pixelRatio(): number;
+}
+export { Canvas, CanvasArgs };

package/node_modules/@playcanvas/pcui/types/components/Code/index.d.ts

@@ -0,0 +1,33 @@
+import { Container, ContainerArgs } from '../Container';
+import { Label } from '../Label';
+/**
+ * The arguments for the {@link Code} constructor.
+ */
+interface CodeArgs extends ContainerArgs {
+    /**
+     * Sets the text to display in the code block.
+     */
+    text?: string;
+}
+/**
+ * Represents a code block.
+ */
+declare class Code extends Container {
+    protected _inner: Label;
+    protected _text: string;
+    /**
+     * Creates a new Code.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<CodeArgs>);
+    /**
+     * Sets the text to display in the code block.
+     */
+    set text(value: string);
+    /**
+     * Gets the text to display in the code block.
+     */
+    get text(): string;
+}
+export { Code, CodeArgs };

package/node_modules/@playcanvas/pcui/types/components/ColorPicker/index.d.ts

@@ -0,0 +1,99 @@
+import { EventHandle } from '@playcanvas/observer';
+import { Element, ElementArgs, IBindable, IBindableArgs } from '../Element';
+import { NumericInput } from '../NumericInput';
+import { Overlay } from '../Overlay';
+import { TextInput } from '../TextInput';
+/**
+ * The arguments for the {@link ColorPicker} constructor.
+ */
+interface ColorPickerArgs extends ElementArgs, IBindableArgs {
+    /**
+     * An array of 4 integers containing the RGBA values the picker should be initialized to. Defaults to `[0, 0, 255, 1]`.
+     */
+    value?: number[];
+    /**
+     * Number of color channels. Defaults to 3. Changing to 4 adds the option to change the alpha value.
+     */
+    channels?: number;
+}
+/**
+ * Represents a color picker.
+ */
+declare class ColorPicker extends Element implements IBindable {
+    protected _historyCombine: boolean;
+    protected _historyPostfix: string;
+    protected _value: number[];
+    protected _channels: number;
+    protected _size: number;
+    protected _directInput: boolean;
+    protected _colorHSV: number[];
+    protected _pickerChannels: NumericInput[];
+    protected _channelsNumber: number;
+    protected _changing: boolean;
+    protected _dragging: boolean;
+    protected _callingCallback: boolean;
+    protected _overlay: Overlay;
+    protected _domColor: HTMLDivElement;
+    protected _pickRect: HTMLDivElement;
+    protected _pickRectPointerId: number;
+    protected _pickRectWhite: HTMLDivElement;
+    protected _pickRectBlack: HTMLDivElement;
+    protected _pickRectHandle: HTMLDivElement;
+    protected _pickHue: HTMLDivElement;
+    protected _pickHuePointerId: number;
+    protected _pickHueHandle: HTMLDivElement;
+    protected _pickOpacity: HTMLDivElement;
+    protected _pickOpacityPointerId: number;
+    protected _pickOpacityHandle: HTMLDivElement;
+    protected _panelFields: HTMLDivElement;
+    protected _evtColorPick: EventHandle;
+    protected _evtColorToPicker: EventHandle;
+    protected _evtColorPickStart: EventHandle;
+    protected _evtColorPickEnd: EventHandle;
+    protected _fieldHex: TextInput;
+    protected _renderChanges: boolean;
+    /**
+     * Creates a new ColorPicker.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<ColorPickerArgs>);
+    destroy(): void;
+    focus(): void;
+    blur(): void;
+    protected _onKeyDown: (evt: KeyboardEvent) => void;
+    protected _onFocus: (evt: FocusEvent) => void;
+    protected _onBlur: (evt: FocusEvent) => void;
+    protected _setColorPickerPosition(x: number, y: number): void;
+    protected _setPickerColor(color: number[]): void;
+    protected _openColorPicker(): void;
+    protected _callPicker(color: number[]): void;
+    protected _valueToColor(value: number): number;
+    protected _setValue(value: number[]): void;
+    protected _updateValue(value: number[]): boolean;
+    protected _getHex(): string;
+    protected _pickRectPointerDown: (event: PointerEvent) => void;
+    protected _pickRectPointerMove: (event: PointerEvent) => void;
+    protected _pickRectPointerUp: (event: PointerEvent) => void;
+    protected _pickHuePointerDown: (event: PointerEvent) => void;
+    protected _pickHuePointerMove: (event: PointerEvent) => void;
+    protected _pickHuePointerUp: (event: PointerEvent) => void;
+    protected _pickOpacityPointerDown: (event: PointerEvent) => void;
+    protected _pickOpacityPointerMove: (event: PointerEvent) => void;
+    protected _pickOpacityPointerUp: (event: PointerEvent) => void;
+    protected _onChangeHex(): void;
+    protected _onChangeRgb(): void;
+    protected _onChangeAlpha(value: number): void;
+    /** @ignore */
+    callbackHandle(): void;
+    /** @ignore */
+    callCallback(): void;
+    set value(value: number[]);
+    get value(): number[];
+    set values(values: Array<number>);
+    set channels(value: number);
+    get channels(): number;
+    set renderChanges(value: boolean);
+    get renderChanges(): boolean;
+}
+export { ColorPicker, ColorPickerArgs };