kotlin-cesium-engine/cesium.engine/Billboard/ConstructorOptions

ConstructorOptions

interface ConstructorOptions(source)

Initialization options for the first param of Billboard constructor

See also

Properties

Link copied to clipboard
abstract val alignedAxis: Cartesian3?

A Cartesian3 Specifying the aligned axis in world space. Default value - Cartesian3.ZERO

Link copied to clipboard
abstract val color: Color?

A Color Specifying the color that is multiplied with the billboard's texture. Default value - Color.WHITE

Link copied to clipboard
abstract val disableDepthTestDistance: Double?

A number specifying the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.

Link copied to clipboard
abstract val distanceDisplayCondition: DistanceDisplayCondition?

A DistanceDisplayCondition Specifying the distance from the camera at which this billboard will be displayed.

Link copied to clipboard
abstract val eyeOffset: Cartesian3?

A Cartesian3 Specifying the 3D Cartesian offset applied to this billboard in eye coordinates. Default value - Cartesian3.ZERO

Link copied to clipboard
abstract val height: Double?

A number specifying the height of the billboard. If undefined, the image height will be used.

Link copied to clipboard
abstract val heightReference: HeightReference?

A HeightReference Specifying the height reference of this billboard. Default value - HeightReference.NONE

Link copied to clipboard
abstract val horizontalOrigin: HorizontalOrigin?

A HorizontalOrigin Specifying the horizontal origin of this billboard. Default value - HorizontalOrigin.CENTER

Link copied to clipboard
abstract val id: Any?

A user-defined object to return when the billboard is picked with Scene.pick.

Link copied to clipboard
abstract val image: <Error class: unknown class>?

A loaded HTMLImageElement, ImageData, or a url to an image to use for the billboard.

Link copied to clipboard
abstract val imageSubRegion: BoundingRectangle?

A BoundingRectangle Specifying the sub-region of the image to use for the billboard, rather than the entire image.

Link copied to clipboard
abstract val pixelOffset: Cartesian2?

A Cartesian2 Specifying the pixel offset in screen space from the origin of this billboard. Default value - Cartesian2.ZERO

Link copied to clipboard
abstract val pixelOffsetScaleByDistance: NearFarScalar?

A NearFarScalar Specifying near and far pixel offset scaling properties of a Billboard based on the billboard's distance from the camera.

Link copied to clipboard
abstract val position: Cartesian3

The cartesian position of the billboard.

Link copied to clipboard
abstract val rotation: Double?

A number specifying the rotation angle in radians. Default value - 0

Link copied to clipboard
abstract val scale: Double?

A number specifying the uniform scale that is multiplied with the billboard's image size in pixels. Default value - 1.0

Link copied to clipboard
abstract val scaleByDistance: NearFarScalar?

A NearFarScalar Specifying near and far scaling properties of a Billboard based on the billboard's distance from the camera.

Link copied to clipboard
abstract val show: Boolean?

Determines if this billboard will be shown. Default value - true

Link copied to clipboard
abstract val sizeInMeters: Boolean?

A boolean specifying if the billboard size is in meters or pixels.

Link copied to clipboard
abstract val splitDirection: SplitDirection?

A SplitDirection Specifying the split property of the billboard.

Link copied to clipboard
abstract val translucencyByDistance: NearFarScalar?

A NearFarScalar Specifying near and far translucency properties of a Billboard based on the billboard's distance from the camera.

Link copied to clipboard
abstract val verticalOrigin: VerticalOrigin?

A VerticalOrigin Specifying the vertical origin of this billboard. Default value - VerticalOrigin.CENTER

Link copied to clipboard
abstract val width: Double?

A number specifying the width of the billboard. If undefined, the image width will be used.