PhotoOverlay

com.phasmidsoftware.xmldoc.kml.PhotoOverlay
See thePhotoOverlay companion object
case class PhotoOverlay(rotation: Rotation, ViewVolume: ViewVolume, ImagePyramid: ImagePyramid, Point: Point, shape: Shape)(overlayData: OverlayData) extends BaseOverlay

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
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class BaseOverlay
trait HasName
trait Overlay
trait Feature
trait KmlObject
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def Icon: Icon

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

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

Attributes

Returns

An Icon representing the image associated with the Overlay.

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

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

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

Value parameters

e

the edit to apply.

fs

the siblings (which actually do include this itself).

Attributes

Returns

an optional Feature.

Inherited from:
Feature
def maybeColor: Option[Color]

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

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

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

Attributes

Returns

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

Inherited from:
BaseOverlay
def maybeDrawOrder: Option[DrawOrder]

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

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

Attributes

Returns

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

Inherited from:
BaseOverlay
def name: Text

Retrieves the name as a Text value.

Retrieves the name as a Text value.

Attributes

Returns

the name represented as a Text instance.

Inherited from:
BaseOverlay
def productElementNames: Iterator[String]

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

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

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product

Concrete fields