com.phasmidsoftware.xmldoc.kml

Trait AbstractView: abstract subelement of KmlObject. AbstractView is the super-type of Camera and LookAt. See AbstractView

Attributes

Companion: object
Supertypes: trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: class Camera

class LookAt

AbstractView serves as an object companion to the AbstractView trait, which represents an abstract subelement of KmlObject. It is the base type for more specific views such as Camera and LookAt.

This object includes implicit utilities for extracting and rendering AbstractView instances and sequences of them:

extractorSeq: MultiExtractor for extracting sequences of AbstractView elements.
renderer: Renderer for rendering individual AbstractView instances.
rendererSeq: Renderer for rendering sequences of AbstractView instances.

The extraction and rendering follows the defined relationships and properties described for AbstractView and its subtypes.

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: AbstractView.type

Companion object for the AbstractViewData case class. Provides extractors and renderers for handling AbstractViewData objects.

NOTE: not currently used.

Extends the Extractors and Renderers traits to facilitate extraction and rendering of AbstractViewData instances. Contains implicit values for extracting and rendering AbstractViewData, as well as a partial extractor for more specific use cases.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: AbstractViewData.type

Properties of AbstractView. There are no properties specific to AbstractView. See AbstractView

Value parameters

kmlData: source of properties.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Case class Alias: sub-element of ResourceMap, mapping a texture reference used within a Model's COLLADA file (sourceHref) to where that resource actually is within the KML/KMZ package (targetHref). See Model

Value parameters

maybeSourceHref: the texture reference as it appears in the COLLADA file: Option[Text].
maybeTargetHref: the actual location of the resource: Option[Text].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Alias case class, providing extractors and renderers for Alias instances and sequences thereof.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Alias.type

Case class representing an altitude value. See Altitude

Value parameters

$: the altitude value, typically measured in meters.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object representing utilities for working with the Altitude case class. See Altitude

Provides implementations for Extractor and Renderer type classes, enabling extraction and rendering functionality for Altitude and Option[Altitude].

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Altitude.type

Companion object for the AltitudeMode case class, providing extractors and renderers.

This object is used for handling extraction and rendering operations related to AltitudeMode instances.

It defines implicit values for extractors and renderers, enabling seamless interaction with AltitudeMode objects in the context of data transformation and rendering pipelines.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: AltitudeMode.type

Represents the mode by which altitude is specified and interpreted. See Camera

This case class wraps a value from the AltitudeModeEnum enumeration, which specifies how the altitude should behave relative to the terrain or sea level.

The possible altitude modes are defined in the AltitudeModeEnum object and include:

clampToGround: Ignores the altitude value and drapes the element on the ground.
relativeToGround: Specifies the altitude as relative to the ground elevation.
absolute: Specifies the altitude relative to sea level.

The AltitudeMode class serves as a wrapper, enabling seamless integration with extractors and renderers for handling data transformations and operations within systems that support AltitudeModeEnum values.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Enumeration representing various methods how the altitude is interpreted

The available altitudeMode in this enumeration are:

clampToGround: (default) Represents to ignore the altitude specification and drape the overlay over the terrain.
relativeToGround: Represents the altitude of the element relative to the actual ground elevation of a particular location.
absolute: Represents the altitude of the coordinate relative to sea level
clampToSeaFloor, relativeToSeaFloor: gx: namespace extensions (see the gx:altitudeMode alias registered in AltitudeMode's companion object) - relative to the sea floor rather than the ground, for underwater features. Not part of plain KML's own altitudeMode enum.

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of AltitudeModeEnum.
renderer: Provides a Renderer instance for rendering values of AltitudeModeEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: AltitudeModeEnum.type

Case class AxisScale: a generic, single-value scale factor along one axis, used by ModelScale for its x/y/z children.

NOTE: see the comment on RefreshInterval for why this is wrapped rather than a bare Double.

Value parameters

$: the scale factor.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the AxisScale case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: AxisScale.type

Object BalloonStyle provides extractors and renderers for the BalloonStyle case class.

This object includes functionalities for extracting and rendering BalloonStyle, allowing conversions and serializations between the case class and its representations in other formats. It leverages the Extractors and Renderers traits, and provides several implicit instances for convenience.

It defines:

extractorPartial: A partial extractor for constructing BalloonStyle from ColorStyleData.
extractor: An implicit extractor for BalloonStyle objects.
renderer: An implicit renderer for BalloonStyle objects.
rendererOpt: An implicit renderer for optional BalloonStyle instances (Option[BalloonStyle]).

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: BalloonStyle.type

Case class BalloonStyle which extends ColorStyle.

See Balloon Style

NOTE Use of the color element has been deprecated (use bgColor instead.) NOTE According to the current KML reference, this object extends SubStyle or ColorStyle (it's not clear which).

Value parameters

colorStyleData: the (auxiliary) color style properties.
maybeBgColor: optional background color (maybe it isn't optional if there's no color element).
maybeDisplayMode: optional display mode.
maybeTextColor: optional text color.
text: the balloon text.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait ColorStyle

trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Show all

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.
Supertypes: trait HasName

trait Overlay

trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Show all
Known subtypes: class GroundOverlay

class PhotoOverlay

class ScreenOverlay

Companion object for the BgColor case class. This object provides utilities to extract and render BgColor instances. It includes implicit definitions for handling BgColor objects and optional BgColor instances using the Extractor and Renderer type classes respectively.

The Extractor instances are used to parse data into BgColor instances, while the Renderer instances manage the conversion of BgColor objects back to their desired output formats.

Key functionalities:

Provides an implicit extractor for BgColor to facilitate data extraction.
Supplies an optional extractor to handle optional BgColor values.
Defines a renderer for BgColor to support data transformation and output.
Includes an optional renderer for handling optional BgColor values.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: BgColor.type

This case class represents a background color element with a single parameter. Used by BalloonStyle and ListStyle. See bgColor

Value parameters

$: a hexadecimal string that defines the background color.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Case class Camera represents a viewpoint from which a KML feature is viewed. See Camera

The Camera defines a viewpoint using geographic coordinates and orientation information, and it is a concrete implementation of the AbstractView trait.

Value parameters

abstractViewData: additional data associated with the Camera's AbstractView.
alt: the altitude of the Camera's location.
heading: the direction that the Camera is facing, in degrees (0 = North).
lat: the latitude of the Camera's location.
long: the longitude of the Camera's location.
maybeAltitudeMode: an optional altitude mode specifying how the altitude is interpreted.
roll: the rotation about the Z-axis (normal to the screen), in degrees.
tilt: the vertical angle between the Camera's direction and the surface, in degrees.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait AbstractView

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the Camera case class, providing Extractor and Renderer implementations.

This object includes functionality to extract and render Camera instances using the defined extractorPartial, extractor, renderer, and rendererOpt members.

extractorPartial: Represents a partial extractor for creating Camera instances based on abstract view data.
extractor: Implicitly provides the complete extractor for Camera instances.
renderer: Implicitly provides the renderer for Camera instances, facilitating conversion to a different representation.
rendererOpt: Implicitly provides the renderer for optional Camera instances.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Camera.type

The Color object provides implicit extractors and renderers for the Color case class. It enhances the functional processing of Color instances, enabling extraction and rendering capabilities.

Implicit extractors provided:

extractor: Extracts a Color instance.
extractorOpt: Extracts an optional Color instance.

Implicit renderers provided:

renderer: Renders a Color instance.
rendererOpt: Renders an optional Color instance.

This object is designed for integration with systems requiring model extraction and rendering logic.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Color.type

Case class to define Color. An element of ColorStyle. See ColorStyle

Value parameters

$: the color as a hexadecimal string.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Case class to model ColorMode. See ColorMode

ColorMode is defined using the ColorModeEnum enumeration, which specifies the possible modes for handling colors. The two primary modes are:

normal: Represents no effect or a base condition.
random: Applies a random linear scale to the base color.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object companion for the ColorMode case class that provides auxiliary utilities.

This object includes implicit Extractor and Renderer instances for ColorMode.

ColorMode represents the mode of color used, typically defined as either "normal" or "random."

Key functionalities:

Implicit Extractor[ColorMode]: Used to extract ColorMode values.
Implicit Extractor[Option[ColorMode]]: Handles optional extraction for ColorMode.
Implicit Renderer[ColorMode]: Converts ColorMode to a renderable form.
Implicit Renderer[Option[ColorMode]]: Renders optional ColorMode values.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ColorMode.type

Enumeration representing Values for ColorMode are normal (no effect) and random

The available ColorMode in this enumeration are:

normal: no effect, base condition
random: applies a random linear scale to the base color as follows.

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of ColorModeEnum.
renderer: Provides a Renderer instance for rendering values of ColorModeEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ColorModeEnum.type

Object that extends Extractors and Renderers to provide implicit extraction and rendering capabilities for ColorStyle.

This object facilitates working with collections of ColorStyle objects and specific rendering configurations.

=== Features ===

Provides an implicit MultiExtractor for extracting sequences of ColorStyle objects from their component styles.
Includes rendering capabilities for individual ColorStyle objects and sequences of ColorStyle objects.
Constructs extractors and renderers for all supported ColorStyle components including BalloonStyle, ListStyle, PolyStyle, LineStyle, IconStyle, and LabelStyle.
All operations are tagged with appropriate identifiers for enhanced traceability and debugging.

TODO BalloonStyle and ListStyle don't belong here according to the KML Reference. ColorStyle is a sub-class of SubStyle. TESTME

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: ColorStyle.type

Class to define ColorStyle which extends SubStyle. See ColorStyle

TODO add ColorStyleData

Attributes

Companion: object
Supertypes: trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: class BalloonStyle

class IconStyle

class LabelStyle

class LineStyle

class ListStyle

class PolyStyle
Show all

Companion object for the ColorStyleData case class.

Provides Extractors and Renderers required to efficiently process ColorStyleData.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: ColorStyleData.type

Case class ColorStyleData to represent the data associated with all ColorStyle elements.

Value parameters

maybeColor: an optional Color.
maybeColorMode: an optional ColorMode.
subStyleData: the SubStyleData.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Container object that extends functionalities from Extractors and Renderers for processing Container elements.

This object defines:

An implicit MultiExtractor for sequences of Container types, facilitating extraction operations involving Folder and Document elements.
An implicit Renderer for rendering Container elements, leveraging provided Folder and Document data.

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Container.type

Abstract Container element. Container is a subtype of Feature and a super-type of Folder, Document. See Container.

A Container has no properties of its own.

Attributes

Companion: object
Supertypes: trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: class Document

class Folder

Properties of a Container (and therefore all its subtypes).

Value parameters

featureData: (auxiliary) member: FeatureData, shared by sub-elements.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The ContainerData object serves as a companion object to the ContainerData case class. It provides utility features for extracting and rendering instances of ContainerData.

This object mixes in the Extractors and Renderers traits, which provide the foundational behavior for extraction and rendering operations.

It defines and initializes the following:

applyFunction: A private function used internally to create ContainerData instances from FeatureData.
extractorPartial: A partially defined extractor for converting FeatureData into ContainerData.
extractor: An implicit extractor instance for ContainerData.
renderer: An implicit renderer instance for ContainerData that manages the rendering of ContainerData instances back into their constituent elements.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ContainerData.type

Companion object for the Coordinate case class, providing methods to parse and render Coordinate objects.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Coordinate.type

Case class Coordinate to represent a three-dimensional point. Although this is part of the KML spec, it is treated somewhat differently than the others.

Value parameters

lat: latitude.
long: longitude.
maybeAlt: altitude: optional per the KML spec (a 2-value "long,lat" tuple is valid KML), kept as Option rather than defaulted so that round-tripping a coordinate that omitted altitude doesn't fabricate an explicit "0" that was never there.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Coordinates class.

This object provides utilities for extracting, rendering, and manipulating instances of Coordinates. It includes implicit extractors and renderers for Coordinates objects and sequences of Coordinates. Additionally, it provides methods for parsing and handling operations related to Coordinates instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Coordinates.type

Represents a sequence of Coordinate objects and provides operations for merging, reversing, and computing geometric properties such as gaps and directions. See Linear Ring coordinates

Value parameters

coordinates: A sequence of Coordinate objects representing this collection.

Attributes

Constructor: Creates an instance of Coordinates with the specified sequence of Coordinate objects.
Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Mergeable[Coordinates]

class Object

trait Matchable

class Any
Show all

Case class Data: sub-element of ExtendedData, representing an untyped name/value pair. See Data

Value parameters

_name: the name of this Data element (an XML attribute).
maybeDisplayName: an optional user-friendly display name: Option[Text].
value: the value: Text.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Data case class, providing extractors and renderers for Data instances and sequences thereof.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Data.type

DisplayMode represents a display preference in association with the DisplayModeEnum enumeration. See displayMode

It is defined as a case class wrapping a value from the DisplayModeEnum enumeration. The DisplayMode can be rendered or extracted for usage, utilizing the implicit values defined in its companion object.

The case class is closely associated with the DisplayModeEnum which provides the following options:

default: Uses the provided information to generate a visible representation.
hide: Suppresses the display of the associated representation.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the DisplayMode case class. Provides extractors and renderers for handling DisplayMode instances.

Contains implicit values for:

Extracting a DisplayMode instance.
Extracting an optional DisplayMode instance.
Rendering a DisplayMode instance.
Rendering an optional DisplayMode instance.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: DisplayMode.type

Enumeration representing Values for DisplayMode are default and hide.

The available DisplayMode in this enumeration are:

default: Google Earth uses the information supplied in text to create a balloon
hide: Google Earth does not display the balloon.

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of DisplayModeEnum.
renderer: Provides a Renderer instance for rendering values of DisplayModeEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DisplayModeEnum.type

Object companion for the Document case class, providing extractors and renderers.

This object serves as a utility for working with Document, offering:

Partial and complete extractors for deserializing Document instances.
Renderers for serializing Document instances or sequences of Document objects.

Members:

extractorPartial: A partial extractor for transforming ContainerData to Document.
extractor: An implicit complete extractor for Document instances.
renderer: An implicit renderer for serializing Document to a string representation.
rendererSeq: An implicit renderer for serializing a sequence of Document instances.

Extraction and rendering processes are defined through the Extractors and Renderers mixins.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Document.type

Case class Document: sub-element of Container. See Document.

TODO add Schemas to this case class

Value parameters

containerData: ContainerData (auxiliary property).
features: a sequence of Features.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait HasName

trait HasFeatures

trait Container

trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the DrawOrder case class, providing utility methods and implicit instances for extraction and rendering.

These utilities enable seamless integration of the DrawOrder type with systems that require parsing, rendering, or manipulation of draw order values.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: DrawOrder.type

Represents a draw order value as an Int. See draworder

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Case class to represent a KML element that will take part in an edit.

Value parameters

name: the identifier.
tag: the tag.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ExtendedData case class. Provides extractor and renderer instances for working with the ExtendedData type and Option[ExtendedData].

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ExtendedData.type

Case class ExtendedData: optional sub-element of Feature, providing custom data in addition to the standard KML fields. See ExtendedData

Value parameters

Data: a sequence of untyped name/value pairs: Seq[Data].
SchemaData: a sequence of Schema-typed name/value pairs: Seq[SchemaData].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The Extrude object serves as a companion to the Extrude case class. It extends the Extractors and Renderers traits to provide both extraction and rendering capabilities for the Extrude type.

This object includes implicit definitions for various extractors and renderers, making it suitable for transforming and handling operations with Extrude instances and their optional counterparts.

Implicit extractors:

extractor: Provides extraction logic for Extrude using extractor10.
extractorOpt: Provides optional extraction logic for Extrude using extractorOption.

Implicit renderers:

renderer: Supplies rendering capabilities for Extrude instances.
rendererOpt: Supplies rendering capabilities for optional Extrude instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Extrude.type

Class Extrude which represents a Boolean. Used by LineString and Polygon. Similar to Tessellate--and in fact they often go together. See Linear Ring extrude

Value parameters

$: the value.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Trait Feature: abstract sub-element of KmlObject. Feature is a sub-type of Object and a super-type of Placemark, Container. See Feature.

TODO add Overlay, NetworkLink.

Attributes

Companion: object
Supertypes: trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: trait Container

class Document

class Folder

class NetworkLink

trait Overlay

class BaseOverlay

class GroundOverlay

class PhotoOverlay

class ScreenOverlay

class Placemark
Show all

The Feature object provides implementations for extractors and renderers related to the Feature trait.

It includes implicit definitions for processing sequences of Feature instances and rendering them. This object is intended to support operations and transformations on Feature and its subtypes.

Attributes

See also: Feature trait for more details on the Feature type hierarchy.
Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Feature.type

Properties of a Feature (and therefore all its sub-types).

CONSIDER redefining abstractView so that it can have only one optional AbstractView (according to KML spec.)

Value parameters

StyleSelectors: a sequence of StyleSelectors: Seq[StyleSelector].
kmlData: (auxiliary) member: KmlData.
maybeDescription: an optional description: Option[Text].
maybeExtendedData: an optional ExtendedData: Option[ExtendedData].
maybeOpen: an optional openness designation: Option[Int].
maybeStyleUrl: an optional style URL: Option[StyleURL].
maybeTimePrimitive: an optional TimeStamp or TimeSpan, kept generic (see GenericElement) since TimePrimitive is an abstract type and its real tag is never literally "TimePrimitive": Option[GenericElement].
name: the name (a Text).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait HasName

trait Mergeable[FeatureData]

class Object

trait Matchable

class Any
Show all

Companion object for FeatureData case class.

The FeatureData object provides extractor and renderer implementations for FeatureData instances, allowing the transformation and processing of FeatureData objects.

It extends the functionality of both Extractors and Renderers traits to enable flexible extraction and rendering of FeatureData.

Members:

extractorPartial: A partial extractor defined for FeatureData using KmlData => FeatureData.
extractor: An implicit extractor for FeatureData based on extractorPartial.
renderer: An implicit renderer for FeatureData facilitating serialization.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: FeatureData.type

Fill. NOTE that this is a boolean that is represented by 0 or 1. See fill

Value parameters

boolean: whether to fill or not.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The Fill object provides extractor and renderer implementations for the Fill case class. It offers mechanisms to extract Fill instances and render them as representations suitable for processing or serialization.

The object includes implicit extractors and renderers for both Fill and Option[Fill] types:

Extractors parse and convert input representations into Fill instances.
Renderers generate output representations from Fill instances.

Operations within this object make use of the provided mechanisms in the Extractors and Renderers traits for consistent and flexible processing pipelines.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Fill.type

Companion object for the FlyToView case class.

This object provides implicits and utilities for serializing and deserializing FlyToView instances. It extends traits Extractors and Renderers to support extraction and rendering functionalities.

Implicit extractors and renderers are provided for both FlyToView and Option[FlyToView], enabling their usage in data processing pipelines that require standardized extraction or rendering logic.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: FlyToView.type

A case class representing FlyToView in KML documents. TESTME

This case class encapsulates a Boolean value that signifies FlyToView attributes in KML data. FlyToView settings often dictate A value of 1 causes Google Earth to fly to the view of the LookAt or Camera in the NetworkLinkControl (if it exists).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Case class Folder: subelement of Container. See Folder.

Value parameters

containerData: the ContainerData (auxiliary property).
features: a sequence of Feature elements (where Feature is an abstract super-type).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait HasName

trait HasFeatures

trait Container

trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Show all

Folder object provides extractors and renderers for the Folder case class.

Extractors are used to parse or transform Folder objects.
Renderers are used to serialize Folder objects and sequences of them.

Members:

extractorPartial: A partial extractor function for transforming ContainerData into Folder.
extractor: Implicit extractor for Folder.
renderer: Implicit renderer for a single Folder.
rendererSeq: Implicit renderer for sequences of Folder instances.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Folder.type

Trait Geometry: abstract subelement of KmlObject. Geometry is the super-type of LineString, Polygon, LinearRing, and Point.

See Geometry

Attributes

Companion: object
Supertypes: trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all
Known subtypes: class LineString

class LinearRing

class Model

class MultiGeometry

class Point

class Polygon
Show all

Object Geometry serves as a utility and companion object for the Geometry trait and its related subtypes (LineString, Point, Polygon, LinearRing). It provides implicit extractors and renderers to facilitate operations such as multi-extraction, rendering, and rendering sequences of Geometry instances.

It leverages the Extractors and Renderers traits to abstract the functionality of parsing and generating Geometry instances while adhering to the expected formats.

Members:

extractorSeq: An implicit utility that facilitates the extraction of sequences of Geometry instances, supporting parsing of its subtypes (LineString, Point, Polygon, LinearRing).
renderer: An implicit utility for rendering instances of Geometry into their expected formats.
rendererSeq: An implicit utility for rendering sequences of Geometry instances.

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Geometry.type

Properties of Geometry. There are no properties specific to Geometry. See Geometry

Value parameters

kmlData: source of properties.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Mergeable[GeometryData]

class Object

trait Matchable

class Any
Show all

Companion object for the GeometryData case class.

Provides utilities and functionality for working with GeometryData such as extractors and renderers which are essential for converting to and from external formats, as well as rendering it into desired representations.

Extends Extractors and Renderers to leverage common extraction and rendering utilities.

Functionality:

Defines a private partial extractor, extractorPartial, for constructing GeometryData instances.
Provides an implicit Extractor instance for GeometryData to enable its seamless extraction.
Provides an implicit Renderer instance for GeometryData for rendering purposes, tagged as "rendererGeometryData".

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: GeometryData.type

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

The GroundOverlay object serves as a companion to the GroundOverlay case class and provides functionality for extracting and rendering instances of GroundOverlay.

It contains predefined extractors and renderers to facilitate the conversion and representation of GroundOverlay objects.

Members:

extractorPartial: A partial extractor function that processes OverlayData and produces GroundOverlay. It is labeled with the identifier "extractorCD2GroundOverlay".
extractor: An implicit extractor for GroundOverlay that utilizes extractorPartial to produce complete instances of GroundOverlay. It is labeled with the identifier "extractorGroundOverlay".
renderer: An implicit renderer for GroundOverlay that manages the representation of instances, delegating to a predefined rendering function. It is labeled with the identifier "renderGroundOverlay".
renderSeq: An implicit renderer for a sequence of GroundOverlay, enabling the structured representation of a collection of GroundOverlay instances. It is labeled with the identifier "rendererGroundOverlays".

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: GroundOverlay.type

Companion object HasFeatures provides utilities for editing objects that have a property of owning features.

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: HasFeatures.type

Trait to define the property of owning features.

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class Document

class Folder

class KML

Trait representing an entity that has a name attribute.

A HasName entity provides access to its name, defined as a Text type.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class BaseOverlay

class GroundOverlay

class PhotoOverlay

class ScreenOverlay

class Document

class FeatureData

class Folder

class NetworkLink

class Placemark
Show all

Provides extractor and renderer instances for the Heading case class.

This object facilitates the conversion of Heading instances to and from different formats, enabling seamless interaction between data representations. It includes implicit implementations of extractors and renderers for both Heading and Option[Heading] types.

The extractors and renderers adhere to a standardized naming convention:

Extractor: Converts external data into Heading or Option[Heading] instances.
Renderer: Converts Heading or Option[Heading] instances into a rendered form.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Heading.type

Case class to represent a Heading which is represented in XML as, for example: 1.1 See heading

Value parameters

$: the value of the heading (a Double).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The Helper object does nothing other than provide a name for this module.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: Helper.type

Companion object for the Hex4 case class that provides utility methods and functionality for working with Hex4 instances, including creation, parsing, and rendering.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: Hex4.type

Represents a color in the RGBA hexadecimal format using four bytes.

Value parameters

alpha: The alpha (transparency) component of the color, represented as a byte.
blue: The blue component of the color, represented as a byte. Overrides the toString method to return the color as a hexadecimal string with each byte formatted as a two-digit hexadecimal number.
green: The green component of the color, represented as a byte.
red: The red component of the color, represented as a byte.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The HotSpot object serves as a companion to the HotSpot case class. It extends the Extractors and Renderers traits, providing implicit extractors and renderers for HotSpot and Option[HotSpot]. These implicits allow for streamlined extraction and rendering of HotSpot instances using predefined extraction and rendering methods.

extractor, extractorOpt, renderer, and rendererOpt are implicitly available for parsing and generating the corresponding representations of HotSpot.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: HotSpot.type

Case class to model a HotSpot. See hotSpot

Value parameters

_x: optional x field.
_xunits: optional xunits field.
_y: optional y field.
_yunits: optional yunits field.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the case class Icon.

Extends functionality with Extractors and Renderers to enable safe conversion and rendering for the Icon case class. The object defines implicit extractor and renderer instances for handling the Icon type. The extractor and renderer are utilized for serializing and deserializing Icon objects.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Icon.type

Case class Icon. NOTE: we do not currently support Link. See Icon

Value parameters

href: a URL reference to an image.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An object that provides extraction and rendering utilities for the IconStyle case class.

IconStyle represents styling information for icons, including color style data and additional properties such as scale, icon details, hotspot, and heading.

This object includes the following:

extractorPartial: A partial extractor that transforms ColorStyleData to IconStyle.
extractor: An implicit extractor for extracting IconStyle instances.
renderer: An implicit renderer for rendering IconStyle instances.
rendererOpt: An implicit renderer for rendering optional IconStyle instances.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: IconStyle.type

Case class to model IconStyle. See IconStyle

Value parameters

Icon: the Icon.
colorStyleData: the (auxiliary) color style properties.
maybeHeading: an optional Heading.
maybeHotSpot: optional HotSpot
maybeScale: optional Scale.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait ColorStyle

trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Show all

This case class represents a hierarchical set of images, each of which is an increasingly lower resolution version of the original image. used by PhotoOverlay.

Value parameters

gridOrigin: Specifies where to begin numbering the tiles in each layer of the pyramid. A value of lowerLeft specifies that row 1, column 1 of each layer is in the bottom left corner of the grid. just exist two values, lowerLeft, upperLeft
maxHeight: Height in pixels of the original image.
maxWidth: Width in pixels of the original image.
tileSize: Size of the tiles, in pixels. Tiles must be square, and "tileSize" must be a power of 2. A tile size of 256 (the default) or 512 is recommended.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ImagePyramid case class. Provides implicit instances for Extractor and Renderer typeclasses to facilitate

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ImagePyramid.type

This case class represents the inner boundary of a polygon in KML (Keyhole Markup Language) files. The inner boundary is defined by a LinearRing, which specifies a closed, linear path (a closed line with four or more positions). See InnerBoundaryIs

Value parameters

LinearRing: The LinearRing defining the closed linear path representing the inner boundary.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion class to InnerBoundaryIs.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: InnerBoundaryIs.type

Trait to satisfy invert command. See also comments re: Mergeable.

Type parameters

T: the underlying type.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait Geometry

class LineString

class LinearRing

class Model

class MultiGeometry

class Point

class Polygon

class Placemark
Show all

Case class representing an icon associated with an item, characterized by its state and a hyperlink reference.

Value parameters

href: the hyperlink reference (represented as Text) associated with the ItemIcon.
state: the state of the ItemIcon, which should ideally represent one of several possible enumerated statuses such as "open," "closed," "error," "fetching0," "fetching1," or "fetching2."

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ItemIcon case class that provides utilities for extracting, rendering, and optionally managing ItemIcon instances. This object facilitates the interaction and transformation of ItemIcon objects through predefined extractors and renderers.

Extractors and Renderers:

Provides implicit definitions for extracting values of type ItemIcon and Option[ItemIcon].
Provides implicit definitions for rendering ItemIcon and Option[ItemIcon] objects.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ItemIcon.type

Enumeration representing Values for ItemIconModeEnum are open, closed, error, fetching0, fetching1 or fetching2.

The available ItemIconModeEnum in this enumeration are:

open
closed
error
fetching0
fetching1
fetching2

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of ItemIconModeEnum.
renderer: Provides a Renderer instance for rendering values of ItemIconModeEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ItemIconModeEnum.type

Case class to define a KML object.

NOTE WELL: do not be tempted to add "_xmlns" as a member. If you do, you will run into the undocumented(?) "feature" of the Xml library that "xmlns" is a reserved attribute name.

Value parameters

features: a sequence of Feature (typically Document).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait HasFeatures

class Object

trait Matchable

class Any
Show all

Companion object for the KML case class. This object provides utilities for rendering, extracting, and managing KML objects in various formats. Additionally, it defines custom renderers and extractors tailored to KML handling.

NOTE that there are two different methods for rendering a KML object. One is to use the KML_Binding mechanism. The other is to invoke the method below: renderKml.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: KML.type

Companion helper object for the KML class. Provides utility methods for loading, rendering, and manipulating KML objects and their features.

CONSIDER merging this with object KML. NOTE that this object depends on cats effect IO.

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: KMLCompanion.type

Attributes

Supertypes: class Object

trait Matchable

class Any

Companion object for the KMLEditParser class, providing utilities and default instantiation.

The apply method creates a new instance of KMLEditParser with default settings.

This object also includes a logger instance for managing logging across the parser.

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: KMLEditParser.type

KMLEditParser: class to parse lines of an edit file. NOTE: list elements always appear as a string in the form { element0 , element1 , ... }

NOTE: Much of this is probably overkill (it was copied from TableParser).

Value parameters

enclosures: the enclosure characters around a list (if any).
listSeparator: the list separator character.
quote: the quote character which is able to preempt the string regex: between two quote characters, there can be any number of any character (other than quote).
verbose: will print the various parameters.

Attributes

Companion: object
Supertypes: trait JavaTokenParsers

trait RegexParsers

trait Parsers

class Object

trait Matchable

class Any
Show all

Case class to represent a set of KmlEdit objects.

Value parameters

edits: a sequence of edits.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Singleton object providing functionalities to parse and process KML files.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: KMLEditor.type

Represents a binding for a KML object with its corresponding XML namespace binding.

NOTE this is a bit of a mystery.

A KML_Binding associates a KML instance with its XML NamespaceBinding to manage XML namespaces.

Value parameters

binding: the NamespaceBinding for managing XML namespaces linked to the KML.
kml: the KML object representing the main geospatial data structure.

Attributes

Constructor: Constructs a new KML_Binding object with a given KML instance and its NamespaceBinding.
Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the KML_Binding case class. Provides implicit implementations for extracting and rendering KML_Binding instances.

The object defines two implicit values:

An Extractor[KML_Binding] to parse an XML Node and construct a KML_Binding instance.
A Renderer[KML_Binding] to facilitate rendering of a KML_Binding instance to XML format.

These implicits make the KML_Binding interoperable with XML nodes and compatible with processes that work with Extraction and Rendering mechanisms.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: KML_Binding.type

Represents a Key that associates a style state with a style map.

The Key case class encapsulates a value from the StyleStateEnum, which defines the specific state of a style, such as normal or highlight. This class is integral to managing and distinguishing between different visual representations of styles, particularly in applications like Google Earth.

Value parameters

$: Represents the state of the style and must be one of the values defined in the StyleStateEnum enumeration.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object Key serves as a companion to the Key case class and provides implicit definitions for extractors and renderers, enabling the integration of Key with parsing and formatting operations.

This object mixes in the Extractors and Renderers traits to leverage reusable methods and functionalities for defining its implicit members.

Implicit Members:

extractor: Defines an Extractor instance for Key, supporting its conversion from data sources into the Key type.
renderer: Provides a Renderer instance for Key, facilitating its conversion from the Key type to human-readable or serialized formats.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Key.type

Properties of KMLObject

Value parameters

__id: an optional identifier.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Mergeable[KmlData]

class Object

trait Matchable

class Any
Show all

Companion object for the KmlData case class.

This object provides utility methods and implicit definitions to facilitate the use of KmlData, including extractors and renderers that integrate with the Extractors and Renderers frameworks.

Defines an implicit Extractor for deserializing KmlData instances, and an implicit Renderer for serializing KmlData instances.

Attributes

See also: KmlData case class for additional details on properties and functionality.
Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: KmlData.type

Companion object for KmlEdit, providing methods and constants used for editing KML elements.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: KmlEdit.type

Case class to represent the definition of a KML edit.

Value parameters

command: the function of the edit.
maybeOp2: the result of the edit.
op1: the target of the edit.
operands: the number of operands required for this edit.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents an exception specific to KML processing errors.

Value parameters

str: A message describing the details of the exception.

Attributes

Supertypes: trait Product

trait Equals

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Trait KmlObject: abstract super-element of all KML elements. Known in the reference document as Object. See KML Reference

NOTE: abstract elements cannot be represented in Kml documents directly but are always super-elements (and therefore ordinary classes). Their usage is in the properties of other elements where more than one possible element type is allowed.

NOTE: there's some argument for having KmlObject extend scala.xml.Node but it's not compelling.

Actual Kml elements (the leaf classes) are all represented here as case classes, which cannot be extended.

The arrangement of the traits and classes within this module follows the KML Reference starting with Object and then doing breadth-first top to bottom.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait AbstractView

class Camera

class LookAt

trait Feature

trait Container

class Document

class Folder

class NetworkLink

trait Overlay

class BaseOverlay

class GroundOverlay

class PhotoOverlay

class ScreenOverlay

class Placemark

trait Geometry

class LineString

class LinearRing

class Model

class MultiGeometry

class Point

class Polygon

class Scale

trait StyleSelector

class Style

class StyleMap

trait SubStyle

trait ColorStyle

class BalloonStyle

class IconStyle

class LabelStyle

class LineStyle

class ListStyle

class PolyStyle
Show all

Object KmlRenderers extends the Renderers base trait and serves as a collection of formatting utilities specifically for KML (Keyhole Markup Language) rendering.

This object contains nested case classes and methods for handling formatting operations.

Attributes

Supertypes: trait Renderers

class Object

trait Matchable

class Any
Self type: KmlRenderers.type

Companion object for the LabelStyle case class.

This object provides functionality for extracting, rendering, and managing LabelStyle instances. It extends Extractors and Renderers to leverage shared utilities for handling data conversion and manipulation.

Members:

extractorPartial: A partial extractor from ColorStyleData to LabelStyle.
extractor: Fully defined extractor to convert inputs into LabelStyle instances.
renderer: Renderer implementation for LabelStyle instances.
rendererOpt: Renderer for optional LabelStyle instances.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: LabelStyle.type

Case class LabelStyle which extends ColorStyle. See Label Style

Value parameters

colorStyleData: the (auxiliary) color style properties.
scale: the scale.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait ColorStyle

trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Show all

Represents a rectangular geographic bounding box defined by its northernmost, southernmost, easternmost, and westernmost limits, along with an optional rotational value. Used by GroundOverlay.

Value parameters

east: The eastern boundary of the box as a Longitude.
north: The northern boundary of the box as a Latitude.
rotation: The rotational angle applied to the box as a Rotation.
south: The southern boundary of the box as a Latitude.
west: The western boundary of the box as a Longitude.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the LatLonBox case class. Provides implicit instances for Extractor and Renderer typeclasses to facilitate parsing LatLonBox objects from XML nodes and rendering them to String representations.

The implicit extractor uses extractor50, enabling the construction of a LatLonBox from its five constituent members: north, south, east, west, and rotation.

The implicit renderer uses renderer5, enabling the rendering of LatLonBox objects by delegating to renderers for each of its five members.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: LatLonBox.type

Represents a latitude value as a Double, an angle90.

Latitude values are commonly used in geographic coordinate systems to specify the north-south position of a point on the Earth's surface.

This case class is typically accompanied by extractors and renderers to facilitate parsing and rendering operations as part of a larger system.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Latitude case class, providing utility methods and implicit instances for extraction and rendering.

This object includes:

An extractor for parsing Latitude instances.
An optional extractor for handling optional Latitude values.
A renderer for converting Latitude instances into a specific format.
An optional renderer for handling optional Latitude values.

These utilities enable seamless integration of the Latitude type with systems that require parsing, rendering, or manipulation of latitude values.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Latitude.type

Case class LineString which extends Geometry.

See LineString

Value parameters

coordinates: a sequence of Coordinates objects.
maybeTessellate: the (optional) tessellation.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Geometry

trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all

Object LineString serves as a companion to the LineString case class. It provides extraction and rendering capabilities for LineString objects.

The object includes implicit values for extraction and rendering to facilitate seamless operations such as serialization, deserialization, and transformation of LineString instances.

This object is designed for internal configuration, such as connecting the Extractor and Renderer abstractions with the LineString case class.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: LineString.type

Companion object for the LineStyle case class, providing extractors and renderers.

This object includes partial extractors, implicit extractors, and renderers for LineStyle instances. It facilitates conversion to and from data structures in the context of LineStyle.

Members:

extractorPartial: Partial extractor for ColorStyleData

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: LineStyle.type

Case class LineStyle which extends ColorStyle. See Line Style

NOTE: the width is optional but I can't actually find an instance of LineStyle that doesn't have a width.

Value parameters

colorStyleData: other properties.
maybeWidth: optional width of the line.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait ColorStyle

trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the LinearRing case class.

This object provides extraction and rendering functionalities for LinearRing instances. It defines an implicit extractor and renderer for working with LinearRing objects. The extractorPartial method is used to create a partial extractor specific to the LinearRing type. The extractor is responsible for extracting LinearRing instances using GeometryData. The renderer is responsible for rendering LinearRing instances back into a specific representation.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: LinearRing.type

Case class LineString which extends Geometry.

See LinearRing

Value parameters

coordinates: a sequence of Coordinates objects.
maybeTessellate: the (optional) tessellation.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Geometry

trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all

Case class Link, used by NetworkLink and Model to reference an external resource, with control over how and when it's refreshed. See Link

Value parameters

maybeHref: the location of the resource: Option[Text].
maybeHttpQuery: an optional format string for an HTTP query: Option[Text].
maybeRefreshInterval: an optional refresh interval: Option[RefreshInterval].
maybeRefreshMode: an optional refresh mode: Option[RefreshMode].
maybeViewBoundScale: an optional scale factor for the view bounding box: Option[ViewBoundScale].
maybeViewFormat: an optional format string for the view: Option[Text].
maybeViewRefreshMode: an optional view refresh mode: Option[ViewRefreshMode].
maybeViewRefreshTime: an optional view refresh time: Option[ViewRefreshTime].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Link case class, providing extractors and renderers for Link and Option[Link].

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Link.type

Represents a type of list item defined by the enumeration ListItemTypeEnum.

The ListItemType case class encapsulates a value from ListItemTypeEnum, which defines the behavior or attributes associated with various types of list items.

This class is used in conjunction with the companion object and other utility traits to facilitate rendering and extraction of ListItemType instances.

Value parameters

$: The enumeration value specifying the type of list item. This value must be one of the predefined values in the ListItemTypeEnum object.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The ListItemType object provides extractors and renderers for the ListItemType case class. It facilitates transformations to and from ListItemType instances.

It includes implicit definitions for:

extractor: Extracts ListItemType instances using the defined pattern.
extractorOpt: Optionally extracts ListItemType instances.
renderer: Converts ListItemType instances into their respective rendered form.
rendererOpt: Renderers for optional ListItemType instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ListItemType.type

Enumeration representing different types of list item behaviors or attributes.

The ListItemTypeEnum object provides a set of predefined values:

check: Represents a list item that can be checked.
checkOffOnly: Represents a list item that can only be unchecked.
checkHideChildren: Represents a list item that hides its children when checked.
radioFolder: Represents a list item with behavior similar to a radio button within a folder.

This object extends Enumeration to define the set of values, and integrates with the Extractors and Renderers traits to provide functionality for extracting and rendering enumeration values.

Contains implicit components:

An extractor for converting to and from ListItemTypeEnum.Value.
A renderer for rendering ListItemTypeEnum.Value.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListItemTypeEnum.type

Case class ListStyle which extends ColorStyle.

See List Style

NOTE According to the current KML reference, this object extends SubStyle or ColorStyle (it's not clear which).

Value parameters

bgColor: optional background color (maybe it isn't optional if there's no color element).
colorStyleData: the (auxiliary) color style properties.
maybeItemIcon: the display mode.
maybeListItemType: optional ListItemType.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait ColorStyle

trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the ListStyle case class, providing extractors and renderers.

This object includes functionality for extracting and rendering ListStyle instances, utilizing partial extractors and renderers. This allows seamless integration with serialization or transformation frameworks.

Members:

extractorPartial: A partial extractor for converting ColorStyleData to ListStyle.
extractor: An implicit extractor for ListStyle, providing the ability to transform data into a ListStyle instance.
renderer: An implicit renderer for ListStyle, enabling transformation of ListStyle instances into a rendered format.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: ListStyle.type

Companion object for the Location case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Location.type

Case class Location: sub-element of Model, specifying where the model is draped onto the Earth's surface. See Model

Value parameters

latitude: the latitude of the model's origin.
longitude: the longitude of the model's origin.
maybeAltitude: an optional altitude of the model's origin: Option[Altitude].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object representing Longitude functionalities, such as rendering and extraction. Provides implicit definitions for rendering and extracting longitude values, as well as optional longitude values. Extends Extractors and Renderers to provide utility methods for longitude manipulation.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Longitude.type

Case class representing a geographical longitude (an angle180).

Value parameters

$: the longitude value in degrees as a Double.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the LookAt class, providing implicit extractors, renderers, and utilities for working with LookAt instances. LookAt represents a viewpoint in a KML visualization, describing location, orientation, and viewing distance.

It extends the functionality of Extractors and Renderers to allow for convenient serialization, deserialization, and optional handling of LookAt objects.

extractorPartial: Defines a partial extractor for the LookAt class.
extractor: An implicit extractor for deserializing LookAt instances.
extractorOpt: An implicit extractor for handling optional LookAt instances.
renderer: An implicit renderer for serializing LookAt instances.
rendererOpt: An implicit renderer for serializing optional LookAt instances.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: LookAt.type

Represents a "LookAt" view element in a KML document, describing a position to look at from a specific viewpoint, with additional details like orientation, range, and optional altitude. See LookAt

LookAt defines the geographic position (longitude, latitude), optional altitude, heading, tilt, and range parameters for setting up a view in a geographic visualization context such as Google Earth.

Value parameters

abstractViewData: additional data inherited from AbstractView.
heading: the direction (in degrees) from the observer to the LookAt point.
latitude: the latitude of the LookAt position in degrees.
longitude: the longitude of the LookAt position in degrees.
maybeAltitude: an optional altitude value for the LookAt position.
maybeAltitudeMode: an optional altitude mode specifying how the altitude is interpreted.
range: the distance (in meters) from the observer to the LookAt point.
tilt: the tilt angle (in degrees) of the view relative to the surface.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait AbstractView

trait KmlObject

class Object

trait Matchable

class Any
Show all

Case class Model, which extends Geometry: a 3D object described in a COLLADA file, placed at a given location and orientation, and scaled. See Model

NOTE: altitude mode is not one of this class's own fields, unlike the KML spec's own grouping - it's already provided by every Geometry subtype via the shared geometryData aux (see GeometryData.maybeAltitudeMode), so adding it again here would render it twice.

Value parameters

geometryData: the other properties of the Model.
maybeLink: an optional reference to the COLLADA (.dae) file: Option[Link].
maybeLocation: an optional location on the Earth's surface: Option[Location].
maybeOrientation: an optional orientation: Option[Orientation].
maybeResourceMap: an optional map from the COLLADA file's own texture references to where those resources actually are in this KML/KMZ package: Option[ResourceMap].
maybeScale: an optional scale factor along each axis: Option[ModelScale].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Geometry

trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the Model case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Model.type

Case class ModelScale: sub-element of Model, a scale factor to apply along each of the three axes. Named ModelScale (not Scale, which already exists elsewhere in this file for the unrelated, single-value icon/label scale factor) since the two are structurally different - only the actual XML tag ("Scale") is shared between them, which is fine since it's Model's own field name (not this class's name) that determines the tag used. See Model

Value parameters

x: the scale factor along the x axis: AxisScale.
y: the scale factor along the y axis: AxisScale.
z: the scale factor along the z axis: AxisScale.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ModelScale case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ModelScale.type

Companion object for the case class MultiGeometry.

This object provides utilities for working with the MultiGeometry type, including extractors and renderers to handle serialization and parsing.

Utilities:

Provides an implicit extractor to parse MultiGeometry objects from GeometryData.
Provides an implicit renderer for serializing MultiGeometry objects.
Provides a renderer for sequences of MultiGeometry objects.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: MultiGeometry.type

Case class MultiGeometry which extends Geometry: a collection of other Geometry elements (Point, LineString, LinearRing, Polygon, and recursively MultiGeometry itself).

See MultiGeometry

Value parameters

Geometry: the child Geometry elements. NOTE: capitalized (matching Placemark's own field of the same type) rather than pluralized ("geometries"): a plural-looking field name triggers extractChildren's stricter, literal-tag-only lookup, which has no fallback to type-based matching - this needs the fallback, since there's no literal "<geometry>" tag.
geometryData: the other properties of the MultiGeometry.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Geometry

trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all

A case class representing an exception that formats the provided input into a multi-line exception message. This can be used to encapsulate exception-related details in a formatted string.

Type parameters

X: The type of the input that will be converted into an exception message.

Value parameters

x: The input value that will be incorporated into the exception message.

Attributes

Supertypes: trait Product

trait Equals

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Case class NetworkLink: subtype of Feature, referencing a KML file or KMZ archive on a local or remote network, optionally with rules for automatically refreshing it. See NetworkLink

Value parameters

featureData: the (auxiliary) FeatureData, shared by sub-elements.
maybeFlyToView: whether a view change is limited to the extent of the referenced feature: Option[FlyToView].
maybeLink: the location of, and refresh rules for, the referenced resource: Option[Link].
maybeRefreshVisibility: whether to reset the visibility of features when the file is refreshed: Option[RefreshVisibility].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait HasName

trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the NetworkLink case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: NetworkLink.type

Represents an Open state with a single boolean parameter.

Value parameters

$: A boolean value indicating the open state.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Open case class. Provides extractor and renderer instances for working with the Open type and Option[Open].

Mixes in functionality from the Extractors and Renderers traits to enable operations such as extraction and rendering for instances of the Open class.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Open.type

Companion object for the Orientation case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Orientation.type

Case class Orientation: sub-element of Model, describing the rotations to apply to the COLLADA model to position it correctly. See Model

Value parameters

heading: the rotation about the z axis (normal to the Earth's surface).
roll: the rotation about the y axis.
tilt: the rotation about the x axis.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the OuterBoundaryIs case class. This object provides utilities for extracting and rendering OuterBoundaryIs instances.

The extractor is an implicit value utilized for extracting OuterBoundaryIs instances, and it uses the extractor10 combinator along with the apply method of OuterBoundaryIs.

The renderer is an implicit value used for rendering OuterBoundaryIs instances into their corresponding KML representations. It employs the renderer1 combinator with the apply method

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: OuterBoundaryIs.type

Represents the outer boundary of a polygon in KML format. This case class holds a LinearRing, which defines the coordinates that create the outer boundary. See outerBoundaryIs

Value parameters

LinearRing: the LinearRing instance that specifies the coordinates of the outer boundary of a polygon.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Outline. NOTE that this is a boolean that is represented by 0 or 1.

Value parameters

boolean: whether to outline or not.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The Outline object provides implicit extractors and renderers for the Outline type.

It facilitates the extraction and rendering of Outline objects and their Option counterparts. The object extends Extractors and Renderers to leverage shared behavior for parsing and formatting.

Implicit members include:

An Extractor for Outline objects, allowing the transformation of data into an Outline instance.
An Extractor for Option[Outline], supporting optional

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Outline.type

Abstract Overlay element. Overlay is a subtype of Feature and a super-type of PhotoOverlay, ScreenOverlay, GroundOverlay. See Overlay. The trait Overlay is extended, abstractly, by BaseOverlay. A Overlay has properties (color, maybeDrawOrder and Icon ) of its own. color The order of expression is aabbggrr in hexadecimal notation, where aa=alpha (00 to ff); bb=blue (00 to ff); gg=green (00 to ff); rr=red (00 to ff). maybeDrawOrder This element defines the stacking order for the images in overlapping overlays. icon Defines the image associated with the Overlay.

Attributes

Companion: object
Supertypes: trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: class BaseOverlay

class GroundOverlay

class PhotoOverlay

class ScreenOverlay

Companion object for the Overlay trait, providing utilities for extraction and rendering of Overlay instances.

The Overlay object leverages Extractors and Renderers to handle its subtypes, which include GroundOverlay, PhotoOverlay, and ScreenOverlay.

Key features:

Implicit extractorSeq for extracting sequences of Overlay instances.
Implicit renderer for rendering Overlay instances and its subtypes.

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Overlay.type

Provides utilities for extracting and rendering OverlayData instances. This object includes an Extractor and Renderer for handling OverlayData serialization and deserialization processes and serves as a companion to the OverlayData case class.

OverlayData encapsulates overlay-specific metadata such as an icon, optional draw order, optional color, and associated feature data. The provided extractors and renderers aim to simplify working with data transformation and rendering tasks in context with OverlayData.

extractorPartial: Defines a partial extractor for transforming FeatureData into OverlayData. It is a composition of utility methods supporting specialized extraction logic.
extractor: An implicit full extractor taking advantage of extractorPartial to deserialize OverlayData instances.
renderer: An implicit renderer for serializing OverlayData objects, designed to include relevant metadata for rendering tasks.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: OverlayData.type

Represents overlay data with associated properties including an icon, optional draw order, optional color, and feature data. This case class is designed to encapsulate metadata relevant to a KML (Keyhole Markup Language) overlay structure.

Value parameters

Icon: the associated icon representing the overlay.
featureData: the associated feature data providing contextual metadata.
maybeColor: an optional color value for overlay customization.
maybeDrawOrder: an optional draw order, determining the rendering order of the overlay.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the OverlayXY case class, providing implicit extractor and renderer instances.

This object facilitates the serialization and deserialization of OverlayXY instances by utilizing predefined extractor and renderer functionalities.

It mixes in the Extractors and Renderers traits to provide support for data extraction and rendering.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: OverlayXY.type

Represents a 2D overlay point with defined coordinates and their corresponding units.

Value parameters

_x: The x-coordinate value.
_xunits: The unit of measurement for the x-coordinate, defined in the UnitsEnum enumeration.
_y: The y-coordinate value.
_yunits: The unit of measurement for the y-coordinate, defined in the UnitsEnum enumeration.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Pair case class, providing utilities for extraction and rendering.

The Pair object extends Extractors and Renderers, offering implicit implementations for extracting and rendering instances of Pair, as well as handling sequences of Pair.

Implicit Utilities:

extractor: Provides a mechanism to extract a single Pair instance.
extractorSeq: Facilitates extraction of a sequence of Pair objects.
renderer: Defines the rendering logic for a single Pair instance.
rendererSeq: Handles the rendering of a sequence of Pair instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Pair.type

A case class representing a key-style URL pair mapping in the KML document context.

This class encapsulates a Key and a StyleURL to represent associations typically used in KML processing frameworks for styling and representation of geographic data.

Value parameters

key: the symbolic identifier as a Key, encapsulating a character sequence.
styleUrl: the associated style reference as a StyleURL, providing a mapping to style definitions.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents an exception that occurs during the parsing process.

Value parameters

e: the underlying cause of the exception, if any (optional)
msg: the detail message describing the error encountered

Attributes

Supertypes: trait Product

trait Equals

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Object PhotoOverlay provides extractors and renderers for the case class PhotoOverlay. It includes functionality for extracting, rendering, and handling sequences of PhotoOverlay instances.

This object serves as a utility companion to the PhotoOverlay type.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: PhotoOverlay.type

Represents a specialized overlay element that adds a photo overlay to a geographical location. See PhotoOverlay The PhotoOverlay class is a concrete implementation of the BaseOverlay abstract class, combining additional properties such as rotation and point location with the base overlay features from OverlayData.

A PhotoOverlay specifies the placement and orientation of an image overlay in geographic space, allowing the image to be placed over a specific location with a defined rotation. It is constructed with Rotation, Point, and OverlayData parameters.

Value parameters

ImagePyramid: a hierarchical set of images, each of which is an increasingly lower resolution version of the original image.
Point: the geographical position for the photo overlay, represented as a Point.
ViewVolume: Defines how much of the current scene is visible.
overlayData: The data associated with the overlay, encapsulated in the OverlayData instance.
rotation: the rotation angle of the photo overlay, represented as a Rotation.
shape: The PhotoOverlay is projected onto the . The can be one of the following: rectangle (default) - for an ordinary photo cylinder - for panoramas, which can be either partial or full cylinders sphere - for spherical panoramas

Attributes

Constructor: Creates a new PhotoOverlay instance.
Companion: object
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

Placemark: subtype of Feature. See Placemark.

CONSIDER restricting the number of Geometry elements to one.

Value parameters

Geometry: a sequence of Geometry elements (where Geometry is an abstract super-type).
featureData: the (auxiliary) FeatureData, shared by sub-elements.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Invertible[Placemark]

trait Mergeable[Placemark]

trait HasName

trait Feature

trait KmlObject

class Object

trait Matchable

class Any
Show all

The companion object for the Placemark class, providing extractors, renderers, and various operations associated with Placemark instances. This object extends traits for extracting, rendering, and handling sequences of Placemark objects.

It includes implicit instances of extractors and renderers for processing Placemark objects and their sequences. The companion object facilitates functionality such as deserialization, serialization, and manipulation of Placemark instances.

Members:

extractorPartial: A partial extractor for transforming FeatureData into a Placemark.
extractor: An implicit full extractor for Placemark instances, utilizing the extractorPartial.
renderer: An implicit renderer for converting Placemark objects into a specific representation.
rendererSeq: An implicit renderer for handling sequences of Placemark instances.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Placemark.type

Case class Point which extends Geometry.

See Point

Value parameters

coordinates: a sequence of Coordinates objects.
geometryData: the other properties of the Point.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Geometry

trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the case class Point.

This object provides utilities for working with the Point type, including extractors and renderers to handle serialization and parsing.

Utilities:

Provides an implicit extractor to parse Point objects from GeometryData.
Provides an implicit renderer for serializing Point objects.
Provides a renderer for sequences of Point objects.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Point.type

Companion object for PolyStyle which provides extractor and renderer utilities. This object combines Extractors and Renderers traits to facilitate the transformation and rendering of PolyStyle instances.

Members:

extractorPartial: Extractor for transforming ColorStyleData into PolyStyle.
extractor: Implicit Extractor instance for PolyStyle.
renderer: Implicit Renderer instance for PolyStyle.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: PolyStyle.type

Case class PolyStyle which extends ColorStyle. See Poly Style

Value parameters

colorStyleData: the (auxiliary) color style properties.
maybeFill: optional value of fill.
maybeOutline: optional value of outline.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait ColorStyle

trait SubStyle

trait KmlObject

class Object

trait Matchable

class Any
Show all

Case class Polygon which extends Geometry.

See Polygon

Value parameters

innerBoundaryIs: a sequence of InnerBoundaryIs objects.
maybeTessellate: the tessellation.
outerBoundaryIs: an OuterBoundaryIs object.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Geometry

trait Invertible[Geometry]

trait Mergeable[Geometry]

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the Polygon case class.

Provides extractors and renderers that are useful for working with the Polygon type. Specifically, it allows for extracting Polygon instances from GeometryData and rendering Polygon instances to their desired outputs.

This object extends Extractors and Renderers, enabling integration with extraction and rendering functionalities of the system.

Members:

extractorPartial: A private partial extractor specifically for handling Polygon extraction logic.
extractor: An implicit Extractor[Polygon] that utilizes extractorPartial for complete extraction functionality.
renderer: An implicit Renderer[Polygon] that allows rendering a Polygon while leveraging its geometry data.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Polygon.type

A case class representing a Range with a single value.

Value parameters

$: the value representing the range.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Range case class. Provides utility functions for extracting and rendering Range objects.

This object mixes in the Extractors and Renderers traits, enabling serialization and deserialization functionality using implicit extractor and renderer instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Range.type

Companion object for the RefreshInterval case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: RefreshInterval.type

RefreshInterval represents the number of seconds to wait before refreshing a Link. See Link

NOTE: this is a plain Double wrapped in its own class - like Rotation/Range/Heading etc. elsewhere in this file - rather than a bare Double field, because doubleRenderer always renders itself as attribute-shaped text (name="value"), which is only ever correct when the enclosing field name starts with "_" (a genuine XML attribute); for an ordinary child element like this one, it has to go through the same single-field-wrapper machinery as those others.

Value parameters

$: the refresh interval, in seconds.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

RefreshMode which has values "onChange" , "onInterval" or "onExpire". Used by Link, Icon.

Value parameters

$: the mode of Refresh

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the RefreshMode case class. Provides extractors and renderers for handling RefreshMode instances.

Contains implicit values for:

Extracting a RefreshMode instance.
Extracting an optional RefreshMode instance.
Rendering a RefreshMode instance.
Rendering an optional RefreshMode instance.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: RefreshMode.type

Enumeration representing a time-based refresh mode.

The available refreshMode in this enumeration are:

onChange: refresh when the file is loaded and whenever the Link parameters change (the default).
onInterval: refresh every n seconds (specified in refreshInterval)
onExpire: refresh the file when the expiration time is reached.

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of RefreshModeEnum.
renderer: Provides a Renderer instance for rendering values of RefreshModeEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: RefreshModeEnum.type

Companion object for the RefreshVisibility case class. TESTME

This object provides implicits and utilities for serializing and deserializing RefreshVisibility instances. It extends traits Extractors and Renderers to support extraction and rendering functionalities.

Implicit extractors and renderers are provided for both RefreshVisibility and Option[RefreshVisibility], enabling their usage in data processing pipelines that require standardized extraction or rendering logic.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: RefreshVisibility.type

A case class representing RefreshVisibility in KML documents.

This case class encapsulates a Boolean value that signifies RefreshVisibility attributes in KML data. RefreshVisibility settings often dictate when the NetworkLink is refreshed, whether a specific KML element should be displayed in a viewer.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ResourceMap case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ResourceMap.type

Case class ResourceMap: sub-element of Model, mapping each texture reference used within the COLLADA file to where that resource actually is within this KML/KMZ package. See Model

Value parameters

Alias: a sequence of source-to-target reference mappings: Seq[Alias].

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

The Roll object provides utility methods and implicits for working with roll angles.

This object extends both Extractors and Renderers and provides functionality for extracting and rendering Roll instances. It contains implicit values to facilitate these operations, allowing seamless transformations between Roll objects and other representations.

Implicit Values:

extractor: An implicit Extractor[Roll] instance for extracting roll values.
renderer: An implicit Renderer[Roll] instance for rendering roll values.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Roll.type

Represents the roll angle in degrees or radians, depending on the specific context of usage.

The Roll class is a wrapper for a Double value that signifies the roll angle. Instances of this class can be used in contexts that involve angle measurements, transformations, or calculations.

Value parameters

$: the numeric value of the roll angle in degrees or radians.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Case class representing a rotation (an angle180).

Value parameters

$: the rotation value in degrees as a Double.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object representing Rotation functionalities, such as rendering and extraction. Of type angle180.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Rotation.type

Represent Point relative to the screen about which the screen overlay is rotated.

Value parameters

_x: the X value, according to the units specified in _xunits.
_xunits: Units in which the x value is specified. A value of "fraction" indicates the x value is a fraction of the image. A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates the indent from the right edge of the image.
_y: the Y value, according to the units specified in _yunits.
_yunits: Units in which the y value is specified. A value of "fraction" indicates the y value is a fraction of the image. A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates the indent from the top edge of the image.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object RotationXY provides implicit extractor and renderer instances for the RotationXY case class.

RotationXY represents a point relative to the screen about which the screen overlay is rotated. The extractor and renderer facilitate the serialization and deserialization of the RotationXY data type.

The extractor is implemented as an Extractor[RotationXY], which handles the deserialization of the RotationXY case class from a structured source.

The renderer is implemented as a Renderer[RotationXY], which manages the serialization of the RotationXY case class for output.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: RotationXY.type

Scale element: subelement of Object in the Kml reference. Case class to represent a Scale which is represented in XML as, for example: 1.1 See Scale

Value parameters

$: the value of the scale (a Double).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait KmlObject

class Object

trait Matchable

class Any
Show all

Companion object for the Scale case class. Provides extractors, renderers, and utility methods to facilitate the creation and manipulation of Scale objects in the Kml context.

The Scale object is used to define the scale factor for the Kml representation. It manages both serialization and deserialization processes between KmlData and Scale instances using provided extractors and renderers.

Functionality includes:

Extractors to derive Scale objects from KmlData.
Renderers for transforming Scale instances into their Kml representations.
Utility factory methods for creating Scale objects.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Scale.type

Case class SchemaData: sub-element of ExtendedData, providing typed name/value pairs whose types are defined by a Schema element elsewhere in the document (that Schema definition itself is not modeled here). See SchemaData

Value parameters

SimpleData: a sequence of typed name/value pairs: Seq[SimpleData].
_schemaUrl: a reference to the Schema which defines this SchemaData's fields (an XML attribute).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the SchemaData case class, providing extractors and renderers for SchemaData instances and sequences thereof.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: SchemaData.type

Represents a screen overlay, which combines graphical data with specific positional and rotation details. See ScreenOverlay

Value parameters

maybeRotation: an optional Rotation
overlayData: The data associated with the overlay, encapsulated in the OverlayData instance.
overlayXY: an OverlayXY
rotationXY: a RotationXY
screenXY: a ScreenXY
size: a Size

Attributes

Constructor: Constructs a ScreenOverlay instance.
Companion: object
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

Companion object for the ScreenOverlay class providing utilities for extraction and rendering of ScreenOverlay objects.

The companion object includes:

A partial extractor for OverlayData to ScreenOverlay.
An implicit extractor to parse ScreenOverlay instances.
An implicit renderer to render ScreenOverlay instances.
An implicit renderer for sequences of ScreenOverlay instances.

These utilities facilitate operations like deserialization, serialization, and transformation of ScreenOverlay objects, and are intended to support working with structured representations of screen overlays.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: ScreenOverlay.type

Represent Specifies a point relative to the screen origin that the overlay image is mapped to. used by ScreenOverlay.

Value parameters

_x: Either the number of pixels, a fractional component of the screen, or a pixel inset indicating the x component of a point on the screen.
_xunits: Units in which the x value is specified. A value of "fraction" indicates the x value is a fraction of the screen. A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates the indent from the right edge of the screen.
_y: Either the number of pixels, a fractional component of the screen, or a pixel inset indicating the y component of a point on the screen.
_yunits: Units in which the y value is specified. A value of "fraction" indicates the y value is a fraction of the screen. A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates the indent from the top edge of the screen.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ScreenXY case class that provides implicit extractors and renderers for the ScreenXY type.

This object includes:

An implicit Extractor instance for parsing or extracting ScreenXY objects.
An implicit Renderer instance for rendering ScreenXY objects into a specific format.

It simplifies the process of transforming ScreenXY to and from other representations.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ScreenXY.type

Companion object for the Shape case class.

This object provides integration with the Extractors and Renderers frameworks by defining the necessary implicit instances for Extractor and Renderer specific to the Shape type.

The extractor is an implicit instance of Extractor[Shape], enabling the automatic extraction of Shape instances.
The renderer is an implicit instance of Renderer[Shape], enabling the customized rendering of Shape instances.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Shape.type

Represents a shape based on the ShapeEnum.Value enumeration.

This case class encapsulates a single shape value, which can represent predefined shapes such as rectangle, cylinder, or sphere. The shape parameter is of type Shapes.Value, which is a value from the Shapes enumeration.

CONSIDER renaming shape as $ (for consistency with other similar Kml objects).

This class integrates with the Extractors and Renderers frameworks to support:

Automatic extraction using an implicit Extractor[Shape].
Custom rendering of shape instances through an implicit Renderer[Shape].

The companion object for this class provides the necessary extractor and renderer implementations for seamless integration.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

An enumeration object representing a collection of shapes. ShapeEnum supports extraction and rendering functionalities.

ShapeEnum include:

rectangle
cylinder
sphere

This object provides implicit values for extraction and rendering:

extractor: Extracts instances of ShapeEnum.Value from a defined context.
renderer: Renders ShapeEnum.Value instances as their string representations.

The ShapeEnum.Value type is an alias for the Value type in this enumeration.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ShapeEnum.type

Companion object for the SimpleData case class, providing extractors and renderers for SimpleData instances and sequences thereof.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: SimpleData.type

Case class SimpleData: sub-element of SchemaData, a single typed name/value pair. See SimpleData

Value parameters

$: the value, as the text content of this element.
_name: the name of this SimpleData element, referencing a SimpleField of the corresponding Schema (an XML attribute).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents the dimensions of a given entity with units for both x and y components. A value of −1 indicates to use the native dimension A value of 0 indicates to maintain the aspect ratio A value of n sets the value of the dimension

Value parameters

_x: The measurement value along the x-axis.
_xunits: The units in which the x-axis measurement is expressed.
_y: The measurement value along the y-axis.
_yunits: The units in which the y-axis measurement is expressed.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Size case class. Provides implicit instances of Extractor and Renderer for the Size type. The Extractor allows parsing and extracting Size values from a data source. The Renderer facilitates rendering Size values into a specific output format.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Size.type

Provides utility functions and implicits for the State case class.

State is considered to potentially represent an enumerated type with values such as: open, closed, error, fetching0, fetching1, or fetching2.

This object extends Extractors and Renderers to leverage reusable components for deserialization (extractors) and serialization (renderers).

Implicit components include:

An extractor for deserializing a State.
A renderer for serializing a State.
A renderer for serializing an optional State.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: State.type

State CONSIDER this should be an enumerated type with values: open, closed, error, fetching0, fetching1, or fetching2

Value parameters

$: the value.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Style object that provides utilities for extracting and rendering Style objects. This object extends functionality provided by Extractors and Renderers.

Extraction and rendering are achieved using partial extractors and renderers that align with the handling of StyleSelectorData and Style instances.

Members:

extractorPartial: Defines a partial extractor for mapping StyleSelectorData to Style.
extractor: An implicit full extractor for Style built from extractorPartial.
renderer: An implicit full renderer for Style that uses its styleSelectorData.
rendererSeq: An implicit renderer to handle sequences of Style objects.

Attributes

Companion: class
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: Style.type

Case class Style which extends StyleSelector. See Style

It seems there are two completely different types of Style element, but they are not distinguished. Type A has IconStyle, LabelStyle, BalloonStyle; Type B has LineStyle.

Value parameters

Styles: a set of different types of Style. CONSIDER constraining this set to be distinct.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait StyleSelector

trait KmlObject

class Object

trait Matchable

class Any
Show all

The StyleMap object provides utility methods and implicit definitions for working with the StyleMap class. It includes extractors and renderers that facilitate parsing and formatting StyleMap instances.

Features:

Partial and full extractors for converting between StyleSelectorData and StyleMap.
Implicit renderers for serializing StyleMap instances and sequences of StyleMap objects.

Attributes

Companion: class
Supertypes: trait Extractors

class Object

trait Matchable

class Any
Self type: StyleMap.type

Case class StyleMap represents a KML StyleMap element, which acts as a mapping of key-value pairs, where keys ('normal' or 'highlight') are mapped to specific styles using style URLs. See StyleMap

StyleMap is a subtype of StyleSelector, and it extends its functionality by providing a mechanism to dynamically switch between styles based on the user interaction.

Value parameters

Pairs: a sequence of key-value pairs, where each key is an instance of Key (e.g., "normal", "highlight") and each value is an instance of StyleURL pointing to the respective style.
styleSelectorData: an instance of StyleSelectorData that associates this StyleMap with additional KML metadata.

Attributes

Constructor: Creates an instance of StyleMap with the given sequence of Pairs and a StyleSelectorData instance.
Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait StyleSelector

trait KmlObject

class Object

trait Matchable

class Any
Show all

Trait StyleSelector is a sub-trait of KmlObject. It is extended by Style and StyleMap. See StyleSelector

Attributes

Companion: object
Supertypes: trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: class Style

class StyleMap

Companion object of StyleSelector that provides extractors and renderers for the StyleSelector trait and its subtypes.

The StyleSelector trait is a sub-trait of KmlObject and is extended by Style and StyleMap. This object includes implicit definitions for extraction and rendering of StyleSelector instances and sequences of StyleSelector instances. These operations are used to transform KML StyleSelector elements into their corresponding internal representations and vice versa.

Included Implicit Definitions:

extractorSeq: Extractor for sequences of StyleSelector instances. Combines multiple elements, such as StyleMap and Style, into a sequence.
renderer: Renderer for an individual StyleSelector instance. Transforms a single StyleSelectorinto a renderable form.
rendererSeq: Renderer for sequences of StyleSelector instances. Transforms a list of StyleSelector into a renderable form.

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: StyleSelector.type

Case class StyleSelectorData: properties of StyleSelector and its subclasses. There are no properties specific to StyleSelector. See StyleSelector

Value parameters

kmlData: the KmlData reference.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Object StyleSelectorData.

A companion object for the StyleSelectorData case class, providing methods and implicits for extracting and rendering StyleSelectorData instances. It extends the Extractors and Renderers traits to leverage their functionality for data extraction and rendering operations.

This object includes:

An Extractor for converting KmlData into StyleSelectorData.
A Renderer for rendering StyleSelectorData into its corresponding output representation.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: StyleSelectorData.type

Enumeration representing two different Styles of StyleMap.

The available StyleState in this enumeration are:

normal: a normal styles version for a placemark
highlight: the highlighted version appears when the user mouses over the icon in Google Earth.

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of StyleStateEnum.
renderer: Provides a Renderer instance for rendering values of StyleStateEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: StyleStateEnum.type

Companion object for the StyleURL class, providing extractors and renderers for StyleURL instances.

This object extends the Extractors and Renderers traits, enabling the extraction and rendering of StyleURL objects in the context of data transformation and representation.

Implicit members:

extractor: Provides functionality for extracting StyleURL instances using the extractor10 method.
renderer: Provides functionality for rendering StyleURL instances using the renderer1 method.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: StyleURL.type

A case class representing a style URL in the KML document context.

This class encapsulates a java.net.URI (Issue #44: not a bare CharSequence) that serves as the identifier or reference to a style within a KML structure - typically a fragment-only reference such as "#some-style", hence URI rather than the stricter URL.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Trait SubStyle which, according to the KML reference extends Object and is extended by ColorStyle, BalloonStyle and ListStyle. Reality seems otherwise, however. See KML

Attributes

Companion: object
Supertypes: trait KmlObject

class Object

trait Matchable

class Any
Known subtypes: trait ColorStyle

class BalloonStyle

class IconStyle

class LabelStyle

class LineStyle

class ListStyle

class PolyStyle
Show all

Companion object for the SubStyle trait, providing utilities for extracting and rendering instances of SubStyle and sequences of SubStyle.

This object includes implicit values for extractors and renderers, which support:

Extracting SubStyle and its subtypes using a MultiExtractor.
Rendering instances of SubStyle and sequences of SubStyle using Renderer.

The extractors and renderers are specifically tailored for the properties and subtypes of SubStyle, such as BalloonStyle, ListStyle, PolyStyle, LineStyle, IconStyle, and LabelStyle.

Note: Consider invoking ColorStyle when utilizing this object.

Attributes

Companion: trait
Supertypes: trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Self type: SubStyle.type

Represents a substyle data container, which encapsulates KML (Keyhole Markup Language) data. This class wraps an instance of KmlData, allowing additional processing or organization of KML metadata.

Value parameters

kmlData: an instance of KmlData containing metadata for the substyle.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the SubStyleData case class.

Provides functionality for extracting and rendering SubStyleData instances. Includes various utilities to work with SubStyleData in the context of KML processing, such as extractors and renderers for the structured data representation.

The object is built upon the Extractors and Renderers traits, which allow for functional composition while interacting with KmlData. It defines an implicit extractor for parsing SubStyleData, and an implicit renderer for converting SubStyleData back into a format suitable for output or transmission.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: SubStyleData.type

Object Tessellate provides extractors and renderers for instances of the Tessellate case class.

This object contains implicit definitions for converting Tessellate instances to and from various representations using Extractor and Renderer utilities. It facilitates parsing and generation of Tessellate representations in a structured manner.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Tessellate.type

Tessellate represents a case class with a Boolean value, extending the Mergeable trait.

Instances of Tessellate can be merged using the merge method, provided the internal Boolean state is compatible. The merge operation will return a new Tessellate instance encapsulated in an Option if the merge criteria are satisfied, otherwise it returns None.

CONSIDER making this part of GeometryData.

Value parameters

$: a Boolean value encapsulated by the Tessellate instance.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Mergeable[Tessellate]

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any

The TextColor object provides extractor and renderer capabilities for the TextColor case class. It enables parsing, rendering, and optional handling of TextColor instances.

This object includes the following:

An implicit extractor for parsing TextColor instances.
An implicit extractor for optional TextColor instances.
An implicit renderer for rendering TextColor instances.
An implicit renderer for rendering optional TextColor instances.

TextColor is used to represent color information, often in contexts related to BalloonStyle.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: TextColor.type

TextColor Used by BalloonStyle.

Value parameters

$: a hexadecimal string that defines the color of Text.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Represents a tilt with a single numeric value.

This case class is utilized to model the notion of tilt in a KML or similar domain representation. It includes a single parameter $ which stores the tilt value. The class is utilized along with its companion object that provides implicit extractors and renderers for serialization and deserialization purposes.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Tilt case class.

Provides implicit extractors and renderers for the Tilt type, allowing for convenient serialization and deserialization of Tilt instances. This includes support for optional Tilt values. The extractors and renderers are defined in terms of the base traits and utilities provided, ensuring seamless integration with parsing and rendering pipelines.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Tilt.type

Enumeration representing various units that can be used.

The available units in this enumeration are:

fraction: Represents fractional units
pixels: Represents pixel-based units
insetPixels: Represents pixel units used for insets

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of UnitsEnum.
renderer: Provides a Renderer instance for rendering values of UnitsEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UnitsEnum.type

Companion object for the ViewBoundScale case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ViewBoundScale.type

ViewBoundScale represents a scale factor to apply to the current view bounding box, used by Link when constructing the BBOX parameters of viewFormat. See Link

NOTE: see the comment on RefreshInterval for why this is wrapped rather than a bare Double.

Value parameters

$: the scale factor (1 leaves the bounding box unchanged).

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

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

The available ViewRefreshEnum in this enumeration are:

never: (default) Ignore changes in the view.
onRequest: Refresh the file only when the user explicitly requests it.
onStop: Refresh the file n seconds after movement stops.
onRegion: Refresh the file when the Region becomes active.

This object extends the capabilities of Enumeration to include Extractors and Renderers.

Implicit members:

extractor: Provides an Extractor instance for extracting values of ViewRefreshEnum.
renderer: Provides a Renderer instance for rendering values of ViewRefreshEnum.

Attributes

Supertypes: trait Renderers

trait Extractors

class Enumeration

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ViewRefreshEnum.type

Companion object for the ViewRefreshMode case class. Provides extractors and renderers for handling ViewRefreshMode instances.

Contains implicit values for:

Extracting a ViewRefreshMode instance.
Extracting an optional ViewRefreshMode instance.
Rendering a ViewRefreshMode instance.
Rendering an optional ViewRefreshMode instance.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ViewRefreshMode.type

ViewRefreshMode which has values "never" , "onStop", "onRequest" or "onRegion". Used by Link, Icon.

Value parameters

$: the mode of View Refresh

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

ViewRefreshTime represents the number of seconds to wait after the view stops moving before refreshing a Link's view-dependent content. See Link

NOTE: see the comment on RefreshInterval for why this is wrapped rather than a bare Double.

Value parameters

$: the wait time, in seconds.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the ViewRefreshTime case class, providing extractors and renderers.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ViewRefreshTime.type

Companion object for the ViewVolume case class. Provides implicit instances for Extractor and Renderer typeclasses to facilitate

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: ViewVolume.type

Represent how much of the current scene is visible. Specifying the field of view is analogous to specifying the lens opening in a physical camera. A small field of view, like a telephoto lens, focuses on a small part of the scene. A large field of view, like a wide-angle lens, focuses on a large part of the scene. Used by PhotoOverlay.

Value parameters

bottomFov: Angle, in degrees, between the camera's viewing direction and the bottom side of the view volume.
leftFov: Angle, in degrees, between the camera's viewing direction and the left side of the view volume.
near: Measurement in meters along the viewing direction from the camera viewpoint to the PhotoOverlay shape.
rightFov: Angle, in degrees, between the camera's viewing direction and the right side of the view volume.
topFov: Angle, in degrees, between the camera's viewing direction and the top side of the view volume.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A case class representing visibility in KML documents.

This case class encapsulates a Boolean value that signifies visibility attributes in KML data. Visibility settings often dictate whether a specific KML element should be displayed in a viewer.

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Companion object for the Visibility case class.

This object provides implicits and utilities for serializing and deserializing Visibility instances. It extends traits Extractors and Renderers to support extraction and rendering functionalities.

Implicit extractors and renderers are provided for both Visibility and Option[Visibility], enabling their usage in data processing pipelines that require standardized extraction or rendering logic.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Visibility.type

The Width object provides essential functionality for extracting and rendering Width case class instances.

This object includes implicit definitions for extractors and renderers, enabling seamless operations like parsing and formatting Width instances.

It extends both Extractors and Renderers traits, leveraging their functionality to define utilities for the Width type.

Implicit extractors allow extracting Width instances or optional Width instances from data sources. Implicit renderers enable creating representations of Width instances or optional Width instances in a particular format.

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

trait Renderers

trait Extractors

class Object

trait Matchable

class Any
Show all
Self type: Width.type

A case class representing the width of an object.

Value parameters

$: the width value as a Double

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

com.phasmidsoftware.xmldoc.kml

Members list

Type members

Classlikes

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes