WorldWind Kotlin/earth.worldwind.layer.starfield/StarFieldLayer

StarFieldLayer

open class StarFieldLayer(starDataSource: FileResource = AssetsMR.files.stars_json) : AbstractLayer

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.

Constructors

StarFieldLayer

constructor(starDataSource: FileResource = AssetsMR.files.stars_json)

Types

StarData

@Serializable

data class StarData(val metadata: List<StarFieldLayer.StarMetadata>, val data: List<List<Float>>)

StarMetadata

@Serializable

data class StarMetadata(val name: String, val description: String, val datatype: String, val arraysize: Int, val unit: String, val ucd: String)

Properties

displayName

open override var displayName: String?

isDynamic

open override var isDynamic: Boolean

isEnabled

open override var isEnabled: Boolean

isPickEnabled

open override var isPickEnabled: Boolean

isShowSun

var isShowSun: Boolean

Indicates weather to show or hide the Sun

maxActiveAltitude

open override var maxActiveAltitude: Double

minActiveAltitude

open override var minActiveAltitude: Double

opacity

open override var opacity: Float

starDataSource

var starDataSource: FileResource

Resource for the stars data

sunImageSource

var sunImageSource: ImageSource

Resource for the sun texture image.

sunSize

var sunSize: Float

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.

Functions

getUserProperty

open override fun getUserProperty(key: Any): Any?

hasUserProperty

open override fun hasUserProperty(key: Any): Boolean

isWithinActiveAltitudes

open override fun isWithinActiveAltitudes(rc: RenderContext): Boolean

putUserProperty

open override fun putUserProperty(key: Any, value: Any): Any?

removeUserProperty

open override fun removeUserProperty(key: Any): Any?

render

open override fun render(rc: RenderContext)