qg3dviewer 1.0.0

package/dist/meshs/splatmesh/SplatMeshOptions.d.ts

@@ -0,0 +1,106 @@
+import { Renderer, Scene } from 'three';
+import { Events } from '../../events/Events';
+import { OrbitControls } from 'three/examples/jsm/Addons.js';
+/**
+ * Splat mesh configuration options
+ */
+export interface SplatMeshOptions {
+    /**
+     * Name
+     */
+    name?: string;
+    /**
+     * Renderer instance to be used
+     */
+    renderer: Renderer;
+    /**
+     * Scene instance to be used
+     */
+    scene: Scene;
+    /**
+     * Camera controls
+     */
+    controls?: OrbitControls;
+    /**
+     * Renderer event manager
+     */
+    viewerEvents?: Events;
+    /**
+     * Debug mode flag; defaults to false in production
+     */
+    debugMode?: boolean;
+    /**
+     * Large-scene mode flag; cannot be changed after initialization
+     */
+    bigSceneMode?: boolean;
+    /**
+     * Point-cloud rendering mode; defaults to true,
+     * Can be updated dynamically via viewer.options()
+     */
+    pointcloudMode?: boolean;
+    /**
+     * Maximum number of Gaussians to render on mobile devices,
+     * Can be updated dynamically via viewer.options()
+     */
+    maxRenderCountOfMobile?: number;
+    /**
+     * Maximum number of Gaussians to render on PC,
+     * Can be updated dynamically via viewer.options()
+     */
+    maxRenderCountOfPc?: number;
+    /**
+     * Brightness scale factor; defaults to 1.0
+     */
+    lightFactor?: number;
+    /**
+     * Whether to display a watermark; defaults to true
+     */
+    showWatermark?: boolean;
+    /**
+     * Spherical harmonics rendering degree; defaults to 0
+     */
+    shDegree?: number;
+    /**
+     * Enable depth testing; defaults to true
+     */
+    depthTest?: boolean;
+    /**
+     * Render quality level (1~9, default to 5)
+     */
+    qualityLevel?: number;
+    /**
+     * Sort type (default to SortTypes.Default)
+     */
+    sortType?: number;
+    /**
+     * map mode, defaults to false
+     */
+    mapMode?: boolean;
+    /**
+     * disable transition effect on load; defaults to false
+     */
+    disableTransitionEffectOnLoad?: boolean;
+    /**
+     * transition effect type; defaults to ModelCenterCirccle
+     */
+    transitionEffect?: TransitionEffects;
+    /**
+     * 最小可渲染直径像素
+     */
+    minPixelDiameter?: number;
+    /**
+     * 最大直径像素
+     */
+    maxPixelDiameter?: number;
+    /**
+     * 最小可渲染透明度
+     */
+    minAlpha?: number;
+}
+/** 过渡效果 */
+export declare enum TransitionEffects {
+    ModelCenterCirccle = 1,
+    ScreenCenterCircle = 2,
+    ScreenMiddleToLeftRight = 3,
+    ScreenMiddleToTopBottom = 4
+}

package/dist/modeldata/ModelData.d.ts

@@ -0,0 +1,205 @@
+import { Matrix4, Vector3 } from 'three';
+import { CameraInfo } from '../controls/SetupCameraControls';
+import { ModelOptions } from './ModelOptions';
+/**
+ * SPX file header information
+ */
+export declare class SpxHeader {
+    Fixed: string;
+    Version: number;
+    SplatCount: number;
+    MinX: number;
+    MaxX: number;
+    MinY: number;
+    MaxY: number;
+    MinZ: number;
+    MaxZ: number;
+    MinTopY: number;
+    MaxTopY: number;
+    CreateDate: number;
+    CreaterId: number;
+    ExclusiveId: number;
+    ShDegree: number;
+    Flag1: number;
+    Flag2: number;
+    Flag3: number;
+    Reserve1: number;
+    Reserve2: number;
+    Comment: string;
+    HashCheck: boolean;
+}
+/**
+ * Splat model
+ */
+export declare class SplatModel {
+    /** Model options */
+    readonly opts: ModelOptions;
+    /** File size (bytes) */
+    fileSize: number;
+    /** Downloaded size (bytes) */
+    downloadSize: number;
+    /** Current model status */
+    status: ModelStatus;
+    /** Raw model data */
+    splatData: Uint8Array;
+    /** Watermark data */
+    watermarkData: Uint8Array;
+    /** Number of Gaussians in the model */
+    dataSplatCount: number;
+    /** Number of watermark Gaussians */
+    watermarkCount: number;
+    /** Spherical harmonics (level 1 or 1+2) */
+    sh12Data: Uint8Array[];
+    /** Spherical harmonics (level 3 only) */
+    sh3Data: Uint8Array[];
+    /** Downloaded SH (level 1 or 1+2) count */
+    sh12Count: number;
+    /** Downloaded SH (level 3 only) count */
+    sh3Count: number;
+    /** Byte length of a single Gaussian record */
+    rowLength: number;
+    /** Total Gaussian count in the model */
+    modelSplatCount: number;
+    /** Downloaded Gaussian count */
+    downloadSplatCount: number;
+    /** Render-ready Gaussian count (dynamic for large scenes) */
+    renderSplatCount: number;
+    /** Abort controller for fetch cancellation */
+    abortController: AbortController;
+    /** Header info for .spx format */
+    header: SpxHeader;
+    spzVersion: number;
+    sogVersion: number;
+    CompressionRatio: string;
+    dataShDegree: number;
+    /** Model metadata */
+    meta: MetaData;
+    /** Map of cut data for large scenes */
+    map: Map<string, CutData>;
+    /** Bounding box extents */
+    minX: number;
+    maxX: number;
+    minY: number;
+    maxY: number;
+    minZ: number;
+    maxZ: number;
+    /** Highest Y coordinate */
+    topY: number;
+    currentRadius: number;
+    aabbCenter: Vector3;
+    /** Bounding sphere radius for .spx */
+    maxRadius: number;
+    metaMatrix: Matrix4;
+    /** Flags */
+    notifyFetchStopDone: boolean;
+    smallSceneUploadDone: boolean;
+    textWatermarkVersion: number;
+    lastTextWatermarkVersion: number;
+    fetchLimit: number;
+    /** Active points data */
+    activePoints: any;
+    constructor(opts: ModelOptions, meta?: MetaData);
+}
+/**
+ * Data chunk used in large-scene tiling
+ */
+export interface CutData {
+    /** Number of Gaussians in this chunk */
+    splatCount?: number;
+    /** Raw data of this chunk */
+    splatData?: Uint8Array;
+    minX?: number;
+    maxX?: number;
+    minY?: number;
+    maxY?: number;
+    minZ?: number;
+    maxZ?: number;
+    center?: Vector3;
+    radius?: number;
+    /** Current renderable points (computed at runtime) */
+    currentRenderCnt?: number;
+    /** Distance to camera (computed at runtime) */
+    distance?: number;
+}
+/**
+ * Model status
+ */
+export declare enum ModelStatus {
+    /** Ready */
+    FetchReady = 0,
+    /** In progress */
+    Fetching = 1,
+    /** Completed successfully */
+    FetchDone = 2,
+    /** Interrupted during request */
+    FetchAborted = 3,
+    /** Request failed */
+    FetchFailed = 4,
+    /** Invalid model format or data */
+    Invalid = 5
+}
+/**
+ * Metadata
+ */
+export interface MetaData {
+    /** Name */
+    name?: string;
+    /** Version */
+    version?: string;
+    /** Update date (YYYYMMDD) */
+    updateDate?: number;
+    /** Enable auto-rotation */
+    autoRotate?: boolean;
+    /** Enable debug mode */
+    debugMode?: boolean;
+    /** Enable point-cloud rendering */
+    pointcloudMode?: boolean;
+    /** Maximum render count for mobile */
+    maxRenderCountOfMobile?: number;
+    /** Maximum render count for PC */
+    maxRenderCountOfPc?: number;
+    /** Maximum download count for mobile splats */
+    mobileDownloadLimitSplatCount?: number;
+    /** Maximum download count for PC splats */
+    pcDownloadLimitSplatCount?: number;
+    /** Meter scale factor */
+    meterScale?: number;
+    /** Text watermark */
+    watermark?: string;
+    /** Display watermark */
+    showWatermark?: boolean;
+    /** Display bounding box */
+    showBoundBox?: boolean;
+    /** Camera parameters */
+    cameraInfo?: CameraInfo;
+    /** Annotations */
+    marks?: any[];
+    /** Fly-through camera positions */
+    flyPositions?: number[];
+    /** Fly-through camera look-at points */
+    flyTargets?: number[];
+    /** render quality level */
+    qualityLevel?: number;
+    /** sort type */
+    sortType?: number;
+    /** depth near rate */
+    depthNearRate?: number;
+    /** depth near value */
+    depthNearValue?: number;
+    /** 最小可渲染直径像素 */
+    minPixelDiameter?: number;
+    /** 最大直径像素 */
+    maxPixelDiameter?: number;
+    /** 最小可渲染透明度 */
+    minAlpha?: number;
+    /** Enable particle loading effect (small scenes) */
+    particleMode?: boolean;
+    /** Auto-cut count */
+    autoCut?: number;
+    /** Transformation matrix */
+    transform?: number[];
+    /** Geolocation (EPSG:4326 WGS 84) */
+    WGS84?: number[];
+    /** Model URL */
+    url?: string;
+}

package/dist/modeldata/ModelOptions.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Gaussian Model Options
+ */
+export interface ModelOptions {
+    /**
+     * Model URL
+     */
+    url: string;
+    /**
+     * Model format (ply | splat | spx | spz | sog | obj), auto-detected by default
+     */
+    format?: 'ply' | 'splat' | 'spx' | 'spz' | 'sog' | 'obj';
+    /**
+     * Whether to force re-download
+     */
+    fetchReload?: boolean;
+}

package/dist/modeldata/SplatTexdata.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 纹理
+ */
+interface SplatTexdata {
+    /** 索引（0 | 1） */
+    index: number;
+    /** 纹理版本（毫秒时间戳） */
+    version?: number;
+    /** 纹理数据 */
+    txdata?: Uint32Array;
+    /** 坐标数据 */
+    xyz?: Float32Array;
+    /** 纹理数据就绪标志 */
+    textureReady?: boolean;
+    /** 纹理数据就绪时间点 */
+    textureReadyTime?: number;
+    /** 是否渲染中的活动状态 */
+    active?: boolean;
+    activeTime?: number;
+    /** 包围盒极限点 */
+    minX?: number;
+    /** 包围盒极限点 */
+    maxX?: number;
+    /** 包围盒极限点 */
+    minY?: number;
+    /** 包围盒极限点 */
+    maxY?: number;
+    /** 包围盒极限点 */
+    minZ?: number;
+    /** 包围盒极限点 */
+    maxZ?: number;
+    /** 待渲染的Splat数量 */
+    renderSplatCount?: number;
+    /** 可见且可用的Splat数量 */
+    visibleSplatCount?: number;
+    /** 所有处理中的模型Splat数量合计 */
+    modelSplatCount?: number;
+    /** 模型数据中的水印数量 */
+    watermarkCount?: number;
+}

package/dist/modeldata/SplatTexdataManager.d.ts

@@ -0,0 +1,5 @@
+import { Events } from '../events/Events';
+/**
+ * 纹理数据管理
+ */
+export declare function setupSplatTextureManager(events: Events): void;

package/dist/modeldata/loaders/FileLoader.d.ts

@@ -0,0 +1,2 @@
+import { Events } from '../../events/Events';
+export declare function loadFile(url: string, events?: Events): Promise<Uint8Array>;

package/dist/modeldata/loaders/PlyLoader.d.ts

@@ -0,0 +1,5 @@
+import { SplatModel } from '../ModelData';
+/**
+ * PLY加载器（注：仅支持3DGS标准格式的PLY）
+ */
+export declare function loadPly(model: SplatModel): Promise<void>;

package/dist/modeldata/loaders/SogLoader.d.ts

@@ -0,0 +1,2 @@
+import { SplatModel } from '../ModelData';
+export declare function loadSog(model: SplatModel): Promise<void>;

package/dist/modeldata/loaders/SplatLoader.d.ts

@@ -0,0 +1,2 @@
+import { SplatModel } from '../ModelData';
+export declare function loadSplat(model: SplatModel): Promise<void>;

package/dist/modeldata/loaders/SpxLoader.d.ts

@@ -0,0 +1,2 @@
+import { SplatModel } from '../ModelData';
+export declare function loadSpx(model: SplatModel): Promise<void>;

package/dist/modeldata/loaders/SpzLoader.d.ts

@@ -0,0 +1,2 @@
+import { SplatModel } from '../ModelData';
+export declare function loadSpz(model: SplatModel): Promise<void>;

package/dist/modeldata/text/SetupGaussianText.d.ts

@@ -0,0 +1,2 @@
+import { Events } from '../../events/Events';
+export declare function setupGaussianText(events: Events): void;

package/dist/modeldata/wasm/WasmParser.d.ts

@@ -0,0 +1,19 @@
+import { SpxHeader } from '../ModelData';
+export declare function parseSpxHeader(header: Uint8Array): Promise<SpxHeader>;
+interface SpxBlockResult {
+    splatCount: number;
+    blockFormat: number;
+    datas?: Uint8Array;
+    isSplat?: boolean;
+    isSh?: boolean;
+    isSh1?: boolean;
+    isSh2?: boolean;
+    isSh3?: boolean;
+    isSh23?: boolean;
+    dataSh3?: Uint8Array;
+    success: boolean;
+}
+export declare function parseSpxBlockData(data: Uint8Array, header?: SpxHeader): Promise<SpxBlockResult>;
+export declare function parseSplatToTexdata(data: Uint8Array, splatCount: number): Promise<Uint8Array>;
+export declare function parseWordToTexdata(x: number, y0z: number, isY?: boolean, isNgativeY?: boolean): Promise<Uint8Array>;
+export {};

package/dist/raycaster/SetupRaycaster.d.ts

@@ -0,0 +1,2 @@
+import { Events } from '../events/Events';
+export declare function setupRaycaster(events: Events): void;

package/dist/sorter/SetupSorter.d.ts

@@ -0,0 +1,2 @@
+import { Events } from '../events/Events';
+export declare function setupSorter(events: Events): void;

package/dist/sorter/Sorter.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tools/brush-selection.d.ts

@@ -0,0 +1,10 @@
+import { Events } from '../events/Events';
+declare class BrushSelection {
+    activate: () => void;
+    deactivate: () => void;
+    constructor(events: Events, parent: HTMLElement, mask: {
+        canvas: HTMLCanvasElement;
+        context: CanvasRenderingContext2D;
+    });
+}
+export { BrushSelection };

package/dist/tools/lasso-selection.d.ts

@@ -0,0 +1,10 @@
+import { Events } from '../events/Events';
+declare class LassoSelection {
+    activate: () => void;
+    deactivate: () => void;
+    constructor(events: Events, parent: HTMLElement, mask: {
+        canvas: HTMLCanvasElement;
+        context: CanvasRenderingContext2D;
+    });
+}
+export { LassoSelection };

package/dist/tools/polygon-selection.d.ts

@@ -0,0 +1,10 @@
+import { Events } from '../events/Events';
+declare class PolygonSelection {
+    activate: () => void;
+    deactivate: () => void;
+    constructor(events: Events, parent: HTMLElement, mask: {
+        canvas: HTMLCanvasElement;
+        context: CanvasRenderingContext2D;
+    });
+}
+export { PolygonSelection };

package/dist/tools/rect-selection.d.ts

@@ -0,0 +1,8 @@
+import { Events } from '../events/Events';
+declare class RectSelection {
+    activate: () => void;
+    deactivate: () => void;
+    constructor(events: Events, parent: HTMLElement);
+    destroy(): void;
+}
+export { RectSelection };

package/dist/tools/tool-manager.d.ts

@@ -0,0 +1,15 @@
+import { Events } from '../events/Events';
+interface Tool {
+    activate: () => void;
+    deactivate: () => void;
+}
+declare class ToolManager {
+    tools: Map<string, Tool>;
+    events: Events;
+    active: string | null;
+    constructor(events: Events);
+    register(name: string, tool: Tool): void;
+    get(toolName: string): Tool;
+    activate(toolName: string | null): void;
+}
+export { ToolManager };

package/dist/utils/CommonUtils.d.ts

@@ -0,0 +1,171 @@
+import { Audio } from 'three';
+import { Events } from '../events/Events';
+import { SplatMeshOptions } from '../meshs/splatmesh/SplatMeshOptions';
+export declare function setupCommonUtils(events: Events): void;
+export declare const shaderChunk: {
+    alphahash_fragment: string;
+    alphahash_pars_fragment: string;
+    alphamap_fragment: string;
+    alphamap_pars_fragment: string;
+    alphatest_fragment: string;
+    alphatest_pars_fragment: string;
+    aomap_fragment: string;
+    aomap_pars_fragment: string;
+    batching_pars_vertex: string;
+    begin_vertex: string;
+    beginnormal_vertex: string;
+    bsdfs: string;
+    iridescence_fragment: string;
+    bumpmap_pars_fragment: string;
+    clipping_planes_fragment: string;
+    clipping_planes_pars_fragment: string;
+    clipping_planes_pars_vertex: string;
+    clipping_planes_vertex: string;
+    color_fragment: string;
+    color_pars_fragment: string;
+    color_pars_vertex: string;
+    color_vertex: string;
+    common: string;
+    cube_uv_reflection_fragment: string;
+    defaultnormal_vertex: string;
+    displacementmap_pars_vertex: string;
+    displacementmap_vertex: string;
+    emissivemap_fragment: string;
+    emissivemap_pars_fragment: string;
+    colorspace_fragment: string;
+    colorspace_pars_fragment: string;
+    envmap_fragment: string;
+    envmap_common_pars_fragment: string;
+    envmap_pars_fragment: string;
+    envmap_pars_vertex: string;
+    envmap_physical_pars_fragment: string;
+    envmap_vertex: string;
+    fog_vertex: string;
+    fog_pars_vertex: string;
+    fog_fragment: string;
+    fog_pars_fragment: string;
+    gradientmap_pars_fragment: string;
+    lightmap_pars_fragment: string;
+    lights_lambert_fragment: string;
+    lights_lambert_pars_fragment: string;
+    lights_pars_begin: string;
+    lights_toon_fragment: string;
+    lights_toon_pars_fragment: string;
+    lights_phong_fragment: string;
+    lights_phong_pars_fragment: string;
+    lights_physical_fragment: string;
+    lights_physical_pars_fragment: string;
+    lights_fragment_begin: string;
+    lights_fragment_maps: string;
+    lights_fragment_end: string;
+    logdepthbuf_fragment: string;
+    logdepthbuf_pars_fragment: string;
+    logdepthbuf_pars_vertex: string;
+    logdepthbuf_vertex: string;
+    map_fragment: string;
+    map_pars_fragment: string;
+    map_particle_fragment: string;
+    map_particle_pars_fragment: string;
+    metalnessmap_fragment: string;
+    metalnessmap_pars_fragment: string;
+    morphcolor_vertex: string;
+    morphnormal_vertex: string;
+    morphtarget_pars_vertex: string;
+    morphtarget_vertex: string;
+    normal_fragment_begin: string;
+    normal_fragment_maps: string;
+    normal_pars_fragment: string;
+    normal_pars_vertex: string;
+    normal_vertex: string;
+    normalmap_pars_fragment: string;
+    clearcoat_normal_fragment_begin: string;
+    clearcoat_normal_fragment_maps: string;
+    clearcoat_pars_fragment: string;
+    iridescence_pars_fragment: string;
+    opaque_fragment: string;
+    packing: string;
+    premultiplied_alpha_fragment: string;
+    project_vertex: string;
+    dithering_fragment: string;
+    dithering_pars_fragment: string;
+    roughnessmap_fragment: string;
+    roughnessmap_pars_fragment: string;
+    shadowmap_pars_fragment: string;
+    shadowmap_pars_vertex: string;
+    shadowmap_vertex: string;
+    shadowmask_pars_fragment: string;
+    skinbase_vertex: string;
+    skinning_pars_vertex: string;
+    skinning_vertex: string;
+    skinnormal_vertex: string;
+    specularmap_fragment: string;
+    specularmap_pars_fragment: string;
+    tonemapping_fragment: string;
+    tonemapping_pars_fragment: string;
+    transmission_fragment: string;
+    transmission_pars_fragment: string;
+    uv_pars_fragment: string;
+    uv_pars_vertex: string;
+    uv_vertex: string;
+    worldpos_vertex: string;
+    background_vert: string;
+    background_frag: string;
+    backgroundCube_vert: string;
+    backgroundCube_frag: string;
+    cube_vert: string;
+    cube_frag: string;
+    depth_vert: string;
+    depth_frag: string;
+    distanceRGBA_vert: string;
+    distanceRGBA_frag: string;
+    equirect_vert: string;
+    equirect_frag: string;
+    linedashed_vert: string;
+    linedashed_frag: string;
+    meshbasic_vert: string;
+    meshbasic_frag: string;
+    meshlambert_vert: string;
+    meshlambert_frag: string;
+    meshmatcap_vert: string;
+    meshmatcap_frag: string;
+    meshnormal_vert: string;
+    meshnormal_frag: string;
+    meshphong_vert: string;
+    meshphong_frag: string;
+    meshphysical_vert: string;
+    meshphysical_frag: string;
+    meshtoon_vert: string;
+    meshtoon_frag: string;
+    points_vert: string;
+    points_frag: string;
+    shadow_vert: string;
+    shadow_frag: string;
+    sprite_vert: string;
+    sprite_frag: string;
+};
+export declare function initSplatMeshOptions(options: SplatMeshOptions): SplatMeshOptions;
+export declare const decodeB64: typeof atob;
+/** 是否7天内 */
+export declare function isNeedReload(yyyymmdd?: number): boolean;
+export declare const isLocalhost: boolean;
+export declare function clipUint8(value: number): number;
+export declare function encodeSplatSH(val: number): number;
+export declare function computeCompressionRatio(splatCount: number, bytelength: number): string;
+export declare function DecompressGzip(data: Uint8Array): Promise<Uint8Array>;
+export declare function DecompressXZ(datas: Uint8Array): Promise<Uint8Array>;
+export declare function showTvText(txt: string, duration: number, audio: Audio): Promise<boolean>;
+export declare function clearTvText(): void;
+export declare function data190To19(data190: Uint8Array): Promise<Uint8Array>;
+export declare function sh123To1(data123: Uint8Array): Promise<Uint8Array>;
+export declare function sh123To2(data123: Uint8Array): Promise<Uint8Array>;
+export declare function sh123To3(data123: Uint8Array): Promise<Uint8Array>;
+export declare function webpToRgba(webps: Uint8Array): Promise<{
+    width: number;
+    height: number;
+    rgba: Uint8Array;
+}>;
+export declare function unzipToMap(zipBytes: Uint8Array): Map<string, Uint8Array>;
+export declare function uint8ArrayToString(uint8Array: Uint8Array): string;
+export declare function logEncode(v: number): number;
+export declare function logDecode(v: number): number;
+export declare function loopByTime(fnRun: Function, fnIsContinue?: Function, delay?: number): void;

package/dist/utils/ViewerUtils.d.ts

@@ -0,0 +1,10 @@
+import { PerspectiveCamera, WebGLRenderer } from 'three';
+import { Events } from '../events/Events';
+import { SplatMeshOptions } from '../meshs/splatmesh/SplatMeshOptions';
+import { Reall3dViewerOptions } from '../viewer/Reall3dViewerOptions';
+export declare function setupViewerUtils(events: Events): void;
+export declare function initSplatMeshOptions(options: SplatMeshOptions): SplatMeshOptions;
+export declare function initGsViewerOptions(options: Reall3dViewerOptions): Reall3dViewerOptions;
+export declare function initRenderer(opts: Reall3dViewerOptions): WebGLRenderer;
+export declare function initCamera(opts: Reall3dViewerOptions): PerspectiveCamera;
+export declare function copyGsViewerOptions(gsViewerOptions: Reall3dViewerOptions): SplatMeshOptions;