Class

com.scalakml.kml

LineString

Related Doc: package kml

Permalink

case class LineString(extrude: Option[Boolean] = None, tessellate: Option[Boolean] = None, altitudeMode: Option[AltitudeMode] = None, coordinates: Option[Seq[Coordinate]] = None, id: Option[String] = None, targetId: Option[String] = None, lineStringSimpleExtensionGroup: Seq[Any] = Nil, lineStringObjectExtensionGroup: Seq[Any] = Nil, geometrySimpleExtensionGroup: Seq[Any] = Nil, geometryObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil) extends Geometry with Product with Serializable

Defines a connected set of line segments. Use <LineStyle> to specify the color, color mode, and width of the line. When a LineString is extruded, the line is extended to the ground, forming a polygon that looks somewhat like a wall or fence. For extruded LineStrings, the line itself uses the current LineStyle, and the extrusion uses the current PolyStyle. See the KML Tutorial for examples of LineStrings (or paths).

extrude

Boolean value. Specifies whether to connect the LineString to the ground. To extrude a LineString, the altitude mode must be either relativeToGround, relativeToSeaFloor, or absolute. The vertices in the LineString are extruded toward the center of the Earth's sphere.

tessellate

Boolean value. Specifies whether to allow the LineString to follow the terrain. To enable tessellation, the altitude mode must be clampToGround or clampToSeaFloor. Very large LineStrings should enable tessellation so that they follow the curvature of the earth (otherwise, they may go underground and be hidden).

altitudeMode

Specifies how altitude components in the <coordinates> element are interpreted. Possible values are clampToGround - (default) Indicates to ignore an altitude specification (for example, in the <coordinates> tag). relativeToGround - Sets the altitude of the element relative to the actual ground elevation of a particular location. For example, if the ground elevation of a location is exactly at sea level and the altitude for a point is set to 9 meters, then the elevation for the icon of a point placemark elevation is 9 meters with this mode. However, if the same coordinate is set over a location where the ground elevation is 10 meters above sea level, then the elevation of the coordinate is 19 meters. A typical use of this mode is for placing telephone poles or a ski lift. absolute - Sets the altitude of the coordinate relative to sea level, regardless of the actual elevation of the terrain beneath the element. For example, if you set the altitude of a coordinate to 10 meters with an absolute altitude mode, the icon of a point placemark will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the placemark will appear elevated above the terrain by 7 meters. A typical use of this mode is for aircraft placement.

coordinates

Two or more coordinate tuples, each consisting of floating point values for longitude, latitude, and altitude. The altitude component is optional. Insert a space between tuples. Do not include spaces within a tuple.

Linear Supertypes
Serializable, Serializable, Product, Equals, Geometry, KmlObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LineString
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Geometry
  7. KmlObject
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LineString(extrude: Boolean, tessellate: Boolean, altitudeMode: AltitudeMode, coordinates: Seq[Coordinate], id: String)

    Permalink
  2. new LineString(extrude: Boolean, tessellate: Boolean, altitudeMode: AltitudeMode, coordinates: Seq[Coordinate])

    Permalink
  3. new LineString(extrude: Boolean, altMode: AltitudeMode, locations: Seq[Coordinate])

    Permalink
  4. new LineString(altMode: AltitudeMode, coordinates: Seq[Coordinate])

    Permalink
  5. new LineString(coordinates: Seq[Coordinate])

    Permalink
  6. new LineString(extrude: Option[Boolean] = None, tessellate: Option[Boolean] = None, altitudeMode: Option[AltitudeMode] = None, coordinates: Option[Seq[Coordinate]] = None, id: Option[String] = None, targetId: Option[String] = None, lineStringSimpleExtensionGroup: Seq[Any] = Nil, lineStringObjectExtensionGroup: Seq[Any] = Nil, geometrySimpleExtensionGroup: Seq[Any] = Nil, geometryObjectExtensionGroup: Seq[Any] = Nil, objectSimpleExtensionGroup: Seq[Any] = Nil)

    Permalink

    extrude

    Boolean value. Specifies whether to connect the LineString to the ground. To extrude a LineString, the altitude mode must be either relativeToGround, relativeToSeaFloor, or absolute. The vertices in the LineString are extruded toward the center of the Earth's sphere.

    tessellate

    Boolean value. Specifies whether to allow the LineString to follow the terrain. To enable tessellation, the altitude mode must be clampToGround or clampToSeaFloor. Very large LineStrings should enable tessellation so that they follow the curvature of the earth (otherwise, they may go underground and be hidden).

    altitudeMode

    Specifies how altitude components in the <coordinates> element are interpreted. Possible values are clampToGround - (default) Indicates to ignore an altitude specification (for example, in the <coordinates> tag). relativeToGround - Sets the altitude of the element relative to the actual ground elevation of a particular location. For example, if the ground elevation of a location is exactly at sea level and the altitude for a point is set to 9 meters, then the elevation for the icon of a point placemark elevation is 9 meters with this mode. However, if the same coordinate is set over a location where the ground elevation is 10 meters above sea level, then the elevation of the coordinate is 19 meters. A typical use of this mode is for placing telephone poles or a ski lift. absolute - Sets the altitude of the coordinate relative to sea level, regardless of the actual elevation of the terrain beneath the element. For example, if you set the altitude of a coordinate to 10 meters with an absolute altitude mode, the icon of a point placemark will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the placemark will appear elevated above the terrain by 7 meters. A typical use of this mode is for aircraft placement.

    coordinates

    Two or more coordinate tuples, each consisting of floating point values for longitude, latitude, and altitude. The altitude component is optional. Insert a space between tuples. Do not include spaces within a tuple.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addToCoordinates(value: Coordinate): LineString

    Permalink

    returns a new object with a new Coordinate added to the sequence of coordinates

    returns a new object with a new Coordinate added to the sequence of coordinates

    value

    the new Coordinate to add

    returns

    a new object with a new Coordinate added to the sequence of coordinates

  5. val altitudeMode: Option[AltitudeMode]

    Permalink

    Specifies how altitude components in the <coordinates> element are interpreted.

    Specifies how altitude components in the <coordinates> element are interpreted. Possible values are clampToGround - (default) Indicates to ignore an altitude specification (for example, in the <coordinates> tag). relativeToGround - Sets the altitude of the element relative to the actual ground elevation of a particular location. For example, if the ground elevation of a location is exactly at sea level and the altitude for a point is set to 9 meters, then the elevation for the icon of a point placemark elevation is 9 meters with this mode. However, if the same coordinate is set over a location where the ground elevation is 10 meters above sea level, then the elevation of the coordinate is 19 meters. A typical use of this mode is for placing telephone poles or a ski lift. absolute - Sets the altitude of the coordinate relative to sea level, regardless of the actual elevation of the terrain beneath the element. For example, if you set the altitude of a coordinate to 10 meters with an absolute altitude mode, the icon of a point placemark will appear to be at ground level if the terrain beneath is also 10 meters above sea level. If the terrain is 3 meters above sea level, the placemark will appear elevated above the terrain by 7 meters. A typical use of this mode is for aircraft placement.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val coordinates: Option[Seq[Coordinate]]

    Permalink

    Two or more coordinate tuples, each consisting of floating point values for longitude, latitude, and altitude.

    Two or more coordinate tuples, each consisting of floating point values for longitude, latitude, and altitude. The altitude component is optional. Insert a space between tuples. Do not include spaces within a tuple.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. val extrude: Option[Boolean]

    Permalink

    Boolean value.

    Boolean value. Specifies whether to connect the LineString to the ground. To extrude a LineString, the altitude mode must be either relativeToGround, relativeToSeaFloor, or absolute. The vertices in the LineString are extruded toward the center of the Earth's sphere.

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. val geometryObjectExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    LineStringGeometry
  13. val geometrySimpleExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    LineStringGeometry
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. val id: Option[String]

    Permalink
    Definition Classes
    LineStringGeometryKmlObject
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. val lineStringObjectExtensionGroup: Seq[Any]

    Permalink
  18. val lineStringSimpleExtensionGroup: Seq[Any]

    Permalink
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. val objectSimpleExtensionGroup: Seq[Any]

    Permalink
    Definition Classes
    LineStringGeometryKmlObject
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. val targetId: Option[String]

    Permalink
    Definition Classes
    LineStringGeometryKmlObject
  25. val tessellate: Option[Boolean]

    Permalink

    Boolean value.

    Boolean value. Specifies whether to allow the LineString to follow the terrain. To enable tessellation, the altitude mode must be clampToGround or clampToSeaFloor. Very large LineStrings should enable tessellation so that they follow the curvature of the earth (otherwise, they may go underground and be hidden).

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Geometry

Inherited from KmlObject

Inherited from AnyRef

Inherited from Any

Ungrouped