TLcdKML22ImagePyramid (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.format.kml22.model.TLcdKML22AbstractObject
  - - com.luciad.format.kml22.model.util.TLcdKML22ImagePyramid

All Implemented Interfaces:: ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdKML22ImagePyramid
extends TLcdKML22AbstractObject

Domain class modeling the KML ImagePyramidType type.

OGC KML Specification description:

 This element can be used wherever the following element is referenced: 
  
  -kml:AbstractObjectGroup
  
 Specifies a hierarchical set of images, each of which is an increasingly lower resolution 
 (towards the top of the pyramid). Each image in the pyramid is subdivided into tiles so only 
 the portions in view are loaded. 
 The pixel size of the original image is specified in the kml:maxWidth and kml:maxHeight 
 elements. The width and height can be any size and do not need to be a power of 2. You can 
 fill out the remaining pixels with blank pixels, as described in. 
 Tiles must be square, and the kml:tileSize must be a power of 2. A tile size of 256 (the 
 default) or 512 is recommended. 
 A kml:ImagePyramid element should have the kml:maxWidth and kml:maxHeight child 
 elements present, and, if supplied, the kml:tileSize should be a power of 2. 
 See also 11.4.3 Handling large images.

Since:: 10.0

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`GRID_ORIGIN_PROPERTY` Data property that maps to the `gridOrigin` element.
`static TLcdDataProperty`	`IMAGE_PYRAMID_OBJECT_EXTENSION_GROUP_PROPERTY` Data property that maps to the `ImagePyramidObjectExtensionGroup` element.
`static TLcdDataProperty`	`IMAGE_PYRAMID_SIMPLE_EXTENSION_GROUP_PROPERTY` Data property that maps to the `ImagePyramidSimpleExtensionGroup` element.
`static TLcdDataProperty`	`MAX_HEIGHT_PROPERTY` Data property that maps to the `maxHeight` element.
`static TLcdDataProperty`	`MAX_WIDTH_PROPERTY` Data property that maps to the `maxWidth` element.
`static TLcdDataProperty`	`TILE_SIZE_PROPERTY` Data property that maps to the `tileSize` element.

Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY

Constructor Summary

Constructors
Constructor and Description

TLcdKML22ImagePyramid()

TLcdKML22ImagePyramid(TLcdDataType aType)

Constructors
Constructor and Description
`TLcdKML22ImagePyramid()`
`TLcdKML22ImagePyramid(TLcdDataType aType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ELcdKML22GridOrigin`	`getGridOrigin()` Returns the value of the property that maps to the `gridOrigin` element.
`Integer`	`getMaxHeight()` Returns the value of the property that maps to the `maxHeight` element.
`Integer`	`getMaxWidth()` Returns the value of the property that maps to the `maxWidth` element.
`Integer`	`getTileSize()` Returns the value of the property that maps to the `tileSize` element.
`void`	`setGridOrigin(ELcdKML22GridOrigin aValue)` Sets the value of the property that maps to the `gridOrigin` element.
`void`	`setMaxHeight(Integer aValue)` Sets the value of the property that maps to the `maxHeight` element.
`void`	`setMaxWidth(Integer aValue)` Sets the value of the property that maps to the `maxWidth` element.
`void`	`setTileSize(Integer aValue)` Sets the value of the property that maps to the `tileSize` element.

Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject
getId, getTargetId, setId, setTargetId

Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TILE_SIZE_PROPERTY
```
public static final TLcdDataProperty TILE_SIZE_PROPERTY
```
    Data property that maps to the tileSize element. The possible values for this property are instances of Integer.
  - MAX_WIDTH_PROPERTY
```
public static final TLcdDataProperty MAX_WIDTH_PROPERTY
```
    Data property that maps to the maxWidth element. The possible values for this property are instances of Integer.
  - MAX_HEIGHT_PROPERTY
```
public static final TLcdDataProperty MAX_HEIGHT_PROPERTY
```
    Data property that maps to the maxHeight element. The possible values for this property are instances of Integer.
  - GRID_ORIGIN_PROPERTY
```
public static final TLcdDataProperty GRID_ORIGIN_PROPERTY
```
    Data property that maps to the gridOrigin element. The possible values for this property are instances of ELcdKML22GridOrigin.
  - IMAGE_PYRAMID_SIMPLE_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty IMAGE_PYRAMID_SIMPLE_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the ImagePyramidSimpleExtensionGroup element. The possible values for this property are instances of List<String>.
  - IMAGE_PYRAMID_OBJECT_EXTENSION_GROUP_PROPERTY
```
public static final TLcdDataProperty IMAGE_PYRAMID_OBJECT_EXTENSION_GROUP_PROPERTY
```
    Data property that maps to the ImagePyramidObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.
- Constructor Detail
  - TLcdKML22ImagePyramid
```
public TLcdKML22ImagePyramid()
```
  - TLcdKML22ImagePyramid
```
public TLcdKML22ImagePyramid(TLcdDataType aType)
```
- Method Detail
  - getTileSize
```
public Integer getTileSize()
```
    Returns the value of the property that maps to the tileSize element.
    
    Returns:
    
    the value of the TILE_SIZE_PROPERTY property.
  - setTileSize
```
public void setTileSize(Integer aValue)
```
    Sets the value of the property that maps to the tileSize element.
    
    Parameters:
    
    aValue - the value to set for the TILE_SIZE_PROPERTY property.
  - getMaxWidth
```
public Integer getMaxWidth()
```
    Returns the value of the property that maps to the maxWidth element.
    
    Returns:
    
    the value of the MAX_WIDTH_PROPERTY property.
  - setMaxWidth
```
public void setMaxWidth(Integer aValue)
```
    Sets the value of the property that maps to the maxWidth element.
    
    Parameters:
    
    aValue - the value to set for the MAX_WIDTH_PROPERTY property.
  - getMaxHeight
```
public Integer getMaxHeight()
```
    Returns the value of the property that maps to the maxHeight element.
    
    Returns:
    
    the value of the MAX_HEIGHT_PROPERTY property.
  - setMaxHeight
```
public void setMaxHeight(Integer aValue)
```
    Sets the value of the property that maps to the maxHeight element.
    
    Parameters:
    
    aValue - the value to set for the MAX_HEIGHT_PROPERTY property.
  - getGridOrigin
```
public ELcdKML22GridOrigin getGridOrigin()
```
    Returns the value of the property that maps to the gridOrigin element.
    
    Returns:
    
    the value of the GRID_ORIGIN_PROPERTY property.
  - setGridOrigin
```
public void setGridOrigin(ELcdKML22GridOrigin aValue)
```
    Sets the value of the property that maps to the gridOrigin element.
    
    Parameters:
    
    aValue - the value to set for the GRID_ORIGIN_PROPERTY property.

LuciadLightspeedClass TLcdKML22ImagePyramid

Field Summary

Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

Constructor Summary

Method Summary

Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

TILE_SIZE_PROPERTY

MAX_WIDTH_PROPERTY

MAX_HEIGHT_PROPERTY

GRID_ORIGIN_PROPERTY

IMAGE_PYRAMID_SIMPLE_EXTENSION_GROUP_PROPERTY

IMAGE_PYRAMID_OBJECT_EXTENSION_GROUP_PROPERTY

Constructor Detail

TLcdKML22ImagePyramid

TLcdKML22ImagePyramid

Method Detail

getTileSize

setTileSize

getMaxWidth

setMaxWidth

getMaxHeight

setMaxHeight

getGridOrigin

setGridOrigin