@openheart/tavio-renderer 1.0.12-with-wasm

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

@@ -0,0 +1,121 @@
+import { RawShaderMaterial } from 'three';
+/**
+ * MaterialGenerator は原則として static なメソッドのみで実装しステートを持たない。
+ *
+ * ビューアの基本機能については src/shaderChunk 以下にシェーダのチャンクとなる各部品を置く。
+ * src/shaderChunk/common 以下にあるシェーダは 3DGS を描画するのみで色もつかない、最もシンプルな形。
+ * src/shaderChunk/viewer は直流成分および交流成分の計算など、ビューアの基本機能を拡張する。
+ * src/shaderChunk/editor はカラーグレーディングなどのエディタ用機能。
+ * src/shaderChunk/picking は座標をレンダリングするピッキング用のシェーダ。
+ *
+ * 独自に拡張する場合は、iMaterialOption 単体またはその配列を定義し MaterialGenerator.generate() に渡す。
+ * iMaterialOption.target で、ベーシックやピッキングなどのシェーダを結合する対象を（CHUNK_TARGET の論理和で）指定する。
+ * iMaterialOption.uniforms で拡張部分で用いる uniform 変数を定義。
+ * iMaterialOption.vertex / fragment でシェーダのチャンク情報を iShaderChunk 単体または配列で指定する。
+ *
+ * iShaderChunk.stage は SHADER_STAGE で定義されているシェーダ内のステージの指定。
+ * iShaderChunk.source はシェーダのソースコード。
+ *
+ * このファイル内で定義されているシェーダのチャンクは src/shaderChunk/common 以下にあるもののみ。
+ * それ以外のチャンクは canvas.ts など、ビューア実装側で付与する。
+ */
+/**
+ * チャンクをどのシェーダに反映するかを表す
+ * これらの値は論理和を用いて組み合わせて指定できる
+ */
+export declare const CHUNK_TARGET: {
+    readonly ANY: 0;
+    readonly BASIC: 1;
+    readonly PICKING: 2;
+};
+export type tChunkTarget = typeof CHUNK_TARGET[keyof typeof CHUNK_TARGET];
+/**
+ * チャンクがどのステージにあたるかを表す
+ * 指定されたステージの末尾に処理が追加される
+ */
+export declare const 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_SIGMA: 5;
+    readonly VERTEX_MAIN_OUT: 6;
+    readonly VERTEX_MAIN_END: 7;
+    readonly FRAGMENT_PRECISION: 8;
+    readonly FRAGMENT_DECLARATION: 9;
+    readonly FRAGMENT_FUNCTION: 10;
+    readonly FRAGMENT_MAIN_BEGIN: 11;
+    readonly FRAGMENT_MAIN_IN: 12;
+    readonly FRAGMENT_MAIN_OUT: 13;
+    readonly FRAGMENT_MAIN_END: 14;
+};
+export type tShaderStage = typeof SHADER_STAGE[keyof typeof SHADER_STAGE];
+/**
+ * シェーダのソースコード定義
+ */
+export interface iShaderSource {
+    vertex: string;
+    fragment: string;
+}
+/**
+ * 生成したマテリアル群
+ */
+export interface iMaterials {
+    basic: RawShaderMaterial;
+    picking: RawShaderMaterial;
+}
+/**
+ * マテリアル生成に使われるシェーダチャンク
+ */
+export interface iShaderChunk {
+    stage: tShaderStage;
+    source: string;
+}
+/**
+ * マテリアルを生成するためのオプション
+ */
+export interface iMaterialOption {
+    target: tChunkTarget;
+    uniforms?: any;
+    defines?: any;
+    vertex?: iShaderChunk | iShaderChunk[];
+    fragment?: iShaderChunk | iShaderChunk[];
+}
+/**
+ * 複数のシェーダチャンクを組み合わせてマテリアルを生成する
+ */
+export declare class MaterialGenerator {
+    /**
+     * shaderChunk/common に含まれる頂点シェーダのチャンクをセットした Map オブジェクトを生成する
+     */
+    private static _createVertexMap;
+    /**
+     * shaderChunk/common に含まれるフラグメントシェーダのチャンクをセットした Map オブジェクトを生成する
+     */
+    private static _createFragmentMap;
+    /**
+     * シェーダチャンクに iMaterialOption.vertex / fragment に含まれるソースコードを結合する
+     * @param option - シェーダチャンクを含むマテリアルオプション
+     * @param vsMap - 頂点シェーダ用
+     * @param fsMap - フラグメントシェーダ用
+     * @return 各ステージに何回チャンクが結合されたかを表す配列
+     */
+    private static _mergeShaderSource;
+    /**
+     * uniform 変数用の雛形を生成する（src/shderChunk/common 以下で定義される最低限のもの）
+     */
+    private static _createUniforms;
+    /**
+     * Map オブジェクトに含まれるソースコードを結合する
+     * @param map - 処理の対象となる Map オブジェクト
+     * @param isDebug - デバッグ用にコンソールにソースコードを出力するかどうか
+     */
+    private static _createShaderSource;
+    /**
+     * マテリアルを生成する
+     * @param option - シェーダチャンクなどの情報を含むマテリアルオプション
+     * @param isDebug - デバッグ用にコンソールにソースコードを出力するかどうか
+     */
+    static generate(option?: iMaterialOption | iMaterialOption[], isDebug?: boolean): iMaterials;
+}

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;
+}