de.micromata.opengis.kml.v_2_2_0
Class PhotoOverlay

java.lang.Object
  de.micromata.opengis.kml.v_2_2_0.AbstractObject
      de.micromata.opengis.kml.v_2_2_0.Feature
          de.micromata.opengis.kml.v_2_2_0.Overlay
              de.micromata.opengis.kml.v_2_2_0.PhotoOverlay

All Implemented Interfaces:

java.lang.Cloneable

public class PhotoOverlay
extends Overlay
implements java.lang.Cloneable

Because is derived from , it can contain one of the two elements derived from —either or . 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.

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

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

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

Extends:

Field Summary

protected ImagePyramid	imagePyramid
protected java.util.List<AbstractObject>	photoOverlayObjectExtension
protected java.util.List<java.lang.Object>	photoOverlaySimpleExtension
protected Point	point
protected double	rotation
protected Shape	shape Shape
protected ViewVolume	viewVolume

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Overlay

color, drawOrder, icon, overlayObjectExtension, overlaySimpleExtension

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature

abstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetails

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

id, objectSimpleExtension, targetId

Constructor Summary

PhotoOverlay()

Method Summary

PhotoOverlay	addToFeatureObjectExtension(AbstractObject featureObjectExtension) add a value to the featureObjectExtension property collection
PhotoOverlay	addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension) add a value to the featureSimpleExtension property collection
PhotoOverlay	addToObjectSimpleExtension(java.lang.Object objectSimpleExtension) add a value to the objectSimpleExtension property collection
PhotoOverlay	addToOverlayObjectExtension(AbstractObject overlayObjectExtension) add a value to the overlayObjectExtension property collection
PhotoOverlay	addToOverlaySimpleExtension(java.lang.Object overlaySimpleExtension) add a value to the overlaySimpleExtension property collection
PhotoOverlay	addToPhotoOverlayObjectExtension(AbstractObject photoOverlayObjectExtension) add a value to the photoOverlayObjectExtension property collection
PhotoOverlay	addToPhotoOverlaySimpleExtension(java.lang.Object photoOverlaySimpleExtension) add a value to the photoOverlaySimpleExtension property collection
PhotoOverlay	addToStyleSelector(StyleSelector styleSelector) add a value to the styleSelector property collection
PhotoOverlay	clone()
ImagePyramid	createAndSetImagePyramid() Creates a new instance of ImagePyramid and set it to imagePyramid.
Point	createAndSetPoint() Creates a new instance of Point and set it to point.
ViewVolume	createAndSetViewVolume() Creates a new instance of ViewVolume and set it to viewVolume.
boolean	equals(java.lang.Object obj)
ImagePyramid	getImagePyramid()
java.util.List<AbstractObject>	getPhotoOverlayObjectExtension()
java.util.List<java.lang.Object>	getPhotoOverlaySimpleExtension()
Point	getPoint()
double	getRotation()
Shape	getShape()
ViewVolume	getViewVolume()
int	hashCode()
void	setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
void	setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
void	setImagePyramid(ImagePyramid value)
void	setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
void	setOverlayObjectExtension(java.util.List<AbstractObject> overlayObjectExtension)
void	setOverlaySimpleExtension(java.util.List<java.lang.Object> overlaySimpleExtension)
void	setPhotoOverlayObjectExtension(java.util.List<AbstractObject> photoOverlayObjectExtension)
void	setPhotoOverlaySimpleExtension(java.util.List<java.lang.Object> photoOverlaySimpleExtension)
void	setPoint(Point value)
void	setRotation(double value)
void	setShape(Shape value)
void	setStyleSelector(java.util.List<StyleSelector> styleSelector)
void	setViewVolume(ViewVolume value)
PhotoOverlay	withAbstractView(AbstractView abstractView) fluent setter
PhotoOverlay	withAddress(java.lang.String address) fluent setter
PhotoOverlay	withAtomAuthor(Author atomAuthor) fluent setter
PhotoOverlay	withAtomLink(Link atomLink) fluent setter
PhotoOverlay	withColor(java.lang.String color) fluent setter
PhotoOverlay	withDescription(java.lang.String description) fluent setter
PhotoOverlay	withDrawOrder(int drawOrder) fluent setter
PhotoOverlay	withExtendedData(ExtendedData extendedData) fluent setter
PhotoOverlay	withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension) fluent setter
PhotoOverlay	withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension) fluent setter
PhotoOverlay	withIcon(Icon icon) fluent setter
PhotoOverlay	withId(java.lang.String id) fluent setter
PhotoOverlay	withImagePyramid(ImagePyramid imagePyramid) fluent setter
PhotoOverlay	withMetadata(Metadata metadata) fluent setter
PhotoOverlay	withName(java.lang.String name) fluent setter
PhotoOverlay	withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension) fluent setter
PhotoOverlay	withOpen(java.lang.Boolean open) fluent setter
PhotoOverlay	withOverlayObjectExtension(java.util.List<AbstractObject> overlayObjectExtension) fluent setter
PhotoOverlay	withOverlaySimpleExtension(java.util.List<java.lang.Object> overlaySimpleExtension) fluent setter
PhotoOverlay	withPhoneNumber(java.lang.String phoneNumber) fluent setter
PhotoOverlay	withPhotoOverlayObjectExtension(java.util.List<AbstractObject> photoOverlayObjectExtension) fluent setter
PhotoOverlay	withPhotoOverlaySimpleExtension(java.util.List<java.lang.Object> photoOverlaySimpleExtension) fluent setter
PhotoOverlay	withPoint(Point point) fluent setter
PhotoOverlay	withRegion(Region region) fluent setter
PhotoOverlay	withRotation(double rotation) fluent setter
PhotoOverlay	withShape(Shape shape) fluent setter
PhotoOverlay	withSnippet(Snippet snippet) fluent setter
PhotoOverlay	withSnippetd(java.lang.String snippetd) fluent setter
PhotoOverlay	withStyleSelector(java.util.List<StyleSelector> styleSelector) fluent setter
PhotoOverlay	withStyleUrl(java.lang.String styleUrl) fluent setter
PhotoOverlay	withTargetId(java.lang.String targetId) fluent setter
PhotoOverlay	withTimePrimitive(TimePrimitive timePrimitive) fluent setter
PhotoOverlay	withViewVolume(ViewVolume viewVolume) fluent setter
PhotoOverlay	withVisibility(java.lang.Boolean visibility) fluent setter
PhotoOverlay	withXalAddressDetails(AddressDetails xalAddressDetails) fluent setter

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Overlay

createAndSetIcon, getColor, getDrawOrder, getIcon, getOverlayObjectExtension, getOverlaySimpleExtension, setColor, setDrawOrder, setIcon

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature

createAndAddStyle, createAndAddStyleMap, createAndSetAtomAuthor, createAndSetAtomLink, createAndSetCamera, createAndSetExtendedData, createAndSetLookAt, createAndSetMetadata, createAndSetRegion, createAndSetSnippet, createAndSetTimeSpan, createAndSetTimeStamp, createAndSetXalAddressDetails, getAbstractView, getAddress, getAtomAuthor, getAtomLink, getDescription, getExtendedData, getFeatureObjectExtension, getFeatureSimpleExtension, getMetadata, getName, getPhoneNumber, getRegion, getSnippet, getSnippetd, getStyleSelector, getStyleUrl, getTimePrimitive, getXalAddressDetails, isOpen, isVisibility, setAbstractView, setAddress, setAtomAuthor, setAtomLink, setDescription, setExtendedData, setMetadata, setName, setOpen, setPhoneNumber, setRegion, setSnippet, setSnippetd, setStyleUrl, setTimePrimitive, setVisibility, setXalAddressDetails

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

getId, getObjectSimpleExtension, getTargetId, setId, setTargetId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

rotation

protected double 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.

Indicates the angle of rotation of the parent object. A value of 0 means no rotation. The value is an angle in degrees counterclockwise starting from north. Use ±180 to indicate the rotation of the parent object from 0. The center of the , if not (.5,.5), is specified in .

viewVolume

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

protected ImagePyramid 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 in the element to include specifications for which tiles to load.

point

protected Point point

A geographic location defined by longitude, latitude, and (optional) altitude. When a Point is contained by a Placemark, the point itself determines the position of the Placemark's name and icon. When a Point is extruded, it is connected to the ground with a line. This "tether" uses the current LineStyle.

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

Syntax:

<Point id="ID">
   <!-- specific to Point -->
   <extrude>0</extrude>                        <!-- boolean -->
   <altitudeMode>clampToGround</altitudeMode>  
              <!-- kml:altitudeModeEnum: clampToGround, relativeToGround, or absolute -->
         <!-- or, substitute gx:altitudeMode: clampToSeaFloor, relativeToSeaFloor -->
   <coordinates>...</coordinates>              <!-- lon,lat[,alt] -->
 </Point>

Extends:

shape

protected Shape shape

Shape

rectangle, cylinder, sphere

See Also: See

photoOverlaySimpleExtension

protected java.util.List<java.lang.Object> photoOverlaySimpleExtension

photoOverlayObjectExtension

protected java.util.List<AbstractObject> photoOverlayObjectExtension