Describes a two dimensional icon located at the position of the containing
Example billboards
Entity.
Example billboards
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
Object with the following properties:
|
Members
-
alignedAxis : Property
-
Gets or sets the
Cartesian3Property 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 Value:
Cartesian3.ZERO -
Gets or sets the Property specifying the
Colorthat is multiplied with theimage. 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 of0.0makes the billboard transparent, and1.0makes the billboard opaque.default
alpha : 0.5
-
Default Value:
Color.WHITE -
readonlydefinitionChanged : Event
-
Gets the event that is raised whenever a property or sub-property is changed or modified.
-
disableDepthTestDistance : Property
-
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.
-
distanceDisplayCondition : Property
-
Gets or sets the
DistanceDisplayConditionProperty specifying at what distance from the camera that this billboard will be displayed. -
eyeOffset : Property
-
Gets or sets the
Cartesian3Property specifying the billboard's offset in eye coordinates. Eye coordinates is a left-handed coordinate system, wherexpoints towards the viewer's right,ypoints up, andzpoints 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);-
Default Value:
Cartesian3.ZERO -
Gets or sets the numeric Property specifying the height of the billboard in pixels. When undefined, the native height is used.
-
heightReference : Property
-
Gets or sets the Property specifying the
HeightReference.-
Default Value:
HeightReference.NONE -
horizontalOrigin : Property
-
Gets or sets the Property specifying the
HorizontalOrigin.-
Default Value:
HorizontalOrigin.CENTER -
Gets or sets the Property specifying the Image, URI, or Canvas to use for the billboard.
-
imageSubRegion : Property
-
Gets or sets the Property specifying a
BoundingRectanglethat defines a sub-region of theimageto use for the billboard, rather than the entire image, measured in pixels from the bottom-left. -
pixelOffset : Property
-
Gets or sets the
Cartesian2Property 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;xincreases from left to right, andyincreases from top to bottom.
The billboard's origin is indicated by the yellow point.default
b.pixeloffset = new Cartesian2(50, 25);
-
Default Value:
Cartesian2.ZERO -
pixelOffsetScaleByDistance : Property
-
Gets or sets
NearFarScalarProperty specifying the pixel offset of the billboard based on the distance from the camera. A billboard's pixel offset will interpolate between theNearFarScalar#nearValueandNearFarScalar#farValuewhile the camera distance falls within the upper and lower bounds of the specifiedNearFarScalar#nearandNearFarScalar#far. Outside of these ranges the billboard's pixel offset remains clamped to the nearest bound. -
rotation : Property
-
Gets or sets the numeric Property specifying the rotation of the image counter clockwise from the
alignedAxis.-
Default Value:
0 -
Gets or sets the numeric Property specifying the uniform scale to apply to the image. A scale greater than
1.0enlarges the billboard while a scale less than1.0shrinks it.
From left to right in the above image, the scales are0.5,1.0, and2.0.-
Default Value:
1.0 -
scaleByDistance : Property
-
Gets or sets
NearFarScalarProperty specifying the scale of the billboard based on the distance from the camera. A billboard's scale will interpolate between theNearFarScalar#nearValueandNearFarScalar#farValuewhile the camera distance falls within the upper and lower bounds of the specifiedNearFarScalar#nearandNearFarScalar#far. Outside of these ranges the billboard's scale remains clamped to the nearest bound. -
Gets or sets the boolean Property specifying the visibility of the billboard.
-
Default Value:
true -
sizeInMeters : Property
-
Gets or sets the boolean Property specifying if this billboard's size will be measured in meters.
-
Default Value:
false -
translucencyByDistance : Property
-
Gets or sets
NearFarScalarProperty specifying the translucency of the billboard based on the distance from the camera. A billboard's translucency will interpolate between theNearFarScalar#nearValueandNearFarScalar#farValuewhile the camera distance falls within the upper and lower bounds of the specifiedNearFarScalar#nearandNearFarScalar#far. Outside of these ranges the billboard's translucency remains clamped to the nearest bound. -
verticalOrigin : Property
-
Gets or sets the Property specifying the
VerticalOrigin.-
Default Value:
VerticalOrigin.CENTER -
Gets or sets the numeric Property specifying the billboard's width in pixels. When undefined, the native width is used.
Methods
-
clone(result) → BillboardGraphics
-
Duplicates this instance.
Name Type Description resultBillboardGraphics optional The object onto which to store the result. Returns:
The modified result parameter or a new instance if one was not provided. -
Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description sourceBillboardGraphics The object to be merged into this object.