Class MapRenderingManager

constructor

• new MapRenderingManager(width, height, lowResPixelRatio, antialiasSettings?): MapRenderingManager

• The constructor of MapRenderingManager.

  Parameters

  • width: number

    Width of the frame buffer.

  • height: number

    Height of the frame buffer.

  • lowResPixelRatio: undefined | number

    The pixelRatio determines the resolution of the internal WebGLRenderTarget. Values between 0.5 and window.devicePixelRatio can be tried to give good results. A value of undefined disables the low res render pass. The value should not be larger thanwindow.devicePixelRatio.

  • antialiasSettings: undefined | IMapAntialiasSettings = ...

  Returns MapRenderingManager

bloom

outline

sepia

vignette

dynamicMsaaSamplingLevel

• get dynamicMsaaSamplingLevel(): MSAASampling

• Return the sampling level defined during continuous rendering.

  Returns MSAASampling
• set dynamicMsaaSamplingLevel(samplingLevel): void

• Set the level of sampling while the user interacts.

  Parameters

  • samplingLevel: MSAASampling

    The sampling level.

  Returns void

lowResPixelRatio

• get lowResPixelRatio(): undefined | number

• The lowResPixelRatio determines the resolution of the internal WebGLRenderTarget. Values between 0.5 and window.devicePixelRatio can be tried to give good results. A value of undefined disables the low res render pass. The value should not be larger than window.devicePixelRatio.

  Returns undefined | number
• set lowResPixelRatio(pixelRatio): void

• Set a pixelRatio for dynamic rendering (i.e. during animations). If a value is specified, the LowResRenderPass will be employed to used to render the scene into a lower resolution render target, which will then be rendered to the screen.

  Parameters

  • pixelRatio: undefined | number

  Returns void

msaaEnabled

• get msaaEnabled(): boolean

• Return whether the MSAA is enabled.

  Returns boolean
• set msaaEnabled(value): void

• Enable or disable the MSAA. If disabled, MapRenderingManager will use the renderer provided in the render method to render the scene.

  Parameters

  • value: boolean

    If true, MSAA is enabled, disabled otherwise.

  Returns void

staticMsaaSamplingLevel

• get staticMsaaSamplingLevel(): MSAASampling

• Return the sampling level defined for rendering static frames.

  Returns MSAASampling
• set staticMsaaSamplingLevel(samplingLevel): void

• Set the sampling level for rendering static frames.

  Parameters

  • samplingLevel: MSAASampling

    The sampling level.

  Returns void

render

• render(renderer, scene, camera, isStaticFrame): void

• The method to call to render the map with the MapRenderingManager instance. It contains the chain of sub-passes that can transfer the write and read buffers, and other sheer rendering conditions as disabling AA when a high DPI device is in use.

  Parameters

  • renderer: WebGLRenderer

    The ThreeJS WebGLRenderer instance to render the map with.

  • scene: Scene

    The ThreeJS Scene instance containing the map objects to render.

  • camera: PerspectiveCamera | OrthographicCamera

    The ThreeJS Camera instance to render the scene through.

  • isStaticFrame: boolean

    Whether the frame to render is static or dynamic. Selects level of antialiasing.

  Returns void

setSize

• setSize(width, height): void

• The resize function to call on resize events to resize the render targets. It shall include the resize methods of all the sub-passes used in MapRenderingManager.

  Parameters

  • width: number

    New width to use.

  • height: number

    New height to use.

  Returns void

updateOutline

• updateOutline(options): void

• Updating the outline rebuilds the outline materials of every outlined mesh.

  Parameters

  • options: {
        color: string;
        ghostExtrudedPolygons: boolean;
        thickness: number;
    }

    outline options from the @xyzmaps/harp-datasource-protocol#Theme.

    • color: string

    • ghostExtrudedPolygons: boolean

    • thickness: number

  Returns void