Class FeatureConverter

Constructors

constructor

new FeatureConverter(scene: Scene): FeatureConverter
Api
Concrete base class for converting from OpenLayers3 vectors to Cesium primitives. Extending this class is possible provided that the extending class and the library are compiled together by the closure compiler.
Parameters
- scene: Scene
  Cesium scene.
Returns FeatureConverter
- Defined in FeatureConverter.ts:138

Properties

`Protected`scene

scene: Scene

Cesium scene.

Methods

`Protected`addTextStyle

addTextStyle(
    layer: PrimitiveLayer,
    feature: Feature,
    geometry: Geometry,
    style: Style,
    primitive: Primitive | PrimitiveCollection | GroundPolylinePrimitive,
): PrimitiveCollection
Create a Cesium primitive if style has a text component. Eventually return a PrimitiveCollection including current primitive.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- geometry: Geometry
- style: Style
- primitive: Primitive | PrimitiveCollection | GroundPolylinePrimitive
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:399

computePlainStyle

computePlainStyle(
    layer: PrimitiveLayer,
    feature: Feature,
    fallbackStyleFunction: StyleFunction,
    resolution: number,
): Style[]
Api
Compute OpenLayers plain style. Evaluates style function, blend arrays, get default style.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- fallbackStyleFunction: StyleFunction
- resolution: number
Returns Style[]
- Defined in FeatureConverter.ts:1280

convert

convert(
    layer: VectorLayer<any>,
    view: View,
    feature: Feature,
    context: OlFeatureToCesiumContext,
): PrimitiveCollection
Api
Convert an OpenLayers feature to Cesium primitive collection.
Parameters
- layer: VectorLayer<any>
- view: View
- feature: Feature
- context: OlFeatureToCesiumContext
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:1574

createBillboardFromImage

createBillboardFromImage(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: Point,
    projection: ProjectionLike,
    style: Style,
    imageStyle: ImageStyle,
    billboards: BillboardCollection,
    opt_newBillboardCallback: (bb: Billboard) => void,
): void
Api
Convert a point geometry to a Cesium BillboardCollection.
Parameters
- layer: PrimitiveLayer
- feature: Feature
  OpenLayers feature..
- olGeometry: Point
  OpenLayers point geometry.
- projection: ProjectionLike
- style: Style
- imageStyle: ImageStyle
- billboards: BillboardCollection
- opt_newBillboardCallback: (bb: Billboard) => void
  Called when the new billboard is added.
Returns void
- Defined in FeatureConverter.ts:826

`Protected`createColoredPrimitive

createColoredPrimitive(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: Geometry,
    geometry: Geometry | CircleGeometry,
    color: Color | ImageMaterialProperty,
    opt_lineWidth?: number,
): Primitive | GroundPrimitive
Basics primitive creation using a color attribute. Note that Cesium has 'interior' and outline geometries.
Parameters
- layer: PrimitiveLayer
- feature: Feature
  OpenLayers feature.
- olGeometry: Geometry
  OpenLayers geometry.
- geometry: Geometry | CircleGeometry
- color: Color | ImageMaterialProperty
- Optionalopt_lineWidth: number
Returns Primitive | GroundPrimitive
primitive
- Defined in FeatureConverter.ts:198

csAddBillboard

csAddBillboard(
    billboards: BillboardCollection,
    bbOptions: ConstructorOptions,
    layer: PrimitiveLayer,
    feature: Feature,
    geometry: Geometry,
    style: Style,
): Billboard
Api
Add a billboard to a Cesium.BillboardCollection. Overriding this wrapper allows manipulating the billboard options.
Parameters
- billboards: BillboardCollection
- bbOptions: ConstructorOptions
- layer: PrimitiveLayer
- feature: Feature
  OpenLayers feature.
- geometry: Geometry
- style: Style
Returns Billboard
newly created billboard
- Defined in FeatureConverter.ts:443

`Protected`extractColorFromOlStyle

extractColorFromOlStyle(
style: Style | Text,
outline: boolean,
): Color | ImageMaterialProperty
Return the fill or stroke color from a plain ol style.
Parameters
- style: Style | Text
- outline: boolean
Returns Color | ImageMaterialProperty
- Defined in FeatureConverter.ts:305

`Protected`extractLineWidthFromOlStyle

extractLineWidthFromOlStyle(style: Style | Text): number
Return the width of stroke from a plain ol style.
Parameters
- style: Style | Text
Returns number
- Defined in FeatureConverter.ts:327

`Protected`getGeometryFromFeature

getGeometryFromFeature(
    feature: Feature,
    style: Style,
    opt_geom?: Geometry,
): Geometry
Parameters
- feature: Feature
- style: Style
- Optionalopt_geom: Geometry
Returns Geometry
- Defined in FeatureConverter.ts:1321

getHeightReference

getHeightReference(
    layer: PrimitiveLayer,
    feature: Feature,
    geometry: Geometry,
): HeightReference
Api
Parameters
- layer: PrimitiveLayer
- feature: Feature
- geometry: Geometry
Returns HeightReference
- Defined in FeatureConverter.ts:786

olCircleGeometryToCesium

olCircleGeometryToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: Circle,
    projection: ProjectionLike,
    olStyle: Style,
): PrimitiveCollection
Api
Convert an OpenLayers circle geometry to Cesium.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- olGeometry: Circle
- projection: ProjectionLike
- olStyle: Style
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:468

olFeatureToCesium

olFeatureToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    style: Style,
    context: OlFeatureToCesiumContext,
    opt_geom?: Geometry,
): PrimitiveCollection
Api
Convert one OpenLayers feature up to a collection of Cesium primitives.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- style: Style
- context: OlFeatureToCesiumContext
- Optionalopt_geom: Geometry
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:1354

olGeometry4326TextPartToCesium

olGeometry4326TextPartToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    geometry: Geometry,
    style: Text,
): LabelCollection
Api
Convert an OpenLayers text style to Cesium.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- geometry: Geometry
- style: Text
Returns LabelCollection
- Defined in FeatureConverter.ts:1142

olLineStringGeometryToCesium

olLineStringGeometryToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: LineString,
    projection: ProjectionLike,
    olStyle: Style,
): PrimitiveCollection
Api
Convert an OpenLayers line string geometry to Cesium.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- olGeometry: LineString
- projection: ProjectionLike
- olStyle: Style
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:559

olMultiGeometryToCesium

olMultiGeometryToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    geometry: Geometry,
    projection: ProjectionLike,
    olStyle: Style,
    billboards: BillboardCollection,
    opt_newBillboardCallback: (bb: Billboard) => void,
): PrimitiveCollection
Api
Convert an OpenLayers multi-something geometry to Cesium.
Parameters
- layer: PrimitiveLayer
- feature: Feature
  OpenLayers feature..
- geometry: Geometry
  OpenLayers geometry.
- projection: ProjectionLike
- olStyle: Style
- billboards: BillboardCollection
- opt_newBillboardCallback: (bb: Billboard) => void
  Called when the new billboard is added.
Returns PrimitiveCollection
primitives
- Defined in FeatureConverter.ts:1045

olPointGeometryToCesium

olPointGeometryToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: Point,
    projection: ProjectionLike,
    style: Style,
    billboards: BillboardCollection,
    opt_newBillboardCallback?: (bb: Billboard) => void,
): PrimitiveCollection
Api
Convert a point geometry to a Cesium BillboardCollection.
Parameters
- layer: PrimitiveLayer
- feature: Feature
  OpenLayers feature..
- olGeometry: Point
  OpenLayers point geometry.
- projection: ProjectionLike
- style: Style
- billboards: BillboardCollection
- Optionalopt_newBillboardCallback: (bb: Billboard) => void
  Called when the new billboard is added.
Returns PrimitiveCollection
primitives
- Defined in FeatureConverter.ts:963

olPolygonGeometryToCesium

olPolygonGeometryToCesium(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: Polygon,
    projection: ProjectionLike,
    olStyle: Style,
): PrimitiveCollection
Api
Convert an OpenLayers polygon geometry to Cesium.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- olGeometry: Polygon
- projection: ProjectionLike
- olStyle: Style
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:629

olStyleToCesium

olStyleToCesium(feature: Feature, style: Style, outline: boolean): Material
Api
Convert an OpenLayers style to a Cesium Material.
Parameters
- feature: Feature
- style: Style
- outline: boolean
Returns Material
- Defined in FeatureConverter.ts:1249

olVectorLayerToCesium

olVectorLayerToCesium(
    olLayer: VectorLayer<any>,
    olView: View,
    featurePrimitiveMap: Record<number, PrimitiveCollection>,
): VectorLayerCounterpart
Api
Convert an OpenLayers vector layer to Cesium primitive collection. For each feature, the associated primitive will be stored in featurePrimitiveMap.
Parameters
- olLayer: VectorLayer<any>
- olView: View
- featurePrimitiveMap: Record<number, PrimitiveCollection>
Returns VectorLayerCounterpart
- Defined in FeatureConverter.ts:1494

`Protected`setReferenceForPicking

setReferenceForPicking(
    layer: PrimitiveLayer,
    feature: Feature,
    primitive:
        | Primitive
        | Billboard
        | GroundPolylinePrimitive
        | GroundPrimitive
        | Label,
): void
Parameters
- layer: PrimitiveLayer
- feature: Feature
  OpenLayers feature.
- primitive: Primitive | Billboard | GroundPolylinePrimitive | GroundPrimitive | Label
Returns void
- Defined in FeatureConverter.ts:177

`Protected`wrapFillAndOutlineGeometries

wrapFillAndOutlineGeometries(
    layer: PrimitiveLayer,
    feature: Feature,
    olGeometry: Geometry,
    fillGeometry: Geometry | CircleGeometry,
    outlineGeometry: Geometry | CircleOutlineGeometry,
    olStyle: Style,
): PrimitiveCollection
Create a primitive collection out of two Cesium geometries. Only the OpenLayers style colors will be used.
Parameters
- layer: PrimitiveLayer
- feature: Feature
- olGeometry: Geometry
- fillGeometry: Geometry | CircleGeometry
- outlineGeometry: Geometry | CircleOutlineGeometry
- olStyle: Style
Returns PrimitiveCollection
- Defined in FeatureConverter.ts:343

Class FeatureConverter

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FeatureConverter

Properties

Protectedscene

Methods

ProtectedaddTextStyle

Parameters

Returns PrimitiveCollection

computePlainStyle

Parameters

Returns Style[]

convert

Parameters

Returns PrimitiveCollection

createBillboardFromImage

Parameters

Returns void

ProtectedcreateColoredPrimitive

Parameters

Returns Primitive | GroundPrimitive

csAddBillboard

Parameters

Returns Billboard

ProtectedextractColorFromOlStyle

Parameters

Returns Color | ImageMaterialProperty

ProtectedextractLineWidthFromOlStyle

Parameters

Returns number

ProtectedgetGeometryFromFeature

Parameters

Returns Geometry

getHeightReference

Parameters

Returns HeightReference

olCircleGeometryToCesium

Parameters

Returns PrimitiveCollection

olFeatureToCesium

Parameters

Returns PrimitiveCollection

olGeometry4326TextPartToCesium

Parameters

Returns LabelCollection

olLineStringGeometryToCesium

Parameters

Returns PrimitiveCollection

olMultiGeometryToCesium

Parameters

Returns PrimitiveCollection

olPointGeometryToCesium

Parameters

Returns PrimitiveCollection

olPolygonGeometryToCesium

Parameters

Returns PrimitiveCollection

olStyleToCesium

Parameters

Returns Material

olVectorLayerToCesium

Parameters

Returns VectorLayerCounterpart

ProtectedsetReferenceForPicking

Parameters

Returns void

ProtectedwrapFillAndOutlineGeometries

Parameters

Returns PrimitiveCollection

Settings

On This Page

`Protected`scene

`Protected`addTextStyle

`Protected`createColoredPrimitive

`Protected`extractColorFromOlStyle

`Protected`extractLineWidthFromOlStyle

`Protected`getGeometryFromFeature

`Protected`setReferenceForPicking

`Protected`wrapFillAndOutlineGeometries