public class TLcdKML22PhotoOverlay extends TLcdKML22AbstractOverlay implements ILcdBounded
OGC KML Specification description:
This element can be used wherever the following element is referenced: -kml:AbstractOverlayGroup The kml:PhotoOverlay element is used to position a photograph relative to the camera viewpoint and also to define field-of-view parameters. The kml:PhotoOverlay may be rendered on one of three shapes (as determined by the value of kml:shape): a 2D planar rectangle, a cylinder (for a panoramic photo), or a sphere (for a spherical panorama). The the photo overlay faces toward the viewpoint and its center is placed at the head of the view vector. The view vector is defined as the vector based at the viewpoint and in the direction specified by the corresponding kml:AbstractView element. The length of the view vector is determined by the value of the kml:near element. The photo overlay is positioned such that the view vector points toward the photo and is orthogonal to the center of the image (see Figure 9). Figure 9: kml:PhotoOverlay View Vector The URL for the kml:PhotoOverlay image is specified in the kml:Icon tag, which is inherited from kml:AbstractOverlayGroup. The kml:Icon tag must contain a kml:href element that specifies the image resource to use for the kml:PhotoOverlay. A kml:PhotoOverlay element shall contain the kml:Icon, kml:ViewVolume, kml:Point, and kml:Camera child elements outside of an update context, that is when not a descendant of kml:Update.
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractFeatureObjectExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractFeatureSimpleExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractOverlayObjectExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
AbstractOverlaySimpleExtensionGroup element. |
static TLcdDataProperty |
ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
Data property that maps to the
AbstractStyleSelectorGroup element. |
static TLcdDataProperty |
ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
Data property that maps to the
AbstractTimePrimitiveGroup element. |
static TLcdDataProperty |
ABSTRACT_VIEW_GROUP_PROPERTY
Data property that maps to the
AbstractViewGroup element. |
static TLcdDataProperty |
ADDRESS_DETAILS_PROPERTY
Data property that maps to the
AddressDetails element. |
static TLcdDataProperty |
ADDRESS_PROPERTY
Data property that maps to the
address element. |
static TLcdDataProperty |
ATOM_LINK_PROPERTY
Data property that maps to the
link element. |
static TLcdDataProperty |
AUTHOR_PROPERTY
Data property that maps to the
author element. |
static TLcdDataProperty |
COLOR_PROPERTY
Data property that maps to the
color element. |
static TLcdDataProperty |
DESCRIPTION_PROPERTY
Data property that maps to the
description element. |
static TLcdDataProperty |
DRAW_ORDER_PROPERTY
Data property that maps to the
drawOrder element. |
static TLcdDataProperty |
EXTENDED_DATA_PROPERTY
Data property that maps to the choice between the
Metadata and ExtendedData elements. |
static TLcdDataProperty |
IMAGE_LINK_PROPERTY
Data property that maps to the
Icon element. |
static TLcdDataProperty |
IMAGE_PYRAMID_PROPERTY
Data property that maps to the
ImagePyramid element. |
static TLcdDataProperty |
NAME_PROPERTY
Data property that maps to the
name element. |
static TLcdDataProperty |
OPEN_PROPERTY
Data property that maps to the
open element. |
static TLcdDataProperty |
PHONE_NUMBER_PROPERTY
Data property that maps to the
phoneNumber element. |
static TLcdDataProperty |
PHOTO_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to the
PhotoOverlayObjectExtensionGroup element. |
static TLcdDataProperty |
PHOTO_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to the
PhotoOverlaySimpleExtensionGroup element. |
static TLcdDataProperty |
POINT_PROPERTY
Data property that maps to the
Point element. |
static TLcdDataProperty |
REGION_PROPERTY
Data property that maps to the
Region element. |
static TLcdDataProperty |
ROTATION_PROPERTY
Data property that maps to the
rotation element. |
static TLcdDataProperty |
SHAPE_PROPERTY
Data property that maps to the
shape element. |
static TLcdDataProperty |
SNIPPET_PROPERTY
Data property that maps to the choice between the
Snippet and snippet elements. |
static TLcdDataProperty |
STYLE_URL_PROPERTY
Data property that maps to the
styleUrl element. |
static TLcdDataProperty |
VIEW_VOLUME_PROPERTY
Data property that maps to the
ViewVolume element. |
static TLcdDataProperty |
VISIBILITY_PROPERTY
Data property that maps to the
visibility element. |
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_PROPERTY
Constructor and Description |
---|
TLcdKML22PhotoOverlay(TLcdDataType aType)
Creates a new
TLcdKML22PhotoOverlay with a custom TLcdDataType . |
Modifier and Type | Method and Description |
---|---|
List<TLcdKML22AbstractStyleSelector> |
getAbstractStyleSelectorGroup()
Returns the value of the property that maps to the
AbstractStyleSelectorGroup element. |
TLcdKML22AbstractTimePrimitive |
getAbstractTimePrimitiveGroup()
Returns the value of the property that maps to the
AbstractTimePrimitiveGroup element. |
TLcdKML22AbstractView |
getAbstractViewGroup()
Returns the value of the property that maps to the
AbstractViewGroup element. |
String |
getAddress()
Returns the value of the property that maps to the
address element. |
ILcdDataObject |
getAddressDetails()
Returns the value of the property that maps to the
AddressDetails element. |
ILcdDataObject |
getAtomLink()
Returns the value of the property that maps to the
link element. |
ILcdDataObject |
getAuthor()
Returns the value of the property that maps to the
author element. |
ILcdBounds |
getBounds()
Returns the bounds of this photo overlay.
|
Color |
getColor()
Returns the value of the property that maps to the
color element. |
String |
getDescription()
Returns the value of the property that maps to the
description element. |
Integer |
getDrawOrder()
Returns the value of the property that maps to the
drawOrder element. |
ILcdDataObject |
getExtendedData()
Returns the value of the property that maps to the choice between the
Metadata and ExtendedData elements. |
TLcdKML22Link |
getImageLink()
Returns the value of the property that maps to the
Icon element. |
TLcdKML22ImagePyramid |
getImagePyramid()
Returns the value of the property that maps to the
ImagePyramid element. |
String |
getName()
Returns the value of the property that maps to the
name element. |
Boolean |
getOpen()
Returns the value of the property that maps to the
open element. |
String |
getPhoneNumber()
Returns the value of the property that maps to the
phoneNumber element. |
TLcdKML22Point |
getPoint()
Returns the value of the property that maps to the
Point element. |
TLcdKML22Region |
getRegion()
Returns the value of the property that maps to the
Region element. |
Double |
getRotation()
Returns the value of the property that maps to the
rotation element. |
ELcdKML22Shape |
getShape()
Returns the value of the property that maps to the
shape element. |
TLcdKML22Snippet |
getSnippet()
Returns the value of the property that maps to the choice between the
Snippet and snippet elements. |
String |
getStyleUrl()
Returns the value of the property that maps to the
styleUrl element. |
TLcdKML22ViewVolume |
getViewVolume()
Returns the value of the property that maps to the
ViewVolume element. |
void |
setAbstractTimePrimitiveGroup(TLcdKML22AbstractTimePrimitive aValue)
Sets the value of the property that maps to the
AbstractTimePrimitiveGroup element. |
void |
setAbstractViewGroup(TLcdKML22AbstractView aValue)
Sets the value of the property that maps to the
AbstractViewGroup element. |
void |
setAddress(String aValue)
Sets the value of the property that maps to the
address element. |
void |
setAddressDetails(ILcdDataObject aValue)
Sets the value of the property that maps to the
AddressDetails element. |
void |
setAtomLink(ILcdDataObject aValue)
Sets the value of the property that maps to the
link element. |
void |
setAuthor(ILcdDataObject aValue)
Sets the value of the property that maps to the
author element. |
void |
setColor(Color aValue)
Sets the value of the property that maps to the
color element. |
void |
setDescription(String aValue)
Sets the value of the property that maps to the
description element. |
void |
setDrawOrder(Integer aValue)
Sets the value of the property that maps to the
drawOrder element. |
void |
setExtendedData(ILcdDataObject aValue)
Sets the value of the property that maps to the choice between the
Metadata and ExtendedData elements. |
void |
setImageLink(TLcdKML22Link aValue)
Sets the value of the property that maps to the
Icon element. |
void |
setImagePyramid(TLcdKML22ImagePyramid aValue)
Sets the value of the property that maps to the
ImagePyramid element. |
void |
setName(String aValue)
Sets the value of the property that maps to the
name element. |
void |
setOpen(Boolean aValue)
Sets the value of the property that maps to the
open element. |
void |
setPhoneNumber(String aValue)
Sets the value of the property that maps to the
phoneNumber element. |
void |
setPoint(TLcdKML22Point aValue)
Sets the value of the property that maps to the
Point element. |
void |
setRegion(TLcdKML22Region aValue)
Sets the value of the property that maps to the
Region element. |
void |
setRotation(Double aValue)
Sets the value of the property that maps to the
rotation element. |
void |
setShape(ELcdKML22Shape aValue)
Sets the value of the property that maps to the
shape element. |
void |
setSnippet(TLcdKML22Snippet aValue)
Sets the value of the property that maps to the choice between the
Snippet and snippet elements. |
void |
setStyleUrl(String aValue)
Sets the value of the property that maps to the
styleUrl element. |
void |
setViewVolume(TLcdKML22ViewVolume aValue)
Sets the value of the property that maps to the
ViewVolume element. |
void |
setVisibility(Boolean aValue)
Sets the value of the property that maps to the
visibility element. |
clearCache, clone, getCachedObject, getInnerStyleSelector, getKMLSourceName, getTimeBounds, getVisibility, insertIntoCache, removeCachedObject, setKMLSourceName
getId, getTargetId, setId, setTargetId
clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
public static final TLcdDataProperty ROTATION_PROPERTY
rotation
element.
The possible values for this property are instances of Double
.public static final TLcdDataProperty VIEW_VOLUME_PROPERTY
ViewVolume
element.
The possible values for this property are instances of TLcdKML22ViewVolume
.public static final TLcdDataProperty IMAGE_PYRAMID_PROPERTY
ImagePyramid
element.
The possible values for this property are instances of TLcdKML22ImagePyramid
.public static final TLcdDataProperty POINT_PROPERTY
Point
element.
The possible values for this property are instances of TLcdKML22Point
.public static final TLcdDataProperty SHAPE_PROPERTY
shape
element.
The possible values for this property are instances of ELcdKML22Shape
.public static final TLcdDataProperty PHOTO_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY
PhotoOverlaySimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty PHOTO_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY
PhotoOverlayObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public static final TLcdDataProperty COLOR_PROPERTY
color
element.
The possible values for this property are instances of Color
.public static final TLcdDataProperty DRAW_ORDER_PROPERTY
drawOrder
element.
The possible values for this property are instances of Integer
.public static final TLcdDataProperty IMAGE_LINK_PROPERTY
Icon
element.
The possible values for this property are instances of TLcdKML22Link
.public static final TLcdDataProperty ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY
AbstractOverlaySimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY
AbstractOverlayObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public static final TLcdDataProperty NAME_PROPERTY
name
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty VISIBILITY_PROPERTY
visibility
element.
The possible values for this property are instances of Boolean
.public static final TLcdDataProperty OPEN_PROPERTY
open
element.
The possible values for this property are instances of Boolean
.public static final TLcdDataProperty AUTHOR_PROPERTY
author
element.
The possible values for this property are instances of ILcdDataObject
.public static final TLcdDataProperty ATOM_LINK_PROPERTY
link
element.
The possible values for this property are instances of ILcdDataObject
.public static final TLcdDataProperty ADDRESS_PROPERTY
address
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty ADDRESS_DETAILS_PROPERTY
AddressDetails
element.
The possible values for this property are instances of ILcdDataObject
.public static final TLcdDataProperty PHONE_NUMBER_PROPERTY
phoneNumber
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty SNIPPET_PROPERTY
Snippet
and snippet
elements.
The possible values for this property are instances of
TLcdKML22Snippet
String
public static final TLcdDataProperty DESCRIPTION_PROPERTY
description
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty ABSTRACT_VIEW_GROUP_PROPERTY
AbstractViewGroup
element.
The possible values for this property are instances of TLcdKML22AbstractView
.public static final TLcdDataProperty ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
AbstractTimePrimitiveGroup
element.
The possible values for this property are instances of TLcdKML22AbstractTimePrimitive
.public static final TLcdDataProperty STYLE_URL_PROPERTY
styleUrl
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
AbstractStyleSelectorGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractStyleSelector>
.public static final TLcdDataProperty REGION_PROPERTY
Region
element.
The possible values for this property are instances of TLcdKML22Region
.public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
Metadata
and ExtendedData
elements.
The possible values for this property are instances of
public static final TLcdDataProperty ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
AbstractFeatureSimpleExtensionGroup
element.
The possible values for this property are instances of List<String>
.public static final TLcdDataProperty ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
AbstractFeatureObjectExtensionGroup
element.
The possible values for this property are instances of List<TLcdKML22AbstractObject>
.public TLcdKML22PhotoOverlay(TLcdDataType aType)
TLcdKML22PhotoOverlay
with a custom TLcdDataType
.aType
- a custom TLcdDataType
public ILcdBounds getBounds()
getBounds
in interface ILcdBounded
public Double getRotation()
rotation
element.ROTATION_PROPERTY
property.public void setRotation(Double aValue)
rotation
element.aValue
- the value to set for the ROTATION_PROPERTY
property.public TLcdKML22ViewVolume getViewVolume()
ViewVolume
element.VIEW_VOLUME_PROPERTY
property.public void setViewVolume(TLcdKML22ViewVolume aValue)
ViewVolume
element.aValue
- the value to set for the VIEW_VOLUME_PROPERTY
property.public TLcdKML22ImagePyramid getImagePyramid()
ImagePyramid
element.IMAGE_PYRAMID_PROPERTY
property.public void setImagePyramid(TLcdKML22ImagePyramid aValue)
ImagePyramid
element.aValue
- the value to set for the IMAGE_PYRAMID_PROPERTY
property.public TLcdKML22Point getPoint()
Point
element.POINT_PROPERTY
property.public void setPoint(TLcdKML22Point aValue)
Point
element.aValue
- the value to set for the POINT_PROPERTY
property.public ELcdKML22Shape getShape()
shape
element.SHAPE_PROPERTY
property.public void setShape(ELcdKML22Shape aValue)
shape
element.aValue
- the value to set for the SHAPE_PROPERTY
property.public Color getColor()
color
element.COLOR_PROPERTY
property.public void setColor(Color aValue)
color
element.aValue
- the value to set for the COLOR_PROPERTY
property.public Integer getDrawOrder()
drawOrder
element.DRAW_ORDER_PROPERTY
property.public void setDrawOrder(Integer aValue)
drawOrder
element.aValue
- the value to set for the DRAW_ORDER_PROPERTY
property.public TLcdKML22Link getImageLink()
Icon
element.IMAGE_LINK_PROPERTY
property.public void setImageLink(TLcdKML22Link aValue)
Icon
element.aValue
- the value to set for the IMAGE_LINK_PROPERTY
property.public String getName()
name
element.NAME_PROPERTY
property.public void setName(String aValue)
name
element.aValue
- the value to set for the NAME_PROPERTY
property.public void setVisibility(Boolean aValue)
visibility
element.aValue
- the value to set for the VISIBILITY_PROPERTY
property.public Boolean getOpen()
open
element.OPEN_PROPERTY
property.public void setOpen(Boolean aValue)
open
element.aValue
- the value to set for the OPEN_PROPERTY
property.public ILcdDataObject getAuthor()
author
element.AUTHOR_PROPERTY
property.public void setAuthor(ILcdDataObject aValue)
author
element.aValue
- the value to set for the AUTHOR_PROPERTY
property.public ILcdDataObject getAtomLink()
link
element.ATOM_LINK_PROPERTY
property.public void setAtomLink(ILcdDataObject aValue)
link
element.aValue
- the value to set for the ATOM_LINK_PROPERTY
property.public String getAddress()
address
element.ADDRESS_PROPERTY
property.public void setAddress(String aValue)
address
element.aValue
- the value to set for the ADDRESS_PROPERTY
property.public ILcdDataObject getAddressDetails()
AddressDetails
element.
This container defines the details of the address. Can define multiple addresses including tracking address history
ADDRESS_DETAILS_PROPERTY
property.public void setAddressDetails(ILcdDataObject aValue)
AddressDetails
element.
This container defines the details of the address. Can define multiple addresses including tracking address history
aValue
- the value to set for the ADDRESS_DETAILS_PROPERTY
property.public String getPhoneNumber()
phoneNumber
element.PHONE_NUMBER_PROPERTY
property.public void setPhoneNumber(String aValue)
phoneNumber
element.aValue
- the value to set for the PHONE_NUMBER_PROPERTY
property.public TLcdKML22Snippet getSnippet()
Snippet
and snippet
elements.
The possible values for this property are instances of
TLcdKML22Snippet
String
SNIPPET_PROPERTY
property.public void setSnippet(TLcdKML22Snippet aValue)
Snippet
and snippet
elements.
The possible values for this property are instances of
TLcdKML22Snippet
String
aValue
- the value to set for the SNIPPET_PROPERTY
property.public String getDescription()
description
element.DESCRIPTION_PROPERTY
property.public void setDescription(String aValue)
description
element.aValue
- the value to set for the DESCRIPTION_PROPERTY
property.public TLcdKML22AbstractView getAbstractViewGroup()
AbstractViewGroup
element.ABSTRACT_VIEW_GROUP_PROPERTY
property.public void setAbstractViewGroup(TLcdKML22AbstractView aValue)
AbstractViewGroup
element.aValue
- the value to set for the ABSTRACT_VIEW_GROUP_PROPERTY
property.public TLcdKML22AbstractTimePrimitive getAbstractTimePrimitiveGroup()
AbstractTimePrimitiveGroup
element.ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
property.public void setAbstractTimePrimitiveGroup(TLcdKML22AbstractTimePrimitive aValue)
AbstractTimePrimitiveGroup
element.aValue
- the value to set for the ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
property.public String getStyleUrl()
styleUrl
element.STYLE_URL_PROPERTY
property.public void setStyleUrl(String aValue)
styleUrl
element.aValue
- the value to set for the STYLE_URL_PROPERTY
property.public List<TLcdKML22AbstractStyleSelector> getAbstractStyleSelectorGroup()
AbstractStyleSelectorGroup
element.ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
property.public TLcdKML22Region getRegion()
Region
element.REGION_PROPERTY
property.public void setRegion(TLcdKML22Region aValue)
Region
element.aValue
- the value to set for the REGION_PROPERTY
property.public ILcdDataObject getExtendedData()
Metadata
and ExtendedData
elements.
The possible values for this property are instances of
EXTENDED_DATA_PROPERTY
property.public void setExtendedData(ILcdDataObject aValue)
Metadata
and ExtendedData
elements.
The possible values for this property are instances of
aValue
- the value to set for the EXTENDED_DATA_PROPERTY
property.