Interface ICesiumBillboardExt
Hierarchy
- BillboardGraphics
- ICesiumBillboardExt
Index
Properties
Methods
Properties
Optional _billboard
aligned
color
Gets or sets the Property specifying the Color that is multiplied with the image.
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 |
alpha : 0.5 |
Readonly definition
Gets the event that is raised whenever a property or sub-property is changed or modified.
Type declaration
-
- (...args): void
-
Parameters
-
Rest...args: any[]
Returns void
-
disable
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.
distance
Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this billboard will be displayed.
eye
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.
 |
 |
b.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);
height
Gets or sets the numeric Property specifying the height of the billboard in pixels. When undefined, the native height is used.
height
Gets or sets the Property specifying the HeightReference.
horizontal
Gets or sets the Property specifying the HorizontalOrigin.
image
Gets or sets the Property specifying the Image, URI, or Canvas to use for the billboard.
image
Gets or sets the Property specifying a BoundingRectangle that defines a
sub-region of the image to use for the billboard, rather than the entire image,
measured in pixels from the bottom-left.
pixel
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 image 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 |
b.pixeloffset = new Cartesian2(50, 25); |
pixel
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 lower and upper 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
Gets or sets the numeric Property specifying the rotation of the image
counter clockwise from the alignedAxis.
scale
Gets or sets the numeric Property specifying the uniform scale to apply to the image.
A scale greater than 1.0 enlarges the billboard while a scale less than 1.0 shrinks it.
From left to right in the above image, the scales are
0.5, 1.0, and 2.0.
scale
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 lower and upper bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the billboard's scale remains clamped to the nearest bound.
show
Gets or sets the boolean Property specifying the visibility of the billboard.
size
Gets or sets the boolean Property specifying if this billboard's size will be measured in meters.
translucency
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 lower and upper bounds of the specified NearFarScalar#near and NearFarScalar#far. Outside of these ranges the billboard's translucency remains clamped to the nearest bound.
vertical
Gets or sets the Property specifying the VerticalOrigin.
width
Gets or sets the numeric Property specifying the width of the billboard in pixels. When undefined, the native width is used.
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.