@galacean/effects-plugin-gui 2.10.0-alpha.5

package/dist/layout/aspect-ratio-container.d.ts

@@ -0,0 +1,26 @@
+import { math } from '@galacean/effects';
+import { Container } from '../core/control';
+import type { AspectRatioContainerData } from '../data';
+import { AspectRatioStretchMode, LayoutAlignment } from './enums';
+/** Fits every visible child into the same rectangle with a fixed width/height ratio. */
+export declare class AspectRatioContainer extends Container {
+    static readonly themeType: string;
+    private _ratio;
+    private _stretchMode;
+    private _horizontalAlignment;
+    private _verticalAlignment;
+    get ratio(): number;
+    set ratio(value: number);
+    get stretchMode(): AspectRatioStretchMode;
+    set stretchMode(value: AspectRatioStretchMode);
+    get horizontalAlignment(): LayoutAlignment;
+    set horizontalAlignment(value: LayoutAlignment);
+    get verticalAlignment(): LayoutAlignment;
+    set verticalAlignment(value: LayoutAlignment);
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    protected sortChildren(): void;
+    private measureChildren;
+    private getAlignedOffset;
+    fromData(data: AspectRatioContainerData): void;
+}

package/dist/layout/box-container.d.ts

@@ -0,0 +1,35 @@
+import { math } from '@galacean/effects';
+import type { Engine } from '@galacean/effects';
+import { Container } from '../core/control';
+import type { BoxContainerData } from '../data';
+import { LayoutAlignment, Orientation } from './enums';
+/** Places visible children in a single horizontal or vertical row. */
+export declare class BoxContainer extends Container {
+    static readonly themeType: string;
+    private _orientation;
+    private _alignment;
+    private _reverse;
+    get orientation(): Orientation;
+    set orientation(value: Orientation);
+    get alignment(): LayoutAlignment;
+    set alignment(value: LayoutAlignment);
+    get reverse(): boolean;
+    set reverse(value: boolean);
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    protected sortChildren(): void;
+    private measureChildren;
+    private getMainSize;
+    private getCrossSize;
+    private isMainExpanded;
+    private invalidateMeasurement;
+    fromData(data: BoxContainerData): void;
+}
+export declare class HBoxContainer extends BoxContainer {
+    static readonly themeType: string;
+    constructor(engine: Engine);
+}
+export declare class VBoxContainer extends BoxContainer {
+    static readonly themeType: string;
+    constructor(engine: Engine);
+}

package/dist/layout/center-container.d.ts

@@ -0,0 +1,15 @@
+import { math } from '@galacean/effects';
+import { Container } from '../core/control';
+import type { CenterContainerData } from '../data';
+/** Centers children at their bound minimum size. */
+export declare class CenterContainer extends Container {
+    static readonly themeType: string;
+    private _useTopLeft;
+    get useTopLeft(): boolean;
+    set useTopLeft(value: boolean);
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    protected sortChildren(): void;
+    private measureChildren;
+    fromData(data: CenterContainerData): void;
+}

package/dist/layout/enums.d.ts

@@ -0,0 +1,15 @@
+export declare enum Orientation {
+    Horizontal = 0,
+    Vertical = 1
+}
+export declare enum LayoutAlignment {
+    Begin = 0,
+    Center = 1,
+    End = 2
+}
+export declare enum AspectRatioStretchMode {
+    WidthControlsHeight = 0,
+    HeightControlsWidth = 1,
+    Fit = 2,
+    Cover = 3
+}

package/dist/layout/grid-container.d.ts

@@ -0,0 +1,19 @@
+import { math } from '@galacean/effects';
+import { Container } from '../core/control';
+import type { GridContainerData } from '../data';
+/** Places visible children in LTR row-major cells without spanning. */
+export declare class GridContainer extends Container {
+    static readonly themeType: string;
+    private _columns;
+    get columns(): number;
+    set columns(value: number);
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    protected sortChildren(): void;
+    private measureGrid;
+    private collectTrackMetrics;
+    private allocateTracks;
+    private getTrackPositions;
+    private invalidateMeasurement;
+    fromData(data: GridContainerData): void;
+}

package/dist/layout/margin-container.d.ts

@@ -0,0 +1,10 @@
+import { math } from '@galacean/effects';
+import { Container } from '../core/control';
+/** Adds four independent margins around every visible child. */
+export declare class MarginContainer extends Container {
+    static readonly themeType: string;
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    protected sortChildren(): void;
+    private measureChildren;
+}

package/dist/layout/panel-container.d.ts

@@ -0,0 +1,10 @@
+import { math } from '@galacean/effects';
+import { Container } from '../core/control';
+export declare class PanelContainer extends Container {
+    static readonly themeType: string;
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    draw(): void;
+    protected sortChildren(): void;
+    private measureChildren;
+}

package/dist/layout/separator.d.ts

@@ -0,0 +1,19 @@
+import { math } from '@galacean/effects';
+import type { Engine } from '@galacean/effects';
+import { Control } from '../core/control';
+declare abstract class Separator extends Control {
+    private readonly vertical;
+    constructor(engine: Engine, vertical: boolean);
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    draw(): void;
+}
+export declare class HSeparator extends Separator {
+    static readonly themeType: string;
+    constructor(engine: Engine);
+}
+export declare class VSeparator extends Separator {
+    static readonly themeType: string;
+    constructor(engine: Engine);
+}
+export {};

package/dist/layout/utils.d.ts

@@ -0,0 +1,10 @@
+export declare function assertFinite(name: string, value: number): void;
+export declare function assertEnumValue(name: string, value: number, maximum: number): void;
+export declare function sum(values: number[]): number;
+/**
+ * Grows slots by weight, removing capped slots and redistributing their
+ * unused share. Fractional pixels are accumulated and the last slot absorbs
+ * the remaining numerical error when the supplied space is integral.
+ */
+export declare function growSlots(sizes: number[], ceilings: number[], weights: number[], extra: number, integerPixels: boolean): number;
+export declare function alignmentOffset(alignment: number, remaining: number): number;

package/dist/plugin/gui-plugin.d.ts

@@ -0,0 +1,8 @@
+import { Plugin } from '@galacean/effects';
+import type { Composition, Engine } from '@galacean/effects';
+export declare class GUIPlugin extends Plugin {
+    order: number;
+    name: string;
+    onEngineCreated(engine: Engine): void;
+    onCompositionCreating(composition: Composition): void;
+}

package/dist/plugin/index.d.ts

@@ -0,0 +1 @@
+export * from './gui-plugin';

package/dist/scroll/enums.d.ts

@@ -0,0 +1,8 @@
+export declare enum ScrollMode {
+    Disabled = 0,
+    Auto = 1,
+    ShowAlways = 2,
+    ShowNever = 3,
+    Reserve = 4,
+    MaximizeFirst = 5
+}

package/dist/scroll/range.d.ts

@@ -0,0 +1,56 @@
+import type { Engine, EventEmitterListener } from '@galacean/effects';
+import { Control } from '../core/control';
+import type { ControlEvent } from '../core/control';
+import type { RangeData } from '../data';
+export type RangeEvent = ControlEvent & {
+    changed: [];
+    valueChanged: [value: number];
+};
+/** Numeric value model shared by scroll bars and future slider controls. */
+export declare class Range extends Control {
+    static readonly themeType: string;
+    private shared;
+    private _rounded;
+    private suppressSignals;
+    private readonly rangeEventEmitter;
+    constructor(engine: Engine);
+    get minValue(): number;
+    set minValue(value: number);
+    get maxValue(): number;
+    set maxValue(value: number);
+    get step(): number;
+    set step(value: number);
+    get page(): number;
+    set page(value: number);
+    get value(): number;
+    set value(value: number);
+    get ratio(): number;
+    set ratio(value: number);
+    get exponentialRatio(): boolean;
+    set exponentialRatio(value: boolean);
+    get rounded(): boolean;
+    set rounded(value: boolean);
+    get allowGreater(): boolean;
+    set allowGreater(value: boolean);
+    get allowLesser(): boolean;
+    set allowLesser(value: boolean);
+    on<E extends keyof RangeEvent>(eventName: E, listener: EventEmitterListener<RangeEvent[E]>): void;
+    off<E extends keyof RangeEvent>(eventName: E, listener: EventEmitterListener<RangeEvent[E]>): void;
+    setValue(value: number): void;
+    setValueNoSignal(value: number): void;
+    setMinValue(value: number): void;
+    setMaxValue(value: number): void;
+    setStep(value: number): void;
+    setPage(value: number): void;
+    setAsRatio(ratio: number): void;
+    getAsRatio(): number;
+    share(range: Range): void;
+    unshare(): void;
+    dispose(): void;
+    protected valueChanged(value: number): void;
+    private calculateValue;
+    private attachShared;
+    private notifyValueChanged;
+    private notifyChanged;
+    fromData(data: RangeData): void;
+}

package/dist/scroll/scroll-bar.d.ts

@@ -0,0 +1,69 @@
+import { math } from '@galacean/effects';
+import type { Engine, EventEmitterListener, InputEventKey, InputEventMouseButton, InputEventMouseMotion } from '@galacean/effects';
+import { Orientation } from '../layout/enums';
+import { Range } from './range';
+import type { RangeEvent } from './range';
+import type { ScrollBarData } from '../data';
+export type ScrollBarEvent = RangeEvent & {
+    scrolling: [];
+};
+/** A horizontal or vertical range scroll bar. */
+export declare class ScrollBar extends Range {
+    static readonly themeType: string;
+    static readonly pageDivisor = 8;
+    private readonly scrollBarEventEmitter;
+    private _orientation;
+    private _customStep;
+    private highlight;
+    private decrementActive;
+    private incrementActive;
+    private dragging;
+    private dragPosition;
+    private dragRatio;
+    constructor(engine: Engine, orientation?: Orientation);
+    get orientation(): Orientation;
+    set orientation(value: Orientation);
+    get customStep(): number;
+    set customStep(value: number);
+    on<E extends keyof ScrollBarEvent>(eventName: E, listener: EventEmitterListener<ScrollBarEvent[E]>): void;
+    off<E extends keyof ScrollBarEvent>(eventName: E, listener: EventEmitterListener<ScrollBarEvent[E]>): void;
+    scroll(amount: number): void;
+    scrollTo(position: number): void;
+    getMinimumSize(): math.Vector2;
+    draw(): void;
+    onMouseEnter(location: math.Vector2): void;
+    onMouseMove(event: InputEventMouseMotion): void;
+    onMouseLeave(): void;
+    onMouseDown(event: InputEventMouseButton): void;
+    onMouseUp(event: InputEventMouseButton): void;
+    onMouseWheel(event: InputEventMouseButton): void;
+    onKeyDown(event: InputEventKey): void;
+    onScrollBegin(): void;
+    private getAxis;
+    private getAxisSize;
+    private getIncrement;
+    private getPageIncrement;
+    private getTrackSize;
+    private getAreaSize;
+    private getGrabberSize;
+    private getGrabberMinimumSize;
+    private getGrabberOffset;
+    private getGrabberRect;
+    private getTrackStartMargin;
+    private getCrossStartPadding;
+    private getCrossEndPadding;
+    private updateHighlight;
+    private drawButtonIcon;
+    private getButtonIcon;
+    private getButtonAxisSize;
+    private getButtonCrossSize;
+    fromData(data: ScrollBarData): void;
+}
+export declare class HScrollBar extends ScrollBar {
+    static readonly themeType: string;
+    constructor(engine: Engine);
+}
+export declare class VScrollBar extends ScrollBar {
+    static readonly themeType: string;
+    constructor(engine: Engine);
+}

package/dist/scroll/scroll-container.d.ts

@@ -0,0 +1,84 @@
+import { math } from '@galacean/effects';
+import type { Engine, EventEmitterListener, InputEventMouseButton, InputEventScreenDrag, InputEventScreenTouch } from '@galacean/effects';
+import { Container } from '../core/control';
+import type { Control, ControlEvent, RootControl } from '../core/control';
+import { ScrollMode } from './enums';
+import { HScrollBar, VScrollBar } from './scroll-bar';
+import type { ScrollContainerData } from '../data';
+export type ScrollContainerEvent = ControlEvent & {
+    scrollStarted: [];
+    scrollEnded: [];
+};
+/** Clips and scrolls its content children using two internal Range scroll bars. */
+export declare class ScrollContainer extends Container {
+    static readonly themeType: string;
+    private readonly scrollContainerEventEmitter;
+    private readonly horizontalBar;
+    private readonly verticalBar;
+    private _horizontalScrollMode;
+    private _verticalScrollMode;
+    private _scrollHorizontalByDefault;
+    private _deadzone;
+    private _followFocus;
+    private focusRoot;
+    private touchIndex;
+    private touchDecelerating;
+    private beyondDeadzone;
+    private readonly dragSpeed;
+    private readonly dragAccum;
+    private readonly dragFrom;
+    private readonly lastDragAccum;
+    private motionSampleTime;
+    private viewportWidth;
+    private viewportHeight;
+    private readonly scrollMoved;
+    private readonly controlStateChanged;
+    private readonly focusOwnerChanged;
+    constructor(engine: Engine);
+    get hScroll(): number;
+    set hScroll(value: number);
+    get vScroll(): number;
+    set vScroll(value: number);
+    get horizontalScrollMode(): ScrollMode;
+    set horizontalScrollMode(value: ScrollMode);
+    get verticalScrollMode(): ScrollMode;
+    set verticalScrollMode(value: ScrollMode);
+    get horizontalCustomStep(): number;
+    set horizontalCustomStep(value: number);
+    get verticalCustomStep(): number;
+    set verticalCustomStep(value: number);
+    get scrollHorizontalByDefault(): boolean;
+    set scrollHorizontalByDefault(value: boolean);
+    get deadzone(): number;
+    set deadzone(value: number);
+    get followFocus(): boolean;
+    set followFocus(value: boolean);
+    on<E extends keyof ScrollContainerEvent>(eventName: E, listener: EventEmitterListener<ScrollContainerEvent[E]>): void;
+    off<E extends keyof ScrollContainerEvent>(eventName: E, listener: EventEmitterListener<ScrollContainerEvent[E]>): void;
+    getHScrollBar(): HScrollBar;
+    getVScrollBar(): VScrollBar;
+    intersectsChildContent(child: Control, position: math.Vector2): boolean;
+    ensureControlVisible(control: Control): void;
+    getMinimumSize(): math.Vector2;
+    getDesiredSize(): math.Vector2;
+    onMouseWheel(event: InputEventMouseButton): void;
+    onTouchDown(event: InputEventScreenTouch): void;
+    onTouchMove(event: InputEventScreenDrag): void;
+    onTouchUp(event: InputEventScreenTouch): void;
+    update(deltaTime: number): void;
+    dispose(): void;
+    protected drawChildren(): void;
+    protected getLayoutChildren(): Control[];
+    protected onRootChanged(previousRoot: RootControl | null, nextRoot: RootControl | null): void;
+    protected sortChildren(): void;
+    private measureContent;
+    private getLargestContentSize;
+    private resolveLayout;
+    private invalidateScrollLayout;
+    private isContentDescendant;
+    private notifyContentScroll;
+    private updateDragVelocity;
+    private updateInertia;
+    private cancelTouchDrag;
+    fromData(data: ScrollContainerData): void;
+}

package/dist/theme/default-theme.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/theme/index.d.ts

@@ -0,0 +1,2 @@
+import './default-theme';
+export {};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@galacean/effects-plugin-gui",
+  "version": "2.10.0-alpha.5",
+  "description": "GUI controls and layout containers for Galacean Effects",
+  "module": "./dist/index.mjs",
+  "main": "./dist/index.js",
+  "browser": "./dist/index.min.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "contributors": [],
+  "author": "Ant Group CO., Ltd.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "devDependencies": {
+    "@galacean/effects": "2.10.0-alpha.5"
+  },
+  "scripts": {
+    "prebuild": "pnpm clean",
+    "build": "pnpm build:declaration && pnpm build:module",
+    "build:module": "rollup -c",
+    "build:declaration": "tsc -d --emitDeclarationOnly",
+    "clean": "rimraf dist && rimraf \"*+(.tsbuildinfo)\""
+  }
+}