@openheart/tavio-renderer 2.3.29-with-wasm → 2.4.0

package/build/esm/types/{src/editor → editor}/selector/boxSelector.d.ts

@@ -1,13 +1,14 @@
-import { PerspectiveCamera, Vector3, Ray, Quaternion, Euler } from 'three';
+import { PerspectiveCamera, Vector3, Ray } from 'three';
 import { Selector, iIntersection } from './selector';
+import { iVectorLike } from '../../viewer/types';
 export interface iBoxSelectorOption {
     width?: number;
     height?: number;
     depth?: number;
     segment?: number;
     color?: number;
-    position?: Vector3 | [number, number, number];
-    rotation?: Euler | Quaternion | [number, number, number];
+    position?: iVectorLike | [number, number, number];
+    rotation?: iVectorLike | [number, number, number];
     visible?: boolean;
 }
 /**

package/build/esm/types/module.d.ts

@@ -0,0 +1,7 @@
+import { Core } from './viewer/canvas';
+import { TavioError, tSelectionMode, tMaskSource, iLoadingOption, iViewerOption, iHeaderInfo, iDistanceInfo, iTransform, iVectorLike, tUniformPlainValue, tCustomDefines, tCustomUniformValue, tCustomUniforms } from './viewer/types';
+import { TAVIO_ERROR_CODE, SELECTION_MODE } from './viewer/constants';
+import { CHUNK_TARGET, SHADER_STAGE, iMaterialOption } from './viewer/materialGenerator';
+export { Core, TavioError, TAVIO_ERROR_CODE, SELECTION_MODE, CHUNK_TARGET, SHADER_STAGE, };
+export type { iMaterialOption, tSelectionMode, tMaskSource, iLoadingOption, iViewerOption, iHeaderInfo, iDistanceInfo, iTransform, iVectorLike, tUniformPlainValue, tCustomDefines, tCustomUniformValue, tCustomUniforms, };
+export default Core;

package/build/esm/types/viewer/canvas.d.ts

@@ -0,0 +1,233 @@
+import { default as EventEmitter } from 'eventemitter3';
+import { MeshStandardMaterialParameters } from 'three';
+import { iLatitudeLongitude } from '../camera/flightControls';
+import { WorkerElementAdapter } from './driver/workerElementAdapter';
+import { CameraPath } from '../camera/cameraPath';
+import { iVectorLike, iViewerOption, iViewerMaterialOption, iLoadingOption, iHeaderInfo, iTransform, iSelectorInfo, iPickingInfo, iCameraPathOption, iCameraParameter, tSelectionMode, tMaskSource, tControlsType, tCustomDefines, tCustomUniforms } from './types';
+import { iCollisionTarget } from '../worker/tavioWorker';
+import { iSphereSelectorOption } from '../editor/selector/sphereSelector';
+import { iBoxSelectorOption } from '../editor/selector/boxSelector';
+export declare class Core extends EventEmitter {
+    private driver;
+    static CHUNK_TARGET: {
+        readonly ANY: 0;
+        readonly ANY_SPLAT: 1;
+        readonly BASIC: 2;
+        readonly PICKING: 4;
+        readonly SHADOWING: 8;
+        readonly INDEX_SELECTION: 16;
+        readonly POINTS: 32;
+    };
+    static SHADER_STAGE: {
+        readonly VERTEX_PRECISION: 0;
+        readonly VERTEX_DECLARATION: 1;
+        readonly VERTEX_FUNCTION: 2;
+        readonly VERTEX_MAIN_BEGIN: 3;
+        readonly VERTEX_MAIN_TRANSFORM: 4;
+        readonly VERTEX_MAIN_CLIPPING: 5;
+        readonly VERTEX_MAIN_SIGMA: 6;
+        readonly VERTEX_MAIN_OUT: 7;
+        readonly VERTEX_MAIN_END: 8;
+        readonly FRAGMENT_PRECISION: 9;
+        readonly FRAGMENT_DECLARATION: 10;
+        readonly FRAGMENT_FUNCTION: 11;
+        readonly FRAGMENT_MAIN_BEGIN: 12;
+        readonly FRAGMENT_MAIN_IN: 13;
+        readonly FRAGMENT_MAIN_OUT: 14;
+        readonly FRAGMENT_MAIN_END: 15;
+    };
+    get canvas(): HTMLCanvasElement | OffscreenCanvas;
+    get viewerOption(): iViewerOption;
+    getElementAdapter(): HTMLCanvasElement | OffscreenCanvas | WorkerElementAdapter;
+    constructor(viewerOption?: iViewerOption);
+    init(canvas: HTMLCanvasElement | OffscreenCanvas, materialOption?: iViewerMaterialOption): void;
+    start(): void;
+    pause(): void;
+    resume(): void;
+    resize(width?: number, height?: number, start?: boolean): void;
+    dispose(): void;
+    addAmbientLight(color: number, intensity: number): void;
+    addSpotLight(position: iVectorLike, target: iVectorLike, color: number, intensity: number, distance: number, angle: number, penumbra: number, decay: number, castShadow?: boolean, isDebug?: boolean): void;
+    addWhiteCube(position?: iVectorLike, scale?: iVectorLike, receiveShadow?: boolean, materialOption?: MeshStandardMaterialParameters): void;
+    setAmbientLightIntensity(intensity: number): void;
+    setSpotLightPosition(position: iVectorLike): void;
+    setSpotLightTargetPosition(target: iVectorLike): void;
+    setSpotLightIntensity(intensity: number): void;
+    setSpotLightDistance(distance: number): void;
+    setSpotLightAngle(angle: number): void;
+    setSpotLightPenumbra(penumbra: number): void;
+    setSpotLightDecay(decay: number): void;
+    renderShadow(): void;
+    loadTavio(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    loadTavioWasm(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    loadPly(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    loadSplat(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    loadImage(name: string, source: string | Blob | ArrayBuffer | ImageBitmap, option?: iLoadingOption): Promise<void>;
+    loadCanvas(name: string, canvas: HTMLCanvasElement | OffscreenCanvas | ImageBitmap, option?: iLoadingOption): Promise<void>;
+    concatTavio(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    concatPly(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    concatSplat(name: string, source: string | Blob | ArrayBuffer, option?: iLoadingOption): Promise<void>;
+    concatImage(name: string, source: string | Blob | ArrayBuffer | ImageBitmap, option?: iLoadingOption): Promise<void>;
+    concatCanvas(name: string, canvas: HTMLCanvasElement | OffscreenCanvas | ImageBitmap, option?: iLoadingOption): Promise<void>;
+    saveSplatWasm(name: string, fileName?: string): Promise<any>;
+    savePlyWasm(name: string, fileName?: string): Promise<any>;
+    saveSpzWasm(name: string, fileName?: string): Promise<any>;
+    saveTavioWasm(name: string, fileName?: string, options?: any): Promise<any>;
+    exportTavioWasm(name: string, options?: any): Promise<any>;
+    addTavioMesh(name: string): void;
+    removeTavioMesh(name: string, renderViewName?: string | Symbol): void;
+    removeTavioMeshAllRenderView(name: string): void;
+    disposeTavioMesh(name: string): void;
+    setVisibilityTavioMesh(name: string, visibility: boolean): void;
+    setVisibilityPoints(name: string, visibility: boolean): void;
+    setBackgroundOpacity(opacity: number): void;
+    setBackgroundByTavioMesh(name: string): void;
+    getFirstMeshName(): Promise<string | null> | string | null;
+    createRenderView(name: string | Symbol): void;
+    setRenderView(name?: string | Symbol | null): void;
+    getCurrentRenderViewName(): Promise<string | null> | string | null;
+    getRenderViewCount(): Promise<number> | number;
+    setRenderViewSize(renderViewName?: string | Symbol, x?: number, y?: number, width?: number, height?: number, start?: boolean): void;
+    getWorldPositionByRenderView(x: number, y: number, isDebug?: boolean): Promise<iPickingInfo | null> | iPickingInfo | null;
+    setCustomDefines(defines: tCustomDefines): void;
+    setCustomUniforms(uniforms: tCustomUniforms): void;
+    setGaussianScale(scale: number): void;
+    setOpacityAdditive(opacity: number): void;
+    setOpacityMultiplier(multiplier: number): void;
+    setOpacityPoints(opacity: number): void;
+    setSphericalHarmonicsIntensity(intensity: number): void;
+    setUsingSphericalHarmonics(isUsing: boolean): void;
+    setColorBlur(blur: number): void;
+    setColorSharpness(sharpness: number): void;
+    setColorTemperature(temperature: number): void;
+    setColorTint(tint: number): void;
+    setColorContrast(contrast: number): void;
+    setHSVColor(hsv: iVectorLike): void;
+    setColorRGB(rgb: iVectorLike): void;
+    setClippingEnabled(enabled: boolean): void;
+    setClippingSphere(position: iVectorLike, scale: iVectorLike): void;
+    setOutsideClipPointSize(size: number): void;
+    setOutsideClipOpacity(opacity: number): void;
+    setEffectMinimumScale(value: number): void;
+    setEffectDistanceBase(value: number): void;
+    setEffectDistanceRange(value: number): void;
+    setWorldOrigin(x: number, y: number, z: number): void;
+    setEffectDistancePoints(value: number): void;
+    setEffectDistanceNearPoints(value: number): void;
+    setEffectSonar(value: number): void;
+    setEffectSonarRange(value: number): void;
+    startBloomPoints(duration?: number): void;
+    startDissolveToGaussian(duration?: number, backgroundFadeInDelay?: number, backgroundFadeInDuration?: number): void;
+    startSonarWave(duration?: number): void;
+    animatePath(name?: string, duration?: number): void;
+    startFadeInBackground(duration?: number): void;
+    startFadeOutBackground(duration?: number): void;
+    applyLocalTransformToSelected(name: string, translation: iVectorLike, rotation: iVectorLike, scale: iVectorLike): void;
+    resetLocalTransformOfSelected(name: string): void;
+    resetAllLocalTransforms(name: string): void;
+    setLocalTransformGizmoEnabled(enabled: boolean): void;
+    setLocalTransformGizmoMode(mode: "translate" | "rotate" | "scale"): void;
+    setDropShadow(enabled: boolean): void;
+    setModelTransform(name: string, translation: iVectorLike, rotation: iVectorLike, scale: number): void;
+    getModelTransform(name: string): Promise<iTransform | null> | iTransform | null;
+    setTransform(name: string, index: number, translation: iVectorLike, rotation: iVectorLike, scale: number): void;
+    getTransform(name: string, index: number): Promise<iTransform | null> | iTransform | null;
+    setBillboard(name: string, index: number, flag: boolean): void;
+    setCameraParameter(position?: number[] | iVectorLike, target?: number[] | iVectorLike, fov?: number): void;
+    getCameraParameter(): Promise<iCameraParameter> | iCameraParameter;
+    setCameraColliderEnabled(enabled: boolean): void;
+    setCameraColliderSelector(selectorNames?: string[]): void;
+    getCameraColliderEnabled(): Promise<boolean> | boolean;
+    setInteractiveMode(interactive: boolean): void;
+    getInteractiveMode(): Promise<boolean> | boolean;
+    setControlsType(controlsType: string): void;
+    getControlsType(): Promise<tControlsType> | tControlsType;
+    setControlsAttenuation(attenuation: number): void;
+    selectCameraPath(name: string): void;
+    updateCameraPath(time?: number): void;
+    createCameraPath(position: number[][] | iVectorLike[], target: number[][] | iVectorLike[], debug?: boolean): CameraPath | void;
+    addCameraPath(name: string, position: number[][] | iVectorLike[], target: number[][] | iVectorLike[], debug?: boolean): void;
+    removeCameraPath(name: string): void;
+    getPathNames(): Promise<string[]> | string[];
+    getActiveCameraPathName(): Promise<string | null> | string | null;
+    getCameraPathByTime(name?: string, time?: number): Promise<{
+        position: iVectorLike;
+        target: iVectorLike;
+    } | null> | {
+        position: iVectorLike;
+        target: iVectorLike;
+    } | null;
+    getCameraPathTime(): Promise<number> | number;
+    setCameraPathOption(option: iCameraPathOption): void;
+    setCameraPathCollisionRadius(radius: number): void;
+    setCameraPathInteraction(x: number, y: number): void;
+    setOrbitPointerDown(isDown: boolean): void;
+    setOrbitRelativeRotateLeft(value: number): void;
+    setOrbitRelativeRotateUp(value: number): void;
+    setOrbitRelativeTranslateLeft(value: number): void;
+    setOrbitRelativeTranslateUp(value: number): void;
+    setOrbitRelativeDollyOut(value: number): void;
+    getOrbitDistance(): Promise<number> | number;
+    setOrbitDistance(distance: number): void;
+    setOrbitRotation(pitch: number, yaw: number, isForce?: boolean): void;
+    setOrbitRelativeRotation(pitch: number, yaw: number): void;
+    setOrbitEnableZoom(enable: boolean): void;
+    setOrbitEnablePan(enable: boolean): void;
+    setOrbitEnableLimit(enable: boolean): void;
+    setOrbitEnableZoomLimit(enable: boolean): void;
+    setOrbitOverflow(value: number): void;
+    setOrbitUpLimit(value: number): void;
+    setOrbitDownLimit(value: number): void;
+    setOrbitLeftLimit(value: number): void;
+    setOrbitRightLimit(value: number): void;
+    setOrbitZoomInLimit(value: number): void;
+    setOrbitZoomOutLimit(value: number): void;
+    setOrbitCursorAutoDisplay(enabled: boolean): void;
+    isOrbitCursorAutoDisplayEnabled(): Promise<boolean> | boolean;
+    setOrbitCursorDisplay(enabled: boolean): void;
+    isOrbitCursorDisplay(): Promise<boolean> | boolean;
+    setAxisVisible(visible: boolean): void;
+    isAxisVisible(): Promise<boolean> | boolean;
+    setOrbitCursorScale(scale: number): void;
+    setTransferPosition(position: iVectorLike): void;
+    setTransferRelativePosition(position: iVectorLike, isForce?: boolean): void;
+    moveTransferByDirection(offset: iVectorLike, scale: number, isForce?: boolean): void;
+    moveTransferByHorizontalDirection(x: number, y: number, scale: number, isForce?: boolean): void;
+    moveTransferToTop(scale: number, isForce?: boolean): void;
+    moveTransferToBottom(scale: number, isForce?: boolean): void;
+    setTransferFov(fov: number): void;
+    getFlightParameter(): Promise<iLatitudeLongitude | null> | iLatitudeLongitude | null;
+    setFlightLongitude(longitude: number): void;
+    setFlightLatitude(latitude: number): void;
+    setFlightRelativeLatitude(latitude: number, isForce?: boolean): void;
+    setFlightRelativeLongitude(longitude: number, isForce?: boolean): void;
+    selectSplatByScreenArea(minX: number, minY: number, maxX: number, maxY: number, mode?: tSelectionMode, maskCanvas?: tMaskSource | {
+        width: number;
+        height: number;
+        data: ArrayBuffer;
+    }): void;
+    setFrameRateLimit(fps: number): void;
+    setDevicePixelRatio(value: number): void;
+    getDevicePixelRatio(): number | null;
+    getHeaderInfo(name: string): Promise<iHeaderInfo | null> | iHeaderInfo | null;
+    setCollisionReversed(reversed: boolean): void;
+    deleteSelectedGaussian(): void;
+    undoDeletedGaussian(): void;
+    resetDeletedGaussian(): void;
+    resetCollision(): void;
+    setCollision(collision: iCollisionTarget | iCollisionTarget[], mode?: tSelectionMode): void;
+    checkCollisionBySelector(name: string, mode?: tSelectionMode): void;
+    checkCollisionBySelectors(names: string[], mode?: tSelectionMode): void;
+    checkCollisionByAllSelectors(mode?: tSelectionMode): void;
+    getAllSelectorInfo(): Promise<iSelectorInfo[]> | iSelectorInfo[];
+    setSelectorVisible(name: string, visible: boolean): void;
+    setSelectorModeTranslate(name: string): void;
+    setSelectorModeScale(name: string): void;
+    setSelectorModeRotate(name: string): void;
+    setSelectorPosition(name: string, position: iVectorLike): void;
+    setSelectorRotation(name: string, rotation: iVectorLike): void;
+    setSelectorScale(name: string, scale: iVectorLike): void;
+    deleteSelector(name: string): void;
+    addSphereSelector(name: string, option?: iSphereSelectorOption): void;
+    addBoxSelector(name: string, option?: iBoxSelectorOption): void;
+}

package/build/esm/types/viewer/constants.d.ts

@@ -0,0 +1,99 @@
+import { Color, Quaternion } from 'three';
+export declare const DEBUG_MODE: boolean;
+/** カメラコントロールの OrbitControls */
+export declare const CONTROLS_TYPE_ORBIT: string;
+/** カメラコントロールの CameraPathControls */
+export declare const CONTROLS_TYPE_PATH: string;
+/** カメラコントロールの FlightControls */
+export declare const CONTROLS_TYPE_FLIGHT: string;
+/** カメラの画角 */
+export declare const PERSPECTIVE_FOV: number;
+/** カメラのニアクリップまでの距離 */
+export declare const PERSPECTIVE_NEAR: number;
+/** カメラのファークリップまでの距離 */
+export declare const PERSPECTIVE_FAR: number;
+/** カメラが配置される Z 軸上の位置 */
+export declare const PERSPECTIVE_POSITION_Z: number;
+/** エフェクト時におけるスプラットの最小スケールの基準値 */
+export declare const EFFECT_MINIMUM_SCALE: number;
+/** エフェクト時におけるスプラットの大きさが変化する範囲の係数 */
+export declare const EFFECT_DISTANCE_RANGE: number;
+/** カメラパスの可動領域（カプセル型）半径の既定値 */
+export declare const CAMERA_PATH_COLLISION_RADIUS: number;
+/** Y 軸を回転させ前後を反転させるクォータニオン */
+export declare const FLIP_Z_QUATERNION: Quaternion;
+/** 既定のクリアカラー */
+export declare const RENDERER_CLEAR_COLOR: Color;
+/** 既定のクリアアルファ */
+export declare const RENDERER_CLEAR_ALPHA: number;
+/** インデックス選択用オフスクリーンバッファの解像度縮小率（割る数） */
+export declare const INDEX_SELECTION_DIVISOR = 1;
+/** 球面調和関数のための交流成分（次数３＝１５）の要素数（RGB なので３倍） */
+export declare const SPHERICAL_HARMONICS_BASE_ELEMENT: number;
+/** 交流成分の次数を表す define の名称 */
+export declare const SPHERICAL_HARMONICS_DEGREES_DEFINE: string;
+/** テクスチャ生成の基準となる幅（worker と共通の値を使う必要がある点に注意） */
+export declare const TEXTURE_WIDTH_BASE: number;
+/** テクスチャ生成の基準となる幅（shader と共通の値を使う必要がある点に注意） */
+export declare const DEPTH_RENDER_TEXTURE_WIDTH_BASE: number;
+/** splat 形式におけるスプラット１つあたりのバイト数 */
+export declare const ROW_LENGTH_SPLAT: number;
+/** tavio 形式におけるスプラット１つあたりのバイト数（パディングを含む） */
+export declare const ROW_LENGTH_TAVIO: number;
+/** 深度焼き込み更新処理の判断基準となる、内積の結果の差（小さいほど更新頻度が上がる） */
+export declare const UPDATE_DEPTH_THRESHOLD = 0.005;
+/** 画像を 3DGS 化した際の各点に掛かるスケールの基本係数 */
+export declare const POINT_BASE_RADIUS: number;
+/** 背景用の全天球を含むかどうかを意味する特性フラグ名 */
+export declare const FEATURE_BACKGROUND_EXISTS: string;
+/** tavio 形式の特性フラグの意味リスト */
+export declare const FEATURE_BITS: string[];
+/**
+ * tavio 形式では内部のデータはファイル先頭のヘッダ部分と単数・複数のチャンクからなる
+ * チャンクの意味を表すインデックスは v2.1 と v2.2 で 0 番目と 1 番目が逆転した
+ * v2.1 では背景球はファイルの末尾にデータが配置されていたが、v2.2 では先頭に配置されている
+ * さらに、背景球のデータは tavio 形式では必須ではないため v2.2 では背景球がない場合がある
+ * 背景球がない場合、メイン被写体のデータが先頭に配置されるためこれらの条件分岐に注意すること
+ * 1. v2.1 で背景あり → メイン被写体はチャンク０、背景球がチャンク１
+ * 2. v2.1 で背景なし → メイン被写体がチャンク０にあり、チャンク１は存在しない
+ * 3. v2.2 で背景あり → メイン被写体はチャンク１、背景球がチャンク０
+ * 4. v2.2 で背景なし → メイン被写体がチャンク０にあり、チャンク１は存在しない
+ * 現状は checkMainObjectIndex() で妥当なインデックスを判定するようになっている
+ */
+/** tavio 形式の、チャンクの意味を表すインデックス */
+export declare const CHUNK_INDEX_BACKGROUND: number;
+export declare const CHUNK_INDEX_MAIN_OBJECT: number;
+export declare const CHUNK_INDEX_MAIN_OBJECT_NO_BACKGROUND: number;
+/** プロパティの種種を表すインデックス */
+export declare const PROPERTY_INDEX_POSITION: number;
+export declare const PROPERTY_INDEX_SH0: number;
+export declare const PROPERTY_INDEX_ALPHA: number;
+export declare const PROPERTY_INDEX_ROTATION: number;
+export declare const PROPERTY_INDEX_SCALE: number;
+export declare const PROPERTY_INDEX_SHN: number;
+/** 圧縮方式のインデックス */
+export declare const COMPRESSED_TYPE_NONE: number;
+export declare const COMPRESSED_TYPE_ZIP: number;
+export declare const COMPRESSED_TYPE_PNG: number;
+/** エラーコードの個別定数 */
+export declare const TAVIO_ERROR_CODE_FLOAT16_NOT_SUPPORTED: "E001";
+/**
+ * Tavio Viewer のエラーコード
+ */
+export declare const TAVIO_ERROR_CODE: {
+    /** Float16Array 未対応環境 */
+    readonly FLOAT16_NOT_SUPPORTED: "E001";
+};
+/** スプラットの個別選択モード定数 */
+export declare const SELECTION_MODE_REPLACE: "replace";
+export declare const SELECTION_MODE_ADD: "add";
+export declare const SELECTION_MODE_SUBTRACT: "subtract";
+/** スプラットの選択モード */
+export declare const SELECTION_MODE: {
+    /** 既存の選択状態をクリアして新規選択（上書き） */
+    readonly REPLACE: "replace";
+    /** 既存の選択状態に追加（論理和） */
+    readonly ADD: "add";
+    /** 既存の選択状態から除外（論理差） */
+    readonly SUBTRACT: "subtract";
+};