WorldWind Kotlin/earth.worldwind.shape/Label

Label

open class Label @JvmOverloads constructor(position: Position, var text: String? = null, var attributes: TextAttributes = TextAttributes()) : AbstractRenderable, Highlightable, Movable

Represents a label at a geographic position. Labels display one or more lines of text, separated by '\n', according to specified TextAttributes. Lines are aligned inside the text block by the horizontal fraction of TextAttributes.textOffset anchor: 0 = left, 0.5 = center, 1 = right.

Constructors

Label

@JvmOverloads

constructor(position: Position, text: String? = null, attributes: TextAttributes = TextAttributes())

Types

Companion

object Companion

Properties

altitudeMode

open override var altitudeMode: AltitudeMode

The label's altitude mode. See AltitudeMode

attributes

var attributes: TextAttributes

Indicates this label's "normal" attributes, that is the attributes used when the label's highlighted flag is false. If null and this label is not highlighted, this label displays nothing.

depthOffset

var depthOffset: Double

The amount of screen depth offset applied to this label's text during rendering. Values less than zero bias depth values toward the viewer, causing the text to appear above nearby terrain rather than being clipped by it. The offset is applied only while the label is within the horizon distance. Defaults to DEFAULT_DEPTH_OFFSET.

displayName

open override var displayName: String?

highlightAttributes

var highlightAttributes: TextAttributes?

The attributes used when this label's highlighted flag is true. If null and the highlighted flag is true, this label's normal attributes are used. If they, too, are null, this label displays nothing.

isAlwaysOnTop

var isAlwaysOnTop: Boolean

Indicates whether this placemark has visual priority over other shapes in the scene.

isEnabled

open override var isEnabled: Boolean

isHighlighted

open override var isHighlighted: Boolean

Determines whether the normal or highlighted attributes should be used.

isPickEnabled

open override var isPickEnabled: Boolean

isPointShape

open override val isPointShape: Boolean

true when this shape's referencePosition coincides with where the user actually sees the shape (Placemark, Label, sightlines — the reference is the rendered location). false for shapes whose reference is computed from extended geometry and may sit far from where the user grabbed (Polygon centroid, Path centroid, Mesh).

isVisible

var isVisible: (Label, RenderContext, Double) -> Boolean?

Optional lambda to control current label visibility based on its attributes, frame render context and camera distance

pickDelegate

open override var pickDelegate: Any?

position

var position: Position

The label's geographic position.

referencePosition

open override val referencePosition: Position

A position associated with the object that indicates its aggregate geographic position. For a Label, this is simply it's position property.

rotation

var rotation: Angle

Indicates the rotation applied to this label. The rotation represents clockwise clockwise degrees relative to this label's labelRotationMode.

rotationMode

var rotationMode: OrientationMode

Indicates the orientation mode used to interpret this label's rotation. Label rotation may be either relative to the screen or relative to the globe, as indicated by the following allowable values: OrientationMode.RELATIVE_TO_SCREEN - The label's orientation is fixed relative to the screen. Rotation indicates clockwise degrees relative to the screen's vertical axis. This is the default mode. OrientationMode.RELATIVE_TO_GLOBE - The label's orientation is fixed relative to the globe. Rotation indicates clockwise degrees relative to North.

text

var text: String?

Indicates the text displayed by this label. The returned string may be null, indicating that this label displays nothing.

visibilityThreshold

var visibilityThreshold: Double

Sets the eye altitude, in meters, above which this label is not displayed.

zOrder

open override var zOrder: Double