@react-three/fiber 8.0.0-alpha.0 → 8.0.0-beta-04

package/dist/declarations/src/core/store.d.ts

@@ -1,106 +1,117 @@
-import * as THREE from 'three';
-import * as React from 'react';
-import * as ReactThreeFiber from '../three-types';
-import { GetState, SetState, UseStore } from 'zustand';
-import { Instance, InstanceProps } from './renderer';
-import { DomEvent, EventManager, ThreeEvent } from './events';
-export interface Intersection extends THREE.Intersection {
-    eventObject: THREE.Object3D;
-}
-export declare type Subscription = {
-    ref: React.MutableRefObject<RenderCallback>;
-    priority: number;
-};
-export declare type Dpr = number | [min: number, max: number];
-export declare type Size = {
-    width: number;
-    height: number;
-};
-export declare type Viewport = Size & {
-    initialDpr: number;
-    dpr: number;
-    factor: number;
-    distance: number;
-    aspect: number;
-};
-export declare type Camera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
-export declare type Raycaster = THREE.Raycaster & {
-    enabled: boolean;
-    filter?: FilterFunction;
-    computeOffsets?: ComputeOffsetsFunction;
-};
-export declare type RenderCallback = (state: RootState, delta: number) => void;
-export declare type Performance = {
-    current: number;
-    min: number;
-    max: number;
-    debounce: number;
-    regress: () => void;
-};
-export declare const isRenderer: (def: THREE.WebGLRenderer) => def is THREE.WebGLRenderer;
-export declare const isOrthographicCamera: (def: THREE.Camera) => def is THREE.OrthographicCamera;
-export declare type InternalState = {
-    active: boolean;
-    priority: number;
-    frames: number;
-    lastProps: StoreProps;
-    interaction: THREE.Object3D[];
-    hovered: Map<string, DomEvent>;
-    subscribers: Subscription[];
-    capturedMap: Map<number, Map<THREE.Object3D, Intersection>>;
-    initialClick: [x: number, y: number];
-    initialHits: THREE.Object3D[];
-    subscribe: (callback: React.MutableRefObject<RenderCallback>, priority?: number) => () => void;
-};
-export declare type RootState = {
-    gl: THREE.WebGLRenderer;
-    scene: THREE.Scene;
-    camera: Camera;
-    controls: THREE.EventDispatcher | null;
-    raycaster: Raycaster;
-    mouse: THREE.Vector2;
-    clock: THREE.Clock;
-    vr: boolean;
-    linear: boolean;
-    flat: boolean;
-    frameloop: 'always' | 'demand' | 'never';
-    performance: Performance;
-    size: Size;
-    viewport: Viewport & {
-        getCurrentViewport: (camera?: Camera, target?: THREE.Vector3, size?: Size) => Omit<Viewport, 'dpr' | 'initialDpr'>;
-    };
-    set: SetState<RootState>;
-    get: GetState<RootState>;
-    invalidate: () => void;
-    advance: (timestamp: number, runGlobalEffects?: boolean) => void;
-    setSize: (width: number, height: number) => void;
-    setDpr: (dpr: Dpr) => void;
-    onPointerMissed?: (event: ThreeEvent<PointerEvent>) => void;
-    events: EventManager<any>;
-    internal: InternalState;
-};
-export declare type FilterFunction = (items: THREE.Intersection[], state: RootState) => THREE.Intersection[];
-export declare type ComputeOffsetsFunction = (event: any, state: RootState) => {
-    offsetX: number;
-    offsetY: number;
-};
-export declare type StoreProps = {
-    gl: THREE.WebGLRenderer;
-    size: Size;
-    vr?: boolean;
-    shadows?: boolean | Partial<THREE.WebGLShadowMap>;
-    linear?: boolean;
-    flat?: boolean;
-    orthographic?: boolean;
-    frameloop?: 'always' | 'demand' | 'never';
-    performance?: Partial<Omit<Performance, 'regress'>>;
-    dpr?: Dpr;
-    clock?: THREE.Clock;
-    raycaster?: Partial<Raycaster>;
-    camera?: Camera | Partial<ReactThreeFiber.Object3DNode<THREE.Camera, typeof THREE.Camera> & ReactThreeFiber.Object3DNode<THREE.PerspectiveCamera, typeof THREE.PerspectiveCamera> & ReactThreeFiber.Object3DNode<THREE.OrthographicCamera, typeof THREE.OrthographicCamera>>;
-    onPointerMissed?: (event: ThreeEvent<PointerEvent>) => void;
-};
-export declare type ApplyProps = (instance: Instance, newProps: InstanceProps, oldProps?: InstanceProps, accumulative?: boolean) => void;
-declare const context: React.Context<UseStore<RootState>>;
-declare const createStore: (applyProps: ApplyProps, invalidate: (state?: RootState | undefined) => void, advance: (timestamp: number, runGlobalEffects?: boolean | undefined, state?: RootState | undefined) => void, props: StoreProps) => UseStore<RootState>;
-export { createStore, context };
+import * as THREE from 'three';
+import * as React from 'react';
+import * as ReactThreeFiber from '../three-types';
+import { GetState, SetState, UseStore } from 'zustand';
+import { Instance, InstanceProps } from './renderer';
+import { DomEvent, EventManager, PointerCaptureTarget, ThreeEvent } from './events';
+export interface Intersection extends THREE.Intersection {
+    eventObject: THREE.Object3D;
+}
+export declare type Subscription = {
+    ref: React.MutableRefObject<RenderCallback>;
+    priority: number;
+};
+export declare type Dpr = number | [min: number, max: number];
+export declare type Size = {
+    width: number;
+    height: number;
+};
+export declare type Viewport = Size & {
+    initialDpr: number;
+    dpr: number;
+    factor: number;
+    distance: number;
+    aspect: number;
+};
+export declare type Camera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
+export declare type Raycaster = THREE.Raycaster & {
+    enabled: boolean;
+    filter?: FilterFunction;
+    computeOffsets?: ComputeOffsetsFunction;
+};
+export declare type RenderCallback = (state: RootState, delta: number) => void;
+export declare type Performance = {
+    current: number;
+    min: number;
+    max: number;
+    debounce: number;
+    regress: () => void;
+};
+export declare type Renderer = {
+    render: (scene: THREE.Scene, camera: THREE.Camera) => any;
+};
+export declare const isRenderer: (def: Renderer) => boolean;
+export declare const isOrthographicCamera: (def: THREE.Camera) => def is THREE.OrthographicCamera;
+export declare type InternalState = {
+    active: boolean;
+    priority: number;
+    frames: number;
+    lastProps: StoreProps;
+    lastEvent: React.MutableRefObject<DomEvent | null>;
+    interaction: THREE.Object3D[];
+    hovered: Map<string, ThreeEvent<DomEvent>>;
+    subscribers: Subscription[];
+    capturedMap: Map<number, Map<THREE.Object3D, PointerCaptureTarget>>;
+    initialClick: [x: number, y: number];
+    initialHits: THREE.Object3D[];
+    xr: {
+        connect: () => void;
+        disconnect: () => void;
+    };
+    subscribe: (callback: React.MutableRefObject<RenderCallback>, priority?: number) => () => void;
+};
+export declare type RootState = {
+    gl: THREE.WebGLRenderer;
+    scene: THREE.Scene;
+    camera: Camera & {
+        manual?: boolean;
+    };
+    controls: THREE.EventDispatcher | null;
+    raycaster: Raycaster;
+    mouse: THREE.Vector2;
+    clock: THREE.Clock;
+    linear: boolean;
+    flat: boolean;
+    frameloop: 'always' | 'demand' | 'never';
+    performance: Performance;
+    size: Size;
+    viewport: Viewport & {
+        getCurrentViewport: (camera?: Camera, target?: THREE.Vector3, size?: Size) => Omit<Viewport, 'dpr' | 'initialDpr'>;
+    };
+    set: SetState<RootState>;
+    get: GetState<RootState>;
+    invalidate: () => void;
+    advance: (timestamp: number, runGlobalEffects?: boolean) => void;
+    setSize: (width: number, height: number) => void;
+    setDpr: (dpr: Dpr) => void;
+    setFrameloop: (frameloop?: 'always' | 'demand' | 'never') => void;
+    onPointerMissed?: (event: MouseEvent) => void;
+    events: EventManager<any>;
+    internal: InternalState;
+};
+export declare type FilterFunction = (items: THREE.Intersection[], state: RootState) => THREE.Intersection[];
+export declare type ComputeOffsetsFunction = (event: any, state: RootState) => {
+    offsetX: number;
+    offsetY: number;
+};
+export declare type StoreProps = {
+    gl: THREE.WebGLRenderer;
+    size: Size;
+    shadows?: boolean | Partial<THREE.WebGLShadowMap>;
+    linear?: boolean;
+    flat?: boolean;
+    orthographic?: boolean;
+    frameloop?: 'always' | 'demand' | 'never';
+    performance?: Partial<Omit<Performance, 'regress'>>;
+    dpr?: Dpr;
+    clock?: THREE.Clock;
+    raycaster?: Partial<Raycaster>;
+    camera?: (Camera | Partial<ReactThreeFiber.Object3DNode<THREE.Camera, typeof THREE.Camera> & ReactThreeFiber.Object3DNode<THREE.PerspectiveCamera, typeof THREE.PerspectiveCamera> & ReactThreeFiber.Object3DNode<THREE.OrthographicCamera, typeof THREE.OrthographicCamera>>) & {
+        manual?: boolean;
+    };
+    onPointerMissed?: (event: MouseEvent) => void;
+};
+export declare type ApplyProps = (instance: Instance, newProps: InstanceProps) => void;
+declare const context: React.Context<UseStore<RootState>>;
+declare const createStore: (applyProps: ApplyProps, invalidate: (state?: RootState | undefined) => void, advance: (timestamp: number, runGlobalEffects?: boolean | undefined, state?: RootState | undefined) => void, props: StoreProps) => UseStore<RootState>;
+export { createStore, context };

package/dist/declarations/src/core/utils.d.ts

@@ -0,0 +1,50 @@
+import * as THREE from 'three';
+import { AttachType, Instance, InstanceProps, LocalState } from './renderer';
+import { Dpr } from './store';
+export declare const DEFAULT = "__default";
+export declare type DiffSet = {
+    memoized: {
+        [key: string]: any;
+    };
+    changes: [key: string, value: unknown, isEvent: boolean, keys: string[]][];
+};
+export declare const isDiffSet: (def: any) => def is DiffSet;
+export declare type ClassConstructor = {
+    new (): void;
+};
+export declare type ObjectMap = {
+    nodes: {
+        [name: string]: THREE.Object3D;
+    };
+    materials: {
+        [name: string]: THREE.Material;
+    };
+};
+export declare function calculateDpr(dpr: Dpr): number;
+export declare function filterKeys<TObj extends {
+    [key: string]: any;
+}, TOmit extends boolean, TKey extends keyof TObj>(obj: TObj, omit: TOmit, ...keys: TKey[]): TOmit extends true ? Omit<TObj, TKey> : Pick<TObj, TKey>;
+export declare const pick: <TObj>(obj: Partial<TObj>, keys: (keyof TObj)[]) => Pick<Partial<TObj>, keyof TObj>;
+export declare const omit: <TObj>(obj: Partial<TObj>, keys: (keyof TObj)[]) => Omit<Partial<TObj>, keyof TObj>;
+export declare const is: {
+    obj: (a: any) => boolean;
+    fun: (a: any) => a is Function;
+    str: (a: any) => a is string;
+    num: (a: any) => a is number;
+    und: (a: any) => boolean;
+    arr: (a: any) => boolean;
+    equ(a: any, b: any): boolean;
+};
+export declare function buildGraph(object: THREE.Object3D): ObjectMap;
+export declare function dispose<TObj extends {
+    dispose?: () => void;
+    type?: string;
+    [key: string]: any;
+}>(obj: TObj): void;
+export declare function prepare<T = THREE.Object3D>(object: T, state?: Partial<LocalState>): T;
+export declare function attach(parent: Instance, child: Instance, type: AttachType): void;
+export declare function detach(parent: Instance, child: Instance, type: AttachType): void;
+export declare function diffProps(instance: Instance, { children: cN, key: kN, ref: rN, ...props }: InstanceProps, { children: cP, key: kP, ref: rP, ...previous }?: InstanceProps, remove?: boolean): DiffSet;
+export declare function applyProps(instance: Instance, data: InstanceProps | DiffSet): void;
+export declare function invalidateInstance(instance: Instance): void;
+export declare function updateInstance(instance: Instance): void;

package/dist/declarations/src/index.d.ts

@@ -1,7 +1,10 @@
-export * from './three-types';
-import * as ReactThreeFiber from './three-types';
-export { ReactThreeFiber };
-export type { Intersection, Subscription, Dpr, Size, Viewport, Camera, RenderCallback, Performance, RootState, } from './core/store';
-export type { ThreeEvent, Events, EventManager } from './core/events';
-export type { Props } from './web/Canvas';
-export * from './web';
+export * from './three-types';
+import * as ReactThreeFiber from './three-types';
+export { ReactThreeFiber };
+export type { Intersection, Subscription, Dpr, Size, Viewport, Camera, RenderCallback, Performance, RootState, } from './core/store';
+export type { ThreeEvent, Events, EventManager } from './core/events';
+export type { ObjectMap } from './core/utils';
+export * from './core/hooks';
+export * from './web/Canvas';
+export { createPointerEvents as events } from './web/events';
+export * from './core';

package/dist/declarations/src/native/Canvas.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { View, ViewProps, ViewStyle } from 'react-native';
+import { UseStore } from 'zustand';
+import { RenderProps } from '../core';
+import { RootState } from '../core/store';
+import { EventManager } from '../core/events';
+export interface Props extends Omit<RenderProps<HTMLCanvasElement>, 'size' | 'events'>, ViewProps {
+    children: React.ReactNode;
+    fallback?: React.ReactNode;
+    style?: ViewStyle;
+    events?: (store: UseStore<RootState>) => EventManager<any>;
+}
+export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<View>>;

package/dist/declarations/src/native/events.d.ts

@@ -0,0 +1,5 @@
+import { UseStore } from 'zustand';
+import { RootState } from '../core/store';
+import { EventManager } from '../core/events';
+import { View } from 'react-native';
+export declare function createTouchEvents(store: UseStore<RootState>): EventManager<View>;

package/dist/declarations/src/native/hooks.d.ts

@@ -0,0 +1,9 @@
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { ObjectMap } from '../core/utils';
+import { Extensions, LoaderResult, BranchingReturn, useStore, useThree, useFrame, useGraph } from '../core/hooks';
+declare function useLoader<T, U extends string | string[]>(Proto: new () => LoaderResult<T>, input: U, extensions?: Extensions, onProgress?: (event: ProgressEvent<EventTarget>) => void): U extends any[] ? BranchingReturn<T, GLTF, GLTF & ObjectMap>[] : BranchingReturn<T, GLTF, GLTF & ObjectMap>;
+declare namespace useLoader {
+    var preload: <T, U extends string | string[]>(Proto: new () => LoaderResult<T>, input: U, extensions?: Extensions | undefined) => undefined;
+    var clear: <T, U extends string | string[]>(Proto: new () => LoaderResult<T>, input: U) => void;
+}
+export { useStore, useThree, useFrame, useGraph, useLoader };

package/dist/declarations/src/native.d.ts

@@ -0,0 +1,10 @@
+export * from './three-types';
+import * as ReactThreeFiber from './three-types';
+export { ReactThreeFiber };
+export type { Intersection, Subscription, Dpr, Size, Viewport, Camera, RenderCallback, Performance, RootState, } from './core/store';
+export type { ThreeEvent, Events, EventManager } from './core/events';
+export type { ObjectMap } from './core/utils';
+export * from './native/hooks';
+export * from './native/Canvas';
+export { createTouchEvents as events } from './native/events';
+export * from './core';