## API Report File for "3d-tiles-tools"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
///
import { PathLike } from 'fs';
// Warning: (ae-internal-missing-underscore) The name "ArchiveFunctions3tz" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export class ArchiveFunctions3tz {
// (undocumented)
static md5LessThan(md5hashA: Buffer, md5hashB: Buffer): boolean;
// (undocumented)
static readEntryData(fd: number, zipIndex: IndexEntry[], path: string): Buffer | undefined;
// (undocumented)
static readFileName(fd: number, offset: number | bigint): string;
// (undocumented)
static readZipIndex(fd: number): IndexEntry[];
// Warning: (ae-forgotten-export) The symbol "ZipLocalFileHeader" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static readZipLocalFileHeader(fd: number, offset: number | bigint, path: string): ZipLocalFileHeader;
// (undocumented)
static zipIndexFind(zipIndex: IndexEntry[], searchHash: Buffer): number;
}
// Warning: (ae-internal-missing-underscore) The name "ArrayValues" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ArrayValues {
static anyDeepGreaterThan(a: any, b: any): boolean;
static anyDeepLessThan(a: any, b: any): boolean;
static deepAdd(value: any, addend: any): any;
static deepClone(value: any): any;
static deepEquals(a: any, b: any): boolean;
static deepMax(a: any, b: any): any;
static deepMin(a: any, b: any): any;
static deepMultiply(value: any, factor: any): any;
}
// Warning: (ae-internal-missing-underscore) The name "Asset" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Asset extends RootProperty {
tilesetVersion?: string;
version: string;
}
// Warning: (ae-internal-missing-underscore) The name "Availability" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Availability extends RootProperty {
availableCount?: number;
bitstream?: number;
constant?: number;
}
// Warning: (ae-internal-missing-underscore) The name "AvailabilityInfo" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface AvailabilityInfo {
isAvailable(index: number): boolean;
get length(): number;
}
// Warning: (ae-internal-missing-underscore) The name "AvailabilityInfos" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class AvailabilityInfos {
static createChildSubtree(availability: Availability, bufferViewDatas: Buffer[], implicitTiling: TileImplicitTiling): AvailabilityInfo;
static createTileOrContent(availability: Availability, bufferViewDatas: Buffer[], implicitTiling: TileImplicitTiling): AvailabilityInfo;
}
// Warning: (ae-internal-missing-underscore) The name "BinaryBufferData" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BinaryBufferData {
buffersData: Buffer[];
bufferViewsData: Buffer[];
}
// Warning: (ae-internal-missing-underscore) The name "BinaryBufferDataResolver" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class BinaryBufferDataResolver {
static resolve(binaryBufferStructure: BinaryBufferStructure, binaryBuffer: Buffer | undefined, resourceResolver: ResourceResolver): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "BinaryBuffers" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class BinaryBuffers {
static createBinaryBufferStructure(binaryBufferData: BinaryBufferData, newBufferViewsData: Buffer[]): BinaryBufferStructure;
}
// Warning: (ae-internal-missing-underscore) The name "BinaryBufferStructure" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BinaryBufferStructure {
// (undocumented)
buffers: BufferObject[];
// (undocumented)
bufferViews: BufferView[];
}
// Warning: (ae-internal-missing-underscore) The name "BinaryDataError" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class BinaryDataError extends Error {
constructor(message: string);
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "BinaryPropertyTable" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BinaryPropertyTable {
binaryBufferData: BinaryBufferData;
binaryBufferStructure: BinaryBufferStructure;
// Warning: (ae-forgotten-export) The symbol "BinaryEnumInfo" needs to be exported by the entry point index.d.ts
binaryEnumInfo: BinaryEnumInfo;
metadataClass: MetadataClass;
propertyTable: PropertyTable;
}
// Warning: (ae-internal-missing-underscore) The name "BinaryPropertyTableModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class BinaryPropertyTableModel implements PropertyTableModel {
constructor(binaryPropertyTable: BinaryPropertyTable);
getClassProperty(propertyId: string): ClassProperty | undefined;
getMetadataEntityModel(index: number): MetadataEntityModel;
getPropertyModel(propertyId: string): PropertyModel | undefined;
getPropertyTableProperty(propertyId: string): PropertyTableProperty | undefined;
}
// Warning: (ae-internal-missing-underscore) The name "BinaryPropertyTables" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class BinaryPropertyTables {
static createBinaryPropertyTable(schema: Schema, className: string, propertyName: string, values: any, arrayOffsetType: string | undefined, stringOffsetType: string | undefined): BinaryPropertyTable;
static createBinaryPropertyTableFromProperty(propertyName: string, classProperty: ClassProperty, values: any, arrayOffsetType: string | undefined, stringOffsetType: string | undefined, metadataEnum: MetadataEnum | undefined): BinaryPropertyTable;
static createSchemaFromClassProperty(propertyName: string, classProperty: ClassProperty, metadataEnum: MetadataEnum | undefined): Schema;
}
// Warning: (ae-internal-missing-underscore) The name "BinarySubtreeData" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BinarySubtreeData {
binaryBufferData: BinaryBufferData;
binaryBufferStructure: BinaryBufferStructure;
subtree: Subtree;
}
// Warning: (ae-internal-missing-underscore) The name "BinarySubtreeDataResolver" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class BinarySubtreeDataResolver {
static resolveFromBuffer(input: Buffer, resourceResolver: ResourceResolver): Promise;
static resolveFromJson(subtree: Subtree, resourceResolver: ResourceResolver): Promise;
static resolveInternal(subtree: Subtree, binaryBuffer: Buffer | undefined, resourceResolver: ResourceResolver): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "BoundingVolume" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BoundingVolume extends RootProperty {
box?: number[];
region?: number[];
sphere?: number[];
}
// Warning: (ae-internal-missing-underscore) The name "BufferObject" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BufferObject extends RootProperty {
byteLength: number;
name?: string;
uri?: string;
}
// Warning: (ae-internal-missing-underscore) The name "Buffers" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class Buffers {
static createBinaryString(buffer: Buffer): string;
static getBufferPadded(buffer: Buffer, byteOffset?: number): Buffer;
static getJson(buffer: Buffer): any;
static getJsonBufferPadded(json: any, byteOffset?: number): Buffer;
static getMagicBytes(buffer: Buffer, byteOffset: number, byteLength: number): Buffer;
static getMagicString(buffer: Buffer, byteOffset?: number): string;
static getUnicodeBOMDescription(buffer: Buffer): string | undefined;
static gunzip(inputBuffer: Buffer): Buffer;
static gzip(inputBuffer: Buffer): Buffer;
static isGzipped(buffer: Buffer): boolean;
static isProbablyJson(buffer: Buffer): boolean;
}
// Warning: (ae-internal-missing-underscore) The name "BufferView" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface BufferView extends RootProperty {
buffer: number;
byteLength: number;
byteOffset: number;
name?: string;
}
// Warning: (ae-internal-missing-underscore) The name "ClassProperties" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ClassProperties {
static hasEffectivelyFloatingPointType(property: ClassProperty): boolean;
static hasNumericType(property: ClassProperty): boolean;
}
// Warning: (ae-internal-missing-underscore) The name "ClassProperty" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface ClassProperty extends RootProperty {
array?: boolean;
componentType?: string;
count?: number;
default?: any;
description?: string;
enumType?: string;
max?: any;
min?: any;
name?: string;
noData?: any;
normalized?: boolean;
offset?: any;
required?: boolean;
scale?: any;
semantic?: string;
type: string;
}
// Warning: (ae-internal-missing-underscore) The name "Content" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Content extends RootProperty {
boundingVolume?: BoundingVolume;
group?: number;
metadata?: MetadataEntity;
uri: string;
}
// Warning: (ae-internal-missing-underscore) The name "ContentData" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface ContentData {
exists(): Promise;
get extension(): string;
getData(): Promise;
getMagic(): Promise;
getParsedObject(): Promise;
get uri(): string;
}
// Warning: (ae-internal-missing-underscore) The name "ContentDataTypeRegistry" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ContentDataTypeRegistry {
static findContentDataType(contentData: ContentData): Promise;
static findType(uri: string, data: Buffer): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "DefaultMetadataEntityModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class DefaultMetadataEntityModel implements MetadataEntityModel {
constructor(metadataClass: MetadataClass, semanticToPropertyId: {
[key: string]: string;
}, json: any);
getPropertyValue(propertyId: string): any;
getPropertyValueBySemantic(semantic: string): any;
}
// Warning: (ae-internal-missing-underscore) The name "defaultValue" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export function defaultValue(a: T | undefined, b: T): T;
// Warning: (ae-internal-missing-underscore) The name "defined" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export function defined(value: T): value is NonNullable;
// Warning: (ae-internal-missing-underscore) The name "DeveloperError" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class DeveloperError extends Error {
constructor(message: string);
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "EnumValue" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface EnumValue extends RootProperty {
description?: string;
name: string;
value: number;
}
// Warning: (ae-internal-missing-underscore) The name "ExplicitTraversedTile" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ExplicitTraversedTile implements TraversedTile {
constructor(tile: Tile, path: string, level: number, parent: TraversedTile | undefined, schema: Schema | undefined, resourceResolver: ResourceResolver);
asFinalTile(): Tile;
asRawTile(): Tile;
static createRoot(root: Tile, schema: Schema | undefined, resourceResolver: ResourceResolver): TraversedTile;
getChildren(): Promise;
getFinalContents(): Content[];
getImplicitTiling(): TileImplicitTiling | undefined;
getMetadata(): MetadataEntity | undefined;
getParent(): TraversedTile | undefined;
getRawContents(): Content[];
getResourceResolver(): ResourceResolver;
getSubtreeUri(): string | undefined;
isImplicitTilesetRoot(): boolean;
get level(): number;
get path(): string;
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "ExplicitTraversedTiles" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ExplicitTraversedTiles {
static createTraversedChildren(implicitTiling: TileImplicitTiling, schema: Schema | undefined, parent: ExplicitTraversedTile, resourceResolver: ResourceResolver): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "FileResourceResolver" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class FileResourceResolver implements ResourceResolver {
constructor(basePath: string);
derive(uri: string): ResourceResolver;
resolveData(uri: string): Promise;
resolveDataPartial(uri: string, maxBytes: number): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "Group" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Group extends MetadataEntity {
}
// Warning: (ae-internal-missing-underscore) The name "ImplicitTilingError" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ImplicitTilingError extends Error {
constructor(message: string);
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "ImplicitTilings" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ImplicitTilings {
static computeNumberOfNodesInLevel(implicitTiling: TileImplicitTiling, level: number): number;
static computeNumberOfNodesPerSubtree(implicitTiling: TileImplicitTiling): number;
static createRootCoordinates(implicitTiling: TileImplicitTiling): TreeCoordinates;
static createString(coordinates: TreeCoordinates): string;
static createSubtreeCoordinatesIterator(implicitTiling: TileImplicitTiling): IterableIterator;
static globalizeCoordinates(implicitTiling: TileImplicitTiling, rootCoordinates: TreeCoordinates, coordinates: TreeCoordinates): TreeCoordinates;
static substituteTemplateUri(subdivisionScheme: string, templateUri: string, coordinates: TreeCoordinates): string;
}
// Warning: (ae-internal-missing-underscore) The name "ImplicitTraversedTile" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ImplicitTraversedTile implements TraversedTile {
constructor(implicitTiling: TileImplicitTiling, resourceResolver: ResourceResolver, root: TraversedTile, path: string, subtreeModel: SubtreeModel, globalLevel: number, globalCoordinate: TreeCoordinates, rootCoordinate: TreeCoordinates, localCoordinate: TreeCoordinates, parent: TraversedTile);
asFinalTile(): Tile;
asRawTile(): Tile;
getChildren(): Promise;
getFinalContents(): Content[];
getGlobalCoordinate(): TreeCoordinates;
getLocalCoordinate(): TreeCoordinates;
getParent(): TraversedTile | undefined;
getRawContents(): Content[];
getResourceResolver(): ResourceResolver;
getSubtreeUri(): string | undefined;
isImplicitTilesetRoot(): boolean;
get level(): number;
get path(): string;
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "IndexBuilder" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class IndexBuilder {
constructor();
addEntry(key: string, size: number): void;
createBuffer(): Buffer;
}
// Warning: (ae-internal-missing-underscore) The name "IndexBuilderEntry" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface IndexBuilderEntry {
key: string;
offset: bigint;
}
// Warning: (ae-internal-missing-underscore) The name "IndexEntry" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface IndexEntry {
hash: Buffer;
offset: bigint;
}
// Warning: (ae-internal-missing-underscore) The name "Iterables" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class Iterables {
static filter(iterable: IterableIterator, include: (element: T) => boolean): {
[Symbol.iterator](): any;
next(): IteratorResult;
};
static map(iterable: IterableIterator, mapper: (element: S) => T): IterableIterator;
static overFiles(directory: string | PathLike, recurse: boolean): IterableIterator;
}
// Warning: (ae-internal-missing-underscore) The name "LazyContentData" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class LazyContentData implements ContentData {
constructor(uri: string, resourceResolver: ResourceResolver);
exists(): Promise;
get extension(): string;
getData(): Promise;
getMagic(): Promise;
getParsedObject(): Promise;
get uri(): string;
}
// Warning: (ae-internal-missing-underscore) The name "MetadataClass" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface MetadataClass extends RootProperty {
description?: string;
name?: string;
properties?: {
[key: string]: ClassProperty;
};
}
// Warning: (ae-internal-missing-underscore) The name "MetadataComponentTypes" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class MetadataComponentTypes {
static allComponentTypes: string[];
static byteSizeForComponentType(componentType: string): number;
static integerComponentTypes: string[];
static isIntegerComponentType(componentType: string | undefined): boolean;
static isUnsignedComponentType(componentType: string | undefined): boolean;
// (undocumented)
static normalize(value: number, componentType: string | undefined): number;
static unsignedComponentTypes: string[];
}
// Warning: (ae-internal-missing-underscore) The name "MetadataEntity" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface MetadataEntity extends RootProperty {
class: string;
properties?: {
[key: string]: any;
};
}
// Warning: (ae-internal-missing-underscore) The name "MetadataEntityModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface MetadataEntityModel {
getPropertyValue(propertyId: string): any;
getPropertyValueBySemantic(semantic: string): any;
}
// Warning: (ae-internal-missing-underscore) The name "MetadataEntityModels" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class MetadataEntityModels {
static computeSemanticToPropertyIdMapping(metadataClass: MetadataClass): {
[key: string]: string;
};
static create(schema: Schema, entity: MetadataEntity): MetadataEntityModel;
static createFromClass(metadataClass: MetadataClass, entityProperties: {
[key: string]: any;
}): DefaultMetadataEntityModel;
}
// Warning: (ae-internal-missing-underscore) The name "MetadataEnum" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface MetadataEnum extends RootProperty {
description?: string;
name?: string;
values: EnumValue[];
valueType?: string;
}
// Warning: (ae-internal-missing-underscore) The name "MetadataError" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class MetadataError extends Error {
constructor(message: string);
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "MetadataTypes" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class MetadataTypes {
static allTypes: string[];
static componentCountForType(type: string): number;
static isNumericType(type: string): boolean;
static numericTypes: string[];
}
// Warning: (ae-internal-missing-underscore) The name "MetadataUtilities" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class MetadataUtilities {
static computeBinaryEnumInfo(schema: Schema): BinaryEnumInfo;
static obtainEnumValueNames(classProperty: ClassProperty, schema: Schema): string[];
}
// Warning: (ae-internal-missing-underscore) The name "MetadataValues" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class MetadataValues {
static processValue(classProperty: ClassProperty, offsetOverride: any, scaleOverride: any, value: any): any;
}
// Warning: (ae-internal-missing-underscore) The name "NumericBuffers" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class NumericBuffers {
static getNumericArrayFromBuffer(buffer: Buffer, index: number, arrayLength: number, componentType: string): any;
static getNumericBufferAsArray(buffer: Buffer, componentType: string): any;
static getNumericFromBuffer(buffer: Buffer, index: number, componentType: string): any;
}
// Warning: (ae-internal-missing-underscore) The name "OctreeCoordinates" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class OctreeCoordinates implements TreeCoordinates {
constructor(level: number, x: number, y: number, z: number);
children(): IterableIterator;
descendants(maxLevelInclusive: number, depthFirst: boolean): IterableIterator;
get level(): number;
parent(): OctreeCoordinates | null;
toArray(): number[];
toIndex(): number;
toIndexInLevel(): number;
// (undocumented)
toString: () => string;
// (undocumented)
get x(): number;
// (undocumented)
get y(): number;
// (undocumented)
get z(): number;
}
// Warning: (ae-internal-missing-underscore) The name "Octrees" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class Octrees {
static computeNumberOfNodesForLevels(levels: number): number;
static coordinatesForLevel(level: number): Generator;
static isValid(c: OctreeCoordinates): boolean;
}
// Warning: (ae-internal-missing-underscore) The name "Paths" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class Paths {
static ensureDirectoryExists(directory: string): void;
static hasExtension(fileName: string, ...extensions: string[]): boolean;
static isDirectory(p: string): boolean;
static join(...paths: string[]): string;
static relativize(directory: string, fileName: string): string;
static replaceExtension(fileName: string, newExtension: string): string;
static resolve(...paths: string[]): string;
}
// Warning: (ae-internal-missing-underscore) The name "Properties" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Properties extends RootProperty {
maximum: number;
minimum: number;
}
// Warning: (ae-internal-missing-underscore) The name "PropertyModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface PropertyModel {
getPropertyValue(index: number): any;
}
// Warning: (ae-internal-missing-underscore) The name "PropertyTable" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface PropertyTable extends RootProperty {
class: string;
count: number;
name?: string;
properties?: {
[key: string]: PropertyTableProperty;
};
}
// Warning: (ae-internal-missing-underscore) The name "PropertyTableModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface PropertyTableModel {
getClassProperty(propertyId: string): ClassProperty | undefined;
getMetadataEntityModel(index: number): MetadataEntityModel;
getPropertyModel(propertyId: string): PropertyModel | undefined;
getPropertyTableProperty(propertyId: string): PropertyTableProperty | undefined;
}
// Warning: (ae-internal-missing-underscore) The name "PropertyTableProperty" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface PropertyTableProperty extends RootProperty {
arrayOffsets?: number;
arrayOffsetType?: string;
max?: any;
min?: any;
offset?: any;
scale?: any;
stringOffsets?: number;
stringOffsetType?: string;
values: number;
}
// Warning: (ae-internal-missing-underscore) The name "QuadtreeCoordinates" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class QuadtreeCoordinates implements TreeCoordinates {
constructor(level: number, x: number, y: number);
children(): IterableIterator;
descendants(maxLevelInclusive: number, depthFirst: boolean): IterableIterator;
get level(): number;
parent(): QuadtreeCoordinates | null;
toArray(): number[];
toIndex(): number;
toIndexInLevel(): number;
// (undocumented)
toString: () => string;
// (undocumented)
get x(): number;
// (undocumented)
get y(): number;
}
// Warning: (ae-internal-missing-underscore) The name "Quadtrees" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class Quadtrees {
static computeNumberOfNodesForLevels(levels: number): number;
static coordinatesForLevel(level: number): Generator;
static isValid(c: QuadtreeCoordinates): boolean;
}
// Warning: (ae-internal-missing-underscore) The name "ResourceResolver" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface ResourceResolver {
derive(uri: string): ResourceResolver;
resolveData(uri: string): Promise;
resolveDataPartial(uri: string, maxBytes: number): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "ResourceResolvers" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class ResourceResolvers {
static createFileResourceResolver(directory: string): UnzippingResourceResolver;
}
// Warning: (ae-internal-missing-underscore) The name "RootProperty" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface RootProperty {
// (undocumented)
extensions?: {
[key: string]: {
[key: string]: any;
};
};
// (undocumented)
extras?: {
[key: string]: any;
};
}
// Warning: (ae-internal-missing-underscore) The name "Schema" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Schema extends RootProperty {
classes?: {
[key: string]: MetadataClass;
};
description?: string;
enums?: {
[key: string]: MetadataEnum;
};
id: string;
name?: string;
version?: string;
}
// Warning: (ae-internal-missing-underscore) The name "Statistics" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Statistics extends RootProperty {
classes?: {
[key: string]: StatisticsClass;
};
}
// Warning: (ae-internal-missing-underscore) The name "StatisticsClass" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface StatisticsClass extends RootProperty {
count?: number;
properties?: {
[key: string]: StatisticsClassProperty;
};
}
// Warning: (ae-internal-missing-underscore) The name "StatisticsClassProperty" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface StatisticsClassProperty extends RootProperty {
max?: any;
mean?: any;
median?: any;
min?: any;
occurrences?: {
[key: string]: any;
};
standardDeviation?: any;
sum?: any;
variance?: any;
}
// Warning: (ae-internal-missing-underscore) The name "Subtree" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Subtree extends RootProperty {
buffers?: BufferObject[];
bufferViews?: BufferView[];
childSubtreeAvailability: Availability;
contentAvailability?: Availability[];
contentMetadata?: number[];
propertyTables?: PropertyTable[];
subtreeMetadata?: MetadataEntity;
tileAvailability: Availability;
tileMetadata?: number;
}
// Warning: (ae-internal-missing-underscore) The name "SubtreeInfo" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface SubtreeInfo {
childSubtreeAvailabilityInfo: AvailabilityInfo;
contentAvailabilityInfos: AvailabilityInfo[];
tileAvailabilityInfo: AvailabilityInfo;
}
// Warning: (ae-internal-missing-underscore) The name "SubtreeInfos" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class SubtreeInfos {
static create(binarySubtreeData: BinarySubtreeData, implicitTiling: TileImplicitTiling): SubtreeInfo;
static createFromBuffer(input: Buffer, implicitTiling: TileImplicitTiling, resourceResolver: ResourceResolver): Promise;
static createFromJson(subtree: Subtree, implicitTiling: TileImplicitTiling, resourceResolver: ResourceResolver): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "SubtreeMetadataModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface SubtreeMetadataModel {
contentIndexMappings: number[][];
contentMetadataModels: PropertyTableModel[];
schema: Schema;
tileIndexMapping: number[] | undefined;
tileMetadataModel: PropertyTableModel | undefined;
}
// Warning: (ae-internal-missing-underscore) The name "SubtreeMetadataModels" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class SubtreeMetadataModels {
static create(binarySubtreeData: BinarySubtreeData, subtreeInfo: SubtreeInfo, schema: Schema): SubtreeMetadataModel;
}
// Warning: (ae-internal-missing-underscore) The name "SubtreeModel" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface SubtreeModel {
subtreeInfo: SubtreeInfo;
subtreeMetadataModel: SubtreeMetadataModel | undefined;
}
// Warning: (ae-internal-missing-underscore) The name "SubtreeModels" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class SubtreeModels {
static resolve(implicitTiling: TileImplicitTiling, schema: Schema | undefined, resourceResolver: ResourceResolver, coordinates: TreeCoordinates): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "Subtrees" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Subtrees extends RootProperty {
uri: string;
}
// Warning: (ae-internal-missing-underscore) The name "TemplateUris" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TemplateUris {
static substituteOctree(templateUri: string, coordinates: OctreeCoordinates): string;
static substituteOctreeInternal(templateUri: string, level: number, x: number, y: number, z: number): string;
static substituteQuadtree(templateUri: string, coordinates: QuadtreeCoordinates): string;
static substituteQuadtreeInternal(templateUri: string, level: number, x: number, y: number): string;
}
// Warning: (ae-internal-missing-underscore) The name "Tile" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Tile extends RootProperty {
boundingVolume: BoundingVolume;
children?: Tile[];
content?: Content;
contents?: Content[];
geometricError: number;
implicitTiling?: TileImplicitTiling;
metadata?: MetadataEntity;
refine?: string;
transform?: number[];
viewerRequestVolume?: BoundingVolume;
}
// Warning: (ae-internal-missing-underscore) The name "TileImplicitTiling" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TileImplicitTiling extends RootProperty {
availableLevels: number;
subdivisionScheme: string;
subtreeLevels: number;
subtrees: Subtrees;
}
// Warning: (ae-internal-missing-underscore) The name "Tileset" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface Tileset extends RootProperty {
asset: Asset;
extensionsRequired?: string[];
extensionsUsed?: string[];
geometricError: number;
groups?: Group[];
metadata?: MetadataEntity;
properties?: {
[key: string]: Properties;
};
root: Tile;
schema?: Schema;
schemaUri?: string;
statistics?: Statistics;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetEntry" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TilesetEntry {
key: string;
value: Buffer;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetError" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetError extends Error {
constructor(message: string);
// (undocumented)
toString: () => string;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetSource" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TilesetSource {
close(): void;
getKeys(): IterableIterator;
getValue(key: string): Buffer | undefined;
open(fullInputName: string): void;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetSource3dtiles" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetSource3dtiles implements TilesetSource {
constructor();
close(): void;
getKeys(): IterableIterator;
getValue(key: string): Buffer | undefined;
open(fullInputName: string): void;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetSource3tz" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetSource3tz implements TilesetSource {
constructor();
close(): void;
getKeys(): IterableIterator;
getValue(key: string): Buffer | undefined;
// (undocumented)
getZipIndex(): IndexEntry[] | undefined;
open(fullInputName: string): void;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetSourceFs" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetSourceFs implements TilesetSource {
constructor();
close(): void;
getKeys(): IterableIterator;
getValue(key: string): Buffer | undefined;
open(fullInputName: string): void;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetSourceResourceResolver" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetSourceResourceResolver implements ResourceResolver {
constructor(basePath: string, tilesetSource: TilesetSource);
derive(uri: string): ResourceResolver;
resolveData(uri: string): Promise;
resolveDataPartial(uri: string, maxBytes: number): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetSources" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetSources {
static create(extension: string): TilesetSource | undefined;
static createAndOpen(name: string): TilesetSource;
static getEntries(tilesetSource: TilesetSource): IterableIterator;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetTarget" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TilesetTarget {
addEntry(key: string, content: Buffer): void;
begin(fullOutputName: string, overwrite: boolean): void;
end(): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetTarget3dtiles" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetTarget3dtiles implements TilesetTarget {
constructor();
addEntry(key: string, content: Buffer): void;
begin(fullOutputName: string, overwrite: boolean): void;
end(): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetTarget3tz" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetTarget3tz implements TilesetTarget {
constructor();
addEntry(key: string, content: Buffer): void;
begin(fullOutputName: string, overwrite: boolean): void;
end(): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetTargetFs" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetTargetFs implements TilesetTarget {
constructor();
addEntry(key: string, content: Buffer): void;
begin(fullOutputName: string, overwrite: boolean): void;
end(): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetTargets" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetTargets {
static create(extension: string): TilesetTarget | undefined;
static createAndBegin(name: string, overwrite: boolean): TilesetTarget;
static putEntries(tilesetTarget: TilesetTarget, entries: IterableIterator): void;
}
// Warning: (ae-internal-missing-underscore) The name "TilesetTraverser" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class TilesetTraverser {
constructor(baseUri: string, resourceResolver: ResourceResolver, options?: TraversalOptions);
traverse(tileset: Tileset, traversalCallback: TraversalCallback): Promise;
traverseWithSchema(tileset: Tileset, schema: Schema | undefined, traversalCallback: TraversalCallback): Promise;
traverseWithSchemaAt(tile: Tile, schema: Schema | undefined, traversalCallback: TraversalCallback): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TraversalCallback" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TraversalCallback {
(traversedTile: TraversedTile): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "TraversalOptions" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export type TraversalOptions = {
depthFirst?: boolean;
traverseExternalTilesets?: boolean;
};
// Warning: (ae-internal-missing-underscore) The name "TraversedTile" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TraversedTile {
asFinalTile(): Tile;
asRawTile(): Tile;
getChildren(): Promise;
getFinalContents(): Content[];
getParent(): TraversedTile | undefined;
getRawContents(): Content[];
getResourceResolver(): ResourceResolver;
getSubtreeUri(): string | undefined;
isImplicitTilesetRoot(): boolean;
get level(): number;
get path(): string;
}
// Warning: (ae-internal-missing-underscore) The name "TreeCoordinates" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export interface TreeCoordinates {
children(): IterableIterator;
descendants(maxLevelInclusive: number, depthFirst: boolean): IterableIterator;
get level(): number;
parent(): TreeCoordinates | null;
toArray(): number[];
toIndex(): number;
toIndexInLevel(): number;
}
// Warning: (ae-internal-missing-underscore) The name "UnzippingResourceResolver" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class UnzippingResourceResolver implements ResourceResolver {
constructor(delegate: ResourceResolver);
derive(uri: string): ResourceResolver;
resolveData(uri: string): Promise;
resolveDataPartial(uri: string, maxBytes: number): Promise;
}
// Warning: (ae-internal-missing-underscore) The name "Uris" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export class Uris {
static isAbsoluteUri(uri: string): boolean;
static isDataUri(uri: string): boolean;
}
// (No @packageDocumentation comment for this package)
```