main.cesium.LabelGraphics.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* Describes a two dimensional label located at the position of the containing [Entity].
* @see Online Documentation
*/
@JsName("\$cesium__LabelGraphics")
external class LabelGraphics {
/**
* Gets the event that is raised whenever a property or sub-property is changed or modified.
* @see Online Documentation
*/
val definitionChanged: Event
/**
* Gets or sets the boolean Property specifying the visibility of the label.
* @see Online Documentation
*/
var show: Property?
/**
* Gets or sets the string Property specifying the text of the label.
* Explicit newlines '\n' are supported.
* @see Online Documentation
*/
var text: Property?
/**
* Gets or sets the string Property specifying the font in CSS syntax.
* @see Online Documentation
*/
var font: Property?
/**
* Gets or sets the Property specifying the [LabelStyle].
* @see Online Documentation
*/
var style: Property?
/**
* Gets or sets the numeric Property specifying the uniform scale to apply to the image.
* A scale greater than `1.0` enlarges the label while a scale less than `1.0` shrinks it.
* @see Online Documentation
*/
var scale: Property?
/**
* Gets or sets the boolean Property specifying the visibility of the background behind the label.
* @see Online Documentation
*/
var showBackground: Property?
/**
* Gets or sets the Property specifying the background [Color].
* @see Online Documentation
*/
var backgroundColor: Property?
/**
* Gets or sets the [Cartesian2] Property specifying the label's horizontal and vertical
* background padding in pixels.
* @see Online Documentation
*/
var backgroundPadding: Property?
/**
* Gets or sets the [Cartesian2] Property specifying the label's pixel offset in screen space
* from the origin of this label. This is commonly used to align multiple labels and labels at
* the same position, e.g., an image and text. The screen space origin is the top, left corner of the
* canvas; `x` increases from left to right, and `y` increases from top to bottom.
* @see Online Documentation
*/
var pixelOffset: Property?
/**
* Gets or sets the [Cartesian3] Property specifying the label's offset in eye coordinates.
* Eye coordinates is a left-handed coordinate system, where `x` points towards the viewer's
* right, `y` points up, and `z` points into the screen.
*
* An eye offset is commonly used to arrange multiple labels or objects at the same position, e.g., to
* arrange a label above its corresponding 3D model.
*
* Below, the label is positioned at the center of the Earth but an eye offset makes it always
* appear on top of the Earth regardless of the viewer's or Earth's orientation.
* @see Online Documentation
*/
var eyeOffset: Property?
/**
* Gets or sets the Property specifying the [HorizontalOrigin].
* @see Online Documentation
*/
var horizontalOrigin: Property?
/**
* Gets or sets the Property specifying the [VerticalOrigin].
* @see Online Documentation
*/
var verticalOrigin: Property?
/**
* Gets or sets the Property specifying the [HeightReference].
* @see Online Documentation
*/
var heightReference: Property?
/**
* Gets or sets the Property specifying the fill [Color].
* @see Online Documentation
*/
var fillColor: Property?
/**
* Gets or sets the Property specifying the outline [Color].
* @see Online Documentation
*/
var outlineColor: Property?
/**
* Gets or sets the numeric Property specifying the outline width.
* @see Online Documentation
*/
var outlineWidth: Property?
/**
* Gets or sets [NearFarScalar] Property specifying the translucency of the label based on the distance from the camera.
* A label's translucency will interpolate between the [NearFarScalar.nearValue] and
* [NearFarScalar.farValue] while the camera distance falls within the lower and upper bounds
* of the specified [NearFarScalar.near] and [NearFarScalar.far].
* Outside of these ranges the label's translucency remains clamped to the nearest bound.
* @see Online Documentation
*/
var translucencyByDistance: Property?
/**
* Gets or sets [NearFarScalar] Property specifying the pixel offset of the label based on the distance from the camera.
* A label's pixel offset will interpolate between the [NearFarScalar.nearValue] and
* [NearFarScalar.farValue] while the camera distance falls within the lower and upper bounds
* of the specified [NearFarScalar.near] and [NearFarScalar.far].
* Outside of these ranges the label's pixel offset remains clamped to the nearest bound.
* @see Online Documentation
*/
var pixelOffsetScaleByDistance: Property?
/**
* Gets or sets near and far scaling properties of a Label based on the label's distance from the camera.
* A label's scale will interpolate between the [NearFarScalar.nearValue] and
* [NearFarScalar.farValue] while the camera distance falls within the lower and upper bounds
* of the specified [NearFarScalar.near] and [NearFarScalar.far].
* Outside of these ranges the label's scale remains clamped to the nearest bound. If undefined,
* scaleByDistance will be disabled.
* @see Online Documentation
*/
var scaleByDistance: Property?
/**
* Gets or sets the [DistanceDisplayCondition] Property specifying at what distance from the camera that this label will be displayed.
* @see Online Documentation
*/
var distanceDisplayCondition: Property?
/**
* Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
* When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.
* @see Online Documentation
*/
var disableDepthTestDistance: Property?
/**
* Duplicates this instance.
* @param [result] The object onto which to store the result.
* @return The modified result parameter or a new instance if one was not provided.
* @see Online Documentation
*/
fun clone(result: LabelGraphics? = definedExternally): LabelGraphics
/**
* Assigns each unassigned property on this object to the value
* of the same property on the provided source object.
* @param [source] The object to be merged into this object.
* @see Online Documentation
*/
fun merge(source: LabelGraphics)
}