@openheart/tavio-renderer 2.3.8-with-wasm → 2.3.9-with-wasm

package/build/esm/types/animation/animationController.d.ts

@@ -115,7 +115,7 @@ export declare class AnimationController extends EventEmitter {
      */
     bloomPoints(duration: number): void;
     /**
-     * 点描画からガウシアンへの溶解効果をアニメーションする
+     * 点描画からスプラットへの溶解効果をアニメーションする
      * @param duration - アニメーションの継続時間（ミリ秒）
      */
     dissolveToGaussian(duration: number): void;

package/build/esm/types/editor/selector/boxSelector.d.ts

@@ -11,7 +11,7 @@ export interface iBoxSelectorOption {
     visible?: boolean;
 }
 /**
- * 3D ガウシアンを選択するための box インターフェースを提供する
+ * スプラットを選択するための box インターフェースを提供する
  * @class
  */
 export declare class BoxSelector extends Selector {

package/build/esm/types/editor/selector/selector.d.ts

@@ -26,7 +26,7 @@ export interface iIntersection {
     exit: iIntersectionData;
 }
 /**
- * 3D ガウシアンを選択するためのインターフェースを提供する基底クラス
+ * スプラットを選択するためのインターフェースを提供する基底クラス
  * @class
  */
 export declare abstract class Selector extends EventEmitter {

package/build/esm/types/editor/selector/sphereSelector.d.ts

@@ -6,7 +6,7 @@ export interface iSphereSelectorOption {
     color?: number;
 }
 /**
- * 3D ガウシアンを選択するための sphere インターフェースを提供する
+ * スプラットを選択するための sphere インターフェースを提供する
  * @class
  */
 export declare class SphereSelector extends Selector {

package/build/esm/types/utility/console.d.ts

@@ -1,6 +1,7 @@
 export declare class ConsoleOutput {
     label: string;
-    constructor(label?: string);
+    enable: boolean;
+    constructor(label?: string, enable?: boolean);
     log(out: any): void;
     warn(out: any): void;
 }

package/build/esm/types/utility/plyDecoder.d.ts

@@ -15,6 +15,7 @@ export interface iPlyData {
 export interface iSplatData {
     splatBuffer: ArrayBufferLike;
     sphericalHarmonicsBuffer: Float32Array;
+    sphericalHarmonicsDegrees: number;
 }
 export interface iTavioData extends iSplatData {
     position: Float32Array;
@@ -40,6 +41,11 @@ export declare class PlyDecoder {
     static ROW_LENGTH_TAVIO: number;
     /** 球面調和関数の交流成分の数 */
     static SPHERICAL_HARMONICS_BASE_ELEMENT: number;
+    /** 交流成分の次数に対する要素の数 */
+    static SH_DEGREES1: number;
+    static SH_DEGREES2: number;
+    static SH_DEGREES3: number;
+    static SH_DEGREES: number[];
     /** 直流成分の係数 */
     static SH_C0: number;
     /** .ply のプロパティのデータタイプと対応付けを行うためのデータ構造 */
@@ -89,8 +95,8 @@ export declare class PlyDecoder {
     /**
      * ply データから tavio および球面調和関数の交流成分のデータを生成する
      * @param data - ヘッダ情報（decodeHeader の戻り値）
-     * @param start - 対象の 3D ガウシアンの開始インデックス
-     * @param end - 対象の 3D ガウシアンの終了インデックス
+     * @param start - 対象のスプラットの開始インデックス
+     * @param end - 対象のスプラットの終了インデックス
      */
     static createTavio(data: iPlyData): iTavioData;
 }

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

@@ -1,13 +1,10 @@
-import { Euler, Group, Matrix4, PerspectiveCamera, Quaternion, RawShaderMaterial, Scene, Vector3, WebGLRenderTarget, WebGLRenderer, PMREMGenerator } from 'three';
+import { Euler, Matrix4, RawShaderMaterial, Vector3, WebGLRenderTarget, WebGLRenderer, PMREMGenerator } from 'three';
 import { default as EventEmitter } from 'eventemitter3';
 import { iCollisionTarget } from '../worker/tavioWorker';
 import { CameraPath } from '../camera/cameraPath';
 import { CameraPathControls } from '../camera/cameraPathControls';
-import { CameraPathManager } from '../camera/cameraPathManager';
 import { FlightControls, iLatitudeLongitude } from '../camera/flightControls';
-import { TransferControls } from '../camera/transferControls';
 import { OrbitControls } from '../camera/orbitControls';
-import { CameraCollider } from '../camera/cameraCollider';
 import { ConsoleOutput } from '../utility/console';
 import { iSphereSelectorOption } from '../editor/selector/sphereSelector';
 import { iBoxSelectorOption } from '../editor/selector/boxSelector';
@@ -15,6 +12,7 @@ import { Selector } from '../editor/selector/selector';
 import { TavioMesh } from './tavioMesh';
 import { iAnimationConfig } from '../animation/animationController';
 import { iMaterialOption } from './materialGenerator';
+import { RenderView } from './renderView';
 /**
  * Tavio Viewer のエラーコード
  */
@@ -33,11 +31,11 @@ export declare class TavioError extends Error {
 /**
  * カメラコントロールの種類
  */
-type tControlsType = "orbit" | "path" | "flight";
+export type tControlsType = "orbit" | "path" | "flight";
 /**
  * カメラコントロールの型チェック用定義
  */
-type tControlInstance = OrbitControls | CameraPathControls | FlightControls;
+export type tControlInstance = OrbitControls | CameraPathControls | FlightControls;
 /**
  * Vector3 と同様に外部データを扱うための型定義
  */
@@ -49,7 +47,7 @@ export interface iVectorLike {
 /**
  * カメラパスコントロールのオプション
  */
-interface iCameraPathOption {
+export interface iCameraPathOption {
     attenuation?: number;
     scaleX?: number;
     scaleY?: number;
@@ -118,6 +116,8 @@ interface iSelectorInfo {
  */
 export interface iLoadingOption {
     useSphericalHarmonics?: boolean;
+    autoInsert?: boolean;
+    autoBackground?: boolean;
 }
 /**
  * ファイル内に含まれる 3DGS の原点からの距離と割合
@@ -161,51 +161,26 @@ export declare class Core extends EventEmitter {
     gl: WebGL2RenderingContext;
     uniforms: any;
     viewerOption: iViewerOption;
+    defaultRenderViewSymbol: Symbol;
+    renderViewMap: Map<Symbol | string, RenderView>;
+    currentRenderViewName: Symbol | string;
+    currentRenderView: RenderView;
     meshMap: Map<string, TavioMesh>;
-    controlsMap: Map<string, tControlInstance>;
-    enableControlsMap: Map<string, boolean>;
-    currentControlsType: tControlsType;
-    transferControls: TransferControls;
     selectorMap: Map<string, Selector>;
     cameraColliderEnabled: boolean;
-    cameraCollider: CameraCollider;
-    cameraPathCollisionRadius: number;
-    cameraPathManager: CameraPathManager;
     reversedCollision: boolean;
-    previousPosition: Vector3;
-    previousRotation: Quaternion;
-    previousFov: number;
     maxDistance: number;
     isInteractive: boolean;
     isRendering: boolean;
     startRendering: number;
-    isDown: boolean;
-    isWheel: boolean;
     isLoading: boolean;
-    onPointerDown: (evt: PointerEvent) => void;
-    onPointerUp: (evt: PointerEvent) => void;
-    onWheel: (evt: WheelEvent) => void;
     renderer: WebGLRenderer;
-    scene: Scene;
     pmremGenerator: PMREMGenerator;
-    gaussianGroup: Group;
-    meshGroup: Group;
-    interfaceGroup: Group;
-    perspectiveCamera: PerspectiveCamera;
     gaussianMaterial: RawShaderMaterial;
     gaussianPickingMaterial: RawShaderMaterial;
     pickingRenderTarget: WebGLRenderTarget;
-    pickingScene: Scene;
     parameters: any;
     console: ConsoleOutput;
-    consoleOutput: boolean;
-    private orbitCursor;
-    private orbitCursorMaterial;
-    private orbitCursorGeometry;
-    private orbitCursorEnabled;
-    private orbitCursorHorizontal;
-    private orbitCursorCenter;
-    private previousOrbitTarget;
     private animationController;
     private pathAnimationLocked;
     /**
@@ -240,7 +215,6 @@ export declare class Core extends EventEmitter {
         readonly FRAGMENT_MAIN_BEGIN: 11;
         readonly FRAGMENT_MAIN_IN: 12;
         readonly FRAGMENT_MAIN_OUT: 13;
-        /** Float16Array 未対応環境 */
         readonly FRAGMENT_MAIN_END: 14;
     };
     /**
@@ -267,34 +241,44 @@ export declare class Core extends EventEmitter {
      */
     init(canvas: HTMLCanvasElement, materialOption?: iViewerMaterialOption): void;
     /**
-     * マテリアルをセットアップする
-     * @param option - シェーダチャンクなどの情報を含むマテリアルオプション
+     * レンダービューをセットアップする
      */
-    setupMaterial(option?: iViewerMaterialOption): void;
+    setupRenderView(): void;
     /**
      * カメラコントロール・カメラコライダーをセットアップする
+     * @param renderView - セットアップの対象となるレンダービュー
      */
-    setupControls(): void;
+    setupControls(renderView: RenderView): void;
     /**
      * OrbitControls をセットアップする
+     * @param renderView - セットアップの対象となるレンダービュー
      */
-    setupOrbitControls(): void;
+    setupOrbitControls(renderView: RenderView): void;
     /**
      * CameraPathControls をセットアップする
+     * @param renderView - セットアップの対象となるレンダービュー
      */
-    setupCameraPathControls(): void;
+    setupCameraPathControls(renderView: RenderView): void;
     /**
      * FlightControls をセットアップする
+     * @param renderView - セットアップの対象となるレンダービュー
      */
-    setupFlightControls(): void;
+    setupFlightControls(renderView: RenderView): void;
     /**
      * TransferControls をセットアップする
+     * @param renderView - セットアップの対象となるレンダービュー
      */
-    setupTransferControls(): void;
+    setupTransferControls(renderView: RenderView): void;
     /**
      * CameraCollider をセットアップする
+     * @param renderView - セットアップの対象となるレンダービュー
+     */
+    setupCameraCollider(renderView: RenderView): void;
+    /**
+     * マテリアルをセットアップする
+     * @param option - シェーダチャンクなどの情報を含むマテリアルオプション
      */
-    setupCameraCollider(): void;
+    setupMaterial(option?: iViewerMaterialOption): void;
     /**
      * セレクターをセットアップする
      */
@@ -316,12 +300,14 @@ export declare class Core extends EventEmitter {
      * TavioMesh を生成しロード前の共通処理を行う
      * @private
      * @param name - このメッシュの固有名
+     * @param option - ロード・パース関連のオプション
      */
     private _beforeLoadMesh;
     /**
      * TavioMesh のロード後の共通処理を行う
      * @private
      * @param name - 設定する名前
+     * @param option - ロード・パース関連のオプション
      */
     private _afterLoadMesh;
     /**
@@ -356,38 +342,44 @@ export declare class Core extends EventEmitter {
      * TavioMesh のインスタンスを生成し splat 形式のリソースをロード、シーンに追加する
      * @param name - このメッシュの固有名
      * @param url - 読み込む .splat ファイル
+     * @param option - ロード・パース関連のオプション
      */
-    loadSplat(name: string, url: string): Promise<void>;
+    loadSplat(name: string, url: string, option?: iLoadingOption): Promise<void>;
     /**
      * 既存の TavioMesh のインスタンスにデータを統合する
      * @param name - このメッシュの固有名
      * @param url - 読み込む .splat ファイル
+     * @param option - ロード・パース関連のオプション
      */
-    concatSplat(name: string, url: string): Promise<void>;
+    concatSplat(name: string, url: string, option?: iLoadingOption): Promise<void>;
     /**
      * TavioMesh のインスタンスを生成し画像形式のリソースをロード、シーンに追加する
      * @param name - このメッシュの固有名
      * @param url - 読み込む画像ファイル
+     * @param option - ロード・パース関連のオプション
      */
-    loadImage(name: string, url: string): Promise<void>;
+    loadImage(name: string, url: string, option?: iLoadingOption): Promise<void>;
     /**
      * 既存の TavioMesh のインスタンスにデータを統合する
      * @param name - このメッシュの固有名
      * @param url - 読み込む画像ファイル
+     * @param option - ロード・パース関連のオプション
      */
-    concatImage(name: string, url: string): Promise<void>;
+    concatImage(name: string, url: string, option?: iLoadingOption): Promise<void>;
     /**
      * canvas 要素から TavioMesh のインスタンスを生成し、シーンに追加する
      * @param name - このメッシュの固有名
      * @param canvas - 処理の対象となる canvas 要素
+     * @param option - ロード・パース関連のオプション
      */
-    loadCanvas(name: string, canvas: HTMLCanvasElement): Promise<void>;
+    loadCanvas(name: string, canvas: HTMLCanvasElement, option?: iLoadingOption): Promise<void>;
     /**
      * 既存の TavioMesh のインスタンスにデータを統合する
      * @param name - このメッシュの固有名
      * @param canvas - 処理の対象となる canvas 要素
+     * @param option - ロード・パース関連のオプション
      */
-    concatCanvas(name: string, canvas: HTMLCanvasElement): Promise<void>;
+    concatCanvas(name: string, canvas: HTMLCanvasElement, option?: iLoadingOption): Promise<void>;
     /**
      * tavio 形式のリソースをロードする
      * @param name - このメッシュの固有名
@@ -443,15 +435,21 @@ export declare class Core extends EventEmitter {
      */
     saveSpzWasm(name: string, fileName: string): Promise<void>;
     /**
-     * 名前を指定してロード済み TavioMesh をシーンに追加する
+     * 名前を指定してロード済み TavioMesh を現在のレンダービューに追加する
      * @param name - 対象の名前
      */
-    addTavioMesh(name: string): Promise<void>;
+    addTavioMesh(name: string): void;
     /**
      * 名前を指定してロード済み TavioMesh をシーンから取り除く
      * @param name - 対象の名前
+     * @param renderViewName - 対象となるレンダービューの名前
      */
-    removeTavioMesh(name: string): Promise<void>;
+    removeTavioMesh(name: string, renderViewName?: string | Symbol): void;
+    /**
+     * 名前を指定してロード済み TavioMesh をシーンから取り除く
+     * @param name - 対象の名前
+     */
+    removeTavioMeshAllRenderView(name: string): void;
     /**
      * 名前を指定して TavioMesh を削除・解放する
      * @param name - 対象の名前
@@ -462,7 +460,7 @@ export declare class Core extends EventEmitter {
      * @param name - 対象の名前
      * @param visibility - 可視状態
      */
-    setVisibilityTavioMesh(name: string, visibility: boolean): Promise<void>;
+    setVisibilityTavioMesh(name: string, visibility: boolean): void;
     /**
      * 名前を指定して TavioMesh の点描画用 Points の表示・非表示を設定する
      * @param name - 対象の名前
@@ -474,6 +472,11 @@ export declare class Core extends EventEmitter {
      * @param opacity - 透明度
      */
     setBackgroundOpacity(opacity: number): void;
+    /**
+     * 名前を指定してロード済み TavioMesh から背景を設定する
+     * @param name - 対象の名前
+     */
+    setBackgroundByTavioMesh(name: string): void;
     /**
      * 名前を指定した TavioMesh に含まれるインスタンスを、インデックスで指定して動かす
      * ※ここでいうインデックスとは load/concat した順番を意味する整数値（concat していない場合常に 0）
@@ -554,7 +557,7 @@ export declare class Core extends EventEmitter {
      * @param y - 取得する Y 座標（スクリーン空間を -1.0 ～ 1.0 に正規化した座標, Y-down）
      * @param isDebug - デバッグモード（有効化するとピッキングバッファを可視化）
      */
-    getWorldPositionByScreen(x: number, y: number, isDebug?: boolean): Promise<iPickingInfo>;
+    getWorldPositionByRenderView(x: number, y: number, isDebug?: boolean): Promise<iPickingInfo>;
     /**
      * 各種リソースを解放する
      * ※このメソッドを呼び出すと、それまで利用していた canvas は再利用できなくなる
@@ -563,7 +566,7 @@ export declare class Core extends EventEmitter {
     dispose(): void;
     /**
      * ビューポートの情報を uniform 変数に設定する
-     * @private
+     * @param renderView - 対象となるレンダービュー
      */
     private _updateViewportUniforms;
     /**
@@ -571,6 +574,51 @@ export declare class Core extends EventEmitter {
      * @param isForce - 強制的に実行するかどうか
      */
     private _renderDepthRenderTarget;
+    /**
+     * ==========================================================================
+     * renderview
+     * ==========================================================================
+     */
+    /**
+     * レンダービューを設定する
+     * @param renderViewName - 対象となるレンダービューの名前
+     */
+    setRenderView(renderViewName: string | Symbol | null): void;
+    /**
+     * レンダービューの個数を返す
+     */
+    getRenderViewCount(): number;
+    /**
+     * アクティブなレンダービューの名前を返す
+     * ※既定のレンダービューがアクティブな場合 null が返る
+     */
+    getCurrentRenderViewName(): string | null;
+    /**
+     * レンダービューを生成する（生成したインスタンスを呼び出し元に返さない）
+     * @param name - 生成されるレンダービューの固有名
+     */
+    createRenderView(name: string): void;
+    /**
+     * レンダービューに位置とサイズを設定する
+     * ※原点が左下角である点に注意（スクリーン座標系と上下が逆）
+     * @param renderViewName - 対象となるレンダービューの名前
+     * @param x - 矩形の左下角の横位置
+     * @param y - 矩形の左下角の縦位置
+     * @param width - 幅
+     * @param height - 高さ
+     * @param start - 同時に描画を開始するかどうか
+     */
+    setRenderViewSize(renderViewName?: string | Symbol | null, x?: number, y?: number, width?: number, height?: number, start?: boolean): void;
+    /**
+     * レンダービューを生成し、各種コントロールのセットアップも同時に行う
+     * @param name - 生成されるレンダービューの固有名
+     */
+    private _createRenderView;
+    /**
+     * 名前を指定してレンダービューを取得する
+     * @param renderViewName - 対象となるレンダービューの名前
+     */
+    private _getRenderView;
     /**
      * ==========================================================================
      * camera
@@ -587,7 +635,7 @@ export declare class Core extends EventEmitter {
      * @param target - 設定する注視点
      * @param fov - 設定する視野角
      */
-    setCameraParameter(position: iVectorLike | null, target?: iVectorLike | null, fov?: number | null): void;
+    setCameraParameter(position?: iVectorLike | null, target?: iVectorLike | null, fov?: number | null): void;
     /**
      * ==========================================================================
      * controls
@@ -888,28 +936,33 @@ export declare class Core extends EventEmitter {
      * @param uniforms - 設定する値を定義したオブジェクト
      */
     private _setPointUniforms;
+    /**
+     * MaterialGenerator で独自に拡張した defines を更新する
+     * @param customUniforms - 設定・更新する defines
+     */
+    setCustomDefines(customDefines: any): void;
     /**
      * MaterialGenerator で独自に拡張した uniform 変数を更新する
      * @param customUniforms - 設定・更新する uniform 変数
      */
     setCustomUniforms(customUniforms: any): void;
     /**
-     * ガウシアンの大きさの基本係数を設定する
+     * スプラットの大きさの基本係数を設定する
      * @param value - 設定する係数（0.0 to 1.0）
      */
     setGaussianScale(value: number): void;
     /**
-     * 距離に応じたガウシアンの大きさにおける最小値を設定する
+     * 距離に応じたスプラットの大きさにおける最小値を設定する
      * @param value - 設定する係数（0.0 to 1.0）
      */
     setEffectMinimumScale(value: number): void;
     /**
-     * 距離に応じたガウシアンの大きさ係数を設定する
+     * 距離に応じたスプラットの大きさ係数を設定する
      * @param value - 設定する係数（0.0 to 1.0）
      */
     setEffectDistanceBase(value: number): void;
     /**
-     * 距離に応じたガウシアンの範囲係数を設定する
+     * 距離に応じたスプラットの範囲係数を設定する
      * @param value - 設定する係数（0.0 < n <= 1.0）
      */
     setEffectDistanceRange(value: number): void;
@@ -992,12 +1045,12 @@ export declare class Core extends EventEmitter {
     setColorRGB(rgb: iVectorLike): void;
     /**
      * シェーダ上で作用する blur を設定する
-     * @param blur - ガウシアン内で色をぼかす係数（適切な範囲はおよそ 0.0 ～ 1.0）
+     * @param blur - スプラット内で色をぼかす係数（適切な範囲はおよそ 0.0 ～ 1.0）
      */
     setColorBlur(blur: number): void;
     /**
      * シェーダ上で作用する sharpness を設定する
-     * @param sharpness - ガウシアン内で色を強調する係数（適切な範囲はおよそ 0.0 ～ 1.0）
+     * @param sharpness - スプラット内で色を強調する係数（適切な範囲はおよそ 0.0 ～ 1.0）
      */
     setColorSharpness(sharpness: number): void;
     /**
@@ -1016,7 +1069,7 @@ export declare class Core extends EventEmitter {
      */
     startBloomPoints(duration: number): void;
     /**
-     * 点描画からガウシアンへの溶解効果をアニメーションする
+     * 点描画からスプラットへの溶解効果をアニメーションする
      * @param duration - アニメーションの継続時間（ミリ秒）
      */
     startDissolveToGaussian(duration: number): void;
@@ -1101,7 +1154,7 @@ export declare class Core extends EventEmitter {
      */
     resetCollision(): void;
     /**
-     * 現在選択しているガウシアンを削除状態とする
+     * 現在選択しているスプラットを削除状態とする
      */
     deleteSelectedGaussian(): void;
     /**

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

@@ -78,6 +78,7 @@ export interface iShaderChunk {
 export interface iMaterialOption {
     target: tChunkTarget;
     uniforms?: any;
+    defines?: any;
     vertex?: iShaderChunk | iShaderChunk[];
     fragment?: iShaderChunk | iShaderChunk[];
 }

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

@@ -0,0 +1,67 @@
+import { Group, PerspectiveCamera, Quaternion, Scene, Vector3 } from 'three';
+import { tControlInstance, tControlsType } from './canvas';
+import { CameraCollider } from '../camera/cameraCollider';
+import { TransferControls } from '../camera/transferControls';
+import { CameraPathManager } from '../camera/cameraPathManager';
+/**
+ * レンダービューはビューポートの設定値、シーングラフとカメラ、カメラコントロールなどを包含する
+ * canvas.ts 内でレンダリングを行う際などに参照され、マルチビューを実現するために実装された
+ * name プロパティに Symbol が指定されている場合、それは既定のレンダービューで初期化時に自動生成される
+ * TavioMesh（の名前）が add メソッドによって追加されている場合、対象のレンダービュー上で描画される
+ * 追加された TavioMesh は children プロパティに格納され、描画時に動的にシーングラフに追加される
+ */
+export declare class RenderView {
+    readonly name: string | Symbol;
+    enabled: boolean;
+    children: string[];
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    scene: Scene;
+    pickingScene: Scene;
+    gaussianGroup: Group;
+    meshGroup: Group;
+    interfaceGroup: Group;
+    perspectiveCamera: PerspectiveCamera;
+    controlsMap: Map<string, tControlInstance>;
+    enableControlsMap: Map<string, boolean>;
+    currentControlsType: tControlsType;
+    transferControls: TransferControls;
+    cameraCollider: CameraCollider;
+    cameraPathCollisionRadius: number;
+    cameraPathManager: CameraPathManager;
+    previousPosition: Vector3;
+    previousRotation: Quaternion;
+    previousFov: number;
+    orbitCursor: Group;
+    orbitCursorEnabled: boolean;
+    previousOrbitTarget: Vector3;
+    /**
+     * @param name - レンダービューの名前
+     */
+    constructor(name: string | Symbol);
+    /**
+     * レンダービューに該当する名前の TavioMesh が含まれるかどうかを返す
+     * @param meshName - 対象となる TavioMesh の名前
+     */
+    has(meshName: string): boolean;
+    /**
+     * レンダービューに TavioMesh を追加する
+     * @param meshName - 対象となる TavioMesh の名前
+     */
+    add(meshName: string): void;
+    /**
+     * レンダービューから TavioMesh を削除する
+     * @param meshName - 対象となる TavioMesh の名前
+     */
+    remove(meshName: string): void;
+    /**
+     * レンダービューからすべての TavioMesh を削除する
+     */
+    removeAll(): void;
+    /**
+     * 解放処理
+     */
+    dispose(): void;
+}