@pmndrs/uikit
Version:
Build performant 3D user interfaces with Three.js and yoga.
73 lines (72 loc) • 4.66 kB
TypeScript
import { YogaProperties } from '../flex/node.js';
import { ScrollbarProperties } from '../scroll.js';
import { WithAllAliases } from '../properties/alias.js';
import { PanelProperties } from '../panel/instanced-panel.js';
import { TransformProperties } from '../transform.js';
import { AllOptionalProperties, WithClasses, WithReactive } from '../properties/default.js';
import { ZIndexProperties } from '../order.js';
import { Signal } from '@preact/signals-core';
import { VisibilityProperties, WithConditionals } from './utils.js';
import { Listeners } from '../listeners.js';
import { ParentContext } from '../context.js';
import { PanelGroupProperties } from '../panel/instanced-panel-group.js';
import { PointerEventsProperties } from '../panel/index.js';
import { UpdateMatrixWorldProperties, EventHandlers, ThreeEventMap } from '../internals.js';
import { Object3D } from 'three';
export type InheritableContainerProperties = WithClasses<WithConditionals<WithAllAliases<WithReactive<YogaProperties & PanelProperties & ZIndexProperties & TransformProperties & ScrollbarProperties & PanelGroupProperties & VisibilityProperties & UpdateMatrixWorldProperties & PointerEventsProperties>>>>;
export type ContainerProperties<EM extends ThreeEventMap = ThreeEventMap> = InheritableContainerProperties & Listeners & EventHandlers<EM>;
export declare function createContainerState<EM extends ThreeEventMap = ThreeEventMap>(parentCtx: ParentContext, objectRef: {
current?: Object3D | null;
}, style: Signal<ContainerProperties<EM> | undefined>, properties: Signal<ContainerProperties<EM> | undefined>, defaultProperties: Signal<AllOptionalProperties | undefined>): {
node: Signal<import("../internals.js").FlexNode | undefined>;
size: Signal<import("three").Vector2Tuple | undefined>;
relativeCenter: Signal<import("three").Vector2Tuple | undefined>;
borderInset: Signal<import("../internals.js").Inset | undefined>;
overflow: Signal<import("yoga-layout/load").Overflow>;
displayed: Signal<boolean>;
scrollable: Signal<[boolean, boolean]>;
paddingInset: Signal<import("../internals.js").Inset | undefined>;
maxScrollPosition: Signal<[(number | undefined)?, (number | undefined)?]>;
} & {
scrollState: {
downPointerMap: Map<number, {
type: "scroll-bar";
localPoint: import("three").Vector3;
axisIndex: number;
} | {
type: "scroll-panel";
localPoint: import("three").Vector3;
timestamp: number;
}>;
scrollVelocity: import("three").Vector2;
};
scrollbarWidth: Signal<number>;
mergedProperties: import("@preact/signals-core").ReadonlySignal<import("../internals.js").MergedProperties>;
transformMatrix: Signal<import("three").Matrix4 | undefined>;
hoveredList: Signal<number[]>;
defaultProperties: {
pointerEvents: Signal<"auto" | "none" | "listener" | undefined>;
pointerEventsOrder: Signal<number | undefined>;
pointerEventsType: Signal<import("../internals.js").AllowedPointerEventsType | undefined>;
renderOrder: Signal<number>;
depthTest: Signal<boolean>;
depthWrite: Signal<boolean>;
};
globalMatrix: Signal<import("three").Matrix4 | undefined>;
isClipped: Signal<boolean>;
isVisible: import("@preact/signals-core").ReadonlySignal<boolean>;
scrollPosition: Signal<import("three").Vector2Tuple>;
groupDeps: import("@preact/signals-core").ReadonlySignal<Required<PanelGroupProperties>>;
orderInfo: Signal<import("../order.js").OrderInfo | undefined>;
anyAncestorScrollable: import("@preact/signals-core").ReadonlySignal<readonly [boolean, boolean]>;
clippingRect: Signal<import("../clipping.js").ClippingRect | undefined>;
childrenMatrix: import("@preact/signals-core").ReadonlySignal<import("three").Matrix4 | undefined>;
root: import("../context.js").RootContext;
} & {
interactionPanel: import("three").Mesh<import("three").PlaneGeometry, import("three").Material | import("three").Material[], import("three").Object3DEventMap> & {
boundingSphere: import("three").Sphere;
};
handlers: import("@preact/signals-core").ReadonlySignal<EventHandlers>;
ancestorsHaveListeners: import("@preact/signals-core").ReadonlySignal<boolean>;
};
export declare function setupContainer<EM extends ThreeEventMap = ThreeEventMap>(state: ReturnType<typeof createContainerState>, parentCtx: ParentContext, style: Signal<ContainerProperties<EM> | undefined>, properties: Signal<ContainerProperties<EM> | undefined>, object: Object3D, childrenContainer: Object3D, abortSignal: AbortSignal): void;