BufferPolygonCollection
BufferPolygonCollection is a high-performance collection of buffer polygon primitives (experimental).
It can have BufferPolygon components as children.
This is a low-level primitive API for rendering large numbers of polygons efficiently. Note: This API is experimental and subject to change without standard deprecation.
- Cesium element: BufferPolygonCollection
- Example: BufferPolygonCollection
Availability
Section titled “Availability”Inside Viewer or CesiumWidget component. A BufferPolygonCollection object will be attached to the PrimitiveCollection of the Viewer or CesiumWidget.
Properties
Section titled “Properties”Cesium properties
Section titled “Cesium properties”| Property | Type | Description |
|---|---|---|
| show | boolean | |
| debugShowBoundingVolume | boolean |
Cesium read-only properties
Section titled “Cesium read-only properties”| Property | Type | Description |
|---|---|---|
| primitiveCountMax | number | undefined | The maximum number of polygons this collection can hold. Fixed at creation time. |
| vertexCountMax | number | undefined | The maximum number of vertices across all polygons in this collection. Fixed at creation time. |
| holeCountMax | number | undefined | The maximum number of holes across all polygons in this collection. Fixed at creation time. |
| triangleCountMax | number | undefined | The maximum number of triangles across all polygons in this collection. Fixed at creation time. |
| positionDatatype | ComponentDatatype | undefined | The component datatype for position data. Fixed at creation time. |
| allowPicking | boolean | undefined | Whether primitives in the collection can be picked. Fixed at creation time. |
| modelMatrix | Matrix4 | undefined | Model-to-world transform applied to every polygon. Fixed at creation time — Cesium 1.141 made the property readonly post-construction. To animate, hold a ref and mutate the Matrix4 in place via Matrix4.clone(next, current). |
| boundingVolume | BoundingSphere | undefined | Precomputed bounding volume. Interpreted in world space (Cesium 1.142+); apply the same modelMatrix to the bounding volume that you apply to the polygons. Fixed at creation time. |
| blendOption | BlendOption | undefined | Blending mode for the collection. Pair with an alpha-aware BufferPrimitiveMaterial to render translucent polygons. Fixed at creation time. |
| heightReference | HeightReference | undefined | When set to a clamping value, the whole collection is draped onto terrain and/or 3D Tiles (Cesium 1.145+) instead of being drawn as geometry of its own. CLAMP_TO_TERRAIN drapes onto terrain, CLAMP_TO_3D_TILE onto 3D Tiles, and CLAMP_TO_GROUND onto both. Fixed at creation time. |
Cesium events
Section titled “Cesium events”N/A
Other properties
Section titled “Other properties”| Property | Type | Description |
|---|---|---|
| children | ReactNode |