Billboard

new Cesium.Billboard ()

Scene/Billboard.js 55

位于 3D 场景中的视口对齐图像，使用 BillboardCollection 创建和渲染。创建一个广告牌，并通过调用 BillboardCollection#add 设置其初始属性。

示例广告牌

Performance:

读取一个属性，例如 Billboard#show ，是一个常数时间。分配给属性是恒定的时间，但在调用 BillboardCollection#update 时会导致 CPU 到 GPU 的流量。无论更新了多少属性，每个广告牌的流量都是相同的。如果集合中的大多数广告牌需要更新，使用 BillboardCollection#removeAll 清除集合并添加新广告牌而不是修改每个广告牌可能会更有效。

Throws:

• DeveloperError : scaleByDistance.far 必须大于 scaleByDistance.near
• DeveloperError : translucencyByDistance.far 必须大于 translucencyByDistance.near
• DeveloperError : pixelOffsetScaleByDistance.far 必须大于 pixelOffsetScaleByDistance.near
• DeveloperError : distanceDisplayCondition.far 必须大于 distanceDisplayCondition.near

Demo:

• Cesium Sandcastle Billboard Demo

See:

• BillboardCollection
• BillboardCollection#add
• Label

Members

Examples:

// Example 1.
// Have the billboard up vector point north
billboard.alignedAxis = Cesium.Cartesian3.UNIT_Z;

// Example 2.
// Have the billboard point east.
billboard.alignedAxis = Cesium.Cartesian3.UNIT_Z;
billboard.rotation = -Cesium.Math.PI_OVER_TWO;

// Example 3.
// Reset the aligned axis
billboard.alignedAxis = Cesium.Cartesian3.ZERO;

获取或设置与广告牌纹理相乘的颜色。这有两个常见的用例。首先，许多不同的广告牌可以使用相同的白色纹理，每个广告牌都有不同的颜色，以创建彩色广告牌。其次，颜色的 alpha 分量可用于使广告牌半透明，如下所示。 alpha 为 0.0 使广告牌透明，而 1.0 使广告牌不透明。

default

alpha : 0.5

红色、绿色、蓝色和 alpha 值由 value 的 red 、 green 、 blue 和 alpha 属性表示，如示例 1 所示。这些分量的范围从 0.0 （无强度）到 1.0 （全强度）。

Examples:

// Example 1. Assign yellow.
b.color = Cesium.Color.YELLOW;

// Example 2. Make a billboard 50% translucent.
b.color = new Cesium.Color(1.0, 1.0, 1.0, 0.5);

Default Value: undefined

获取或设置在眼睛坐标中应用于此广告牌的 3D 笛卡尔偏移。眼睛坐标是左手坐标系，其中 x 指向观看者的右侧， y 指向上方， z 指向屏幕内。眼睛坐标使用与世界和模型坐标相同的比例，通常为米。

眼睛偏移通常用于将多个广告牌或对象布置在同一位置，例如，将广告牌布置在其对应的 3D 模型上方。

下面，广告牌位于地球的中心，但视线偏移使其始终出现在地球顶部，无论观看者或地球的方向如何。

b.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);

Default Value: HeightReference.NONE

获取或设置此广告牌的水平原点，确定广告牌是在其锚点位置的左侧、中心还是右侧。

Example:

// Use a bottom, left origin
b.horizontalOrigin = Cesium.HorizontalOrigin.LEFT;
b.verticalOrigin = Cesium.VerticalOrigin.BOTTOM;

Example:

// load an image from a URL
b.image = 'some/image/url.png';

// assuming b1 and b2 are billboards in the same billboard collection,
// use the same image for both billboards.
b2.image = b1.image;

获取或设置屏幕空间中相对于该广告牌原点的像素偏移量。这通常用于在同一位置对齐多个广告牌和标签，例如图像和文本。屏幕空间原点是画布的左上角； x 从左到右增加， y 从上到下增加。

default

b.pixeloffset = new Cartesian2(50, 25);

广告牌的原点由黄点指示。

Examples:

// Example 1.
// Set a billboard's pixel offset scale to 0.0 when the
// camera is 1500 meters from the billboard and scale pixel offset to 10.0 pixels
// in the y direction the camera distance approaches 8.0e6 meters.
b.pixelOffset = new Cesium.Cartesian2(0.0, 1.0);
b.pixelOffsetScaleByDistance = new Cesium.NearFarScalar(1.5e2, 0.0, 8.0e6, 10.0);

// Example 2.
// disable pixel offset by distance
b.pixelOffsetScaleByDistance = undefined;

Default Value: false

获取或设置与广告牌图像大小相乘的统一比例（以像素为单位）。 1.0 的比例不会改变广告牌的大小；大于 1.0 的比例会放大广告牌；小于 1.0 的正比例会缩小广告牌。

上图中从左到右，比例分别为 0.5 、 1.0 和 2.0 。

Examples:

// Example 1.
// Set a billboard's scaleByDistance to scale by 1.5 when the
// camera is 1500 meters from the billboard and disappear as
// the camera distance approaches 8.0e6 meters.
b.scaleByDistance = new Cesium.NearFarScalar(1.5e2, 1.5, 8.0e6, 0.0);

// Example 2.
// disable scaling by distance
b.scaleByDistance = undefined;

Default Value: true

Default Value: false

Examples:

// Example 1.
// Set a billboard's translucency to 1.0 when the
// camera is 1500 meters from the billboard and disappear as
// the camera distance approaches 8.0e6 meters.
b.translucencyByDistance = new Cesium.NearFarScalar(1.5e2, 1.0, 8.0e6, 0.0);

// Example 2.
// disable translucency by distance
b.translucencyByDistance = undefined;

获取或设置此广告牌的垂直原点，确定广告牌是在其锚点位置的上方、下方还是中心。

Example:

// Use a bottom, left origin
b.horizontalOrigin = Cesium.HorizontalOrigin.LEFT;
b.verticalOrigin = Cesium.VerticalOrigin.BOTTOM;

Methods

Returns:

Throws:

• DeveloperError : 广告牌必须在一个集合中。

Example:

console.log(b.computeScreenSpacePosition(scene).toString());

See:

• Billboard#eyeOffset
• Billboard#pixelOffset

Returns:

Example:

// create a billboard image dynamically
function drawImage(id) {
  // create and draw an image using a canvas
  const canvas = document.createElement('canvas');
  const context2D = canvas.getContext('2d');
  // ... draw image
  return canvas;
}
// drawImage will be called to create the texture
b.setImage('myImage', drawImage);

// subsequent billboards created in the same collection using the same id will use the existing
// texture, without the need to create the canvas or draw the image
b2.setImage('myImage', drawImage);

Throws:

• RuntimeError : 带有 id 的图像必须在图集中

Type Definitions

Returns: