XmlDoc
API
Generated with
XmlDoc/com.phasmidsoftware.xmldoc/com.phasmidsoftware.xmldoc.kml/Placemark

Placemark

com.phasmidsoftware.xmldoc.kml.Placemark
See thePlacemark companion object
case class Placemark(Geometry: Seq[Geometry])(featureData: FeatureData) extends Feature, HasName, Mergeable[Placemark], Invertible[Placemark]

Placemark: subtype of Feature. See Placemark.

CONSIDER restricting the number of Geometry elements to one.

Value parameters

Geometry

a sequence of Geometry elements (where Geometry is an abstract super-type).

featureData

the (auxiliary) FeatureData, shared by sub-elements.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait HasName
trait Feature
trait KmlObject
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def editToOptionOption(e: KmlEdit, fs: Seq[Feature]): Option[Option[Feature]]

Method to edit this Feature, given a sequence of sibling Features such that we may be able to combine features. TESTME

Method to edit this Feature, given a sequence of sibling Features such that we may be able to combine features. TESTME

Value parameters

e

the edit which may (or may not) apply to this.

fs

a sequence of Features which are the children of this's family (including p itself).

Attributes

Returns

an optional Feature.

def invert: Option[Placemark]

Inverts the current Placemark instance by reversing the orientation or nature of its underlying geometric structure, if applicable. This is achieved by attempting to invert each associated Geometry. TESTME

Inverts the current Placemark instance by reversing the orientation or nature of its underlying geometric structure, if applicable. This is achieved by attempting to invert each associated Geometry. TESTME

Attributes

Returns

an Option containing a new Placemark with inverted Geometries, or None if inversion is not possible.

infix def merge(t: Placemark, mergeName: Boolean = ...): Option[Placemark]

Merge this mergeable object with t.

Merge this mergeable object with t.

Value parameters

t

the object to be merged with this.

Attributes

Returns

the merged value of T.

def name: Text

Retrieves the name of the feature data.

Retrieves the name of the feature data.

Attributes

Returns

The name of the feature as a Text instance.

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Inherited methods

def editToOption(e: KmlEdit, fs: Seq[Feature]): Option[Feature]

Method to edit this Feature, given a sequence of sibling Features such that we may be able to combine features. TESTME

Method to edit this Feature, given a sequence of sibling Features such that we may be able to combine features. TESTME

Value parameters

e

the edit to apply.

fs

the siblings (which actually do include this itself).

Attributes

Returns

an optional Feature.

Inherited from:
Feature
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product

Concrete fields

Generated with