WorldWind Kotlin/earth.worldwind.formats.kml.models/Icon

Icon

@Serializable

data class Icon(val id: String? = null, val href: String, val x: Int = 0, val y: Int = 0, val w: Int = 0, val h: Int = 0, val refreshMode: RefreshMode = RefreshMode.onChange, val refreshInterval: Int = 4, val viewRefreshMode: ViewRefreshMode = ViewRefreshMode.never, val viewRefreshTime: Int = 4, val viewBoundScale: Float = 1.0f, val viewFormat: String? = null, val httpQuery: String? = null) : Object

Defines an image associated with an Icon style or overlay. The required child element defines the location of the image to be used as the overlay or as the icon for the placemark. This location can either be on a local file system or a remote web server. The gx:x, gx:y, gx:w, and gx:h elements are used to select one icon from an image that contains multiple icons (often referred to as an icon palette).

Constructors

Icon

constructor(id: String? = null, href: String, x: Int = 0, y: Int = 0, w: Int = 0, h: Int = 0, refreshMode: RefreshMode = RefreshMode.onChange, refreshInterval: Int = 4, viewRefreshMode: ViewRefreshMode = ViewRefreshMode.never, viewRefreshTime: Int = 4, viewBoundScale: Float = 1.0f, viewFormat: String? = null, httpQuery: String? = null)

Properties

@XmlSerialName(value = "h", namespace = "http://www.google.com/kml/ext/2.2", prefix = "gx")

@XmlElement

val h: Int

If the specifies an icon palette, these elements specify the width (gx:w) and height (gx:h), in pixels, of the icon to use.

href

@XmlElement

val href: String

An HTTP address or a local file specification used to load an icon.

httpQuery

@XmlElement

val httpQuery: String?

Specifies the format of the query string that is appended to the Link's before the file is fetched. (If the specifies a local file, this element is ignored.)

open override val id: String?

refreshInterval

@XmlElement

val refreshInterval: Int

Indicates to refresh the file every n seconds.

refreshMode

@XmlElement

val refreshMode: RefreshMode

Specifies a time-based refresh mode

viewBoundScale

@XmlElement

val viewBoundScale: Float

Scales the BBOX parameters before sending them to the server. A value less than 1 specifies to use less than the full view (screen). A value greater than 1 specifies to fetch an area that extends beyond the edges of the current view.

viewFormat

@XmlElement

val viewFormat: String?

Specifies the format of the query string that is appended to the Link's before the file is fetched. (If the specifies a local file, this element is ignored.)

viewRefreshMode

@XmlElement

val viewRefreshMode: ViewRefreshMode

Specifies how the link is refreshed when the "camera" changes.

viewRefreshTime

@XmlElement

val viewRefreshTime: Int

After camera movement stops, specifies the number of seconds to wait before refreshing the view. (See viewRefreshMode and ViewRefreshMode.onStop above.)

@XmlSerialName(value = "w", namespace = "http://www.google.com/kml/ext/2.2", prefix = "gx")

@XmlElement

val w: Int

If the specifies an icon palette, these elements specify the width (gx:w) and height (gx:h), in pixels, of the icon to use.

@XmlSerialName(value = "x", namespace = "http://www.google.com/kml/ext/2.2", prefix = "gx")

@XmlElement

val x: Int

If the specifies an icon palette, these elements identify the offsets, in pixels, from the lower-left corner of the icon palette.If no values are specified for x and y, the lower left corner of the icon palette is assumed to be the lower-left corner of the icon to use.

@XmlSerialName(value = "y", namespace = "http://www.google.com/kml/ext/2.2", prefix = "gx")

@XmlElement

val y: Int