LuciadRIA (2026.0.08)
    Preparing search index...

    EnvironmentMapImagery that supports equirectangular images. The width:height ratio is expected to be 2:1 for this type of imagery.

    Use this class if you want to load the image (or URL) yourself.

    You can use createEquirectangularImagery to create EquirectangularImagery with a URL.

    2021.1

    Hierarchy (View Summary)

    Constructors

    Accessors

    Methods

    Constructors

    Accessors

    • get credentials(): boolean

      Indicates whether or not credentials should be included with HTTP requests.

      Set this to true if the server requires credentials, like HTTP basic authentication headers or cookies. You should disable if the server is configured to allow cross-origin requests from all domains (Acces-Control-Allow-Origin=*). If the server allows CORS requests from all domains, the browser will block all requests where credentials=true.

      Once set, all subsequent HTTP requests will use the newly set value.

      The default value is false.

      Returns boolean

    • set credentials(credentials: boolean): void

      Parameters

      • credentials: boolean

      Returns void

    • get requestHeaders(): HttpRequestHeaders | null

      Headers to send with every HTTP request.

      An object literal that represents the headers to send with every HTTP request. The property names represent HTTP header names, the property values represent the HTTP header values. This property can be set dynamically (post-construction). Once set, all subsequent HTTP requests will use the newly set headers.

      Note that when custom headers are being sent to a server on another domain, the server will have to properly respond to pre-flight CORS requests (a HTTP OPTION request sent by the browser before doing the actual request). The server has to indicate that the header can be used in the actual request, by including it in the pre-flight's Access-Control-Allow-Headers response header.

      The default value is null.

      Returns HttpRequestHeaders | null

    • set requestHeaders(requestHeaders: HttpRequestHeaders | null): void

      Parameters

      Returns void

    Methods

    • Load the image or URL.

      Parameters

      • onSuccess: (image: string | HTMLImageElement | HTMLCanvasElement) => void

        the callback function that should be invoked when the image or URL was successfully loaded. The function will receive the image object or an URL.

      • onError: (error?: Error) => void

        the callback function that should be invoked when the image or URL could not be loaded. The function will receive an optional Error object.

      Returns void