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

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

@@ -0,0 +1,224 @@
+import { Container, ContainerArgs } from '../Container';
+import { Element } from '../Element';
+import { Label } from '../Label';
+import type { TreeView } from '../TreeView';
+/**
+ * The arguments for the {@link TreeViewItem} constructor.
+ */
+interface TreeViewItemArgs extends ContainerArgs {
+    /**
+     * Whether the item is selected.
+     */
+    selected?: boolean;
+    /**
+     * Whether the item can be selected. Defaults to `true`.
+     */
+    allowSelect?: boolean;
+    /**
+     * Whether the item is open (showing its children). Defaults to `false`.
+     */
+    open?: boolean;
+    /**
+     * Whether this {@link TreeViewItem} can be dragged. Only considered if the parent {@link TreeView}
+     * has `allowDrag` set to `true`. Defaults to `true`.
+     */
+    allowDrag?: boolean;
+    /**
+     * Whether dropping is allowed on the {@link TreeViewItem}. Defaults to `true`.
+     */
+    allowDrop?: boolean;
+    /**
+     * The text shown by the {@link TreeViewItem}.
+     */
+    text?: string;
+    /**
+     * The icon shown before the text in the {@link TreeViewItem}. Defaults to 'E360'.
+     */
+    icon?: string;
+    /**
+     * Method to be called when the {@link TreeViewItem} is selected.
+     */
+    onSelect?: (deselect: () => void) => void;
+    /**
+     * Method to be called when the {@link TreeViewItem} is deselected.
+     */
+    onDeselect?: () => void;
+}
+/**
+ * A TreeViewItem is a single node in a hierarchical {@link TreeView} control.
+ */
+declare class TreeViewItem extends Container {
+    /**
+     * Fired when user selects the TreeViewItem.
+     *
+     * @event
+     * @example
+     * ```ts
+     * treeViewItem.on('select', (item: TreeViewItem) => {
+     *     console.log('TreeViewItem selected', item);
+     * });
+     * ```
+     */
+    static readonly EVENT_SELECT = "select";
+    /**
+     * Fired when user deselects the TreeViewItem.
+     *
+     * @event
+     * @example
+     * ```ts
+     * treeViewItem.on('deselect', (item: TreeViewItem) => {
+     *     console.log('TreeViewItem deselected', item);
+     * });
+     * ```
+     */
+    static readonly EVENT_DESELECT = "deselect";
+    /**
+     * Fired when user opens the TreeViewItem.
+     *
+     * @event
+     * @example
+     * ```ts
+     * treeViewItem.on('open', (item: TreeViewItem) => {
+     *     console.log('TreeViewItem opened', item);
+     * });
+     * ```
+     */
+    static readonly EVENT_OPEN = "open";
+    /**
+     * Fired when user closes the TreeViewItem.
+     *
+     * @event
+     * @example
+     * ```ts
+     * treeViewItem.on('close', (item: TreeViewItem) => {
+     *     console.log('TreeViewItem closed', item);
+     * });
+     * ```
+     */
+    static readonly EVENT_CLOSE = "close";
+    /**
+     * Determines whether dropping is allowed on the tree item.
+     */
+    allowDrop: boolean;
+    /**
+     * Determines whether this tree item can be dragged. Only considered if the parent
+     * {@link TreeView} has {@link TreeView#allowDrag} set to `true`.
+     */
+    allowDrag: boolean;
+    /**
+     * Determines whether the item can be selected.
+     */
+    allowSelect: boolean;
+    protected _containerContents: Container;
+    protected _labelIcon: Label;
+    protected _labelText: Label;
+    protected _numChildren: number;
+    protected _treeView: any;
+    protected _icon: string;
+    protected _open: boolean;
+    /**
+     * Creates a new TreeViewItem.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<TreeViewItemArgs>);
+    destroy(): void;
+    protected _onAppendChild(element: Element): void;
+    protected _onRemoveChild(element: Element): void;
+    protected _onContentKeyDown: (evt: KeyboardEvent) => void;
+    protected _onContentMouseDown: (evt: MouseEvent) => void;
+    protected _onContentMouseUp: (evt: MouseEvent) => void;
+    protected _onContentMouseOver: (evt: MouseEvent) => void;
+    protected _onContentDragStart: (evt: DragEvent) => void;
+    protected _onContentClick: (evt: MouseEvent) => void;
+    protected _dfs(fn: (item: TreeViewItem) => void): void;
+    protected _onContentDblClick: (evt: MouseEvent) => void;
+    protected _onContentContextMenu: (evt: MouseEvent) => void;
+    protected _onContentFocus: (evt: FocusEvent) => void;
+    protected _onContentBlur: (evt: FocusEvent) => void;
+    rename(): void;
+    focus(): void;
+    blur(): void;
+    /**
+     * Sets whether the item is selected.
+     */
+    set selected(value: boolean);
+    /**
+     * Gets whether the item is selected.
+     */
+    get selected(): boolean;
+    /**
+     * Sets the text shown by the TreeViewItem.
+     */
+    set text(value: string);
+    /**
+     * Gets the text shown by the TreeViewItem.
+     */
+    get text(): string;
+    /**
+     * Gets the internal label that shows the text.
+     */
+    get textLabel(): Label;
+    /**
+     * Gets the internal label that shows the icon.
+     */
+    get iconLabel(): Label;
+    /**
+     * Gets the container that holds the icon and text for this tree view item. Useful for
+     * positioning calculations or appending custom content alongside the item row.
+     */
+    get content(): Container;
+    /**
+     * Sets whether the item is expanded and showing its children.
+     */
+    set open(value: boolean);
+    /**
+     * Gets whether the item is expanded and showing its children.
+     */
+    get open(): boolean;
+    /**
+     * Sets whether the ancestors of the item are open or closed.
+     */
+    set parentsOpen(value: boolean);
+    /**
+     * Gets whether the ancestors of the item are open or closed.
+     */
+    get parentsOpen(): boolean;
+    /**
+     * Sets the parent {@link TreeView}.
+     */
+    set treeView(value: TreeView | null);
+    /**
+     * Gets the parent {@link TreeView}.
+     */
+    get treeView(): TreeView | null;
+    /**
+     * Gets the number of direct children.
+     */
+    get numChildren(): number;
+    /**
+     * Gets the first child item.
+     */
+    get firstChild(): TreeViewItem;
+    /**
+     * Gets the last child item.
+     */
+    get lastChild(): TreeViewItem;
+    /**
+     * Gets the next sibling item.
+     */
+    get nextSibling(): TreeViewItem;
+    /**
+     * Gets the previous sibling item.
+     */
+    get previousSibling(): TreeViewItem;
+    /**
+     * Sets the icon shown before the text in the TreeViewItem.
+     */
+    set icon(value: string);
+    /**
+     * Gets the icon shown before the text in the TreeViewItem.
+     */
+    get icon(): string;
+}
+export { TreeViewItem, TreeViewItemArgs };

package/node_modules/@playcanvas/pcui/react/types/components/VectorInput/component.d.ts

@@ -0,0 +1,9 @@
+import { Element } from '../Element/component';
+import { VectorInput as VectorInputClass, VectorInputArgs } from './index';
+/**
+ * A vector input.
+ */
+declare class VectorInput extends Element<VectorInputArgs, any> {
+    static ctor: typeof VectorInputClass;
+}
+export { VectorInput };

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

@@ -0,0 +1,176 @@
+import { Observer } from '@playcanvas/observer';
+import { Element, ElementArgs, IBindable, IBindableArgs, IFocusable, IMultiPlaceholder, IMultiPlaceholderArgs } from '../Element';
+import { NumericInput } from '../NumericInput';
+/**
+ * The arguments for the {@link VectorInput} constructor.
+ */
+interface VectorInputArgs extends ElementArgs, IBindableArgs, IMultiPlaceholderArgs {
+    /**
+     * The number of dimensions in the vector. Can be between 2 to 4. Defaults to 3.
+     */
+    dimensions?: 2 | 3 | 4;
+    /**
+     * The minimum value of each vector element.
+     */
+    min?: number;
+    /**
+     * The maximum value of each vector element.
+     */
+    max?: number;
+    /**
+     * The incremental step when using arrow keys or dragger for each vector element.
+     */
+    step?: number;
+    /**
+     * The decimal precision of each vector element. Defaults to 7.
+     */
+    precision?: number;
+    /**
+     *  The incremental step when holding Shift and using arrow keys or dragger for each vector element.
+     */
+    stepPrecision?: number;
+}
+/**
+ * A vector input. The vector can have 2 to 4 dimensions with each dimension being a {@link NumericInput}.
+ */
+declare class VectorInput extends Element implements IBindable, IFocusable, IMultiPlaceholder {
+    /**
+     * Fired when the value of the VectorInput changes.
+     *
+     * @event
+     * @example
+     * ```ts
+     * const vectorInput = new VectorInput({ dimensions: 3 });
+     * vectorInput.on('change', (value: number[]) => {
+     *     console.log('Value changed to:', value);
+     * });
+     * ```
+     */
+    static readonly EVENT_CHANGE = "change";
+    /**
+     * Fired when the VectorInput receives focus.
+     *
+     * @event
+     * @example
+     * ```ts
+     * const vectorInput = new VectorInput();
+     * vectorInput.on('focus', () => {
+     *     console.log('VectorInput focused');
+     * });
+     * ```
+     */
+    static readonly EVENT_FOCUS = "focus";
+    /**
+     * Fired when the VectorInput loses focus.
+     *
+     * @event
+     * @example
+     * ```ts
+     * const vectorInput = new VectorInput();
+     * vectorInput.on('blur', () => {
+     *     console.log('VectorInput blurred');
+     * });
+     * ```
+     */
+    static readonly EVENT_BLUR = "blur";
+    protected _inputs: NumericInput[];
+    protected _applyingChange: boolean;
+    protected _bindAllInputs: boolean;
+    /**
+     * Creates a new VectorInput.
+     *
+     * @param args - The arguments.
+     */
+    constructor(args?: Readonly<VectorInputArgs>);
+    protected _onInputChange(input: NumericInput): void;
+    protected _updateValue(value: number[]): boolean;
+    link(observers: Observer | Observer[], paths: string | string[]): void;
+    unlink(): void;
+    /**
+     * Focuses the first input element.
+     */
+    focus(): void;
+    /**
+     * Unfocuses (blurs) all input elements.
+     */
+    blur(): void;
+    /**
+     * Sets the value of the VectorInput. This should be an array of numbers matching the
+     * dimensions of the vector (e.g. [x, y] for 2D, [x, y, z] for 3D).
+     */
+    set value(value: number[]);
+    /**
+     * Gets the value of the VectorInput as an array of numbers.
+     */
+    get value(): number[];
+    /**
+     * Sets multiple values on the VectorInput. Each value should be an array representing the
+     * vector dimensions. If all values are the same, the VectorInput will display that value.
+     * Otherwise, it will display a "multiple values" state.
+     */
+    set values(values: Array<any>);
+    /**
+     * Sets the Binding object for the VectorInput. The binding is cloned for each input.
+     */
+    set binding(value: import("../..").BindingBase);
+    /**
+     * Gets the Binding object for the VectorInput.
+     */
+    get binding(): import("../..").BindingBase;
+    /**
+     * Sets the placeholder text for all inputs. Can be a single string applied to all inputs,
+     * or an array of strings for each input.
+     */
+    set placeholder(value: string | string[]);
+    /**
+     * Gets the placeholder text of all inputs as an array.
+     */
+    get placeholder(): string[];
+    /**
+     * Gets the array of NumericInput elements owned by this vector.
+     */
+    get inputs(): NumericInput[];
+    /**
+     * Sets whether inputs should flash when their values change.
+     */
+    set renderChanges(value: boolean);
+    /**
+     * Gets whether inputs should flash when their values change.
+     */
+    get renderChanges(): boolean;
+    /**
+     * Sets the minimum value accepted by all inputs of the vector.
+     */
+    set min(value: number);
+    /**
+     * Gets the minimum value accepted by all inputs of the vector.
+     */
+    get min(): number;
+    /**
+     * Sets the maximum value accepted by all inputs of the vector.
+     */
+    set max(value: number);
+    /**
+     * Gets the maximum value accepted by all inputs of the vector.
+     */
+    get max(): number;
+    /**
+     * Sets the maximum number of decimal places supported by all inputs of the vector.
+     */
+    set precision(value: number);
+    /**
+     * Gets the maximum number of decimal places supported by all inputs of the vector.
+     */
+    get precision(): number;
+    /**
+     * Sets the amount that the value will be increased or decreased when using the arrow keys and
+     * the slider input for all inputs of the vector.
+     */
+    set step(value: number);
+    /**
+     * Gets the amount that the value will be increased or decreased when using the arrow keys and
+     * the slider input for all inputs of the vector.
+     */
+    get step(): number;
+}
+export { VectorInput, VectorInputArgs };

package/node_modules/@playcanvas/pcui/react/types/components/components.d.ts

@@ -0,0 +1,30 @@
+import { ArrayInput } from './ArrayInput/component';
+import { BooleanInput } from './BooleanInput/component';
+import { Button } from './Button/component';
+import { Canvas } from './Canvas/component';
+import { Code } from './Code/component';
+import { ColorPicker } from './ColorPicker/component';
+import { Container } from './Container/component';
+import { Divider } from './Divider/component';
+import { Element } from './Element/component';
+import { GradientPicker } from './GradientPicker/component';
+import { GridView } from './GridView/component';
+import { GridViewItem } from './GridViewItem/component';
+import { InfoBox } from './InfoBox/component';
+import { Label } from './Label/component';
+import { LabelGroup } from './LabelGroup/component';
+import { Menu } from './Menu/component';
+import { NumericInput } from './NumericInput/component';
+import { Overlay } from './Overlay/component';
+import { Panel } from './Panel/component';
+import { Progress } from './Progress/component';
+import { RadioButton } from './RadioButton/component';
+import { SelectInput } from './SelectInput/component';
+import { SliderInput } from './SliderInput/component';
+import { Spinner } from './Spinner/component';
+import { TextAreaInput } from './TextAreaInput/component';
+import { TextInput } from './TextInput/component';
+import { TreeView } from './TreeView/component';
+import { TreeViewItem } from './TreeViewItem/component';
+import { VectorInput } from './VectorInput/component';
+export { ArrayInput, BooleanInput, Button, Canvas, Code, ColorPicker, Container, Divider, Element, GradientPicker, GridView, GridViewItem, InfoBox, Label, LabelGroup, Menu, NumericInput, Overlay, Panel, Progress, RadioButton, SelectInput, SliderInput, Spinner, TextAreaInput, TextInput, TreeView, TreeViewItem, VectorInput };

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

@@ -0,0 +1,32 @@
+import { ArrayInput, ArrayInputArgs } from './ArrayInput';
+import { BooleanInput, BooleanInputArgs } from './BooleanInput';
+import { Button, ButtonArgs } from './Button';
+import { Canvas, CanvasArgs } from './Canvas';
+import { Code, CodeArgs } from './Code';
+import { ColorPicker, ColorPickerArgs } from './ColorPicker';
+import { Container, ContainerArgs } from './Container';
+import { Divider } from './Divider';
+import { Element, ElementArgs, IBindable, IBindableArgs, IFlexArgs, IFocusable, IParentArgs, IPlaceholder, IPlaceholderArgs } from './Element';
+import { GradientPicker, GradientPickerArgs } from './GradientPicker';
+import { GridView, GridViewArgs } from './GridView';
+import { GridViewItem, GridViewItemArgs } from './GridViewItem';
+import { InfoBox, InfoBoxArgs } from './InfoBox';
+import { InputElement, InputElementArgs } from './InputElement';
+import { Label, LabelArgs } from './Label';
+import { LabelGroup, LabelGroupArgs } from './LabelGroup';
+import { Menu, MenuArgs } from './Menu';
+import { MenuItem, MenuItemArgs } from './MenuItem';
+import { NumericInput, NumericInputArgs } from './NumericInput';
+import { Overlay, OverlayArgs } from './Overlay';
+import { Panel, PanelArgs } from './Panel';
+import { Progress, ProgressArgs } from './Progress';
+import { RadioButton, RadioButtonArgs } from './RadioButton';
+import { SelectInput, SelectInputArgs } from './SelectInput';
+import { SliderInput, SliderInputArgs } from './SliderInput';
+import { Spinner, SpinnerArgs } from './Spinner';
+import { TextAreaInput, TextAreaInputArgs } from './TextAreaInput';
+import { TextInput, TextInputArgs } from './TextInput';
+import { TreeView, TreeViewArgs, ReparentedItem } from './TreeView';
+import { TreeViewItem, TreeViewItemArgs } from './TreeViewItem';
+import { VectorInput, VectorInputArgs } from './VectorInput';
+export { ArrayInput, ArrayInputArgs, BooleanInput, BooleanInputArgs, Button, ButtonArgs, Canvas, CanvasArgs, Code, CodeArgs, ColorPicker, ColorPickerArgs, Container, ContainerArgs, Divider, Element, ElementArgs, GradientPicker, GradientPickerArgs, GridView, GridViewArgs, GridViewItem, GridViewItemArgs, InfoBox, InfoBoxArgs, InputElement, InputElementArgs, Label, LabelArgs, LabelGroup, LabelGroupArgs, Menu, MenuArgs, MenuItem, MenuItemArgs, NumericInput, NumericInputArgs, Overlay, OverlayArgs, Panel, PanelArgs, Progress, ProgressArgs, RadioButton, RadioButtonArgs, SelectInput, SelectInputArgs, SliderInput, SliderInputArgs, Spinner, SpinnerArgs, TextAreaInput, TextAreaInputArgs, TextInput, TextInputArgs, TreeView, TreeViewArgs, ReparentedItem, TreeViewItem, TreeViewItemArgs, VectorInput, VectorInputArgs, IBindable, IBindableArgs, IPlaceholder, IPlaceholderArgs, IFocusable, IParentArgs, IFlexArgs };

package/node_modules/@playcanvas/pcui/react/types/helpers/search.d.ts

@@ -0,0 +1,31 @@
+type SearchArgs = {
+    /**
+     * Tolerance for how many characters of the search string must be contained in the item name. Default is 0.5.
+     */
+    containsCharsTolerance?: number;
+    /**
+     * Tolerance for how many edits are allowed between the search string and the item name. Default is 0.5.
+     */
+    editsDistanceTolerance?: number;
+    /**
+     * Limit the number of results. If not set, all results will be returned.
+     */
+    limitResults?: number;
+};
+/**
+ * Perform search through items.
+ *
+ * @param items - Array of objects to search through.
+ * @param searchKey - The property name to search within each item.
+ * @param search - String to search for.
+ * @param args - Search arguments.
+ * @returns Array of found items.
+ * @example
+ * const items = [
+ *     { text: 'Item 1', id: 1 },
+ *     { text: 'Item 2', id: 2 }
+ * ];
+ * const results = searchItems(items, 'text', 'item');
+ */
+export declare const searchItems: <K extends string, T extends Record<K, string>>(items: T[], searchKey: K, search?: string, args?: SearchArgs) => T[];
+export {};

package/node_modules/@playcanvas/pcui/react/types/helpers/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function deepCopy(data: any): any;
+export declare function arrayEquals(lhs: Array<any>, rhs: Array<any>): boolean;

package/node_modules/@playcanvas/pcui/react/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './binding';
+export * from './components/components';
+export declare const version = "PACKAGE_VERSION";
+export declare const revision = "PACKAGE_REVISION";