org.cesiumjs.cs.scene

Class Label

java.lang.Object

org.cesiumjs.cs.scene.Label

@JsType(isNative=true,
        namespace="Cesium",
        name="Label")
public class Label
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Color	backgroundColor Gets or sets the background color of this label.
Cartesian2	backgroundPadding Gets or sets the background padding, in pixels, of this label.
double	disableDepthTestDistance Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
DistanceDisplayCondition	distanceDisplayCondition Gets or sets the condition specifying at what distance from the camera that this label will be displayed.
static boolean	enableRightToLeftDetection Determines whether or not run the algorithm, that match the text of the label to right-to-left languages Default: false
Cartesian3	eyeOffset Gets and sets the 3D Cartesian offset applied to this label in eye coordinates.
Color	fillColor Gets or sets the fill color of this label.
String	font Gets or sets the font used to draw this label.
int	heightReference Gets or sets the height reference of this billboard.
Number	horizontalOrigin Gets or sets the horizontal origin of this label, which determines if the label is drawn to the left, center, or right of its position.
Object	id Gets or sets the user-defined object returned when the label is picked.
Color	outlineColor Gets or sets the outline color of this label.
int	outlineWidth Gets or sets the outline width of this label.
Cartesian2	pixelOffset Gets or sets the pixel offset in screen space from the origin of this label.
NearFarScalar	pixelOffsetScaleByDistance Gets or sets near and far pixel offset scaling properties of a Label based on the Label's distance from the camera.
Cartesian3	position Gets or sets the Cartesian position of this label.
double	scale Gets or sets the uniform scale that is multiplied with the label's size in pixels.
NearFarScalar	scaleByDistance Gets or sets near and far scaling properties of a Label based on the label's distance from the camera.
boolean	show Determines if this label will be shown.
Number	style Gets or sets the style of this label.
String	text Gets or sets the text of this label.
NearFarScalar	translucencyByDistance Gets or sets near and far translucency properties of a Label based on the Label's distance from the camera.
Number	verticalOrigin Gets or sets the vertical origin of this label, which determines if the label is to the above, below, or at the center of its position.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Label() A Label draws viewport-aligned text positioned in the 3D scene.

Method Summary

Modifier and Type	Method and Description
Cartesian2	computeScreenSpacePosition(Scene scene, Cartesian2 result) Computes the screen-space position of the label's origin, taking into account eye and pixel offsets.
boolean	equals(Label other) Determines if this label equals another label.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enableRightToLeftDetection

@JsProperty
public static boolean enableRightToLeftDetection

Determines whether or not run the algorithm, that match the text of the label to right-to-left languages Default: false

backgroundColor

@JsProperty
public Color backgroundColor

Gets or sets the background color of this label. Default: new Color(0.165, 0.165, 0.165, 0.8)

backgroundPadding

@JsProperty
public Cartesian2 backgroundPadding

Gets or sets the background padding, in pixels, of this label. The x value controls horizontal padding, and the y value controls vertical padding. Default: new Cartesian2(7, 5)

disableDepthTestDistance

@JsProperty
public double disableDepthTestDistance

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. Default: 0.0

distanceDisplayCondition

@JsProperty
public DistanceDisplayCondition distanceDisplayCondition

Gets or sets the condition specifying at what distance from the camera that this label will be displayed. Default: undefined

eyeOffset

@JsProperty
public Cartesian3 eyeOffset

Gets and sets the 3D Cartesian offset applied to this label 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. Eye coordinates use the same scale as world and model coordinates, which is typically meters. An eye offset is commonly used to arrange multiple label 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.

fillColor

@JsProperty
public Color fillColor

Gets or sets the fill color of this label.

See Also:

HTML canvas 2D context fill and stroke styles

font

@JsProperty
public String font

Gets or sets the font used to draw this label. Fonts are specified using the same syntax as the CSS 'font' property.

See Also:

HTML canvas 2D context text styles

heightReference

@JsProperty
public int heightReference

Gets or sets the height reference of this billboard.

See Also:

HeightReference

horizontalOrigin

@JsProperty
public Number horizontalOrigin

Gets or sets the horizontal origin of this label, which determines if the label is drawn to the left, center, or right of its position.

See Also:

HorizontalOrigin

id

@JsProperty
public Object id

Gets or sets the user-defined object returned when the label is picked.

outlineColor

@JsProperty
public Color outlineColor

Gets or sets the outline color of this label.

See Also:

HTML canvas 2D context fill and stroke styles

outlineWidth

@JsProperty
public int outlineWidth

Gets or sets the outline width of this label.

See Also:

HTML canvas 2D context fill and stroke styles

pixelOffset

@JsProperty
public Cartesian2 pixelOffset

Gets or sets the pixel offset in screen space from the origin of this label. This is commonly used to align multiple labels and billboards at the same position, e.g., an imagery 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.

pixelOffsetScaleByDistance

@JsProperty
public NearFarScalar pixelOffsetScaleByDistance

Gets or sets near and far pixel offset scaling properties of a Label based on the Label's distance from the camera. A label's pixel offset will be scaled between the NearFarScalar#nearValue and NearFarScalar#farValue while the camera distance falls within the upper and lower bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the label's pixel offset scaling remains clamped to the nearest bound. If undefined, pixelOffsetScaleByDistance will be disabled.

     Example:
     
     // Example 1.
     // Set a label's pixel offset scale to 0.0 when the
     // camera is 1500 meters from the label and scale pixel offset to 10.0 pixels
     // in the y direction the camera distance approaches 8.0e6 meters.
     text.pixelOffset = new Cartesian2(0.0, 1.0);
     text.pixelOffsetScaleByDistance = new NearFarScalar(1.5e2, 0.0, 8.0e6, 10.0);
     // Example 2.
     // disable pixel offset by distance
     text.pixelOffsetScaleByDistance = undefined;
     
 

position

@JsProperty
public Cartesian3 position

Gets or sets the Cartesian position of this label.

scale

@JsProperty
public double scale

Gets or sets the uniform scale that is multiplied with the label's size in pixels. A scale of 1.0 does not change the size of the label; a scale greater than 1.0 enlarges the label; a positive scale less than 1.0 shrinks the label. Applying a large scale value may pixelate the label. To make text larger without pixelation, use a larger font size when calling Label#font instead.

scaleByDistance

@JsProperty
public NearFarScalar scaleByDistance

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 upper and lower 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.

show

@JsProperty
public boolean show

Determines if this label will be shown. Use this to hide or show a label, instead of removing it and re-adding it to the collection.

style

public Number style

Gets or sets the style of this label.

See Also:

LabelStyle

text

@JsProperty
public String text

Gets or sets the text of this label.

translucencyByDistance

public NearFarScalar translucencyByDistance

Gets or sets near and far translucency properties of a Label based on the Label's distance from the camera. A label's translucency will interpolate between the NearFarScalar#nearValue and NearFarScalar#farValue while the camera distance falls within the upper and lower bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the label's translucency remains clamped to the nearest bound. If undefined, translucencyByDistance will be disabled.

verticalOrigin

@JsProperty
public Number verticalOrigin

Gets or sets the vertical origin of this label, which determines if the label is to the above, below, or at the center of its position.

See Also:

VerticalOrigin

Constructor Detail

Label

@JsConstructor
protected Label()

A Label draws viewport-aligned text positioned in the 3D scene. This constructor should not be used directly, instead create labels by calling LabelCollection.add(org.cesiumjs.cs.scene.options.LabelOptions).

See Also:

LabelCollection, LabelCollection.add(org.cesiumjs.cs.scene.options.LabelOptions)

Method Detail

computeScreenSpacePosition

@JsMethod
public Cartesian2 computeScreenSpacePosition(Scene scene,
                                                       Cartesian2 result)

Computes the screen-space position of the label's origin, taking into account eye and pixel offsets. 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.

Parameters:

scene - The scene the label is in.

result - The object onto which to store the result.

Returns:

The screen-space position of the label.

See Also:

eyeOffset, pixelOffset

equals

@JsMethod
public boolean equals(Label other)

Determines if this label equals another label. Labels are equal if all their properties are equal. Labels in different collections can be equal.

Parameters:

other - The label to compare for equality.

Returns:

true if the labels are equal; otherwise, false.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

True if this object was destroyed; otherwise, false.