Source code for py3dtiles.typing

from __future__ import annotations

from dataclasses import dataclass
from pathlib import Path
from typing import TYPE_CHECKING, Any, Literal, Optional, TypedDict, Union

import numpy as np
import numpy.typing as npt
from pyproj import CRS

if TYPE_CHECKING:
    from typing_extensions import NotRequired

# Tileset types

ExtensionDictType = dict[str, Any]
ExtraDictType = dict[str, Any]
GeometricErrorType = float
PropertyType = dict[str, Any]
RefineType = Literal["ADD", "REPLACE"]
TransformDictType = list[float]




class RootPropertyDictType(TypedDict):
    extensions: NotRequired[dict[str, ExtensionDictType]]
    extras: NotRequired[ExtraDictType]





class BoundingVolumeBoxDictType(RootPropertyDictType):
    box: list[float]





class BoundingVolumeRegionDictType(RootPropertyDictType):
    region: list[float]





class BoundingVolumeSphereDictType(RootPropertyDictType):
    sphere: list[float]



BoundingVolumeDictType = Union[
    BoundingVolumeBoxDictType,
    BoundingVolumeRegionDictType,
    BoundingVolumeSphereDictType,
]




class ContentType(RootPropertyDictType):
    boundingVolume: NotRequired[BoundingVolumeDictType]
    uri: str





class PropertyDictType(RootPropertyDictType):
    maximum: float
    minimum: float





class AssetDictType(RootPropertyDictType):
    version: Literal["1.0", "1.1"]
    tilesetVersion: NotRequired[str]





class TileDictType(RootPropertyDictType):
    boundingVolume: BoundingVolumeDictType
    geometricError: GeometricErrorType
    viewerRequestVolume: NotRequired[BoundingVolumeDictType]
    refine: NotRequired[RefineType]
    transform: NotRequired[TransformDictType]
    content: NotRequired[ContentType]
    children: NotRequired[list[TileDictType]]





class TilesetDictType(RootPropertyDictType):
    asset: AssetDictType
    geometricError: GeometricErrorType
    root: TileDictType
    properties: NotRequired[PropertyType]
    extensionsUsed: NotRequired[list[str]]
    extensionsRequired: NotRequired[list[str]]



# Tile content types

BatchTableHeaderDataType = dict[str, Union[list[Any], dict[str, Any]]]

FeatureTableHeaderDataType = dict[
    str,
    Union[
        int,  # points_length
        dict[str, int],  # byte offsets
        tuple[float, float, float],  # rtc
        list[float],  # quantized_volume_offset and quantized_volume_scale
        tuple[int, int, int, int],  # constant_rgba
    ],
]




class HierarchyClassDictType(TypedDict):
    name: str
    length: int
    instances: dict[str, list[Any]]



# Tiler types

PortionItemType = tuple[int, ...]
PortionsType = list[tuple[Path, PortionItemType]]




@dataclass
class ExtraFieldsDescription:
    name: str
    dtype: np.dtype[Any]





class MetadataReaderType(TypedDict):
    portions: PortionsType
    aabb: npt.NDArray[np.float64]
    crs_in: CRS | None
    point_count: int
    avg_min: npt.NDArray[np.float64]
    has_color: bool
    extra_fields: list[ExtraFieldsDescription]



OffsetScaleType = tuple[
    npt.NDArray[np.float64],
    npt.NDArray[np.float64],
    Optional[npt.NDArray[np.float64]],
    Optional[float],
]