@itwin/frontend-tiles 4.1.0-dev.7 → 4.1.0-dev.71

package/src/BatchedTileTreeReference.ts

@@ -1,113 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-import { Range3d, Transform } from "@itwin/core-geometry";
-import {
-  BatchType, FeatureAppearance, FeatureAppearanceProvider, FeatureAppearanceSource, GeometryClass, RenderSchedule,
-} from "@itwin/core-common";
-import {
-  AnimationNodeId, formatAnimationBranchId, SceneContext, TileDrawArgs, TileTree, TileTreeOwner, TileTreeReference,
-} from "@itwin/core-frontend";
-import { BatchedModels } from "./BatchedModels";
-
-/** @internal */
-export abstract class BatchedTileTreeReference extends TileTreeReference {
-  protected readonly _treeOwner: TileTreeOwner;
-
-  protected constructor(treeOwner: TileTreeOwner) {
-    super();
-    this._treeOwner = treeOwner;
-  }
-
-  public override get treeOwner(): TileTreeOwner {
-    return this._treeOwner;
-  }
-
-  protected computeBaseTransform(tree: TileTree): Transform {
-    return super.computeTransform(tree);
-  }
-
-  protected override computeTransform(tree: TileTree): Transform {
-    const baseTf = this.computeBaseTransform(tree);
-    // ###TODO this.view.modelDisplayTransformProvider?.getModelDisplayTransform(modelId...)
-    return baseTf;
-  }
-}
-
-export class PrimaryBatchedTileTreeReference extends BatchedTileTreeReference implements FeatureAppearanceProvider {
-  private readonly _models: BatchedModels;
-
-  public constructor(treeOwner: TileTreeOwner, models: BatchedModels) {
-    super(treeOwner);
-    this._models = models;
-  }
-
-  public override unionFitRange(range: Range3d): void {
-    this._models.unionRange(range);
-  }
-
-  public override getAppearanceProvider(): FeatureAppearanceProvider | undefined {
-    return this;
-  }
-
-  public getFeatureAppearance(
-    source: FeatureAppearanceSource,
-    elemLo: number, elemHi: number,
-    subcatLo: number, subcatHi: number,
-    geomClass: GeometryClass,
-    modelLo: number, modelHi: number,
-    type: BatchType,
-    animationNodeId: number
-  ): FeatureAppearance | undefined {
-    if (!this._models.isViewed(modelLo, modelHi))
-      return undefined;
-
-    return source.getAppearance(elemLo, elemHi, subcatLo, subcatHi, geomClass, modelLo, modelHi, type, animationNodeId);
-  }
-
-  public override getAnimationTransformNodeId() {
-    return AnimationNodeId.Untransformed;
-  }
-}
-
-export interface AnimationNode {
-  readonly timeline: RenderSchedule.ModelTimeline;
-  readonly nodeId: number;
-  getCurrentTimePoint(): number;
-}
-
-export class AnimatedBatchedTileTreeReference extends BatchedTileTreeReference {
-  private readonly _node: AnimationNode;
-  private readonly _branchId: string;
-
-  public constructor(treeOwner: TileTreeOwner, node: AnimationNode) {
-    super(treeOwner);
-    this._node = node;
-    this._branchId = formatAnimationBranchId(node.timeline.modelId, node.nodeId);
-  }
-
-  public override getAnimationTransformNodeId(): number {
-    return this._node.nodeId;
-  }
-
-  public override computeBaseTransform(tree: TileTree): Transform {
-    const tf = super.computeBaseTransform(tree);
-    const animTf = this._node.timeline.getTransform(this._node.nodeId, this._node.getCurrentTimePoint());
-    if (animTf)
-      animTf.multiplyTransformTransform(tf, tf);
-
-    return tf;
-  }
-
-  public override createDrawArgs(context: SceneContext): TileDrawArgs | undefined {
-    const animBranch = context.viewport.target.animationBranches?.branchStates.get(this._branchId);
-    if (animBranch && animBranch.omit)
-      return undefined;
-
-    const args = super.createDrawArgs(context);
-    // ###TODO args.boundingRange = args.tree.getTransformNodeRange(this._animationTransformNodeId);
-    return args;
-  }
-}

package/src/BatchedTileTreeSupplier.ts

@@ -1,52 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-import { comparePossiblyUndefined, compareStrings, Logger } from "@itwin/core-bentley";
-import { RenderSchedule } from "@itwin/core-common";
-import {
-  IModelConnection, TileTree, TileTreeOwner, TileTreeSupplier,
-} from "@itwin/core-frontend";
-import { loggerCategory } from "./LoggerCategory";
-import { BatchedTilesetReader } from "./BatchedTilesetReader";
-import { BatchedTileTree } from "./BatchedTileTree";
-
-/** @internal */
-export interface BatchedTileTreeId {
-  baseUrl: URL;
-  script?: RenderSchedule.Script;
-}
-
-class BatchedTileTreeSupplier implements TileTreeSupplier {
-  public compareTileTreeIds(lhs: BatchedTileTreeId, rhs: BatchedTileTreeId): number {
-    return compareStrings(lhs.toString(), rhs.toString())
-      || comparePossiblyUndefined((x, y) => x.compareTo(y), lhs.script, rhs.script);
-  }
-
-  public async createTileTree(treeId: BatchedTileTreeId, iModel: IModelConnection): Promise<TileTree | undefined> {
-    const baseUrl = treeId.baseUrl;
-    const url = new URL("tileset.json", baseUrl);
-    url.search = baseUrl.search;
-    try {
-      const response = await fetch(url.toString());
-      const json = await response.json();
-
-      const reader = new BatchedTilesetReader(json, iModel, baseUrl);
-      const params = await reader.readTileTreeParams();
-
-      params.script = treeId.script;
-      return new BatchedTileTree(params);
-    } catch (err) {
-      Logger.logException(loggerCategory, err);
-      return undefined;
-    }
-  }
-}
-
-const batchedTileTreeSupplier: TileTreeSupplier = new BatchedTileTreeSupplier();
-
-/** @internal */
-export function getBatchedTileTreeOwner(iModel: IModelConnection, treeId: BatchedTileTreeId): TileTreeOwner {
-  return iModel.tiles.getTileTreeOwner(treeId, batchedTileTreeSupplier);
-}

package/src/BatchedTilesetReader.ts

@@ -1,113 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-import {
-  Matrix3d, Point3d, Range3d, Transform, Vector3d,
-} from "@itwin/core-geometry";
-import { Tileset3dSchema as schema } from "@itwin/core-common";
-import { IModelConnection, RealityModelTileUtils, TileLoadPriority } from "@itwin/core-frontend";
-import { BatchedTileTreeParams } from "./BatchedTileTree";
-import { BatchedTile, BatchedTileParams } from "./BatchedTile";
-
-function isTileset3d(json: unknown): json is schema.Tileset {
-  if (typeof json !== "object")
-    return false;
-
-  const props = json as schema.Tileset;
-
-  if (!props.root || !props.asset)
-    return false;
-
-  // ###TODO spec requires geometricError to be present on tileset and all tiles; exporter is omitting from tileset.
-  if (undefined === props.geometricError)
-    props.geometricError = props.root.geometricError;
-
-  return true;
-}
-
-function rangeFromBoundingVolume(vol: schema.BoundingVolume): Range3d {
-  if (vol.box) {
-    const center = new Point3d(vol.box[0], vol.box[1], vol.box[2]);
-    const ux = new Vector3d(vol.box[3], vol.box[4], vol.box[5]);
-    const uy = new Vector3d(vol.box[6], vol.box[7], vol.box[8]);
-    const uz = new Vector3d(vol.box[9], vol.box[10], vol.box[11]);
-
-    const range = Range3d.createNull();
-    for (let i = -1; i <= 1; i += 2)
-      for (let j = -1; j <= 1; j += 2)
-        for (let k = -1; k <= 1; k += 2)
-          range.extendPoint(center.plus3Scaled(ux, i, uy, j, uz, k));
-
-    return range;
-  } else if (vol.sphere) {
-    const center = new Point3d(vol.sphere[0], vol.sphere[1], vol.sphere[2]);
-    const radius = vol.sphere[3];
-    return Range3d.createXYZXYZ(center.x - radius, center.y - radius, center.z - radius, center.x + radius, center.y + radius, center.z + radius);
-  }
-
-  // We won't get region bounding volumes in our tiles.
-  throw new Error("region bounding volume unimplemented");
-}
-
-function transformFromJSON(json: schema.Transform): Transform {
-  const translation = new Point3d(json[12], json[13], json[14]);
-  const matrix = Matrix3d.createRowValues(
-    json[0], json[4], json[8],
-    json[1], json[5], json[9],
-    json[2], json[6], json[10]
-  );
-
-  return Transform.createOriginAndMatrix(translation, matrix);
-}
-
-/** @internal */
-export class BatchedTilesetReader {
-  private readonly _iModel: IModelConnection;
-  private readonly _tileset: schema.Tileset;
-  public readonly baseUrl: URL;
-
-  public constructor(json: unknown, iModel: IModelConnection, baseUrl: URL) {
-    if (!isTileset3d(json))
-      throw new Error("Invalid tileset JSON");
-
-    this._iModel = iModel;
-    this._tileset = json;
-    this.baseUrl = baseUrl;
-  }
-
-  public readTileParams(json: schema.Tile, parent?: BatchedTile): BatchedTileParams {
-    const content = json.content;
-    const geometricError = json.geometricError;
-    const range = rangeFromBoundingVolume(json.boundingVolume);
-    const isLeaf = undefined === json.children || json.children.length === 0;
-
-    // ###TODO evaluate this. The geometric errors in the tiles seem far too small.
-    const maximumSizeScale = 8;
-    return {
-      parent,
-      contentId: content?.uri ?? "",
-      range,
-      contentRange: content?.boundingVolume ? rangeFromBoundingVolume(content.boundingVolume) : undefined,
-      isLeaf,
-      maximumSize: maximumSizeScale * RealityModelTileUtils.maximumSizeFromGeometricTolerance(range, geometricError),
-      childrenProps: isLeaf ? undefined : json.children,
-    };
-  }
-
-  public async readTileTreeParams(): Promise<BatchedTileTreeParams> {
-    const root = this._tileset.root;
-    const location = root.transform ? transformFromJSON(root.transform) : Transform.createIdentity();
-
-    return {
-      id: "spatial-models",
-      modelId: this._iModel.transientIds.getNext(),
-      iModel: this._iModel,
-      location,
-      priority: TileLoadPriority.Primary,
-      rootTile: this.readTileParams(root),
-      reader: this,
-    };
-  }
-}

package/src/FrontendTiles.ts

@@ -1,52 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-import { IModelConnection, SpatialTileTreeReferences, SpatialViewState } from "@itwin/core-frontend";
-import { createBatchedSpatialTileTreeReferences } from "./BatchedSpatialTileTreeRefs";
-
-/** A function that can provide the base URL where a tileset representing all of the spatial models in a given iModel are stored.
- * The tileset is expected to reside at "baseUrl/tileset.json" and to have been produced by the [mesh export service](https://developer.bentley.com/apis/mesh-export/).
- * If no such tileset exists for the given iModel, return `undefined`.
- * @see [[FrontendTilesOptions.computeSpatialTilesetBaseUrl]].
- * @alpha
- */
-export type ComputeSpatialTilesetBaseUrl = (iModel: IModelConnection) => Promise<URL | undefined>;
-
-/** Options supplied to [[initializeFrontendTiles]].
- * @alpha
- */
-export interface FrontendTilesOptions {
-  /** Provide the base URL for the pre-published tileset for a given iModel. */
-  computeSpatialTilesetBaseUrl: ComputeSpatialTilesetBaseUrl;
-  /** The maximum number of levels in the tile tree to skip loading if they do not provide the desired level of detail for the current view.
-   * Default: 4.
-   * Reducing this value will load more intermediate tiles, which causes more gradual refinement: low-resolution tiles will display quickly, followed more gradually by
-   * successively higher-resolution ones.
-   * Increasing the value jumps more directly to tiles of the exact level of detail desired, which may load more, smaller tiles up-front, leaving some areas of the view
-   * vacant for longer; and when zooming out some newly-exposed areas of the view may remain vacant for longer because no lower-resolution tiles are initially available to
-   * fill them. However, tiles close to the viewer (and therefore likely of most interest to them) will refine to an appropriate level of detail more quickly.
-   */
-  maxLevelsToSkip?: number;
-}
-
-/** @internal */
-export const createFallbackSpatialTileTreeReferences = SpatialTileTreeReferences.create;
-
-let maxLevelsToSkip = 4;
-
-/** @internal */
-export function getMaxLevelsToSkip(): number {
-  return maxLevelsToSkip;
-}
-
-/** Initialize the frontend-tiles package to obtain tiles for spatial views.
- * @alpha
- */
-export function initializeFrontendTiles(options: FrontendTilesOptions): void {
-  if (undefined !== options.maxLevelsToSkip && options.maxLevelsToSkip >= 0)
-    maxLevelsToSkip = options.maxLevelsToSkip;
-
-  SpatialTileTreeReferences.create = (view: SpatialViewState) => createBatchedSpatialTileTreeReferences(view, options.computeSpatialTilesetBaseUrl);
-}

package/src/LoggerCategory.ts

@@ -1,8 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-/** @internal */
-export const loggerCategory = "frontend-tiles";
-

package/src/frontend-tiles.ts

@@ -1,6 +0,0 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-export * from "./FrontendTiles";

package/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./node_modules/@itwin/build-tools/tsconfig-base.json",
-  "compilerOptions": {
-    "outDir": "./lib"
-  }
-}