de.micromata.opengis.kml.v_2_2_0
Class ImagePyramid

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.ImagePyramid
All Implemented Interfaces:
java.lang.Cloneable

public class ImagePyramid
extends AbstractObject
implements java.lang.Cloneable

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.


Field Summary
protected  GridOrigin gridOrigin
          GridOrigin
protected  java.util.List<AbstractObject> imagePyramidObjectExtension
          
protected  java.util.List<java.lang.Object> imagePyramidSimpleExtension
           
protected  int maxHeight
          
protected  int maxWidth
          
protected  int tileSize
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
ImagePyramid()
           
 
Method Summary
 ImagePyramid addToImagePyramidObjectExtension(AbstractObject imagePyramidObjectExtension)
          add a value to the imagePyramidObjectExtension property collection
 ImagePyramid addToImagePyramidSimpleExtension(java.lang.Object imagePyramidSimpleExtension)
          add a value to the imagePyramidSimpleExtension property collection
 ImagePyramid addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 ImagePyramid clone()
           
 boolean equals(java.lang.Object obj)
           
 GridOrigin getGridOrigin()
           
 java.util.List<AbstractObject> getImagePyramidObjectExtension()
           
 java.util.List<java.lang.Object> getImagePyramidSimpleExtension()
           
 int getMaxHeight()
           
 int getMaxWidth()
           
 int getTileSize()
           
 int hashCode()
           
 void setGridOrigin(GridOrigin value)
           
 void setImagePyramidObjectExtension(java.util.List<AbstractObject> imagePyramidObjectExtension)
           
 void setImagePyramidSimpleExtension(java.util.List<java.lang.Object> imagePyramidSimpleExtension)
           
 void setMaxHeight(int value)
           
 void setMaxWidth(int value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setTileSize(int value)
           
 ImagePyramid withGridOrigin(GridOrigin gridOrigin)
          fluent setter
 ImagePyramid withId(java.lang.String id)
          fluent setter
 ImagePyramid withImagePyramidObjectExtension(java.util.List<AbstractObject> imagePyramidObjectExtension)
          fluent setter
 ImagePyramid withImagePyramidSimpleExtension(java.util.List<java.lang.Object> imagePyramidSimpleExtension)
          fluent setter
 ImagePyramid withMaxHeight(int maxHeight)
          fluent setter
 ImagePyramid withMaxWidth(int maxWidth)
          fluent setter
 ImagePyramid withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 ImagePyramid withTargetId(java.lang.String targetId)
          fluent setter
 ImagePyramid withTileSize(int tileSize)
          fluent setter
 
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

tileSize

protected int tileSize

Size of the tiles, in pixels. Tiles must be square, and must be a power of 2. A tile size of 256 (the default) or 512 is recommended. The original image is divided into tiles of this size, at varying resolutions.


maxWidth

protected int maxWidth

Width in pixels of the original image.


maxHeight

protected int maxHeight

Height in pixels of the original image.


gridOrigin

protected GridOrigin gridOrigin
GridOrigin

lowerLeft, upperLeft

See Also: See


imagePyramidSimpleExtension

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

imagePyramidObjectExtension

protected java.util.List<AbstractObject> imagePyramidObjectExtension

This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.

Syntax:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

ImagePyramid

public ImagePyramid()
Method Detail

getTileSize

public int getTileSize()
Returns:
possible object is Integer
See Also:
tileSize

setTileSize

public void setTileSize(int value)
Parameters:
value - allowed object is Integer
See Also:
tileSize

getMaxWidth

public int getMaxWidth()
Returns:
possible object is Integer
See Also:
maxWidth

setMaxWidth

public void setMaxWidth(int value)
Parameters:
value - allowed object is Integer
See Also:
maxWidth

getMaxHeight

public int getMaxHeight()
Returns:
possible object is Integer
See Also:
maxHeight

setMaxHeight

public void setMaxHeight(int value)
Parameters:
value - allowed object is Integer
See Also:
maxHeight

getGridOrigin

public GridOrigin getGridOrigin()
Returns:
possible object is GridOrigin
See Also:
gridOrigin

setGridOrigin

public void setGridOrigin(GridOrigin value)
Parameters:
value - allowed object is GridOrigin
See Also:
gridOrigin

getImagePyramidSimpleExtension

public java.util.List<java.lang.Object> getImagePyramidSimpleExtension()
See Also:
imagePyramidSimpleExtension

getImagePyramidObjectExtension

public java.util.List<AbstractObject> getImagePyramidObjectExtension()
See Also:
imagePyramidObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class AbstractObject

setImagePyramidSimpleExtension

public void setImagePyramidSimpleExtension(java.util.List<java.lang.Object> imagePyramidSimpleExtension)
Parameters:
imagePyramidSimpleExtension -
See Also:
imagePyramidSimpleExtension

addToImagePyramidSimpleExtension

public ImagePyramid addToImagePyramidSimpleExtension(java.lang.Object imagePyramidSimpleExtension)
add a value to the imagePyramidSimpleExtension property collection

Parameters:
imagePyramidSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setImagePyramidObjectExtension

public void setImagePyramidObjectExtension(java.util.List<AbstractObject> imagePyramidObjectExtension)
Parameters:
imagePyramidObjectExtension -
See Also:
imagePyramidObjectExtension

addToImagePyramidObjectExtension

public ImagePyramid addToImagePyramidObjectExtension(AbstractObject imagePyramidObjectExtension)
add a value to the imagePyramidObjectExtension property collection

Parameters:
imagePyramidObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class AbstractObject
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public ImagePyramid addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class AbstractObject
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

withTileSize

public ImagePyramid withTileSize(int tileSize)
fluent setter

Parameters:
tileSize - required parameter
See Also:
setTileSize(int)

withMaxWidth

public ImagePyramid withMaxWidth(int maxWidth)
fluent setter

Parameters:
maxWidth - required parameter
See Also:
setMaxWidth(int)

withMaxHeight

public ImagePyramid withMaxHeight(int maxHeight)
fluent setter

Parameters:
maxHeight - required parameter
See Also:
setMaxHeight(int)

withGridOrigin

public ImagePyramid withGridOrigin(GridOrigin gridOrigin)
fluent setter

Parameters:
gridOrigin - required parameter
See Also:
setGridOrigin(GridOrigin)

withImagePyramidSimpleExtension

public ImagePyramid withImagePyramidSimpleExtension(java.util.List<java.lang.Object> imagePyramidSimpleExtension)
fluent setter

Parameters:
imagePyramidSimpleExtension - required parameter
See Also:
#setImagePyramidSimpleExtension(List)

withImagePyramidObjectExtension

public ImagePyramid withImagePyramidObjectExtension(java.util.List<AbstractObject> imagePyramidObjectExtension)
fluent setter

Parameters:
imagePyramidObjectExtension - required parameter
See Also:
#setImagePyramidObjectExtension(List)

withObjectSimpleExtension

public ImagePyramid withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class AbstractObject
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public ImagePyramid withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class AbstractObject
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public ImagePyramid withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class AbstractObject
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

clone

public ImagePyramid clone()
Overrides:
clone in class AbstractObject