@nativescript-community/ui-massifmaps
    Preparing search index...

    Interface OptionsSpec_terrain

    interface OptionsSpec_terrain {
        autoFlattenDuration?: number;
        autoFlattenParallax?: number;
        autoFlattenRiseDuration?: number;
        autoFlattenTilt?: number;
        backgroundColor?: number;
        billboardOcclusionEnabled?: boolean;
        billboardOcclusionTolerance?: number;
        bridges3DEnabled?: boolean;
        cameraClampDuration?: number;
        cameraClearance?: number;
        cameraClearanceFraction?: number;
        depthBias?: number;
        drapeCacheSize?: number;
        drapeFillsEnabled?: boolean;
        drapeLinesEnabled?: boolean;
        drapeResolution?: number;
        drapeWorkingSet?: number;
        elevationCacheSize?: number;
        elevationPrefetchEnabled?: boolean;
        enabled?: boolean;
        exaggeration?: number;
        flattened?: boolean;
        flattenMode?:
            | number
            | "TERRAIN_FLATTEN_MODE_RENDER"
            | "TERRAIN_FLATTEN_MODE_FULL";
        flattenRatio?: number;
        focusLift?: number;
        maxTileZoomCoarsening?: number;
        maxTileZoomOffset?: number;
        maxZoom?: number;
        meshCacheSize?: number;
        meshResolution?: number;
        minZoom?: number;
        noDrapeLayerFilter?: string;
        normalSampleDistance?: number;
        postProcessDownscale?: number;
        seamlessTileEdgesEnabled?: boolean;
        sharedGroundEnabled?: boolean;
        source: string
        | Handle<any>
        | SourceSpec;
        subdivideDistance?: number;
        surfaceNodeResolution?: number;
        surfaceShaderSource?: string;
        textOcclusionOpacity?: number;
        tileEdgeStitchingEnabled?: boolean;
        type: "terrain";
        viewDistance?: number;
        viewDistanceFactor?: number;
        viewDistanceMax?: number;
    }
    Index

    Properties

    autoFlattenDuration?: number

    Returns how long the terrain takes to sink flat.

    autoFlattenParallax?: number

    Returns the screen parallax below which the terrain renders flat.

    autoFlattenRiseDuration?: number

    Returns how long the terrain takes to rise back into 3D.

    autoFlattenTilt?: number

    Returns the tilt at or above which the terrain renders flat.

    backgroundColor?: number

    Returns the terrain background color.

    billboardOcclusionEnabled?: boolean

    Returns the billboard/label terrain occlusion state.

    billboardOcclusionTolerance?: number

    Returns the billboard/label terrain occlusion tolerance.

    bridges3DEnabled?: boolean

    Returns whether bridges and tunnels stand on their own chord (3D bridges).

    cameraClampDuration?: number

    Returns the duration of the camera terrain-following correction animation.

    cameraClearance?: number

    Returns the camera terrain clearance floor: an explicit minimum height the camera is kept above the terrain surface, in meters.

    cameraClearanceFraction?: number

    Returns the share of the camera's altitude that the terrain clearance takes.

    depthBias?: number

    Returns the clip-space depth bias used when depth-testing draped 2D geometry against the terrain.

    drapeCacheSize?: number

    Returns the drape cache budget in megabytes.

    drapeFillsEnabled?: boolean

    Returns whether polygon fills are draped as a render-to-texture surface.

    drapeLinesEnabled?: boolean

    Returns whether vt tile lines are also draped (in addition to fills).

    drapeResolution?: number

    Returns the per-tile drape texture resolution, 0 when it follows the screen.

    drapeWorkingSet?: number

    Returns how many drape tiles the automatic resolution assumes are cached at once.

    elevationCacheSize?: number

    Returns the elevation grid cache budget in megabytes, 0 for the SDK's own rule.

    elevationPrefetchEnabled?: boolean

    Returns whether elevation tile prefetching is enabled.

    enabled?: boolean

    Returns the enabled state of the terrain.

    exaggeration?: number

    Returns the terrain height exaggeration factor.

    flattened?: boolean

    Returns whether the map is asked to render flat. This is the 2D/3D state, whether it was set by the app or by auto-flattening; the switch itself is animated, so for a moment after a change the map is still on its way there.

    flattenMode?:
        | number
        | "TERRAIN_FLATTEN_MODE_RENDER"
        | "TERRAIN_FLATTEN_MODE_FULL"

    Returns how far a flattened terrain goes back towards a plain 2D map.

    flattenRatio?: number

    Returns how far the terrain is flattened right now, 0 (full 3D) to 1 (flat).

    focusLift?: number

    Returns the height the viewpoint is lifted above the ground-following focus, in meters.

    maxTileZoomCoarsening?: number

    Returns how many zoom levels below the camera a tile may coarsen to.

    maxTileZoomOffset?: number

    Returns the maximum visible tile zoom offset, relative to the camera zoom level.

    maxZoom?: number

    Returns the maximum tile zoom level the terrain mesh is cut at.

    meshCacheSize?: number

    Returns how many terrain surface meshes may be cached.

    meshResolution?: number

    Returns the terrain mesh resolution.

    minZoom?: number

    Returns the minimum tile zoom level with 3D terrain.

    noDrapeLayerFilter?: string

    Returns the style layers that are kept out of the terrain drape bake.

    normalSampleDistance?: number

    Returns the ground distance the surface normals are measured over, in meters.

    postProcessDownscale?: number

    Returns the downscale factor of the packed depth/normal texture post-process effects read.

    seamlessTileEdgesEnabled?: boolean

    Returns whether seamless tile edge handling is enabled.

    sharedGroundEnabled?: boolean

    Returns whether the shared ground pass draws the terrain a second time.

    source: string | Handle<any> | SourceSpec
    subdivideDistance?: number

    Returns the distance geo-three's terrain LOD subdivides at.

    surfaceNodeResolution?: number

    Returns the resolution the elevation node field is built at.

    surfaceShaderSource?: string

    Returns the custom terrain surface fragment shader source, or an empty string if no shaded surface is drawn.

    textOcclusionOpacity?: number

    Returns the opacity a label keeps while its anchor is behind 3D content.

    tileEdgeStitchingEnabled?: boolean

    Returns whether cross-LOD tile edge stitching is enabled.

    type: "terrain"
    viewDistance?: number

    Returns the minimum view distance, in meters.

    viewDistanceFactor?: number

    Returns the factor applied to the view distance.

    viewDistanceMax?: number

    Returns the maximum view distance, in meters.