Skip to content

KBE3D / KBCore / Cesium / Billboard / ConstructorOptions

接口: ConstructorOptions

Initialization options for the first param of Billboard constructor

属性

position

position: Cartesian3

The cartesian position of the billboard.


id?

optional id: any

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


show?

optional show: boolean

Determines if this billboard will be shown.


image?

optional image: string | HTMLCanvasElement | HTMLImageElement

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


scale?

optional scale: number

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


pixelOffset?

optional pixelOffset: Cartesian2

A Cartesian2 Specifying the pixel offset in screen space from the origin of this billboard.


eyeOffset?

optional eyeOffset: Cartesian3

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


horizontalOrigin?

optional horizontalOrigin: HorizontalOrigin

A HorizontalOrigin Specifying the horizontal origin of this billboard.


verticalOrigin?

optional verticalOrigin: VerticalOrigin

A VerticalOrigin Specifying the vertical origin of this billboard.


heightReference?

optional heightReference: HeightReference

A HeightReference Specifying the height reference of this billboard.


color?

optional color: Color

A Color Specifying the color that is multiplied with the billboard's texture.


rotation?

optional rotation: number

A number specifying the rotation angle in radians.


alignedAxis?

optional alignedAxis: Cartesian3

A Cartesian3 Specifying the aligned axis in world space.


sizeInMeters?

optional sizeInMeters: boolean

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


width?

optional width: number

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


height?

optional height: number

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


scaleByDistance?

optional scaleByDistance: NearFarScalar

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


translucencyByDistance?

optional translucencyByDistance: NearFarScalar

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


pixelOffsetScaleByDistance?

optional pixelOffsetScaleByDistance: NearFarScalar

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


imageSubRegion?

optional imageSubRegion: BoundingRectangle

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


distanceDisplayCondition?

optional distanceDisplayCondition: DistanceDisplayCondition

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


disableDepthTestDistance?

optional disableDepthTestDistance: number

The distance from the camera, beyond which, depth testing is disabled—to, for example, prevent clipping against terrain.


splitDirection?

optional splitDirection: SplitDirection

A SplitDirection Specifying the split property of the billboard.

KBE3D @3.0.0 Copyright © 2024-present KBE3D