@fugood/bricks-ctor 2.25.0-beta.60 → 2.25.0-beta.61

package/types/bricks/Scene3D.d.ts

@@ -1,676 +0,0 @@
-/* Auto generated by build script
- *
- * 3D scene renderer powered by WebGPU/WebGL with declarative objects, lights, camera, controls, and a script hook (tvOS support is experimental)
- */
-import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
-import type { Data, DataLink } from '../data'
-import type { Animation, AnimationBasicEvents, AnimationOrGetter } from '../animation'
-import type {
-  Brick,
-  EventAction,
-  EventActionForItem,
-  ActionWithDataParams,
-  ActionWithParams,
-  Action,
-  EventProperty,
-} from '../common'
-import type { BrickBasicProperty, BrickBasicEvents, BrickBasicEventsForItem } from '../brick-base'
-import type { TemplateEventPropsMap } from '../../utils/event-props'
-
-/* Add an object to the scene */
-export type BrickScene3DActionAddObject = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_ADD_OBJECT'
-  params?: Array<
-    | {
-        input: 'objectId'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectType'
-        value?:
-          | 'gltf'
-          | 'usd'
-          | 'usdz'
-          | 'box'
-          | 'sphere'
-          | 'plane'
-          | 'cylinder'
-          | 'cone'
-          | 'torus'
-          | 'text'
-          | DataLink
-          | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectUrl'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectMd5'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectPosition'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectRotation'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectScale'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectColor'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Remove an object by id */
-export type BrickScene3DActionRemoveObject = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_REMOVE_OBJECT'
-  params?: Array<{
-    input: 'objectId'
-    value?: string | DataLink | EventProperty
-    mapping?: string
-  }>
-}
-
-/* Update an object's transform / appearance */
-export type BrickScene3DActionUpdateObject = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_UPDATE_OBJECT'
-  params?: Array<
-    | {
-        input: 'objectId'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectPosition'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectRotation'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectScale'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectVisible'
-        value?: boolean | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectColor'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'objectNodes'
-        value?: any | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Move the camera (optionally animated) */
-export type BrickScene3DActionSetCamera = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_SET_CAMERA'
-  params?: Array<
-    | {
-        input: 'cameraPosition'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'cameraTarget'
-        value?: any | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'cameraFov'
-        value?: number | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'cameraAnimateMs'
-        value?: number | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Aim the camera at an object */
-export type BrickScene3DActionLookAt = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_LOOK_AT'
-  params?: Array<{
-    input: 'objectId'
-    value?: string | DataLink | EventProperty
-    mapping?: string
-  }>
-}
-
-/* Play an animation clip on a gltf object */
-export type BrickScene3DActionPlayAnimation = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_PLAY_ANIMATION'
-  params?: Array<
-    | {
-        input: 'objectId'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'animationName'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'animationLoop'
-        value?: boolean | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'animationSpeed'
-        value?: number | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Stop an animation clip */
-export type BrickScene3DActionStopAnimation = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_STOP_ANIMATION'
-  params?: Array<
-    | {
-        input: 'objectId'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'animationName'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Replace the background (color or HDR image) */
-export type BrickScene3DActionSetBackground = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_SET_BACKGROUND'
-  params?: Array<
-    | {
-        input: 'backgroundColor'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'backgroundHdrUrl'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'backgroundMd5'
-        value?: string | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Toggle interaction controls at runtime */
-export type BrickScene3DActionSetControls = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_SET_CONTROLS'
-  params?: Array<
-    | {
-        input: 'controlsEnabled'
-        value?: boolean | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'controlsAutoRotate'
-        value?: boolean | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'controlsAutoRotateSpeed'
-        value?: number | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Capture a screenshot (file URI emitted to BRICK_SCENE_3D_LAST_SCREENSHOT_URI) */
-export type BrickScene3DActionScreenshot = ActionWithParams & {
-  __actionName: 'BRICK_SCENE_3D_SCREENSHOT'
-  params?: Array<
-    | {
-        input: 'screenshotFormat'
-        value?: 'png' | 'jpeg' | DataLink | EventProperty
-        mapping?: string
-      }
-    | {
-        input: 'screenshotQuality'
-        value?: number | DataLink | EventProperty
-        mapping?: string
-      }
-  >
-}
-
-/* Reset the scene back to the declared `objects` / `lights` / `camera` props */
-export type BrickScene3DActionReset = Action & {
-  __actionName: 'BRICK_SCENE_3D_RESET'
-}
-
-interface BrickScene3DDef {
-  /*
-Default property:
-{
-  "backend": "auto",
-  "antialias": true,
-  "alpha": false,
-  "shadows": false,
-  "toneMapping": "aces",
-  "exposure": 1,
-  "pixelRatio": 0,
-  "colorSpace": "srgb",
-  "powerPreference": "default",
-  "frameLoop": "always",
-  "cameraType": "perspective",
-  "cameraPosition": {
-    "x": 3,
-    "y": 3,
-    "z": 5
-  },
-  "cameraTarget": {
-    "x": 0,
-    "y": 0,
-    "z": 0
-  },
-  "fov": 50,
-  "near": 0.1,
-  "far": 1000,
-  "zoom": 1,
-  "controls": "none",
-  "autoRotate": false,
-  "autoRotateSpeed": 2,
-  "enableDamping": true,
-  "minDistance": 0.5,
-  "maxDistance": 50,
-  "minPolarAngle": 0,
-  "backgroundBlur": 0,
-  "backgroundIntensity": 1,
-  "envMapProjection": "equirect",
-  "envIntensity": 1,
-  "envRotation": 0,
-  "groundEnabled": false,
-  "groundColor": "",
-  "groundOpacity": 0.5,
-  "groundY": 0,
-  "groundSize": 100,
-  "ambientColor": "#ffffff",
-  "ambientIntensity": 0.4,
-  "lights": [],
-  "objects": [],
-  "bloom": false,
-  "bloomStrength": 0.6,
-  "bloomThreshold": 1,
-  "bloomRadius": 0.4,
-  "fxaa": false,
-  "ssao": false,
-  "frameRuntime": "ui",
-  "variables": {},
-  "eventScriptEvents": "none",
-  "eventScriptKeys": [],
-  "eventScriptKeyRepeat": false,
-  "eventScriptKeyRepeatInterval": 90,
-  "enableRaycast": false,
-  "emitFrameEvents": false,
-  "frameEventInterval": 250
-}
-  */
-  property?: BrickBasicProperty & {
-    /* Renderer backend. `auto` uses WebGPU when available and falls back to WebGL. */
-    backend?: 'auto' | 'webgpu' | 'webgl' | DataLink
-    /* Enable multi-sample antialiasing */
-    antialias?: boolean | DataLink
-    /* Render with a transparent canvas (alpha channel) */
-    alpha?: boolean | DataLink
-    /* Enable shadow mapping for lights and meshes */
-    shadows?: boolean | DataLink
-    /* Tone mapping curve */
-    toneMapping?: 'none' | 'linear' | 'reinhard' | 'cineon' | 'aces' | 'agx' | DataLink
-    /* Tone mapping exposure */
-    exposure?: number | DataLink
-    /* Render pixel ratio. `0` follows the device pixel ratio (capped at 2 on web; native renders at 1) */
-    pixelRatio?: number | DataLink
-    /* Output color space */
-    colorSpace?: 'srgb' | 'srgb-linear' | DataLink
-    /* GPU power preference */
-    powerPreference?: 'default' | 'high-performance' | 'low-power' | DataLink
-    /* Frame loop policy. `always` renders every frame; `whenVisible` pauses off-screen; `demand` renders only on prop change or invalidate */
-    frameLoop?: 'always' | 'whenVisible' | 'demand' | DataLink
-    /* Camera projection type */
-    cameraType?: 'perspective' | 'orthographic' | DataLink
-    /* Camera position in world space */
-    cameraPosition?:
-      | DataLink
-      | {
-          x?: number | DataLink
-          y?: number | DataLink
-          z?: number | DataLink
-        }
-    /* Point the camera looks at */
-    cameraTarget?:
-      | DataLink
-      | {
-          x?: number | DataLink
-          y?: number | DataLink
-          z?: number | DataLink
-        }
-    /* Field of view in degrees (perspective camera only) */
-    fov?: number | DataLink
-    /* Near clipping plane */
-    near?: number | DataLink
-    /* Far clipping plane */
-    far?: number | DataLink
-    /* Camera zoom factor */
-    zoom?: number | DataLink
-    /* Interaction controls */
-    controls?: 'none' | 'orbit' | 'pan-zoom' | DataLink
-    /* Auto-rotate the camera around the target */
-    autoRotate?: boolean | DataLink
-    /* Auto-rotate speed (units per second) */
-    autoRotateSpeed?: number | DataLink
-    /* Smooth interaction with damping */
-    enableDamping?: boolean | DataLink
-    /* Minimum dolly distance */
-    minDistance?: number | DataLink
-    /* Maximum dolly distance */
-    maxDistance?: number | DataLink
-    /* Minimum polar angle (radians) */
-    minPolarAngle?: number | DataLink
-    /* Maximum polar angle (radians) */
-    maxPolarAngle?: number | DataLink
-    /* Background solid color (used when no background image is set) */
-    backgroundColor?: string | DataLink
-    /* Equirect environment image URL (HDR/EXR/LDR). Used for PBR image-based lighting; also shown as the scene background unless `backgroundColor` is set */
-    backgroundImage?: string | DataLink
-    /* Background image blurriness (0–1, only when the environment image is shown as background) */
-    backgroundBlur?: number | DataLink
-    /* Background image intensity multiplier */
-    backgroundIntensity?: number | DataLink
-    /* Environment map projection. `none` disables environment lighting from the background image */
-    envMapProjection?: 'equirect' | 'cube' | 'none' | DataLink
-    /* Environment lighting intensity multiplier */
-    envIntensity?: number | DataLink
-    /* Environment rotation around the Y axis (radians, also rotates the background) */
-    envRotation?: number | DataLink
-    /* Fog color */
-    fogColor?: string | DataLink
-    /* Fog near distance */
-    fogNear?: number | DataLink
-    /* Fog far distance */
-    fogFar?: number | DataLink
-    /* Show a ground plane that catches shadows (enable `shadows` and a `castShadow` light for the shadow itself) */
-    groundEnabled?: boolean | DataLink
-    /* Ground color. Empty renders a shadow-only (invisible) catcher */
-    groundColor?: string | DataLink
-    /* Shadow opacity for the shadow-only ground (0–1) */
-    groundOpacity?: number | DataLink
-    /* Ground plane height (Y position) */
-    groundY?: number | DataLink
-    /* Ground plane size (width and depth) */
-    groundSize?: number | DataLink
-    /* Ambient light color */
-    ambientColor?: string | DataLink
-    /* Ambient light intensity */
-    ambientIntensity?: number | DataLink
-    /* Scene lights. Each entry: `{ type, color, intensity, position, target, castShadow, ... }` */
-    lights?:
-      | Array<
-          | DataLink
-          | {
-              type?: 'ambient' | 'directional' | 'point' | 'spot' | 'hemisphere' | DataLink
-              color?: string | DataLink
-              intensity?: number | DataLink
-              position?:
-                | DataLink
-                | {
-                    x?: number | DataLink
-                    y?: number | DataLink
-                    z?: number | DataLink
-                  }
-              target?:
-                | DataLink
-                | {
-                    x?: number | DataLink
-                    y?: number | DataLink
-                    z?: number | DataLink
-                  }
-              castShadow?: boolean | DataLink
-              distance?: number | DataLink
-              decay?: number | DataLink
-              angle?: number | DataLink
-              penumbra?: number | DataLink
-              groundColor?: string | DataLink
-            }
-        >
-      | DataLink
-    /* Scene objects. Each entry: `{ id, type, url?, md5?, position, rotation, scale, color?, animation?, visible, nodes? }`. `nodes` overrides named nodes inside a loaded model: `[{ name, visible?, position?, rotation?, scale?, color?, emissive?, emissiveIntensity?, metalness?, roughness?, opacity? }]` */
-    objects?:
-      | Array<
-          | DataLink
-          | {
-              id?: string | DataLink
-              type?:
-                | 'gltf'
-                | 'usd'
-                | 'usdz'
-                | 'box'
-                | 'sphere'
-                | 'plane'
-                | 'cylinder'
-                | 'cone'
-                | 'torus'
-                | 'text'
-                | DataLink
-              url?: string | DataLink
-              md5?: string | DataLink
-              position?:
-                | DataLink
-                | {
-                    x?: number | DataLink
-                    y?: number | DataLink
-                    z?: number | DataLink
-                  }
-              rotation?:
-                | DataLink
-                | {
-                    x?: number | DataLink
-                    y?: number | DataLink
-                    z?: number | DataLink
-                  }
-              scale?:
-                | DataLink
-                | {
-                    x?: number | DataLink
-                    y?: number | DataLink
-                    z?: number | DataLink
-                  }
-              color?: string | DataLink
-              text?: string | DataLink
-              animation?: string | DataLink
-              visible?: boolean | DataLink
-              castShadow?: boolean | DataLink
-              receiveShadow?: boolean | DataLink
-              nodes?:
-                | Array<
-                    | DataLink
-                    | {
-                        name?: string | DataLink
-                        visible?: boolean | DataLink
-                        position?:
-                          | DataLink
-                          | {
-                              x?: number | DataLink
-                              y?: number | DataLink
-                              z?: number | DataLink
-                            }
-                        rotation?:
-                          | DataLink
-                          | {
-                              x?: number | DataLink
-                              y?: number | DataLink
-                              z?: number | DataLink
-                            }
-                        scale?:
-                          | DataLink
-                          | {
-                              x?: number | DataLink
-                              y?: number | DataLink
-                              z?: number | DataLink
-                            }
-                        color?: string | DataLink
-                        emissive?: string | DataLink
-                        emissiveIntensity?: number | DataLink
-                        metalness?: number | DataLink
-                        roughness?: number | DataLink
-                        opacity?: number | DataLink
-                      }
-                  >
-                | DataLink
-            }
-        >
-      | DataLink
-    /* Enable bloom post-effect */
-    bloom?: boolean | DataLink
-    /* Bloom intensity */
-    bloomStrength?: number | DataLink
-    /* Bloom luminance threshold. The chain is HDR — values ≥ 1 keep bloom on highlights only */
-    bloomThreshold?: number | DataLink
-    /* Bloom radius (glow spread) */
-    bloomRadius?: number | DataLink
-    /* Enable FXAA antialiasing post-effect */
-    fxaa?: boolean | DataLink
-    /* Enable screen-space ambient occlusion (SSAO) */
-    ssao?: boolean | DataLink
-    /* Where the per-frame script runs. `ui` dispatches the data-op to reanimated's UI runtime via `runOnUI` (slightly less Promise overhead). `js` evaluates on the worklets-core thread via `runOnUIAsync` (Promise-resolved). Pick `js` if you don't have `react-native-reanimated` installed. */
-    frameRuntime?: 'js' | 'ui' | DataLink
-    /* JS expression or script. Pure expressions run on the worklet thread per frame (`time`, `dt`, `objects`, `camera`, `variables` are in scope). Statement-form scripts run once on mount via the JS sandbox. */
-    script?: string | DataLink
-    /* JS expression run when an enabled key or pointer event fires. It receives `event` / `input` plus `time`, `objects`, `camera`, and `variables`, and returns the same mutation map as `script`. */
-    eventScript?: string | DataLink
-    /* Object of values exposed to the inline `script` as `variables.<key>`. Updates re-flow into the script on the next frame. */
-    variables?: DataLink | {}
-    /* Which input events can run `eventScript`. `none` disables it; `all` enables key + pointer; `keys` and `pointer` enable only that input family. */
-    eventScriptEvents?: 'none' | 'all' | 'keys' | 'pointer' | DataLink
-    /* Optional key allowlist for `eventScript` (`pressedKey`, `code`, or `keyCode`). Empty means every key. */
-    eventScriptKeys?:
-      | string
-      | DataLink
-      | Array<string | DataLink | number | DataLink | DataLink>
-      | DataLink
-      | DataLink
-    /* Repeat `keydown` event scripts while an allowed key is held. Repeat events include `event.repeat === true`. */
-    eventScriptKeyRepeat?: boolean | DataLink
-    /* Interval in milliseconds for repeated key event scripts. */
-    eventScriptKeyRepeatInterval?: number | DataLink
-    /* Enable pointer raycast → emits `BRICK_SCENE_3D_ON_OBJECT_CLICK` / `_ON_OBJECT_HOVER` */
-    enableRaycast?: boolean | DataLink
-    /* Emit periodic `BRICK_SCENE_3D_ON_FRAME` events */
-    emitFrameEvents?: boolean | DataLink
-    /* Throttle interval for frame events (ms) */
-    frameEventInterval?: number | DataLink
-  }
-  events?: BrickBasicEvents & {
-    /* An asset finished loading (gltf/usd/usdz/hdr/texture) */
-    onLoad?: Array<EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onLoad']>>
-    /* An asset failed to load */
-    onLoadError?: Array<EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onLoadError']>>
-    /* Pointer click hit an object */
-    onObjectClick?: Array<
-      EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onObjectClick']>
-    >
-    /* Pointer hover entered or left an object */
-    onObjectHover?: Array<
-      EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onObjectHover']>
-    >
-    /* An animation clip finished */
-    onAnimationEnd?: Array<
-      EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onAnimationEnd']>
-    >
-    /* Periodic frame tick (throttled by `frameEventInterval`, gated by `emitFrameEvents`) */
-    onFrame?: Array<EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onFrame']>>
-    /* Inline `script` failed at compile, init, or per-frame execution */
-    onScriptError?: Array<
-      EventAction<string & keyof TemplateEventPropsMap['Scene3D']['onScriptError']>
-    >
-  }
-  outlets?: {
-    /* Latest frame rate (frames per second) */
-    fps?: () => Data<number>
-    /* Number of objects in the scene */
-    objectCount?: () => Data<number>
-    /* ID of the most recently selected object (via raycast click) */
-    selectedObjectId?: () => Data<string>
-    /* URI of the most recent screenshot */
-    lastScreenshotUri?: () => Data<string>
-    /* Snapshot of scene state (objects, camera, lights) */
-    sceneState?: () => Data<{
-      objects?: any[]
-      camera?: { [key: string]: any }
-      lights?: any[]
-      [key: string]: any
-    }>
-  }
-  animation?: AnimationBasicEvents & {
-    onLoad?: AnimationOrGetter
-    onLoadError?: AnimationOrGetter
-    onObjectClick?: AnimationOrGetter
-    onObjectHover?: AnimationOrGetter
-    onAnimationEnd?: AnimationOrGetter
-    onFrame?: AnimationOrGetter
-    onScriptError?: AnimationOrGetter
-  }
-}
-
-/* 3D scene renderer powered by WebGPU/WebGL with declarative objects, lights, camera, controls, and a script hook (tvOS support is experimental) */
-export type BrickScene3D = Brick &
-  BrickScene3DDef & {
-    templateKey: 'BRICK_SCENE_3D'
-    switches?: Array<
-      SwitchDef &
-        BrickScene3DDef & {
-          conds?: Array<{
-            method: '==' | '!=' | '>' | '<' | '>=' | '<='
-            cond:
-              | SwitchCondInnerStateCurrentCanvas
-              | SwitchCondData
-              | {
-                  __typename: 'SwitchCondInnerStateOutlet'
-                  outlet:
-                    | 'fps'
-                    | 'objectCount'
-                    | 'selectedObjectId'
-                    | 'lastScreenshotUri'
-                    | 'sceneState'
-                  value: any
-                }
-          }>
-        }
-    >
-  }