Class KmlViewpoint


  • public final class KmlViewpoint
    extends Object
    A KML viewpoint contains information about a viewer's position, defined as either a LookAt relationship to another object or a camera.

    See the guide documentation and samples for information about converting KmlViewpoints into Runtime viewpoints.

    Since:
    100.4.0
    • Method Detail

      • getAltitudeMode

        public KmlAltitudeMode getAltitudeMode()
        Gets the KML viewpoint's altitude mode, which determines how altitude values should be interpreted. The default is KmlAltitudeMode.RELATIVE_TO_GROUND.
        Returns:
        the KML viewpoint's altitude mode
        Since:
        100.4.0
      • getHeading

        public double getHeading()
        Gets the KML viewpoint's heading in degrees. Values range from 0 (North) to 360, with 90 being East.
        Returns:
        the KML viewpoint's heading
        Since:
        100.4.0
      • getLocation

        public Point getLocation()
        Gets the KML viewpoint's location.

        For LOOK_AT viewpoints, this defines the position of an object for the camera to observe. For CAMERA viewpoints, this defines the position of the camera directly.

        Returns:
        the KML viewpoint's location.
        Since:
        100.4.0
      • getRange

        public double getRange()
        Gets the KML viewpoint's range, which only applies to LookAt viewpoints. Range is the distance in meters between the getLocation() and the camera.
        Returns:
        the KML viewpoint's range
        Since:
        100.4.0
      • getRoll

        public double getRoll()
        Gets the KML viewpoint's rotation of the camera around the Z axis. Values range from -180 to 180 degrees.
        Returns:
        the KML viewpoint's roll
        Since:
        100.4.0
      • getPitch

        public double getPitch()
        Gets the KML viewpoint's Pitch.

        The range of the pitch is from -180 to 180 degrees. A value of 0 indicates that the view is aimed straight down towards the earth (the default). A value of 90 indicates that the view is aimed toward the horizon. Values greater than 90 indicate that the view is pointed towards the sky.

        Corresponds to the 'tilt' property from the KML specification.

        Returns:
        the KML viewpoint's pitch
        Since:
        100.4.0
      • getType

        public KmlViewpoint.Type getType()
        Gets the KML viewpoint's type. Camera viewpoints define the position of the camera directly. LookAt viewpoints define the position of the camera relative to a point of interest.
        Returns:
        the KML viewpoint's type
        Since:
        100.4.0