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

package/dist/core/data.d.ts

@@ -0,0 +1,88 @@
+import type { FontStyle, FontWeight, spec } from '@galacean/effects';
+export interface ThemeFontData {
+    family: string;
+    weight?: FontWeight;
+    style?: FontStyle;
+}
+export interface StyleBoxMarginsData {
+    left?: number;
+    top?: number;
+    right?: number;
+    bottom?: number;
+}
+export interface StyleBoxEmptyData {
+    type: 'empty';
+    contentMargins?: StyleBoxMarginsData;
+}
+export interface StyleBoxFlatData {
+    type: 'flat';
+    backgroundColor?: spec.ColorData;
+    borderColor?: spec.ColorData;
+    borderWidths?: StyleBoxMarginsData;
+    cornerRadii?: StyleBoxMarginsData;
+    contentMargins?: StyleBoxMarginsData;
+}
+export interface StyleBoxTextureData {
+    type: 'texture';
+    texture: spec.DataPath | null;
+    sourceRect?: RectData;
+    patchMargins?: StyleBoxMarginsData;
+    contentMargins?: StyleBoxMarginsData;
+    horizontalAxisStretchMode?: number;
+    verticalAxisStretchMode?: number;
+    drawCenter?: boolean;
+    tint?: spec.ColorData;
+}
+export type StyleBoxData = StyleBoxEmptyData | StyleBoxFlatData | StyleBoxTextureData;
+export interface ThemeItemCollectionData {
+    colors?: Record<string, spec.ColorData>;
+    constants?: Record<string, number>;
+    fonts?: Record<string, ThemeFontData>;
+    fontSizes?: Record<string, number>;
+    icons?: Record<string, spec.DataPath | null>;
+    styleBoxes?: Record<string, StyleBoxData>;
+}
+export interface ThemeData {
+    types: Record<string, ThemeItemCollectionData>;
+    variations?: Record<string, string>;
+}
+export interface ThemeOverridesData extends ThemeItemCollectionData {
+}
+/** Common serialized properties shared by every GUI Control. */
+export interface ControlData {
+    anchorMin?: spec.vec2;
+    anchorMax?: spec.vec2;
+    offsetMin?: spec.vec2;
+    offsetMax?: spec.vec2;
+    pivot?: spec.vec2;
+    scale?: spec.vec2;
+    shear?: spec.vec2;
+    rotation?: number;
+    customMinimumSize?: spec.vec2;
+    customMaximumSize?: spec.vec2;
+    horizontalSizeFlags?: number;
+    verticalSizeFlags?: number;
+    stretchRatio?: number;
+    horizontalGrowDirection?: number;
+    verticalGrowDirection?: number;
+    mouseFilter?: number;
+    mouseBehaviorRecursive?: number;
+    mouseForcePassScrollEvents?: boolean;
+    focusMode?: number;
+    focusBehaviorRecursive?: number;
+    defaultCursorShape?: number | string;
+    clipContents?: boolean;
+    themeTypeVariation?: string;
+    themeOverrides?: ThemeOverridesData;
+}
+export interface SerializedControlData<T extends ControlData = ControlData> {
+    type: string;
+    data: T;
+}
+export interface UIControlData<T extends ControlData = ControlData> extends spec.ComponentData {
+    control: SerializedControlData<T>;
+}
+export interface RectData {
+    position: spec.vec2;
+    size: spec.vec2;
+}

package/dist/core/enums.d.ts

@@ -0,0 +1,42 @@
+export declare enum MouseFilter {
+    Stop = 0,
+    Pass = 1,
+    Ignore = 2
+}
+export declare enum MouseBehaviorRecursive {
+    Inherited = 0,
+    Disabled = 1,
+    Enabled = 2
+}
+export declare enum FocusMode {
+    None = 0,
+    Click = 1,
+    All = 2,
+    Accessibility = 3
+}
+export declare enum FocusBehaviorRecursive {
+    Inherited = 0,
+    Disabled = 1,
+    Enabled = 2
+}
+export declare enum CursorShape {
+    Arrow = 0,
+    Ibeam = 1,
+    PointingHand = 2,
+    Cross = 3,
+    Wait = 4,
+    Busy = 5,
+    Drag = 6,
+    CanDrop = 7,
+    Forbidden = 8,
+    Vsize = 9,
+    Hsize = 10,
+    Bdiagsize = 11,
+    Fdiagsize = 12,
+    Move = 13,
+    Vsplit = 14,
+    Hsplit = 15,
+    Help = 16
+}
+/** A preset cursor shape or a complete CSS cursor value. */
+export type CursorStyle = CursorShape | string;

package/dist/core/index.d.ts

@@ -0,0 +1,5 @@
+export * from './control';
+export * from './data';
+export * from './enums';
+export * from './roots';
+export * from './theme';

package/dist/core/roots.d.ts

@@ -0,0 +1,97 @@
+import type { UICanvas } from '../components/ui-canvas';
+import { InputEvent, math } from '@galacean/effects';
+import type { Engine } from '@galacean/effects';
+import type { Container } from './control';
+import { Control, RootControl } from './control';
+type Vector2 = math.Vector2;
+declare const Vector2: typeof math.Vector2;
+/** CanvasLayer-like boundary for a single UICanvas GUI tree. */
+export declare class CanvasRootControl extends Control {
+    readonly canvas: UICanvas;
+    constructor(engine: Engine, canvas: UICanvas);
+    get inputDisabled(): boolean;
+}
+/** Global ordered collection of UICanvas roots. */
+export declare class CanvasContainer extends Control {
+    constructor(engine: Engine);
+    sortCanvases(): void;
+    addChildInternal(child: Control): void;
+    protected drawChildren(): void;
+}
+/** Engine window GUI root. Routes events across all UICanvas roots. */
+export declare class WindowRootControl extends RootControl {
+    readonly canvases: CanvasContainer;
+    private readonly popupLayer;
+    private readonly popupStack;
+    dragThreshold: number;
+    private lastInput;
+    private readonly dirtyContainers;
+    private readonly dirtyMeasurements;
+    private readonly gui;
+    constructor(engine: Engine);
+    pushInput(event: InputEvent): void;
+    isInputHandled(): boolean;
+    getMousePosition(): Vector2;
+    guiGetFocusOwner(): Control | null;
+    guiControlHasFocus(control: Control, visibleOnly?: boolean): boolean;
+    guiReleaseFocus(): void;
+    guiIsDragging(): boolean;
+    guiGetDragData(): unknown;
+    guiIsDragSuccessful(): boolean;
+    guiCancelDrag(): void;
+    grabControlFocus(control: Control, hideFocus?: boolean): void;
+    grabControlClickFocus(control: Control): void;
+    releaseControlFocus(control?: Control): void;
+    warpControlMouse(position: Vector2): void;
+    updateMouseCursorState(): void;
+    controlStateChanged(control: Control): void;
+    controlRemoved(control: Control): void;
+    controlTreeChanged(): void;
+    popupControl(control: Control, source: Control | null, position: Vector2): void;
+    closePopupControl(control: Control): void;
+    queueLayout(container: Container): void;
+    queueMeasurementChange(control: Control): void;
+    cancelPointerInput(): void;
+    onCanvasBlur(): void;
+    cancelPointerPress(control: Control, touchIndex: number): void;
+    resize(width: number, height: number): void;
+    render(): void;
+    update(deltaTime: number): void;
+    dispose(): void;
+    private flushLayout;
+    private getControlDepth;
+    private processGUIInput;
+    private processMouseButton;
+    private processMouseMotion;
+    private processScreenTouch;
+    private processScreenDrag;
+    private callGUIInput;
+    private callControlInput;
+    private findInputControl;
+    private findControlAtPosition;
+    private toControlLocal;
+    private updateMouseOver;
+    private updateMouseOverHierarchy;
+    private applyMouseOver;
+    private buildHoverHierarchy;
+    private findClickFocus;
+    private beginDragging;
+    private finishDrop;
+    private findDropTarget;
+    private endDragging;
+    private updateCursor;
+    private postGrabClickFocus;
+    private cleanupInternalState;
+    private dropMouseFocus;
+    private dropMouseOver;
+    private dropControlState;
+    private getGlobalInverse;
+    private toLocal;
+    private controlBelongsToSubtree;
+    private isControlValid;
+    private isControlUsable;
+    private findCanvasRoot;
+    private notifyFocusOwnerChanged;
+    private isFocusTargetUsable;
+}
+export {};

package/dist/core/theme.d.ts

@@ -0,0 +1,186 @@
+import { math } from '@galacean/effects';
+import type { Engine, EventEmitterListener, FontStyle, FontWeight, Graphics, Texture } from '@galacean/effects';
+import type { StyleBoxData, ThemeData } from './data';
+type Color = math.Color;
+type Vector2 = math.Vector2;
+declare const Color: typeof math.Color;
+declare const Vector2: typeof math.Vector2;
+export declare enum ThemeItemType {
+    Color = "color",
+    Constant = "constant",
+    Font = "font",
+    FontSize = "fontSize",
+    Icon = "icon",
+    StyleBox = "styleBox"
+}
+export interface ThemeFont {
+    family: string;
+    weight: FontWeight;
+    style: FontStyle;
+}
+export interface StyleBoxMargins {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+}
+export interface StyleBoxRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export declare enum PatchStretchMode {
+    Stretch = 0,
+    Tile = 1,
+    TileFit = 2
+}
+export type ThemeValue = Color | number | ThemeFont | Texture | StyleBox | null;
+export interface ThemeItemDefinition<T extends ThemeValue = ThemeValue> {
+    type: ThemeItemType;
+    defaultValue: T;
+    affectsLayout?: boolean;
+}
+export type ThemeItemDefinitions = Record<string, ThemeItemDefinition>;
+type StyleBoxEvent = {
+    changed: [styleBox: StyleBox];
+};
+type ThemeEvent = {
+    changed: [theme: Theme, affectsLayout: boolean];
+};
+export declare function cloneThemeValue<T extends ThemeValue>(value: T): T;
+/** Drawable box resource used for rendering and content measurement. */
+export declare abstract class StyleBox {
+    private readonly eventEmitter;
+    private contentMargins;
+    private readOnly;
+    on(eventName: 'changed', listener: EventEmitterListener<StyleBoxEvent['changed']>): void;
+    off(eventName: 'changed', listener: EventEmitterListener<StyleBoxEvent['changed']>): void;
+    getContentMargins(): StyleBoxMargins;
+    get isReadOnly(): boolean;
+    setContentMargins(left: number, top: number, right: number, bottom: number): void;
+    getMinimumSize(): Vector2;
+    abstract draw(graphics: Graphics, rect: StyleBoxRect): void;
+    protected notifyChanged(): void;
+    protected assertMutable(): void;
+}
+export declare class StyleBoxEmpty extends StyleBox {
+    static readonly shared: StyleBoxEmpty;
+    draw(): void;
+}
+export declare class StyleBoxFlat extends StyleBox {
+    private backgroundColor;
+    private borderColor;
+    private borderWidths;
+    private cornerRadii;
+    getBackgroundColor(): Color;
+    getBorderColor(): Color;
+    getBorderWidths(): StyleBoxMargins;
+    getCornerRadii(): StyleBoxMargins;
+    setBackgroundColor(value: Color): void;
+    setBorderColor(value: Color): void;
+    setBorderWidths(left: number, top: number, right: number, bottom: number): void;
+    setCornerRadii(topLeft: number, topRight: number, bottomRight: number, bottomLeft: number): void;
+    draw(graphics: Graphics, rect: StyleBoxRect): void;
+    private hasRoundedCorners;
+    private drawRounded;
+}
+export declare class StyleBoxTexture extends StyleBox {
+    private _texture;
+    private sourceRect;
+    private patchMargins;
+    private tint;
+    private _horizontalAxisStretchMode;
+    private _verticalAxisStretchMode;
+    private _drawCenter;
+    get texture(): Texture | null;
+    set texture(value: Texture | null);
+    get horizontalAxisStretchMode(): PatchStretchMode;
+    set horizontalAxisStretchMode(value: PatchStretchMode);
+    get verticalAxisStretchMode(): PatchStretchMode;
+    set verticalAxisStretchMode(value: PatchStretchMode);
+    get drawCenter(): boolean;
+    set drawCenter(value: boolean);
+    getSourceRect(): StyleBoxRect | null;
+    getPatchMargins(): StyleBoxMargins;
+    getTint(): Color;
+    setSourceRect(x: number, y: number, width: number, height: number): void;
+    clearSourceRect(): void;
+    setPatchMargins(left: number, top: number, right: number, bottom: number): void;
+    setTint(value: Color): void;
+    draw(graphics: Graphics, rect: StyleBoxRect): void;
+}
+/** Registry for stable control type inheritance and immutable native defaults. */
+export declare class ThemeRegistry {
+    private static readonly types;
+    static registerType(type: string, baseType: string | null, definitions?: ThemeItemDefinitions): void;
+    static hasType(type: string): boolean;
+    static getTypeChain(type: string): string[];
+    static getDefault(type: string, itemType: ThemeItemType, name: string): ThemeValue | undefined;
+    static getItemDefinition(type: string, itemType: ThemeItemType, name: string): ThemeItemDefinition | undefined;
+    static affectsLayout(type: string, itemType: ThemeItemType, name: string): boolean;
+    static getItemDefinitions(type: string, includeInherited?: boolean): ThemeItemDefinitions;
+}
+export declare class Theme {
+    private readonly eventEmitter;
+    private readonly values;
+    private readonly variations;
+    private readonly styleBoxReferences;
+    private batchDepth;
+    private changePending;
+    private layoutChangePending;
+    private readonly styleBoxChanged;
+    on(eventName: 'changed', listener: EventEmitterListener<ThemeEvent['changed']>): void;
+    off(eventName: 'changed', listener: EventEmitterListener<ThemeEvent['changed']>): void;
+    batch<T>(callback: () => T): T;
+    setTypeVariation(variation: string, baseType: string): void;
+    clearTypeVariation(variation: string): void;
+    hasTypeVariation(variation: string): boolean;
+    getTypeVariationBase(variation: string): string | undefined;
+    getTypeDependencies(variation: string): string[];
+    setColor(type: string, name: string, value: Color): void;
+    getColor(type: string, name: string): Color | undefined;
+    hasColor(type: string, name: string): boolean;
+    clearColor(type: string, name: string): void;
+    setConstant(type: string, name: string, value: number): void;
+    getConstant(type: string, name: string): number | undefined;
+    hasConstant(type: string, name: string): boolean;
+    clearConstant(type: string, name: string): void;
+    setFont(type: string, name: string, value: ThemeFont): void;
+    getFont(type: string, name: string): ThemeFont | undefined;
+    hasFont(type: string, name: string): boolean;
+    clearFont(type: string, name: string): void;
+    setFontSize(type: string, name: string, value: number): void;
+    getFontSize(type: string, name: string): number | undefined;
+    hasFontSize(type: string, name: string): boolean;
+    clearFontSize(type: string, name: string): void;
+    setIcon(type: string, name: string, value: Texture | null): void;
+    getIcon(type: string, name: string): Texture | null | undefined;
+    hasIcon(type: string, name: string): boolean;
+    clearIcon(type: string, name: string): void;
+    setStyleBox(type: string, name: string, value: StyleBox): void;
+    getStyleBox(type: string, name: string): StyleBox | undefined;
+    hasStyleBox(type: string, name: string): boolean;
+    clearStyleBox(type: string, name: string): void;
+    hasItem(type: string, itemType: ThemeItemType, name: string): boolean;
+    getItem(type: string, itemType: ThemeItemType, name: string): ThemeValue | undefined;
+    clearItem(type: string, itemType: ThemeItemType, name: string): void;
+    clear(): void;
+    static fromData(engine: Engine, data: ThemeData): Theme;
+    private setCollectionFromData;
+    private setItem;
+    private retainStyleBox;
+    private releaseStyleBox;
+    private notifyChanged;
+    private affectsLayout;
+}
+export declare function styleBoxFromData(engine: Engine, data: StyleBoxData): StyleBox;
+export declare const themeFallbacks: {
+    color: math.Color;
+    constant: number;
+    font: ThemeFont;
+    fontSize: number;
+    icon: Texture | null;
+    styleBox: StyleBoxEmpty;
+};
+export {};

package/dist/data.d.ts

@@ -0,0 +1,147 @@
+import type { spec } from '@galacean/effects';
+import type { ControlData, RectData } from './core/data';
+import type { AspectRatioStretchMode, LayoutAlignment } from './layout/enums';
+import type { ScrollMode } from './scroll/enums';
+import type { AutowrapMode, AxisStretchMode, ButtonActionMode, HorizontalAlignment, ProgressFillMode, TextOverflow, TextureExpandMode, TextureStretchMode, VerticalAlignment } from './controls/enums';
+export interface BoxContainerData extends ControlData {
+    alignment?: LayoutAlignment;
+    reverse?: boolean;
+}
+export interface GridContainerData extends ControlData {
+    columns?: number;
+}
+export interface MarginContainerData extends ControlData {
+}
+export interface CenterContainerData extends ControlData {
+    useTopLeft?: boolean;
+}
+export interface AspectRatioContainerData extends ControlData {
+    ratio?: number;
+    stretchMode?: AspectRatioStretchMode;
+    horizontalAlignment?: LayoutAlignment;
+    verticalAlignment?: LayoutAlignment;
+}
+export interface RangeData extends ControlData {
+    minValue?: number;
+    maxValue?: number;
+    step?: number;
+    page?: number;
+    value?: number;
+    exponentialRatio?: boolean;
+    rounded?: boolean;
+    allowGreater?: boolean;
+    allowLesser?: boolean;
+}
+export interface ScrollBarData extends RangeData {
+    customStep?: number;
+}
+export interface ScrollContainerData extends ControlData {
+    hScroll?: number;
+    vScroll?: number;
+    horizontalScrollMode?: ScrollMode;
+    verticalScrollMode?: ScrollMode;
+    horizontalCustomStep?: number;
+    verticalCustomStep?: number;
+    scrollHorizontalByDefault?: boolean;
+    deadzone?: number;
+    followFocus?: boolean;
+}
+export interface LabelData extends ControlData {
+    text?: string;
+    horizontalAlignment?: HorizontalAlignment;
+    verticalAlignment?: VerticalAlignment;
+    autowrapMode?: AutowrapMode;
+    textOverflow?: TextOverflow;
+}
+export interface TextureRectData extends ControlData {
+    texture?: spec.DataPath | null;
+    expandMode?: TextureExpandMode;
+    stretchMode?: TextureStretchMode;
+    flipH?: boolean;
+    flipV?: boolean;
+    tint?: spec.ColorData;
+}
+export interface NinePatchRectData extends ControlData {
+    texture?: spec.DataPath | null;
+    regionRect?: RectData;
+    patchMarginLeft?: number;
+    patchMarginTop?: number;
+    patchMarginRight?: number;
+    patchMarginBottom?: number;
+    drawCenter?: boolean;
+    horizontalAxisStretchMode?: AxisStretchMode;
+    verticalAxisStretchMode?: AxisStretchMode;
+    tint?: spec.ColorData;
+}
+export interface ColorRectData extends ControlData {
+    color?: spec.ColorData;
+}
+export interface PanelData extends ControlData {
+}
+export interface BaseButtonData extends ControlData {
+    disabled?: boolean;
+    toggleMode?: boolean;
+    buttonPressed?: boolean;
+    buttonMask?: number;
+    actionMode?: ButtonActionMode;
+    keepPressedOutside?: boolean;
+}
+export interface ButtonData extends BaseButtonData {
+    text?: string;
+    icon?: spec.DataPath | null;
+    flat?: boolean;
+    clipText?: boolean;
+    expandIcon?: boolean;
+    textAlignment?: HorizontalAlignment;
+    iconAlignment?: HorizontalAlignment;
+    iconVerticalAlignment?: VerticalAlignment;
+}
+export interface CheckboxData extends ButtonData {
+}
+export interface CheckButtonData extends ButtonData {
+}
+export interface SliderData extends RangeData {
+    editable?: boolean;
+    scrollable?: boolean;
+}
+export interface ProgressBarData extends RangeData {
+    showPercentage?: boolean;
+    fillMode?: ProgressFillMode;
+}
+export interface TextInputData extends ControlData {
+    text?: string;
+    placeholderText?: string;
+    editable?: boolean;
+    maxLength?: number;
+}
+export interface LineEditData extends TextInputData {
+    secret?: boolean;
+    secretCharacter?: string;
+    alignment?: HorizontalAlignment;
+}
+export interface TextEditData extends TextInputData {
+}
+export interface PopupMenuItemData {
+    id: number | string;
+    text: string;
+    disabled?: boolean;
+    separator?: boolean;
+    checked?: boolean;
+}
+export interface PopupMenuData extends ControlData {
+    items?: PopupMenuItemData[];
+}
+export interface MenuButtonData extends ButtonData {
+    items?: PopupMenuItemData[];
+}
+export interface OptionButtonData extends MenuButtonData {
+    selected?: number;
+}
+export interface ColorPickerData extends ControlData {
+    color?: spec.ColorData;
+    editAlpha?: boolean;
+}
+export interface ColorPickerButtonData extends ButtonData {
+    color?: spec.ColorData;
+    editAlpha?: boolean;
+}

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+export * from './core';
+export * from './components';
+export * from './data';
+export * from './layout/enums';
+export * from './layout/box-container';
+export * from './layout/grid-container';
+export * from './layout/margin-container';
+export * from './layout/center-container';
+export * from './layout/aspect-ratio-container';
+export * from './layout/panel-container';
+export * from './layout/separator';
+export * from './scroll/enums';
+export * from './scroll/range';
+export * from './scroll/scroll-bar';
+export * from './scroll/scroll-container';
+export * from './theme';
+export * from './controls';
+export * from './plugin';
+/** GUI plugin package version. Importing this package registers the GUI runtime and native fallback theme. */
+export declare const version: string;