@hello-terrain/react 0.0.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +85 -0
  2. package/dist/index.cjs +603 -0
  3. package/dist/index.d.cts +63 -0
  4. package/dist/index.d.mts +63 -0
  5. package/dist/index.d.ts +63 -0
  6. package/dist/index.mjs +598 -0
  7. package/package.json +57 -0
package/dist/index.d.cts ADDED
@@ -0,0 +1,63 @@
1
+ import * as react_jsx_runtime from 'react/jsx-runtime';
2
+ import { ElevationCallback, Surface, TerrainGraph, TerrainTasks, TerrainQuery, TerrainRaycast } from '@hello-terrain/three';
3
+ import { Task } from '@hello-terrain/work';
4
+ import { ThreeElements, RootState } from '@react-three/fiber';
5
+ import { ReactNode } from 'react';
6
+ import { WebGPURenderer } from 'three/webgpu';
7
+ import { ShaderCallNodeInternal } from 'three/src/nodes/TSL.js';
8
+
9
+ type TerrainVector3Like = {
10
+ x: number;
11
+ y: number;
12
+ z: number;
13
+ };
14
+ type TerrainTask = Task<unknown, string, {
15
+ renderer: WebGPURenderer;
16
+ }>;
17
+ interface TerrainNodes {
18
+ positionNode: ShaderCallNodeInternal | null;
19
+ }
20
+ interface TerrainRuntime {
21
+ query: TerrainQuery | null;
22
+ raycast: TerrainRaycast | null;
23
+ }
24
+ interface TerrainHandle extends TerrainNodes {
25
+ graph: TerrainGraph;
26
+ tasks: TerrainTasks;
27
+ runtime: TerrainRuntime;
28
+ ready: boolean;
29
+ }
30
+ interface TerrainOptions {
31
+ rootSize?: number;
32
+ origin?: TerrainVector3Like;
33
+ maxLevel?: number;
34
+ maxNodes?: number;
35
+ innerTileSegments?: number;
36
+ skirtScale?: number;
37
+ elevationScale?: number;
38
+ elevation?: ElevationCallback;
39
+ surface?: Surface | null;
40
+ terrainFieldFilter?: "nearest" | "linear";
41
+ getCameraOrigin?: (state: RootState) => TerrainVector3Like;
42
+ cameraHysteresis?: number;
43
+ tasks?: readonly TerrainTask[];
44
+ }
45
+ type TerrainPrimitiveProps = Omit<ThreeElements["primitive"], "object" | "children">;
46
+ interface TerrainProps extends TerrainPrimitiveProps, TerrainOptions {
47
+ terrain?: TerrainHandle;
48
+ children: (nodes: TerrainNodes) => ReactNode;
49
+ }
50
+
51
+ declare function Terrain({ terrain: providedTerrain, children, rootSize, origin, maxLevel, innerTileSegments, skirtScale, elevationScale, elevation, surface, terrainFieldFilter, getCameraOrigin, cameraHysteresis, tasks, maxNodes, ...primitiveProps }: TerrainProps): react_jsx_runtime.JSX.Element;
52
+
53
+ interface TerrainProviderProps {
54
+ value: TerrainHandle;
55
+ children: ReactNode;
56
+ }
57
+ declare function TerrainProvider({ value, children }: TerrainProviderProps): react_jsx_runtime.JSX.Element;
58
+ declare function useTerrainContext(): TerrainHandle;
59
+
60
+ declare function useTerrain(options?: TerrainOptions): TerrainHandle;
61
+
62
+ export { Terrain, TerrainProvider, useTerrain, useTerrainContext };
63
+ export type { TerrainHandle, TerrainNodes, TerrainOptions, TerrainPrimitiveProps, TerrainProps, TerrainRuntime, TerrainTask, TerrainVector3Like };
package/dist/index.d.mts ADDED
@@ -0,0 +1,63 @@
1
+ import * as react_jsx_runtime from 'react/jsx-runtime';
2
+ import { ElevationCallback, Surface, TerrainGraph, TerrainTasks, TerrainQuery, TerrainRaycast } from '@hello-terrain/three';
3
+ import { Task } from '@hello-terrain/work';
4
+ import { ThreeElements, RootState } from '@react-three/fiber';
5
+ import { ReactNode } from 'react';
6
+ import { WebGPURenderer } from 'three/webgpu';
7
+ import { ShaderCallNodeInternal } from 'three/src/nodes/TSL.js';
8
+
9
+ type TerrainVector3Like = {
10
+ x: number;
11
+ y: number;
12
+ z: number;
13
+ };
14
+ type TerrainTask = Task<unknown, string, {
15
+ renderer: WebGPURenderer;
16
+ }>;
17
+ interface TerrainNodes {
18
+ positionNode: ShaderCallNodeInternal | null;
19
+ }
20
+ interface TerrainRuntime {
21
+ query: TerrainQuery | null;
22
+ raycast: TerrainRaycast | null;
23
+ }
24
+ interface TerrainHandle extends TerrainNodes {
25
+ graph: TerrainGraph;
26
+ tasks: TerrainTasks;
27
+ runtime: TerrainRuntime;
28
+ ready: boolean;
29
+ }
30
+ interface TerrainOptions {
31
+ rootSize?: number;
32
+ origin?: TerrainVector3Like;
33
+ maxLevel?: number;
34
+ maxNodes?: number;
35
+ innerTileSegments?: number;
36
+ skirtScale?: number;
37
+ elevationScale?: number;
38
+ elevation?: ElevationCallback;
39
+ surface?: Surface | null;
40
+ terrainFieldFilter?: "nearest" | "linear";
41
+ getCameraOrigin?: (state: RootState) => TerrainVector3Like;
42
+ cameraHysteresis?: number;
43
+ tasks?: readonly TerrainTask[];
44
+ }
45
+ type TerrainPrimitiveProps = Omit<ThreeElements["primitive"], "object" | "children">;
46
+ interface TerrainProps extends TerrainPrimitiveProps, TerrainOptions {
47
+ terrain?: TerrainHandle;
48
+ children: (nodes: TerrainNodes) => ReactNode;
49
+ }
50
+
51
+ declare function Terrain({ terrain: providedTerrain, children, rootSize, origin, maxLevel, innerTileSegments, skirtScale, elevationScale, elevation, surface, terrainFieldFilter, getCameraOrigin, cameraHysteresis, tasks, maxNodes, ...primitiveProps }: TerrainProps): react_jsx_runtime.JSX.Element;
52
+
53
+ interface TerrainProviderProps {
54
+ value: TerrainHandle;
55
+ children: ReactNode;
56
+ }
57
+ declare function TerrainProvider({ value, children }: TerrainProviderProps): react_jsx_runtime.JSX.Element;
58
+ declare function useTerrainContext(): TerrainHandle;
59
+
60
+ declare function useTerrain(options?: TerrainOptions): TerrainHandle;
61
+
62
+ export { Terrain, TerrainProvider, useTerrain, useTerrainContext };
63
+ export type { TerrainHandle, TerrainNodes, TerrainOptions, TerrainPrimitiveProps, TerrainProps, TerrainRuntime, TerrainTask, TerrainVector3Like };
package/dist/index.d.ts ADDED
@@ -0,0 +1,63 @@
1
+ import * as react_jsx_runtime from 'react/jsx-runtime';
2
+ import { ElevationCallback, Surface, TerrainGraph, TerrainTasks, TerrainQuery, TerrainRaycast } from '@hello-terrain/three';
3
+ import { Task } from '@hello-terrain/work';
4
+ import { ThreeElements, RootState } from '@react-three/fiber';
5
+ import { ReactNode } from 'react';
6
+ import { WebGPURenderer } from 'three/webgpu';
7
+ import { ShaderCallNodeInternal } from 'three/src/nodes/TSL.js';
8
+
9
+ type TerrainVector3Like = {
10
+ x: number;
11
+ y: number;
12
+ z: number;
13
+ };
14
+ type TerrainTask = Task<unknown, string, {
15
+ renderer: WebGPURenderer;
16
+ }>;
17
+ interface TerrainNodes {
18
+ positionNode: ShaderCallNodeInternal | null;
19
+ }
20
+ interface TerrainRuntime {
21
+ query: TerrainQuery | null;
22
+ raycast: TerrainRaycast | null;
23
+ }
24
+ interface TerrainHandle extends TerrainNodes {
25
+ graph: TerrainGraph;
26
+ tasks: TerrainTasks;
27
+ runtime: TerrainRuntime;
28
+ ready: boolean;
29
+ }
30
+ interface TerrainOptions {
31
+ rootSize?: number;
32
+ origin?: TerrainVector3Like;
33
+ maxLevel?: number;
34
+ maxNodes?: number;
35
+ innerTileSegments?: number;
36
+ skirtScale?: number;
37
+ elevationScale?: number;
38
+ elevation?: ElevationCallback;
39
+ surface?: Surface | null;
40
+ terrainFieldFilter?: "nearest" | "linear";
41
+ getCameraOrigin?: (state: RootState) => TerrainVector3Like;
42
+ cameraHysteresis?: number;
43
+ tasks?: readonly TerrainTask[];
44
+ }
45
+ type TerrainPrimitiveProps = Omit<ThreeElements["primitive"], "object" | "children">;
46
+ interface TerrainProps extends TerrainPrimitiveProps, TerrainOptions {
47
+ terrain?: TerrainHandle;
48
+ children: (nodes: TerrainNodes) => ReactNode;
49
+ }
50
+
51
+ declare function Terrain({ terrain: providedTerrain, children, rootSize, origin, maxLevel, innerTileSegments, skirtScale, elevationScale, elevation, surface, terrainFieldFilter, getCameraOrigin, cameraHysteresis, tasks, maxNodes, ...primitiveProps }: TerrainProps): react_jsx_runtime.JSX.Element;
52
+
53
+ interface TerrainProviderProps {
54
+ value: TerrainHandle;
55
+ children: ReactNode;
56
+ }
57
+ declare function TerrainProvider({ value, children }: TerrainProviderProps): react_jsx_runtime.JSX.Element;
58
+ declare function useTerrainContext(): TerrainHandle;
59
+
60
+ declare function useTerrain(options?: TerrainOptions): TerrainHandle;
61
+
62
+ export { Terrain, TerrainProvider, useTerrain, useTerrainContext };
63
+ export type { TerrainHandle, TerrainNodes, TerrainOptions, TerrainPrimitiveProps, TerrainProps, TerrainRuntime, TerrainTask, TerrainVector3Like };