Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* A renderable collection of labels. Labels are viewport-aligned text positioned in the 3D scene.
* Each label can have a different font, color, scale, etc.
*
* Labels are added and removed from the collection using [LabelCollection.add]
* and [LabelCollection.remove].
* ```
* // Create a label collection with two labels
* var labels = scene.primitives.add(new LabelCollection());
* labels.add({
* position : new Cartesian3(1.0, 2.0, 3.0),
* text : 'A label'
* });
* labels.add({
* position : new Cartesian3(4.0, 5.0, 6.0),
* text : 'Another label'
* });
* ```
* @see Online Documentation
*/
@JsName("\$cesium__LabelCollection")
external class LabelCollection(options: ConstructorOptions? = definedExternally) {
/**
* @property [modelMatrix] The 4x4 transformation matrix that transforms each label from model to world coordinates.
* Default value - [Matrix4.IDENTITY]
* @property [debugShowBoundingVolume] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
* Default value - `false`
* @property [scene] Must be passed in for labels that use the height reference property or will be depth tested against the globe.
* @property [blendOption] The label blending option. The default
* is used for rendering both opaque and translucent labels. However, if either all of the labels are completely opaque or all are completely translucent,
* setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve performance by up to 2x.
* Default value - [BlendOption.OPAQUE_AND_TRANSLUCENT]
* @property [show] Determines if the labels in the collection will be shown.
* Default value - `true`
*/
interface ConstructorOptions {
var modelMatrix: Matrix4?
var debugShowBoundingVolume: Boolean?
var scene: Scene?
var blendOption: BlendOption?
var show: Boolean?
}
/**
* Determines if labels in this collection will be shown.
* @see Online Documentation
*/
var show: Boolean
/**
* The 4x4 transformation matrix that transforms each label in this collection from model to world coordinates.
* When this is the identity matrix, the labels are drawn in world coordinates, i.e., Earth's WGS84 coordinates.
* Local reference frames can be used by providing a different transformation matrix, like that returned
* by [Transforms.eastNorthUpToFixedFrame].
* ```
* var center = Cartesian3.fromDegrees(-75.59777, 40.03883);
* labels.modelMatrix = Transforms.eastNorthUpToFixedFrame(center);
* labels.add({
* position : new Cartesian3(0.0, 0.0, 0.0),
* text : 'Center'
* });
* labels.add({
* position : new Cartesian3(1000000.0, 0.0, 0.0),
* text : 'East'
* });
* labels.add({
* position : new Cartesian3(0.0, 1000000.0, 0.0),
* text : 'North'
* });
* labels.add({
* position : new Cartesian3(0.0, 0.0, 1000000.0),
* text : 'Up'
* });
* ```
* @see Online Documentation
*/
var modelMatrix: Matrix4
/**
* This property is for debugging only; it is not for production use nor is it optimized.
*
* Draws the bounding sphere for each draw command in the primitive.
* @see Online Documentation
*/
var debugShowBoundingVolume: Boolean
/**
* The label blending option. The default is used for rendering both opaque and translucent labels.
* However, if either all of the labels are completely opaque or all are completely translucent,
* setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve
* performance by up to 2x.
* @see Online Documentation
*/
var blendOption: BlendOption
/**
* Returns the number of labels in this collection. This is commonly used with
* [LabelCollection.get] to iterate over all the labels
* in the collection.
* @see Online Documentation
*/
var length: Int
/**
* Creates and adds a label with the specified initial properties to the collection.
* The added label is returned so it can be modified or removed from the collection later.
* ```
* // Example 1: Add a label, specifying all the default values.
* var l = labels.add({
* show : true,
* position : Cartesian3.ZERO,
* text : '',
* font : '30px sans-serif',
* fillColor : Color.WHITE,
* outlineColor : Color.BLACK,
* outlineWidth : 1.0,
* showBackground : false,
* backgroundColor : new Color(0.165, 0.165, 0.165, 0.8),
* backgroundPadding : new Cartesian2(7, 5),
* style : LabelStyle.FILL,
* pixelOffset : Cartesian2.ZERO,
* eyeOffset : Cartesian3.ZERO,
* horizontalOrigin : HorizontalOrigin.LEFT,
* verticalOrigin : VerticalOrigin.BASELINE,
* scale : 1.0,
* translucencyByDistance : undefined,
* pixelOffsetScaleByDistance : undefined,
* heightReference : HeightReference.NONE,
* distanceDisplayCondition : undefined
* });
* ```
* ```
* // Example 2: Specify only the label's cartographic position,
* // text, and font.
* var l = labels.add({
* position : Cartesian3.fromRadians(longitude, latitude, height),
* text : 'Hello World',
* font : '24px Helvetica',
* });
* ```
* @param [options] A template describing the label's properties as shown in Example 1.
* @return The label that was added to the collection.
* @see Online Documentation
*/
fun add(options: Any? = definedExternally): Label
/**
* Removes a label from the collection. Once removed, a label is no longer usable.
* ```
* var l = labels.add(...);
* labels.remove(l); // Returns true
* ```
* @param [label] The label to remove.
* @return `true` if the label was removed; `false` if the label was not found in the collection.
* @see Online Documentation
*/
fun remove(label: Label): Boolean
/**
* Removes all labels from the collection.
* ```
* labels.add(...);
* labels.add(...);
* labels.removeAll();
* ```
* @see Online Documentation
*/
fun removeAll()
/**
* Check whether this collection contains a given label.
* @param [label] The label to check for.
* @return true if this collection contains the label, false otherwise.
* @see Online Documentation
*/
fun contains(label: Label): Boolean
/**
* Returns the label in the collection at the specified index. Indices are zero-based
* and increase as labels are added. Removing a label shifts all labels after
* it to the left, changing their indices. This function is commonly used with
* [LabelCollection.length] to iterate over all the labels
* in the collection.
* ```
* // Toggle the show property of every label in the collection
* var len = labels.length;
* for (var i = 0; i < len; ++i) {
* var l = billboards.get(i);
* l.show = !l.show;
* }
* ```
* @param [index] The zero-based index of the billboard.
* @return The label at the specified index.
* @see Online Documentation
*/
fun get(index: Int): Label
/**
* 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.
* @return True if this object was destroyed; otherwise, false.
* @see Online Documentation
*/
fun isDestroyed(): Boolean
/**
* Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
* release of WebGL resources, instead of relying on the garbage collector to destroy this object.
*
* Once an object is destroyed, it should not be used; calling any function other than
* `isDestroyed` will result in a [DeveloperError] exception. Therefore,
* assign the return value (`undefined`) to the object as done in the example.
* ```
* labels = labels && labels.destroy();
* ```
* @see Online Documentation
*/
fun destroy()
}
