XmlDoc
API
Generated with
XmlDoc/com.phasmidsoftware.xmldoc/com.phasmidsoftware.xmldoc.kml/GroundOverlay

GroundOverlay

com.phasmidsoftware.xmldoc.kml.GroundOverlay
See theGroundOverlay companion object
case class GroundOverlay(maybeAltitude: Option[Altitude], maybeAltitudeMode: Option[AltitudeMode], LatLonBox: LatLonBox)(overlayData: OverlayData) extends BaseOverlay

Represents a GroundOverlay, which is a KML feature that overlays an image on the surface of the Earth. The image is geographically bound to a LatLonBox and can have an optional altitude and altitude mode. See GroundOverlay

A GroundOverlay extends the BaseOverlay class to include additional geographic attributes such as the bounding box and altitude-related data.

Value parameters

LatLonBox

Defines the geographic bounding rectangle where the overlay image is positioned, including its rotation.

maybeAltitude

An optional Altitude value that specifies the elevation of the overlay, typically measured in meters.

maybeAltitudeMode

An optional AltitudeMode value indicating how the altitude of the overlay is interpreted (e.g., relative to the ground or absolute).

overlayData

The overlay-specific data encapsulated in OverlayData, containing attributes such as the icon, draw order, and associated feature data.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class BaseOverlay
trait HasName
trait Overlay
trait Feature
trait KmlObject
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def Icon: Icon

Retrieves the Icon associated with the Overlay. The Icon defines the image representation of the Overlay.

Retrieves the Icon associated with the Overlay. The Icon defines the image representation of the Overlay.

Attributes

Returns

An Icon representing the image associated with the Overlay.

Inherited from:
BaseOverlay
def editToOption(e: KmlEdit, fs: Seq[Feature]): Option[Feature]

Method to edit this Feature, given a sequence of sibling Features such that we may be able to combine features. TESTME

Method to edit this Feature, given a sequence of sibling Features such that we may be able to combine features. TESTME

Value parameters

e

the edit to apply.

fs

the siblings (which actually do include this itself).

Attributes

Returns

an optional Feature.

Inherited from:
Feature
def maybeColor: Option[Color]

Retrieves the optional color of the overlay. The color is represented in hexadecimal notation as aabbggrr, where:

Retrieves the optional color of the overlay. The color is represented in hexadecimal notation as aabbggrr, where:

  • aa: alpha (transparency) channel (00 to ff)
  • bb: blue channel (00 to ff)
  • gg: green channel (00 to ff)
  • rr: red channel (00 to ff)

Attributes

Returns

An Option containing the color of the overlay if defined, otherwise None.

Inherited from:
BaseOverlay
def maybeDrawOrder: Option[DrawOrder]

Retrieves the optional draw order for the overlay. The draw order defines the stacking order for images in overlapping overlays. Higher values are drawn on top of lower values.

Retrieves the optional draw order for the overlay. The draw order defines the stacking order for images in overlapping overlays. Higher values are drawn on top of lower values.

Attributes

Returns

An Option containing the draw order if defined, otherwise None.

Inherited from:
BaseOverlay
def name: Text

Retrieves the name as a Text value.

Retrieves the name as a Text value.

Attributes

Returns

the name represented as a Text instance.

Inherited from:
BaseOverlay
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product

Concrete fields

Generated with