Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderContext

The core state of the WWT rendering engine.

This class contains most of the information about the WWT camera, view configuration, and core datasets being rendered.

The Camera

Core Datasets

The Viewport

Hierarchy

  • RenderContext

Index

Constructors

constructor

Properties

alt

alt: number

az

az: number

customTrackingParams

customTrackingParams: CameraParameters

height

height: number

lighting

lighting: boolean

nearPlane

nearPlane: number

perspectiveFov

perspectiveFov: number

space

space: boolean

targetAlt

targetAlt: number

targetAltitude

targetAltitude: number

targetAz

targetAz: number

targetCamera

targetCamera: CameraParameters

viewCamera

viewCamera: CameraParameters

width

width: number

Methods

addCatalogHips

  • Add a new "catalog HiPS" imageset to the view.

    Each catalog HiPS imageset is associated with a SpreadSheetLayer that is updated with dynamically-loaded data as the WWT camera moves around. This API adds this layer to the LayerManager and invokes the onLoad callback when the imageset's initial loading has completed.

    The caller must ensure that the imageset argument actually does correspond to a "catalog HiPS" dataset.

    Parameters

    • imageset: Imageset

      The imageset to load.

    • onLoad: null | Action

      An optional callback to invoke after the initial load is completed.

    Returns void

getAltitudeForLatLongForPlanet

  • getAltitudeForLatLongForPlanet(planetID: number, viewLat: number, viewLong: number): number

getCatalogHipsDataInView

  • Fetch the subset of catalog HiPS data contained within the current view.

    The imageset should have been loaded with the addCatalogHips call. The limit parameter should almost always be true, since if false the data-fetch operation can potentially attempt to download and return gigabytes of data.

    Parameters

    • imageset: Imageset

      The catalog HiPS imageset to query

    • limit: boolean

      If true, limit the amount of data returned

    • onComplete: InViewReturnMessageCallback

      A callback to be invoked when the data have been fetched.

    Returns void

get_RA

  • get_RA(): number

get_backgroundImageset

  • get_backgroundImageset(): null | Imageset

get_catalogHipsImagesets

  • get_catalogHipsImagesets(): Imageset[]

get_dec

  • get_dec(): number

get_foregroundImageset

  • get_foregroundImageset(): null | Imageset

get_fovAngle

  • get_fovAngle(): number

get_fovLocal

  • get_fovLocal(): number

get_fovScale

  • get_fovScale(): number

get_nominalRadius

  • get_nominalRadius(): number

get_sandboxMode

  • get_sandboxMode(): boolean

get_solarSystemCameraDistance

  • get_solarSystemCameraDistance(): number

get_solarSystemTrack

  • get_solarSystemTrack(): SolarSystemObjects

get_trackingFrame

  • get_trackingFrame(): string

get_twoSidedLighting

  • get_twoSidedLighting(): boolean

onTarget

  • onTarget(place: Place): boolean

removeCatalogHips

  • removeCatalogHips(imageset: Imageset): void

set_backgroundImageset

set_foregroundImageset

set_fovLocal

  • set_fovLocal(): number

set_fovScale

  • set_fovScale(v: number): number

set_nominalRadius

  • set_nominalRadius(v: number): number

set_solarSystemTrack

  • set_solarSystemTrack(v: SolarSystemObjects): SolarSystemObjects

set_trackingFrame

  • set_trackingFrame(v: string): string

set_twoSidedLighting

  • set_twoSidedLighting(v: boolean): boolean

Generated using TypeDoc