Class: StarFieldLayer

StarFieldLayer(starDataSource)

Provides a layer showing stars, and the Sun around the Earth

Constructor

new StarFieldLayer(starDataSource)

Constructs a layer showing stars and the Sun around the Earth. If used together with the AtmosphereLayer, the StarFieldLayer must be inserted before the AtmosphereLayer. If you want to use your own star data, the file provided must be .json and the fields 'ra', 'dec' and 'vmag' must be present in the metadata. ra and dec must be expressed in degrees. This layer uses J2000.0 as the ref epoch. If the star data .json file is too big, consider enabling gzip compression on your web server. For more info about enabling gzip compression consult the configuration for your web server.
Parameters:
Name Type Description
starDataSource URL optional url for the stars data
Source:

Extends

Members

displayName :String

This layer's display name.
Type:
  • String
Inherited From:
Default Value:
  • "Layer"
Source:

enabled :Boolean

Indicates whether to display this layer.
Type:
  • Boolean
Inherited From:
Default Value:
  • true
Source:

(readonly) inCurrentFrame :Boolean

Indicates whether elements of this layer were drawn in the most recently generated frame.
Type:
  • Boolean
Inherited From:
Source:

maxActiveAltitude :Number

The eye altitude below which this layer is displayed, in meters.
Type:
  • Number
Inherited From:
Default Value:
  • Number.MAX_VALUE (always displayed)
Source:

minActiveAltitude :Number

The eye altitude above which this layer is displayed, in meters.
Type:
  • Number
Inherited From:
Default Value:
  • -Number.MAX_VALUE (always displayed)
Source:

opacity :Number

This layer's opacity, which is combined with the opacity of shapes within layers. Opacity is in the range [0, 1], with 1 indicating fully opaque.
Type:
  • Number
Inherited From:
Default Value:
  • 1
Source:

pickEnabled :Boolean

Indicates whether this layer is pickable.
Type:
  • Boolean
Overrides:
Default Value:
  • true
Source:

showSun :Boolean

Indicates weather to show or hide the Sun
Type:
  • Boolean
Default Value:
  • true
Source:

starDataSource :URL

Url for the stars data.
Type:
  • URL
Source:

sunImageSource :URL

Url for the sun texture image.
Type:
  • URL
Source:

sunSize :Number

The size of the Sun in pixels. This can not exceed the maximum allowed pointSize of the GPU. A warning will be given if the size is too big and the allowed max size will be used.
Type:
  • Number
Default Value:
  • 128
Source:

time :Date

The time to display. This property selects the layer contents that represents the specified time. If null, layer-type dependent contents are displayed.
Type:
  • Date
Inherited From:
Source:

Methods

(protected) doRender(dc)

Subclass method called to display this layer. Subclasses should implement this method rather than the render method, which determines enable, pick and active altitude status and does not call this doRender method if the layer should not be displayed.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Overrides:
Source:

(protected) isLayerInView(dc) → {boolean}

Indicates whether this layer is within the current view. Subclasses may override this method and when called determine whether the layer contents are visible in the current view frustum. The default implementation always returns true.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Inherited From:
Source:
Returns:
true If this layer is within the current view, otherwise false.
Type
boolean

refresh()

Refreshes the data associated with this layer. The behavior of this function varies with the layer type. For image layers, it causes the images to be re-retrieved from their origin.
Inherited From:
Source:

render(dc)

Displays this layer. Subclasses should generally not override this method but should instead override the doRender method. This method calls that method after verifying that the layer is enabled, the eye point is within this layer's active altitudes and the layer is in view.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Inherited From:
Source: