org.cesiumjs.cs.datasources.graphics

Class BillboardGraphics

java.lang.Object

org.cesiumjs.cs.datasources.graphics.BillboardGraphics

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Property	alignedAxis Gets or sets the Cartesian3 Property specifying the unit vector axis of rotation in the fixed frame.
Property	color Gets or sets the Property specifying the Color that is multiplied with the imagery.
Property	disableDepthTestDistance Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
Property	distanceDisplayCondition Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this billboard will be displayed.
Property	eyeOffset Gets or sets the Cartesian3 Property specifying the billboard's offset in eye coordinates.
Property	height Gets or sets the numeric Property specifying the height of the billboard in pixels.
Property	heightReference Gets or sets the Property specifying the HeightReference.
Property	horizontalOrigin Gets or sets the Property specifying the HorizontalOrigin.
Property	image Gets or sets the Property specifying the Image, URI, or Canvas to use for the billboard.
Property	imageSubRegion Gets or sets the Property specifying a BoundingRectangle that defines a sub-region of the imagery to use for the billboard, rather than the entire imagery, measured in pixels from the bottom-left.
Property	pixelOffset Gets or sets the Cartesian2 Property specifying the billboard's pixel offset in screen space from the origin of this billboard.
Property	pixelOffsetScaleByDistance Gets or sets NearFarScalar Property specifying the pixel offset of the billboard based on the distance from the camera.
Property	rotation Gets or sets the numeric Property specifying the rotation of the imagery counter clockwise from the alignedAxis.
Property	scale Gets or sets the numeric Property specifying the uniform scale to apply to the imagery.
Property	scaleByDistance Gets or sets NearFarScalar Property specifying the scale of the billboard based on the distance from the camera.
Property	show Gets or sets the boolean Property specifying the visibility of the billboard.
Property	sizeInMeters Gets or sets the boolean Property specifying if this billboard's size will be measured in meters.
Property	translucencyByDistance Gets or sets NearFarScalar Property specifying the translucency of the billboard based on the distance from the camera.
Property	verticalOrigin Gets or sets the Property specifying the VerticalOrigin.
Property	width Gets or sets the numeric Property specifying the billboard's width in pixels.

Constructor Summary

Constructors

Constructor and Description
BillboardGraphics()
BillboardGraphics(BillboardGraphicsOptions options)

Method Summary

Modifier and Type	Method and Description
BillboardGraphics	clone() Duplicates this instance.
BillboardGraphics	clone(BillboardGraphics result) Duplicates this instance.
Event	definitionChanged() Gets the event that is raised whenever a property or sub-property is changed or modified.
void	merge(BillboardGraphics source) Assigns each unassigned property on this object to the value of the same property on the provided source object.

Methods inherited from class java.lang.Object

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

Field Detail

alignedAxis

@JsProperty
public Property alignedAxis

Gets or sets the Cartesian3 Property specifying the unit vector axis of rotation in the fixed frame. When set to Cartesian3.ZERO the rotation is from the top of the screen. Default: Cartesian3.ZERO()

color

@JsProperty
public Property color

Gets or sets the Property specifying the Color that is multiplied with the imagery. This has two common use cases. First, the same white texture may be used by many different billboards, each with a different color, to create colored billboards. Second, the color's alpha component can be used to make the billboard translucent as shown below. An alpha of 0.0 makes the billboard transparent, and 1.0 makes the billboard opaque. Default: Color.WHITE()

disableDepthTestDistance

@JsProperty
public Property 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 Property distanceDisplayCondition

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this billboard will be displayed.

eyeOffset

@JsProperty
public Property eyeOffset

Gets or sets the Cartesian3 Property specifying the billboard'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 billboards or objects at the same position, e.g., to arrange a billboard above its corresponding 3D model. Below, the billboard 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. Default: Cartesian3.ZERO()

height

@JsProperty
public Property height

Gets or sets the numeric Property specifying the height of the billboard in pixels. When undefined, the native height is used.

heightReference

@JsProperty
public Property heightReference

Gets or sets the Property specifying the HeightReference. Default: HeightReference.NONE()

horizontalOrigin

@JsProperty
public Property horizontalOrigin

Gets or sets the Property specifying the HorizontalOrigin. Default: HorizontalOrigin.CENTER()

image

@JsProperty
public Property image

Gets or sets the Property specifying the Image, URI, or Canvas to use for the billboard.

imageSubRegion

@JsProperty
public Property imageSubRegion

Gets or sets the Property specifying a BoundingRectangle that defines a sub-region of the imagery to use for the billboard, rather than the entire imagery, measured in pixels from the bottom-left.

pixelOffset

@JsProperty
public Property pixelOffset

Gets or sets the Cartesian2 Property specifying the billboard's pixel offset in screen space from the origin of this billboard. This is commonly used to align multiple billboards and labels 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. Default Value: Cartesian2.ZERO()

pixelOffsetScaleByDistance

@JsProperty
public Property pixelOffsetScaleByDistance

Gets or sets NearFarScalar Property specifying the pixel offset of the billboard based on the distance from the camera. A billboard's pixel offset 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 billboard's pixel offset remains clamped to the nearest bound.

rotation

@JsProperty
public Property rotation

Gets or sets the numeric Property specifying the rotation of the imagery counter clockwise from the alignedAxis. Default Value: 0

scale

@JsProperty
public Property scale

Gets or sets the numeric Property specifying the uniform scale to apply to the imagery. A scale greater than 1.0 enlarges the billboard while a scale less than 1.0 shrinks it. Default: 1.0

scaleByDistance

@JsProperty
public Property scaleByDistance

Gets or sets NearFarScalar Property specifying the scale of the billboard based on the distance from the camera. A billboard'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 billboard's scale remains clamped to the nearest bound.

show

@JsProperty
public Property show

Gets or sets the boolean Property specifying the visibility of the billboard. Default: true

sizeInMeters

@JsProperty
public Property sizeInMeters

Gets or sets the boolean Property specifying if this billboard's size will be measured in meters. Default: false

translucencyByDistance

@JsProperty
public Property translucencyByDistance

Gets or sets NearFarScalar Property specifying the translucency of the billboard based on the distance from the camera. A billboard'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 billboard's translucency remains clamped to the nearest bound.

verticalOrigin

@JsProperty
public Property verticalOrigin

Gets or sets the Property specifying the VerticalOrigin. Default: VerticalOrigin.CENTER()

width

@JsProperty
public Property width

Gets or sets the numeric Property specifying the billboard's width in pixels. When undefined, the native width is used.

Constructor Detail

BillboardGraphics

@JsConstructor
public BillboardGraphics()

BillboardGraphics

@JsConstructor
public BillboardGraphics(BillboardGraphicsOptions options)

Method Detail

definitionChanged

@JsProperty(name="definitionChanged")
public Event definitionChanged()

Gets the event that is raised whenever a property or sub-property is changed or modified.

clone

@JsMethod
public BillboardGraphics clone()

Duplicates this instance.

Overrides:

clone in class Object

Returns:

The modified result parameter or a new instance if one was not provided.

clone

@JsMethod
public BillboardGraphics clone(BillboardGraphics result)

Duplicates this instance.

Parameters:

result - The object onto which to store the result.

Returns:

The modified result parameter or a new instance if one was not provided.

merge

@JsMethod
public void merge(BillboardGraphics source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Parameters:

source - The object to be merged into this object.