Class ArtifactMapper<CategoryKind, AddressKind>

Type Parameters

CategoryKind extends AssetArtifactCategory = AssetArtifactCategory
AddressKind extends AssetArtifactAddressFragment = AssetArtifactAddressFragment

Index

Constructors

constructor

new ArtifactMapper<
    CategoryKind extends
        | "PANORAMIC"
        | "LOCALIZATION"
        | "MESH"
        | "POINT_CLOUD"
        | "VECTOR_OR_RASTER"
        | "GENERIC_SINGLE_FILE"
        | "SIMPLIFIED_MESH"
        | "CLASSIFIED_POINT_CLOUD"
        | "GAUSSIAN_SPLAT"
        | "DEPTH_MAP"
        | "DXF_MESH_PLACEHOLDER" = | "PANORAMIC"
    | "LOCALIZATION"
    | "MESH"
    | "POINT_CLOUD"
    | "VECTOR_OR_RASTER"
    | "GENERIC_SINGLE_FILE"
    | "SIMPLIFIED_MESH"
    | "CLASSIFIED_POINT_CLOUD"
    | "GAUSSIAN_SPLAT"
    | "DEPTH_MAP"
    | "DXF_MESH_PLACEHOLDER",
    AddressKind extends
        AssetArtifactAddressFragment = AssetArtifactAddressFragment,
>(
    adapter: AssetArtifactAdapter<CategoryKind, AddressKind>,
): ArtifactMapper<CategoryKind, AddressKind>
Type Parameters
- CategoryKind extends
      | "PANORAMIC"
      | "LOCALIZATION"
      | "MESH"
      | "POINT_CLOUD"
      | "VECTOR_OR_RASTER"
      | "GENERIC_SINGLE_FILE"
      | "SIMPLIFIED_MESH"
      | "CLASSIFIED_POINT_CLOUD"
      | "GAUSSIAN_SPLAT"
      | "DEPTH_MAP"
      | "DXF_MESH_PLACEHOLDER" =
      | "PANORAMIC"
      | "LOCALIZATION"
      | "MESH"
      | "POINT_CLOUD"
      | "VECTOR_OR_RASTER"
      | "GENERIC_SINGLE_FILE"
      | "SIMPLIFIED_MESH"
      | "CLASSIFIED_POINT_CLOUD"
      | "GAUSSIAN_SPLAT"
      | "DEPTH_MAP"
      | "DXF_MESH_PLACEHOLDER"
- AddressKind extends AssetArtifactAddressFragment = AssetArtifactAddressFragment
Parameters
- adapter: AssetArtifactAdapter<CategoryKind, AddressKind>
Returns ArtifactMapper<CategoryKind, AddressKind>
- Defined in api/mapper/artifacts/ArtifactMapper.ts:66

Properties

`Protected` `Readonly`adapter

adapter: AssetArtifactAdapter<CategoryKind, AddressKind>

Methods

fromAsset

fromAsset(fragment: AssetFragment): AssetArtifact | null
Tries to get an AssetArtifact from the given asset API fragment. Which artifact, if any, gets returned depends on the outcome of getArtifactCategory.
Parameters
- fragment: AssetFragment
Returns AssetArtifact | null
- Defined in api/mapper/artifacts/ArtifactMapper.ts:72

fromAssetArtifact

fromAssetArtifact(fragment: LegacyAssetArtifactFragment): AssetArtifact | null
Like fromAsset, but when you know exactly which asset artifact API fragment you want to map.
Parameters
- fragment: LegacyAssetArtifactFragment
Returns AssetArtifact | null
- Defined in api/mapper/artifacts/ArtifactMapper.ts:80

`Static`compareCandidatesByDate

compareCandidatesByDate<
    CategoryKind extends
        | "PANORAMIC"
        | "LOCALIZATION"
        | "MESH"
        | "POINT_CLOUD"
        | "VECTOR_OR_RASTER"
        | "GENERIC_SINGLE_FILE"
        | "SIMPLIFIED_MESH"
        | "CLASSIFIED_POINT_CLOUD"
        | "GAUSSIAN_SPLAT"
        | "DEPTH_MAP"
        | "DXF_MESH_PLACEHOLDER" = | "PANORAMIC"
    | "LOCALIZATION"
    | "MESH"
    | "POINT_CLOUD"
    | "VECTOR_OR_RASTER"
    | "GENERIC_SINGLE_FILE"
    | "SIMPLIFIED_MESH"
    | "CLASSIFIED_POINT_CLOUD"
    | "GAUSSIAN_SPLAT"
    | "DEPTH_MAP"
    | "DXF_MESH_PLACEHOLDER",
    AddressKind extends
        AssetArtifactAddressFragment = AssetArtifactAddressFragment,
>(
    a: ArtifactCandidate<CategoryKind, AddressKind>,
    b: ArtifactCandidate<CategoryKind, AddressKind>,
): number
Default compare function of two candidates, compares them by createdAt date, where the more recently created candidate gets priority.
Type Parameters
- CategoryKind extends
      | "PANORAMIC"
      | "LOCALIZATION"
      | "MESH"
      | "POINT_CLOUD"
      | "VECTOR_OR_RASTER"
      | "GENERIC_SINGLE_FILE"
      | "SIMPLIFIED_MESH"
      | "CLASSIFIED_POINT_CLOUD"
      | "GAUSSIAN_SPLAT"
      | "DEPTH_MAP"
      | "DXF_MESH_PLACEHOLDER" =
      | "PANORAMIC"
      | "LOCALIZATION"
      | "MESH"
      | "POINT_CLOUD"
      | "VECTOR_OR_RASTER"
      | "GENERIC_SINGLE_FILE"
      | "SIMPLIFIED_MESH"
      | "CLASSIFIED_POINT_CLOUD"
      | "GAUSSIAN_SPLAT"
      | "DEPTH_MAP"
      | "DXF_MESH_PLACEHOLDER"
- AddressKind extends AssetArtifactAddressFragment = AssetArtifactAddressFragment
Parameters
- a: ArtifactCandidate<CategoryKind, AddressKind>
- b: ArtifactCandidate<CategoryKind, AddressKind>
Returns number
- Defined in api/mapper/artifacts/ArtifactMapper.ts:59

Class ArtifactMapper<CategoryKind, AddressKind>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArtifactMapper<CategoryKind, AddressKind>

Properties

`Protected` `Readonly`adapter

Methods

fromAsset

Parameters

Returns AssetArtifact | null

fromAssetArtifact

Parameters

Returns AssetArtifact | null

`Static`compareCandidatesByDate

Type Parameters

Parameters

Returns number

Settings

On This Page

Class ArtifactMapper<CategoryKind, AddressKind>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArtifactMapper<CategoryKind, AddressKind>

Properties

Protected Readonlyadapter

Methods

fromAsset

Parameters

Returns AssetArtifact | null

fromAssetArtifact

Parameters

Returns AssetArtifact | null

StaticcompareCandidatesByDate

Type Parameters

Parameters

Returns number

Settings

On This Page

`Protected` `Readonly`adapter

`Static`compareCandidatesByDate