Package com.luciad.format.kml22.model.feature

Class TLcdKML22PhotoOverlay

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.feature.TLcdKML22AbstractFeature
com.luciad.format.kml22.model.feature.TLcdKML22AbstractOverlay
com.luciad.format.kml22.model.feature.TLcdKML22PhotoOverlay
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdTimeBounded, ILcdCache, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdKML22PhotoOverlay extends TLcdKML22AbstractOverlay implements ILcdBounded
Domain class modeling the KML PhotoOverlayType type.

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.

Since:
10.0

  • Field Details

    • ROTATION_PROPERTY

      public static final TLcdDataProperty ROTATION_PROPERTY
      Data property that maps to the rotation element. The possible values for this property are instances of Double.

    • VIEW_VOLUME_PROPERTY

      public static final TLcdDataProperty VIEW_VOLUME_PROPERTY
      Data property that maps to the ViewVolume element. The possible values for this property are instances of TLcdKML22ViewVolume.

    • IMAGE_PYRAMID_PROPERTY

      public static final TLcdDataProperty IMAGE_PYRAMID_PROPERTY
      Data property that maps to the ImagePyramid element. The possible values for this property are instances of TLcdKML22ImagePyramid.

    • POINT_PROPERTY

      public static final TLcdDataProperty POINT_PROPERTY
      Data property that maps to the Point element. The possible values for this property are instances of TLcdKML22Point.

    • SHAPE_PROPERTY

      public static final TLcdDataProperty SHAPE_PROPERTY
      Data property that maps to the shape element. The possible values for this property are instances of ELcdKML22Shape.

    • PHOTO_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty PHOTO_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the PhotoOverlaySimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • PHOTO_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty PHOTO_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the PhotoOverlayObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

    • COLOR_PROPERTY

      public static final TLcdDataProperty COLOR_PROPERTY
      Data property that maps to the color element. The possible values for this property are instances of Color.

    • DRAW_ORDER_PROPERTY

      public static final TLcdDataProperty DRAW_ORDER_PROPERTY
      Data property that maps to the drawOrder element. The possible values for this property are instances of Integer.

    • ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_OVERLAY_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractOverlaySimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_OVERLAY_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractOverlayObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

    • NAME_PROPERTY

      public static final TLcdDataProperty NAME_PROPERTY
      Data property that maps to the name element. The possible values for this property are instances of String.

    • VISIBILITY_PROPERTY

      public static final TLcdDataProperty VISIBILITY_PROPERTY
      Data property that maps to the visibility element. The possible values for this property are instances of Boolean.

    • OPEN_PROPERTY

      public static final TLcdDataProperty OPEN_PROPERTY
      Data property that maps to the open element. The possible values for this property are instances of Boolean.

    • AUTHOR_PROPERTY

      public static final TLcdDataProperty AUTHOR_PROPERTY
      Data property that maps to the author element. The possible values for this property are instances of ILcdDataObject.

    • ADDRESS_PROPERTY

      public static final TLcdDataProperty ADDRESS_PROPERTY
      Data property that maps to the address element. The possible values for this property are instances of String.

    • ADDRESS_DETAILS_PROPERTY

      public static final TLcdDataProperty ADDRESS_DETAILS_PROPERTY
      Data property that maps to the AddressDetails element. The possible values for this property are instances of ILcdDataObject.

    • PHONE_NUMBER_PROPERTY

      public static final TLcdDataProperty PHONE_NUMBER_PROPERTY
      Data property that maps to the phoneNumber element. The possible values for this property are instances of String.

    • SNIPPET_PROPERTY

      public static final TLcdDataProperty SNIPPET_PROPERTY
      Data property that maps to the choice between the Snippet and snippet elements. The possible values for this property are instances of

    • DESCRIPTION_PROPERTY

      public static final TLcdDataProperty DESCRIPTION_PROPERTY
      Data property that maps to the description element. The possible values for this property are instances of String.

    • ABSTRACT_VIEW_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_VIEW_GROUP_PROPERTY
      Data property that maps to the AbstractViewGroup element. The possible values for this property are instances of TLcdKML22AbstractView.

    • ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
      Data property that maps to the AbstractTimePrimitiveGroup element. The possible values for this property are instances of TLcdKML22AbstractTimePrimitive.

    • STYLE_URL_PROPERTY

      public static final TLcdDataProperty STYLE_URL_PROPERTY
      Data property that maps to the styleUrl element. The possible values for this property are instances of String.

    • ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
      Data property that maps to the AbstractStyleSelectorGroup element. The possible values for this property are instances of List<TLcdKML22AbstractStyleSelector>.

    • REGION_PROPERTY

      public static final TLcdDataProperty REGION_PROPERTY
      Data property that maps to the Region element. The possible values for this property are instances of TLcdKML22Region.

    • EXTENDED_DATA_PROPERTY

      public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
      Data property that maps to the choice between the Metadata and ExtendedData elements. The possible values for this property are instances of

    • ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractFeatureSimpleExtensionGroup element. The possible values for this property are instances of List<String>.

    • ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY

      public static final TLcdDataProperty ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
      Data property that maps to the AbstractFeatureObjectExtensionGroup element. The possible values for this property are instances of List<TLcdKML22AbstractObject>.

  • Constructor Details

    • TLcdKML22PhotoOverlay

      public TLcdKML22PhotoOverlay(TLcdDataType aType)
      Creates a new TLcdKML22PhotoOverlay with a custom TLcdDataType.
      Parameters:
      aType - a custom TLcdDataType

  • Method Details

    • getBounds

      public ILcdBounds getBounds()
      Returns the bounds of this photo overlay. Returns null if no bounds were available.
      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      The bounds of the point of this photo overlay.

    • getRotation

      public Double getRotation()
      Returns the value of the property that maps to the rotation element.
      Returns:
      the value of the ROTATION_PROPERTY property.

    • setRotation

      public void setRotation(Double aValue)
      Sets the value of the property that maps to the rotation element.
      Parameters:
      aValue - the value to set for the ROTATION_PROPERTY property.

    • getViewVolume

      public TLcdKML22ViewVolume getViewVolume()
      Returns the value of the property that maps to the ViewVolume element.
      Returns:
      the value of the VIEW_VOLUME_PROPERTY property.

    • setViewVolume

      public void setViewVolume(TLcdKML22ViewVolume aValue)
      Sets the value of the property that maps to the ViewVolume element.
      Parameters:
      aValue - the value to set for the VIEW_VOLUME_PROPERTY property.

    • getImagePyramid

      public TLcdKML22ImagePyramid getImagePyramid()
      Returns the value of the property that maps to the ImagePyramid element.
      Returns:
      the value of the IMAGE_PYRAMID_PROPERTY property.

    • setImagePyramid

      public void setImagePyramid(TLcdKML22ImagePyramid aValue)
      Sets the value of the property that maps to the ImagePyramid element.
      Parameters:
      aValue - the value to set for the IMAGE_PYRAMID_PROPERTY property.

    • getPoint

      public TLcdKML22Point getPoint()
      Returns the value of the property that maps to the Point element.
      Returns:
      the value of the POINT_PROPERTY property.

    • setPoint

      public void setPoint(TLcdKML22Point aValue)
      Sets the value of the property that maps to the Point element.
      Parameters:
      aValue - the value to set for the POINT_PROPERTY property.

    • getShape

      public ELcdKML22Shape getShape()
      Returns the value of the property that maps to the shape element.
      Returns:
      the value of the SHAPE_PROPERTY property.

    • setShape

      public void setShape(ELcdKML22Shape aValue)
      Sets the value of the property that maps to the shape element.
      Parameters:
      aValue - the value to set for the SHAPE_PROPERTY property.

    • getColor

      public Color getColor()
      Returns the value of the property that maps to the color element.
      Returns:
      the value of the COLOR_PROPERTY property.

    • setColor

      public void setColor(Color aValue)
      Sets the value of the property that maps to the color element.
      Parameters:
      aValue - the value to set for the COLOR_PROPERTY property.

    • getDrawOrder

      public Integer getDrawOrder()
      Returns the value of the property that maps to the drawOrder element.
      Returns:
      the value of the DRAW_ORDER_PROPERTY property.

    • setDrawOrder

      public void setDrawOrder(Integer aValue)
      Sets the value of the property that maps to the drawOrder element.
      Parameters:
      aValue - the value to set for the DRAW_ORDER_PROPERTY property.

    • getImageLink

      public TLcdKML22Link getImageLink()
      Returns the value of the property that maps to the Icon element.
      Returns:
      the value of the IMAGE_LINK_PROPERTY property.

    • setImageLink

      public void setImageLink(TLcdKML22Link aValue)
      Sets the value of the property that maps to the Icon element.
      Parameters:
      aValue - the value to set for the IMAGE_LINK_PROPERTY property.

    • getName

      public String getName()
      Returns the value of the property that maps to the name element.
      Returns:
      the value of the NAME_PROPERTY property.

    • setName

      public void setName(String aValue)
      Sets the value of the property that maps to the name element.
      Parameters:
      aValue - the value to set for the NAME_PROPERTY property.

    • setVisibility

      public void setVisibility(Boolean aValue)
      Sets the value of the property that maps to the visibility element.
      Parameters:
      aValue - the value to set for the VISIBILITY_PROPERTY property.

    • getOpen

      public Boolean getOpen()
      Returns the value of the property that maps to the open element.
      Returns:
      the value of the OPEN_PROPERTY property.

    • setOpen

      public void setOpen(Boolean aValue)
      Sets the value of the property that maps to the open element.
      Parameters:
      aValue - the value to set for the OPEN_PROPERTY property.

    • getAuthor

      public ILcdDataObject getAuthor()
      Returns the value of the property that maps to the author element.
      Returns:
      the value of the AUTHOR_PROPERTY property.

    • setAuthor

      public void setAuthor(ILcdDataObject aValue)
      Sets the value of the property that maps to the author element.
      Parameters:
      aValue - the value to set for the AUTHOR_PROPERTY property.

    • getAtomLink

      public ILcdDataObject getAtomLink()
      Returns the value of the property that maps to the link element.
      Returns:
      the value of the ATOM_LINK_PROPERTY property.

    • setAtomLink

      public void setAtomLink(ILcdDataObject aValue)
      Sets the value of the property that maps to the link element.
      Parameters:
      aValue - the value to set for the ATOM_LINK_PROPERTY property.

    • getAddress

      public String getAddress()
      Returns the value of the property that maps to the address element.
      Returns:
      the value of the ADDRESS_PROPERTY property.

    • setAddress

      public void setAddress(String aValue)
      Sets the value of the property that maps to the address element.
      Parameters:
      aValue - the value to set for the ADDRESS_PROPERTY property.

    • getAddressDetails

      public ILcdDataObject getAddressDetails()
      Returns the value of the property that maps to the AddressDetails element.

      This container defines the details of the address. Can define multiple addresses including tracking address history

      Returns:
      the value of the ADDRESS_DETAILS_PROPERTY property.

    • setAddressDetails

      public void setAddressDetails(ILcdDataObject aValue)
      Sets the value of the property that maps to the AddressDetails element.

      This container defines the details of the address. Can define multiple addresses including tracking address history

      Parameters:
      aValue - the value to set for the ADDRESS_DETAILS_PROPERTY property.

    • getPhoneNumber

      public String getPhoneNumber()
      Returns the value of the property that maps to the phoneNumber element.
      Returns:
      the value of the PHONE_NUMBER_PROPERTY property.

    • setPhoneNumber

      public void setPhoneNumber(String aValue)
      Sets the value of the property that maps to the phoneNumber element.
      Parameters:
      aValue - the value to set for the PHONE_NUMBER_PROPERTY property.

    • getSnippet

      public TLcdKML22Snippet getSnippet()
      Returns the value of the property that maps to the choice between the Snippet and snippet elements.

      The possible values for this property are instances of

      Returns:
      the value of the SNIPPET_PROPERTY property.

    • setSnippet

      public void setSnippet(TLcdKML22Snippet aValue)
      Sets the value of the property that maps to the choice between the Snippet and snippet elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the SNIPPET_PROPERTY property.

    • getDescription

      public String getDescription()
      Returns the value of the property that maps to the description element.
      Returns:
      the value of the DESCRIPTION_PROPERTY property.

    • setDescription

      public void setDescription(String aValue)
      Sets the value of the property that maps to the description element.
      Parameters:
      aValue - the value to set for the DESCRIPTION_PROPERTY property.

    • getAbstractViewGroup

      public TLcdKML22AbstractView getAbstractViewGroup()
      Returns the value of the property that maps to the AbstractViewGroup element.
      Returns:
      the value of the ABSTRACT_VIEW_GROUP_PROPERTY property.

    • setAbstractViewGroup

      public void setAbstractViewGroup(TLcdKML22AbstractView aValue)
      Sets the value of the property that maps to the AbstractViewGroup element.
      Parameters:
      aValue - the value to set for the ABSTRACT_VIEW_GROUP_PROPERTY property.

    • getAbstractTimePrimitiveGroup

      public TLcdKML22AbstractTimePrimitive getAbstractTimePrimitiveGroup()
      Returns the value of the property that maps to the AbstractTimePrimitiveGroup element.
      Returns:
      the value of the ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY property.

    • setAbstractTimePrimitiveGroup

      public void setAbstractTimePrimitiveGroup(TLcdKML22AbstractTimePrimitive aValue)
      Sets the value of the property that maps to the AbstractTimePrimitiveGroup element.
      Parameters:
      aValue - the value to set for the ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY property.

    • getStyleUrl

      public String getStyleUrl()
      Returns the value of the property that maps to the styleUrl element.
      Returns:
      the value of the STYLE_URL_PROPERTY property.

    • setStyleUrl

      public void setStyleUrl(String aValue)
      Sets the value of the property that maps to the styleUrl element.
      Parameters:
      aValue - the value to set for the STYLE_URL_PROPERTY property.

    • getAbstractStyleSelectorGroup

      public List<TLcdKML22AbstractStyleSelector> getAbstractStyleSelectorGroup()
      Returns the value of the property that maps to the AbstractStyleSelectorGroup element.
      Returns:
      the value of the ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY property.

    • getRegion

      public TLcdKML22Region getRegion()
      Returns the value of the property that maps to the Region element.
      Returns:
      the value of the REGION_PROPERTY property.

    • setRegion

      public void setRegion(TLcdKML22Region aValue)
      Sets the value of the property that maps to the Region element.
      Parameters:
      aValue - the value to set for the REGION_PROPERTY property.

    • getExtendedData

      public ILcdDataObject getExtendedData()
      Returns the value of the property that maps to the choice between the Metadata and ExtendedData elements.

      The possible values for this property are instances of

      Returns:
      the value of the EXTENDED_DATA_PROPERTY property.

    • setExtendedData

      public void setExtendedData(ILcdDataObject aValue)
      Sets the value of the property that maps to the choice between the Metadata and ExtendedData elements.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the EXTENDED_DATA_PROPERTY property.