qg3dviewer 1.0.0

package/dist/utils/consts/GlobalConstants.d.ts

@@ -0,0 +1,62 @@
+export declare const ViewerVersion = "v2.0.0-dev";
+export declare const isMobile: boolean;
+export declare const HalfChars = "QWERTYUIOPLKJHGFDSAZXCVBNM1234567890qwertyuioplkjhgfdsazxcvbnm`~!@#$%^&*()-_=+\\|]}[{'\";::,<.>//? \t";
+export declare const BlankingTimeOfSmallScene: number;
+export declare const BlankingTimeOfLargeScene: number;
+export declare const BinHeaderSize = 140;
+export declare const SpxHeaderSize = 128;
+export declare const DataSize36 = 36;
+export declare const DataSize32 = 32;
+export declare const SplatDataSize32 = 32;
+export declare const SplatDataSize20 = 20;
+export declare const SplatDataSize16 = 16;
+export declare const WasmBlockSize: number;
+export declare const MobileDownloadLimitSplatCount: number;
+export declare const PcDownloadLimitSplatCount: number;
+export declare const SH_C0 = 0.28209479177387814;
+export declare const MinQualityLevel = 1;
+export declare const DefaultQualityLevel = 5;
+export declare const MaxQualityLevel = 9;
+/** 【官方创建者Reall3d】Creater: Reall3d */
+export declare const SpxCreaterReall3d = 0;
+/** 【spx中定义的公开格式】spx open format */
+export declare const SpxOpenFormat0 = 0;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 20, basic data */
+export declare const SpxBlockFormatData20 = 20;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 19, basic data */
+export declare const SpxBlockFormatData19 = 19;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 190, basic data */
+export declare const SpxBlockFormatData190 = 190;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 1, data of SH degree 1 （SH1 only） */
+export declare const SpxBlockFormatSH1 = 1;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 2, data of SH degree 2 （SH1 + SH2） */
+export declare const SpxBlockFormatSH2 = 2;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 3, data of SH degree 3 （SH3 only） */
+export declare const SpxBlockFormatSH3 = 3;
+/** 【spx中定义的公开数据块格式】Open Block Content Format 4, data of SH degree 1~3 （SH1 + SH2 + SH3） */
+export declare const SpxBlockFormatSH4 = 4;
+/** 【Reall3D扩展的专属格式】the exclusive format extended by reall3d */
+export declare const SpxExclusiveFormatReall3d = 3141592653;
+/**
+ * 【排序类型】
+ * 并不存在一种即性能高效又普遍适用的排序方法，这里提供默认方式作为普适性使用，以及其他多种方式供个性化场景选择使用。
+ *
+ * 允许按不同场景选择参数，配合调优的近端分段参数depthNearRate或depthNearValue一并写入meta达到个性化优化效果。
+ * 注意应避免动态切换排序类型，否则可能因为不相吻合而适得其反
+ * 例:室内迷宫场景，即使场景尺寸远大于2000，但实际拐弯抹角每个角度可能都最多看10个深度尺寸，
+ *    这时选择【2010】并设定depthNearValue=10就是合适的。
+ *
+ * 默认以外的排序类型都是为了具体个性化场景而准备的，应当具体实验后再确定选用。
+ */
+export declare enum SortTypes {
+    /** 默认，按视图投影矩阵计算z-depth进行全量排序 */
+    Default = 1,
+    /** 按相机方向计算z-depth进行排序，剔除背后和远端数据，仅渲染近端，有遮挡只能看到近端场景时适用 */
+    ZdepthFrontNearest2010 = 2010,
+    /** 按相机方向计算z-depth进行排序，剔除背后数据 */
+    ZdepthFront2011 = 2011,
+    /** 按相机方向计算z-depth进行排序，剔除背后数据，分近端远端两段排序，用以提高近端渲染精度 */
+    ZdepthFrontNearFar2012 = 2012,
+    /** 按相机方向计算z-depth进行排序，不剔除数据，分近端远端两段排序，用以提高近端渲染精度 */
+    ZdepthFullNearFar2112 = 2112
+}

package/dist/utils/consts/Index.d.ts

@@ -0,0 +1,2 @@
+export * from './GlobalConstants';
+export * from './WkConstants';

package/dist/utils/consts/WkConstants.d.ts

@@ -0,0 +1,76 @@
+/** Splat纹理 */
+export declare const WkTexdata: string;
+/** Splat索引 */
+export declare const WkSplatIndex: string;
+/** Splat索引传递完成 */
+export declare const WkSplatIndexDone: string;
+/** 当前模型已下载数据的最大半径 */
+export declare const WkCurrentMaxRadius: string;
+/** 模型的最大半径（小场景bin格式用） */
+export declare const WkMaxRadius: string;
+/** 模型中心点高度（小场景bin格式用） */
+export declare const WkTopY: string;
+/** 纹理索引 */
+export declare const WkIndex: string;
+/** 数据版本(时间戳) */
+export declare const WkVersion: string;
+/** 渲染的高斯数量 */
+export declare const WkRenderSplatCount: string;
+/** 可见的高斯数量 */
+export declare const WkVisibleSplatCount: string;
+/** 模型中的高斯数量 */
+export declare const WkModelSplatCount: string;
+/** 排序开始时间 */
+export declare const WkSortStartTime: string;
+/** 排序消耗时间 */
+export declare const WkSortTime: string;
+/** 纹理就绪 */
+export declare const WkTextureReady: string;
+/** 模型数据缓冲 */
+export declare const WkSplatDataBuffer: string;
+/** 是否大场景 */
+export declare const WkIsBigSceneMode: string;
+/** 最大渲染数量 */
+export declare const WkMaxRenderCount: string;
+/** bin格式版本 */
+export declare const WkBinVersion: string;
+/** 视图投影矩阵 */
+export declare const WkViewProjection: string;
+/** 上传纹理的版本 */
+export declare const WkUploadTextureVersion: string;
+/** 排序用已就绪的坐标 */
+export declare const WkXyz: string;
+/** 排序用已就绪的水印坐标 */
+export declare const WkWxyz: string;
+/** 包围盒 */
+export declare const WkMinX: string;
+/** 包围盒 */
+export declare const WkMaxX: string;
+/** 包围盒 */
+export declare const WkMinY: string;
+/** 包围盒 */
+export declare const WkMaxY: string;
+/** 包围盒 */
+export declare const WkMinZ: string;
+/** 包围盒 */
+export declare const WkMaxZ: string;
+/** 初始化 */
+export declare const WkInit: string;
+/** 水印数量 */
+export declare const WkWatermarkCount: string;
+/** 相机方向 */
+export declare const WkCameraDirection: string;
+/** 相机位置 */
+export declare const WkCameraPosition: string;
+/** 渲染质量级别 */
+export declare const WkQualityLevel: string;
+/** 更新参数 */
+export declare const WkUpdateParams: string;
+/** 排序桶使用的位数 */
+export declare const WkBucketBits: string;
+/** 排序类型 */
+export declare const WkSortType: string;
+/** 深度远近分段比例 */
+export declare const WkDepthNearRate: string;
+/** 深度远近分段值（设定时优先） */
+export declare const WkDepthNearValue: string;

package/dist/viewer/Reall3dViewer.d.ts

@@ -0,0 +1,57 @@
+import { ModelOptions } from '../modeldata/ModelOptions';
+import { Reall3dViewerOptions } from './Reall3dViewerOptions';
+/**
+ * Built-in Gaussian Splatting model viewer
+ */
+export declare class Reall3dViewer {
+    private disposed;
+    private splatMesh;
+    private events;
+    private updateTime;
+    private metaMatrix;
+    needUpdate: boolean;
+    constructor(opts?: Reall3dViewerOptions);
+    private init;
+    /**
+     * 允许拖拽本地文件进行渲染
+     */
+    private enableDropLocalFile;
+    /**
+     * 刷新
+     */
+    update(): void;
+    fire(n: number, p1?: any, p2?: any): void;
+    /**
+     * 设定或者获取最新配置项
+     * @param opts 配置项
+     * @returns 最新配置项
+     */
+    options(opts?: Reall3dViewerOptions): Reall3dViewerOptions;
+    /**
+     * 重置
+     */
+    reset(opts?: Reall3dViewerOptions): void;
+    /**
+     * 光圈过渡切换显示
+     * @returns
+     */
+    switchDeiplayMode(): void;
+    /**
+     * 添加场景
+     * @param sceneUrl 场景地址
+     */
+    addScene(sceneUrl: string): Promise<void>;
+    /**
+     * 添加要渲染的高斯模型（小场景模式）
+     * @param urlOpts 高斯模型链接或元数据文件链接或选项
+     */
+    addModel(urlOpts: string | ModelOptions, useMeta?: boolean): Promise<void>;
+    /**
+     * 根据需要暴露的接口
+     */
+    private initGsApi;
+    /**
+     * 销毁渲染器不再使用
+     */
+    dispose(): void;
+}

package/dist/viewer/Reall3dViewerOptions.d.ts

@@ -0,0 +1,174 @@
+import { PerspectiveCamera, Renderer, Scene } from 'three';
+import { OrbitControls } from 'three/examples/jsm/Addons.js';
+import { Events } from '../events/Events';
+import { TransitionEffects } from '../meshs/splatmesh/SplatMeshOptions';
+/**
+ * Configuration options for Reall3dViewer
+ */
+export interface Reall3dViewerOptions {
+    /**
+     * Specify a custom renderer instance. If undefined, one will be created automatically.
+     */
+    renderer?: Renderer | undefined;
+    /**
+     * Specify a custom scene instance. If undefined, one will be created automatically.
+     */
+    scene?: Scene | undefined;
+    /**
+     * Specify a custom camera instance. If undefined, one will be created automatically.
+     */
+    camera?: PerspectiveCamera | undefined;
+    /**
+     * Orbit controls instance
+     */
+    controls?: OrbitControls;
+    /**
+     * Renderer event manager
+     */
+    viewerEvents?: Events | undefined;
+    /**
+     * Debug mode flag. Defaults to false in production.
+     */
+    debugMode?: boolean | undefined;
+    /**
+     * Large scene mode flag. Cannot be modified after initialization.
+     */
+    bigSceneMode?: boolean;
+    /**
+     * Point cloud rendering mode. Defaults to true.
+     * Can be dynamically updated via viewer.options()
+     */
+    pointcloudMode?: boolean | undefined;
+    /**
+     * Maximum renderable Gaussian points count for mobile devices.
+     * Can be dynamically updated via viewer.options()
+     */
+    maxRenderCountOfMobile?: number | undefined;
+    /**
+     * Maximum renderable Gaussian points count for PC.
+     * Can be dynamically updated via viewer.options()
+     */
+    maxRenderCountOfPc?: number | undefined;
+    /**
+     * Color brightness factor. Defaults to 1.1.
+     */
+    lightFactor?: number | undefined;
+    /**
+     * Container element or its selector. Defaults to '#gsviewer'.
+     * If no container is found when creating canvas, one will be automatically created under body.
+     */
+    root?: HTMLElement | string | undefined;
+    /**
+     * Camera field of view. Defaults to 45.
+     */
+    fov?: number | undefined;
+    /**
+     * Camera near clipping plane. Defaults to 0.1.
+     */
+    near?: number | undefined;
+    /**
+     * Camera far clipping plane. Defaults to 1000.
+     */
+    far?: number | undefined;
+    /**
+     * Camera position. Defaults to [0, -5, 15].
+     */
+    position?: number[] | undefined;
+    /**
+     * Camera look-at target. Defaults to [0, 0, 0].
+     */
+    lookAt?: number[] | undefined;
+    /**
+     * Camera up vector. Defaults to [0, -1, 0].
+     */
+    lookUp?: number[] | undefined;
+    /**
+     * Auto-rotation flag. Defaults to true.
+     * Can be dynamically updated via viewer.options()
+     */
+    autoRotate?: boolean | undefined;
+    /**
+     * Damping effect flag. Defaults to true.
+     */
+    enableDamping?: boolean | undefined;
+    /**
+     * Zoom control flag. Defaults to true.
+     */
+    enableZoom?: boolean | undefined;
+    /**
+     * Rotation control flag. Defaults to true.
+     */
+    enableRotate?: boolean | undefined;
+    /**
+     * Pan control flag. Defaults to true.
+     */
+    enablePan?: boolean | undefined;
+    /**
+     * Minimum camera distance
+     */
+    minDistance?: number | undefined;
+    /**
+     * Maximum camera distance
+     */
+    maxDistance?: number | undefined;
+    /**
+     * Minimum polar angle (vertical rotation limit)
+     */
+    minPolarAngle?: number | undefined;
+    /**
+     * Maximum polar angle (vertical rotation limit)
+     */
+    maxPolarAngle?: number | undefined;
+    /**
+     * Keyboard controls flag. Defaults to true.
+     */
+    enableKeyboard?: boolean | undefined;
+    /**
+     * Annotation mode flag. Defaults to false.
+     */
+    markMode?: boolean | undefined;
+    /**
+     * Annotation type (point/lines/plans/distance/area/circle)
+     */
+    markType?: 'point' | 'lines' | 'plans' | 'distance' | 'area' | 'circle' | undefined;
+    /**
+     * Annotation visibility flag. Defaults to true.
+     */
+    markVisible?: boolean | undefined;
+    /**
+     * Meter scale (how many meters per unit length). Defaults to 1.
+     */
+    meterScale?: number | undefined;
+    /**
+     * Disable local file drag-and-drop flag. Defaults to false.
+     */
+    disableDropLocalFile?: boolean | undefined;
+    /**
+     * Spherical harmonics rendering level. Defaults to the maximum renderable level of model data.
+     */
+    shDegree?: number | undefined;
+    /**
+     * Background color (defaults to '#000000')
+     */
+    background?: string;
+    /**
+     * Render quality level (1~9, default to 5)
+     */
+    qualityLevel?: number;
+    /**
+     * Sort type (default to SortTypes.Default)
+     */
+    sortType?: number;
+    /**
+     * disable transition effect on load; defaults to false
+     */
+    disableTransitionEffectOnLoad?: boolean;
+    /**
+     * transition effect type; defaults to ModelCenterCirccle
+     */
+    transitionEffect?: TransitionEffects;
+    /**
+     * Auto play background audio (defaults to false)
+     */
+    autoPlayBgAudio?: boolean;
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+    "name": "qg3dviewer",
+    "version": "1.0.0",
+    "type": "module",
+    "main": "./dist/index.umd.js",
+    "module": "./dist/index.es.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.es.js",
+            "require": "./dist/index.umd.js"
+        }
+    },
+    "files": [
+        "dist",
+        "package.json",
+        "README.md"
+    ],
+    "scripts": {
+        "dev": "vite --config vite.config.dev.ts",
+        "build:demo": "tsc && vite build --config vite.config.dev.ts",
+        "build": "tsc && vite build",
+        "preview": "vite preview"
+    },
+    "dependencies": {
+        "fflate": "^0.8.2",
+        "lzma": "^2.3.2",
+        "xz-decompress": "^0.2.3"
+    },
+    "devDependencies": {
+        "@types/node": "^22.13.5",
+        "@types/three": "^0.171.0",
+        "@vituum/vite-plugin-postcss": "^1.1.0",
+        "less": "^4.2.2",
+        "typescript": "^5.6.3",
+        "vite": "^6.1.1",
+        "vite-plugin-dts": "^4.5.4",
+        "vite-plugin-glsl": "^1.4.2",
+        "vite-plugin-svg-icons": "^2.0.1"
+    },
+    "peerDependencies": {
+        "@gotoeasy/three-tile": "^0.8.7",
+        "@tweenjs/tween.js": "^25.0.0",
+        "three": "^0.171.0"
+    },
+    "license": "MIT",
+    "keywords": [],
+    "author": ""
+}