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

BaseOverlay

com.phasmidsoftware.xmldoc.kml.BaseOverlay
abstract class BaseOverlay(overlayData: OverlayData) extends Overlay, HasName

Abstract class BaseOverlay representing the base implementation for Overlay elements. It extends the functionalities of the Overlay trait and the HasName trait.

A BaseOverlay is associated with overlay-specific data defined by OverlayData. It provides access to essential properties like maybeColor, maybeDrawOrder, Icon, and name.

Value parameters

overlayData

The data associated with the overlay, encapsulated in the OverlayData instance.

Attributes

Constructor

Creates a BaseOverlay instance with the specified overlay data.

Graph
Supertypes
trait HasName
trait Overlay
trait Feature
trait KmlObject
class Object
trait Matchable
class Any
Show all
Known subtypes
class PhotoOverlay

Members list

Value members

Concrete 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.

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.

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.

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 methods

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
Generated with