Package com.luciad.format.kml22.model.util

Class TLcdKML22ViewVolume

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.kml22.model.TLcdKML22AbstractObject
com.luciad.format.kml22.model.util.TLcdKML22ViewVolume
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdKML22ViewVolume extends TLcdKML22AbstractObject
Domain class modeling the KML ViewVolumeType type.

OGC KML Specification description: 

 This element can be used wherever the following element is referenced:

  -kml:AbstractObjectGroup

 Defines how much of the current scene in a kml:PhotoOverlay 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.
 A kml:ViewVolume element shall contain the kml:leftFov, kml:rightFov,
 kml:bottomFov, kml:topFov, and kml:near child elements outside of an update context,
 that is when not a descendant of kml:Update.

Since:
10.0

  • Field Details

    • LEFT_FOV_PROPERTY

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

    • RIGHT_FOV_PROPERTY

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

    • BOTTOM_FOV_PROPERTY

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

    • TOP_FOV_PROPERTY

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

    • NEAR_PROPERTY

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

    • VIEW_VOLUME_SIMPLE_EXTENSION_GROUP_PROPERTY

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

    • VIEW_VOLUME_OBJECT_EXTENSION_GROUP_PROPERTY

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

  • Constructor Details

    • TLcdKML22ViewVolume

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

  • Method Details

    • getLeftFov

      public Double getLeftFov()
      Gets the left field of view of this view volume. If it was undefined it will return a default value of (0.0).
      Returns:
      a left field of view value for this view volume

    • getRightFov

      public Double getRightFov()
      Gets the right field of view of this view volume. If it was undefined it will return a default value of (0.0).
      Returns:
      a right field of view value for this view volume

    • getBottomFov

      public Double getBottomFov()
      Gets the bottom field of view of this view volume. If it was undefined it will return a default value of (0.0).
      Returns:
      a bottom field of view value for this view volume

    • getTopFov

      public Double getTopFov()
      Gets the top field of view of this view volume. If it was undefined it will return a default value of (0.0).
      Returns:
      a top field of view value for this view volume

    • getNear

      public Double getNear()
      Gets the near plane of this view volume. If it was undefined it will return a default value of (0.0).
      Returns:
      a near plane for this view volume

    • setLeftFov

      public void setLeftFov(Double aValue)
      Sets the value of the property that maps to the leftFov element.
      Parameters:
      aValue - the value to set for the LEFT_FOV_PROPERTY property.

    • setRightFov

      public void setRightFov(Double aValue)
      Sets the value of the property that maps to the rightFov element.
      Parameters:
      aValue - the value to set for the RIGHT_FOV_PROPERTY property.

    • setBottomFov

      public void setBottomFov(Double aValue)
      Sets the value of the property that maps to the bottomFov element.
      Parameters:
      aValue - the value to set for the BOTTOM_FOV_PROPERTY property.

    • setTopFov

      public void setTopFov(Double aValue)
      Sets the value of the property that maps to the topFov element.
      Parameters:
      aValue - the value to set for the TOP_FOV_PROPERTY property.

    • setNear

      public void setNear(Double aValue)
      Sets the value of the property that maps to the near element.
      Parameters:
      aValue - the value to set for the NEAR_PROPERTY property.