Class

com.scalakml.kml

PhotoOverlay

Related Doc: package kml

Permalink

case class PhotoOverlay(rotation: Option[Double] = None, viewVolume: Option[ViewVolume] = None, imagePyramid: Option[ImagePyramid] = None, point: Option[Point] = None, shape: Option[Shape] = None, featurePart: FeaturePart = new FeaturePart(), color: Option[HexColor] = None, drawOrder: Option[Int] = None, icon: Option[Icon] = None, id: Option[String] = None, targetId: Option[String] = None, photoOverlaySimpleExtensionGroup: Seq[Any] = Nil, photoOverlayObjectExtensionGroup: Seq[Any] = Nil, overlaySimpleExtensionGroup: Seq[Any] = Nil, overlayObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil) extends Overlay with Product with Serializable

The <PhotoOverlay> element allows you to geographically locate a photograph on the Earth and to specify viewing parameters for this PhotoOverlay. The PhotoOverlay can be a simple 2D rectangle, a partial or full cylinder, or a sphere (for spherical panoramas). The overlay is placed at the specified location and oriented toward the viewpoint. Because <PhotoOverlay> is derived from <Feature>, it can contain one of the two elements derived from <AbstractView>—either <Camera> or <LookAt>. The Camera (or LookAt) specifies a viewpoint and a viewing direction (also referred to as a view vector). The PhotoOverlay is positioned in relation to the viewpoint. Specifically, the plane of a 2D rectangular image is orthogonal (at right angles to) the view vector. The normal of this plane—that is, its front, which is the part with the photo—is oriented toward the viewpoint.

The URL for the PhotoOverlay image is specified in the <Icon> tag, which is inherited from <Overlay>. The <Icon> tag must contain an <href> element that specifies the image file to use for the PhotoOverlay. In the case of a very large image, the <href> is a special URL that indexes into a pyramid of images of varying resolutions (see ImagePyramid).

For more information, see the "Topics in KML" page on PhotoOverlay.

rotation

Adjusts how the photo is placed inside the field of view. This element is useful if your photo has been rotated and deviates slightly from a desired horizontal view.

viewVolume

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

imagePyramid

For very large images, you'll need to construct an image pyramid, which is a hierarchical set of images, each of which is an increasingly lower resolution version of the original image. Each image in the pyramid is subdivided into tiles, so that only the portions in view need to be loaded. Google Earth calculates the current viewpoint and loads the tiles that are appropriate to the user's distance from the image. As the viewpoint moves closer to the PhotoOverlay, Google Earth loads higher resolution tiles. Since all the pixels in the original image can't be viewed on the screen at once, this preprocessing allows Google Earth to achieve maximum performance because it loads only the portions of the image that are in view, and only the pixel details that can be discerned by the user at the current viewpoint. When you specify an image pyramid, you also modify the <href> in the <Icon> element to include specifications for which tiles to load.

point

The <Point> element acts as a <Point> inside a <Placemark> element. It draws an icon to mark the position of the PhotoOverlay. The icon drawn is specified by the <styleUrl> and <StyleSelector> fields, just as it is for <Placemark>.

shape

The PhotoOverlay is projected onto the <shape>. The <shape> 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

Linear Supertypes
Serializable, Serializable, Product, Equals, Overlay, Feature, KmlObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PhotoOverlay
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Overlay
  7. Feature
  8. KmlObject
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PhotoOverlay(name: String, rotation: Double, viewVolume: ViewVolume, imagePyramid: ImagePyramid, point: Point, shape: Shape)

    Permalink
  2. new PhotoOverlay(rotation: Double, viewVolume: ViewVolume, imagePyramid: ImagePyramid, point: Point, shape: Shape)

    Permalink
  3. new PhotoOverlay(rotation: Option[Double] = None, viewVolume: Option[ViewVolume] = None, imagePyramid: Option[ImagePyramid] = None, point: Option[Point] = None, shape: Option[Shape] = None, featurePart: FeaturePart = new FeaturePart(), color: Option[HexColor] = None, drawOrder: Option[Int] = None, icon: Option[Icon] = None, id: Option[String] = None, targetId: Option[String] = None, photoOverlaySimpleExtensionGroup: Seq[Any] = Nil, photoOverlayObjectExtensionGroup: Seq[Any] = Nil, overlaySimpleExtensionGroup: Seq[Any] = Nil, overlayObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil)

    Permalink

    rotation

    Adjusts how the photo is placed inside the field of view. This element is useful if your photo has been rotated and deviates slightly from a desired horizontal view.

    viewVolume

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

    imagePyramid

    For very large images, you'll need to construct an image pyramid, which is a hierarchical set of images, each of which is an increasingly lower resolution version of the original image. Each image in the pyramid is subdivided into tiles, so that only the portions in view need to be loaded. Google Earth calculates the current viewpoint and loads the tiles that are appropriate to the user's distance from the image. As the viewpoint moves closer to the PhotoOverlay, Google Earth loads higher resolution tiles. Since all the pixels in the original image can't be viewed on the screen at once, this preprocessing allows Google Earth to achieve maximum performance because it loads only the portions of the image that are in view, and only the pixel details that can be discerned by the user at the current viewpoint. When you specify an image pyramid, you also modify the <href> in the <Icon> element to include specifications for which tiles to load.

    point

    The <Point> element acts as a <Point> inside a <Placemark> element. It draws an icon to mark the position of the PhotoOverlay. The icon drawn is specified by the <styleUrl> and <StyleSelector> fields, just as it is for <Placemark>.

    shape

    The PhotoOverlay is projected onto the <shape>. The <shape> 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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val color: Option[HexColor]

    Permalink
    Definition Classes
    PhotoOverlayOverlay
  7. val drawOrder: Option[Int]

    Permalink
    Definition Classes
    PhotoOverlayOverlay
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. val featurePart: FeaturePart

    Permalink

    featurePart the feature part of this object

    featurePart the feature part of this object

    Definition Classes
    PhotoOverlayOverlayFeature
    See also

    FeaturePart

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. val icon: Option[Icon]

    Permalink
    Definition Classes
    PhotoOverlayOverlay
  13. val id: Option[String]

    Permalink

    a unique identification of this KML element

    a unique identification of this KML element

    Definition Classes
    PhotoOverlayFeatureKmlObject
  14. val imagePyramid: Option[ImagePyramid]

    Permalink

    For very large images, you'll need to construct an image pyramid, which is a hierarchical set of images, each of which is an increasingly lower resolution version of the original image.

    For very large images, you'll need to construct an image pyramid, which is a hierarchical set of images, each of which is an increasingly lower resolution version of the original image. Each image in the pyramid is subdivided into tiles, so that only the portions in view need to be loaded. Google Earth calculates the current viewpoint and loads the tiles that are appropriate to the user's distance from the image. As the viewpoint moves closer to the PhotoOverlay, Google Earth loads higher resolution tiles. Since all the pixels in the original image can't be viewed on the screen at once, this preprocessing allows Google Earth to achieve maximum performance because it loads only the portions of the image that are in view, and only the pixel details that can be discerned by the user at the current viewpoint. When you specify an image pyramid, you also modify the <href> in the <Icon> element to include specifications for which tiles to load.

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val objectSimpleExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    PhotoOverlayFeatureKmlObject
  20. val overlayObjectExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    PhotoOverlayOverlay
  21. val overlaySimpleExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    PhotoOverlayOverlay
  22. val photoOverlayObjectExtensionGroup: Seq[Any]

    Permalink
  23. val photoOverlaySimpleExtensionGroup: Seq[Any]

    Permalink
  24. val point: Option[Point]

    Permalink

    The <Point> element acts as a <Point> inside a <Placemark> element.

    The <Point> element acts as a <Point> inside a <Placemark> element. It draws an icon to mark the position of the PhotoOverlay. The icon drawn is specified by the <styleUrl> and <StyleSelector> fields, just as it is for <Placemark>.

  25. val rotation: Option[Double]

    Permalink

    Adjusts how the photo is placed inside the field of view.

    Adjusts how the photo is placed inside the field of view. This element is useful if your photo has been rotated and deviates slightly from a desired horizontal view.

  26. val shape: Option[Shape]

    Permalink

    The PhotoOverlay is projected onto the <shape>.

    The PhotoOverlay is projected onto the <shape>. The <shape> 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

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. val targetId: Option[String]

    Permalink

    a reference to objects that have already been loaded into Google Earth

    a reference to objects that have already been loaded into Google Earth

    Definition Classes
    PhotoOverlayFeatureKmlObject
  29. val viewVolume: Option[ViewVolume]

    Permalink

    Defines how much of the current scene is visible.

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

  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Overlay

Inherited from Feature

Inherited from KmlObject

Inherited from AnyRef

Inherited from Any

Ungrouped