three-loader-3dtiles.api.md 3.2 KB

API Report File for "three-loader-3dtiles"

Do not edit this file. It is a report generated by API Extractor.


import { LoadingManager } from 'three';
import { Material } from 'three';
import { Object3D } from 'three';
import { Shader } from 'three';
import { Stats } from '@probe.gl/stats';
import { Tileset3D } from '@loaders.gl/tiles';
import { Vector3 } from 'three';
import { WebGLRenderer } from 'three';

// @public
export interface GeoCoord {
    // (undocumented)
    height: number;
    // (undocumented)
    lat: number;
    // (undocumented)
    long: number;
}

// @public (undocumented)
export enum GeoTransform {
    // (undocumented)
    Mercator = 2,
    // (undocumented)
    Reset = 1,
    // (undocumented)
    WGS84Cartesian = 3
}

// @public
export class Loader3DTiles {
    static load(props: LoaderProps): Promise<{
        model: Object3D;
        runtime: Runtime;
    }>;
}

// @public
export interface LoaderOptions {
    basisTranscoderPath?: string;
    cesiumIONToken?: string;
    computeNormals?: boolean;
    debug?: boolean;
    dracoDecoderPath?: string;
    geoTransform?: GeoTransform;
    material?: Material;
    maxConcurrency?: number;
    maximumMemoryUsage?: number;
    maximumScreenSpaceError?: number;
    maxRequests?: number;
    pointCloudColoring?: PointCloudColoring;
    pointSize?: number;
    preloadTilesCount?: number;
    shaderCallback?: (shader: Shader, renderer: WebGLRenderer) => void;
    shading?: Shading;
    skipLevelOfDetail?: boolean;
    throttleRequests?: boolean;
    transparent?: boolean;
    updateInterval?: number;
    updateTransforms?: boolean;
    viewDistanceScale?: number;
    wireframe?: boolean;
    worker?: boolean;
}

// @public
export interface LoaderProps {
    loadingManager?: LoadingManager;
    onProgress?(progress: number | ProgressEvent<EventTarget>, total?: number): void;
    options?: LoaderOptions;
    renderer?: WebGLRenderer;
    url: string;
}

// @public
export enum PointCloudColoring {
    // (undocumented)
    Classification = 2,
    // (undocumented)
    Elevation = 3,
    // (undocumented)
    Intensity = 1,
    // (undocumented)
    RGB = 4,
    // (undocumented)
    White = 5
}

// @public
export interface Runtime {
    dispose(): void;
    getCameraFrustum(Camera: any): Object3D;
    getLatLongHeightFromPosition(Vector3: any): GeoCoord;
    getPositionFromLatLongHeight(GeoCoord: any): Vector3;
    getStats(): Stats;
    getTileBoxes(): Object3D;
    getTileset(): Tileset3D;
    setDebug(boolean: any): void;
    setElevationRange(range: ReadonlyArray<number>): void;
    setHideGround(boolean: any): void;
    setIntensityContrast(number: any): void;
    setMaxIntensity(number: any): void;
    setPointAlpha(number: any): void;
    setPointCloudColoring(PointCloudColoring: any): void;
    setShading(Shading: any): void;
    setViewDistanceScale(number: any): void;
    setWireframe(boolean: any): void;
    showTiles(boolean: any): void;
    update(number: any, WebGLRenderer: any, Camera: any): void;
}

// @public
export enum Shading {
    // (undocumented)
    FlatTexture = 1,
    // (undocumented)
    ShadedNoTexture = 3,
    // (undocumented)
    ShadedTexture = 2
}


// (No @packageDocumentation comment for this package)