UNPKG

ol-cesium

Version:

OpenLayers Cesium integration library

915 lines 79.9 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>FeatureConverter | ol-cesium</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">ol-cesium</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_olcs_featureconverter_.html">&quot;olcs/FeatureConverter&quot;</a> </li> <li> <a href="_olcs_featureconverter_.featureconverter.html">FeatureConverter</a> </li> </ul> <h1>Class FeatureConverter</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>typedef</dt> <dd><p>{Object} ModelStyle</p> </dd> <dt>property</dt> <dd><p>{Cesium.Matrix4} [debugModelMatrix]</p> </dd> <dt>property</dt> <dd><p>{Cesium.ModelFromGltfOptions} cesiumOptions</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">FeatureConverter</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#addtextstyle" class="tsd-kind-icon">add<wbr>Text<wbr>Style</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#computeplainstyle" class="tsd-kind-icon">compute<wbr>Plain<wbr>Style</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#convert" class="tsd-kind-icon">convert</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#createbillboardfromimage" class="tsd-kind-icon">create<wbr>Billboard<wbr>From<wbr>Image</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#createcoloredprimitive" class="tsd-kind-icon">create<wbr>Colored<wbr>Primitive</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#createstackedgroundcorridors" class="tsd-kind-icon">create<wbr>Stacked<wbr>Ground<wbr>Corridors</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#csaddbillboard" class="tsd-kind-icon">cs<wbr>Add<wbr>Billboard</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#extractcolorfromolstyle" class="tsd-kind-icon">extract<wbr>Color<wbr>From<wbr>OlStyle</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#extractlinewidthfromolstyle" class="tsd-kind-icon">extract<wbr>Line<wbr>Width<wbr>From<wbr>OlStyle</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#getgeometryfromfeature" class="tsd-kind-icon">get<wbr>Geometry<wbr>From<wbr>Feature</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#getheightreference" class="tsd-kind-icon">get<wbr>Height<wbr>Reference</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olcirclegeometrytocesium" class="tsd-kind-icon">ol<wbr>Circle<wbr>Geometry<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olfeaturetocesium" class="tsd-kind-icon">ol<wbr>Feature<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olgeometry4326textparttocesium" class="tsd-kind-icon">ol<wbr>Geometry4326<wbr>Text<wbr>Part<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#ollinestringgeometrytocesium" class="tsd-kind-icon">ol<wbr>Line<wbr>String<wbr>Geometry<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olmultigeometrytocesium" class="tsd-kind-icon">ol<wbr>Multi<wbr>Geometry<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olpointgeometrytocesium" class="tsd-kind-icon">ol<wbr>Point<wbr>Geometry<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olpolygongeometrytocesium" class="tsd-kind-icon">ol<wbr>Polygon<wbr>Geometry<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olstyletocesium" class="tsd-kind-icon">ol<wbr>Style<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_featureconverter_.featureconverter.html#olvectorlayertocesium" class="tsd-kind-icon">ol<wbr>Vector<wbr>Layer<wbr>ToCesium</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_olcs_featureconverter_.featureconverter.html#onremoveorclearfeature_" class="tsd-kind-icon">on<wbr>Remove<wbr>OrClear<wbr>Feature_</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#setreferenceforpicking" class="tsd-kind-icon">set<wbr>Reference<wbr>For<wbr>Picking</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="_olcs_featureconverter_.featureconverter.html#wrapfillandoutlinegeometries" class="tsd-kind-icon">wrap<wbr>Fill<wbr>And<wbr>Outline<wbr>Geometries</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Feature<wbr>Converter<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_olcs_featureconverter_.featureconverter.html" class="tsd-signature-type">FeatureConverter</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L23">olcs/FeatureConverter.js:23</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>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.</p> </div> <dl class="tsd-comment-tags"> <dt>constructor</dt> <dd></dd> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>scene: <span class="tsd-signature-type">Scene</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cesium scene.</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_olcs_featureconverter_.featureconverter.html" class="tsd-signature-type">FeatureConverter</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="addtextstyle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> add<wbr>Text<wbr>Style</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">add<wbr>Text<wbr>Style<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, geometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, primitive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Primitive</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PrimitiveCollection</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L269">olcs/FeatureConverter.js:269</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create a Cesium primitive if style has a text component. Eventually return a PrimitiveCollection including current primitive.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>geometry: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>primitive: <span class="tsd-signature-type">Primitive</span></h5> <div class="tsd-comment tsd-typography"> <p>current primitive</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PrimitiveCollection</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="computeplainstyle" class="tsd-anchor"></a> <h3>compute<wbr>Plain<wbr>Style</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compute<wbr>Plain<wbr>Style<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, fallbackStyleFunction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, resolution<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L1044">olcs/FeatureConverter.js:1044</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Compute OpenLayers plain style. Evaluates style function, blend arrays, get default style.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>fallbackStyleFunction: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>resolution: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> <p>null if no style is available</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="convert" class="tsd-anchor"></a> <h3>convert</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">convert<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, view<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Primitive</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L1271">olcs/FeatureConverter.js:1271</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert an OpenLayers feature to Cesium primitive collection.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>view: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>context: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Primitive</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="createbillboardfromimage" class="tsd-anchor"></a> <h3>create<wbr>Billboard<wbr>From<wbr>Image</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">create<wbr>Billboard<wbr>From<wbr>Image<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olGeometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, projection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, imageStyle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, billboards<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BillboardCollection</span>, opt_newBillboardCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L677">olcs/FeatureConverter.js:677</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert a point geometry to a Cesium BillboardCollection.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>olGeometry: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers point geometry.</p> </div> </li> <li> <h5>projection: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>imageStyle: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>billboards: <span class="tsd-signature-type">BillboardCollection</span></h5> </li> <li> <h5>opt_newBillboardCallback: <span class="tsd-signature-type">object</span></h5> <div class="tsd-comment tsd-typography"> <p>Called when the new billboard is added.</p> </div> <ul class="tsd-parameters"> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="createcoloredprimitive" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Colored<wbr>Primitive</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">create<wbr>Colored<wbr>Primitive<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olGeometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, geometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Geometry</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Color</span>, opt_lineWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Primitive</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L108">olcs/FeatureConverter.js:108</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Basics primitive creation using a color attribute. Note that Cesium has &#39;interior&#39; and outline geometries.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature.</p> </div> </li> <li> <h5>olGeometry: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers geometry.</p> </div> </li> <li> <h5>geometry: <span class="tsd-signature-type">Geometry</span></h5> </li> <li> <h5>color: <span class="tsd-signature-type">Color</span></h5> </li> <li> <h5>opt_lineWidth: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Primitive</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="createstackedgroundcorridors" class="tsd-anchor"></a> <h3>create<wbr>Stacked<wbr>Ground<wbr>Corridors</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">create<wbr>Stacked<wbr>Ground<wbr>Corridors<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Color</span>, positions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Cartesian3</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Cartesian3</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L398">olcs/FeatureConverter.js:398</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>width: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The width of the line.</p> </div> </li> <li> <h5>color: <span class="tsd-signature-type">Color</span></h5> <div class="tsd-comment tsd-typography"> <p>The color of the line.</p> </div> </li> <li> <h5>positions: <span class="tsd-signature-type">Cartesian3</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Cartesian3</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>The vertices of the line(s).</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> <p>primitive</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="csaddbillboard" class="tsd-anchor"></a> <h3>cs<wbr>Add<wbr>Billboard</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">cs<wbr>Add<wbr>Billboard<span class="tsd-signature-symbol">(</span>billboards<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BillboardCollection</span>, bbOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, geometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Billboard</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L303">olcs/FeatureConverter.js:303</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add a billboard to a Cesium.BillboardCollection. Overriding this wrapper allows manipulating the billboard options.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>billboards: <span class="tsd-signature-type">BillboardCollection</span></h5> </li> <li> <h5>bbOptions: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature.</p> </div> </li> <li> <h5>geometry: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Billboard</span></h4> <p>newly created billboard</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="extractcolorfromolstyle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> extract<wbr>Color<wbr>From<wbr>OlStyle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">extract<wbr>Color<wbr>From<wbr>OlStyle<span class="tsd-signature-symbol">(</span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, outline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Color</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L193">olcs/FeatureConverter.js:193</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return the fill or stroke color from a plain ol style.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>outline: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Color</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="extractlinewidthfromolstyle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> extract<wbr>Line<wbr>Width<wbr>From<wbr>OlStyle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">extract<wbr>Line<wbr>Width<wbr>From<wbr>OlStyle<span class="tsd-signature-symbol">(</span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L213">olcs/FeatureConverter.js:213</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Return the width of stroke from a plain ol style.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="getgeometryfromfeature" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Geometry<wbr>From<wbr>Feature</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">get<wbr>Geometry<wbr>From<wbr>Feature<span class="tsd-signature-symbol">(</span>feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, opt_geom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L1082">olcs/FeatureConverter.js:1082</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>opt_geom: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>Geometry to be converted.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getheightreference" class="tsd-anchor"></a> <h3>get<wbr>Height<wbr>Reference</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Height<wbr>Reference<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, geometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HeightReference</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L640">olcs/FeatureConverter.js:640</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>geometry: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HeightReference</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="olcirclegeometrytocesium" class="tsd-anchor"></a> <h3>ol<wbr>Circle<wbr>Geometry<wbr>ToCesium</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">ol<wbr>Circle<wbr>Geometry<wbr>ToCesium<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olGeometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, projection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olStyle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PrimitiveCollection</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L322">olcs/FeatureConverter.js:322</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert an OpenLayers circle geometry to Cesium.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>olGeometry: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers circle geometry.</p> </div> </li> <li> <h5>projection: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>olStyle: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PrimitiveCollection</span></h4> <p>primitives</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="olfeaturetocesium" class="tsd-anchor"></a> <h3>ol<wbr>Feature<wbr>ToCesium</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">ol<wbr>Feature<wbr>ToCesium<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, opt_geom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Primitive</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L1112">olcs/FeatureConverter.js:1112</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert one OpenLayers feature up to a collection of Cesium primitives.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature.</p> </div> </li> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>context: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>opt_geom: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>Geometry to be converted.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Primitive</span></h4> <p>primitives</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="olgeometry4326textparttocesium" class="tsd-anchor"></a> <h3>ol<wbr>Geometry4326<wbr>Text<wbr>Part<wbr>ToCesium</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">ol<wbr>Geometry4326<wbr>Text<wbr>Part<wbr>ToCesium<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, geometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">LabelCollection</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L909">olcs/FeatureConverter.js:909</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert an OpenLayers text style to Cesium.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>geometry: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>style: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">LabelCollection</span></h4> <p>Cesium primitive</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="ollinestringgeometrytocesium" class="tsd-anchor"></a> <h3>ol<wbr>Line<wbr>String<wbr>Geometry<wbr>ToCesium</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">ol<wbr>Line<wbr>String<wbr>Geometry<wbr>ToCesium<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olGeometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, projection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olStyle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PrimitiveCollection</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L445">olcs/FeatureConverter.js:445</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert an OpenLayers line string geometry to Cesium.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>olGeometry: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers line string geometry.</p> </div> </li> <li> <h5>projection: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>olStyle: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PrimitiveCollection</span></h4> <p>primitives</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="olmultigeometrytocesium" class="tsd-anchor"></a> <h3>ol<wbr>Multi<wbr>Geometry<wbr>ToCesium</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">ol<wbr>Multi<wbr>Geometry<wbr>ToCesium<span class="tsd-signature-symbol">(</span>layer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, feature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, geometry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, projection<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, olStyle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, billboards<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BillboardCollection</span>, opt_newBillboardCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Primitive</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openlayers/ol-cesium/blob/642e1e2/src/olcs/FeatureConverter.js#L842">olcs/FeatureConverter.js:842</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert an OpenLayers multi-something geometry to Cesium.</p> </div> <dl class="tsd-comment-tags"> <dt>api</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>layer: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>feature: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers feature..</p> </div> </li> <li> <h5>geometry: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>OpenLayers geometry.</p> </div> </li> <li> <h5>projection: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>olStyle: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>billboards: <span class="tsd-signature-type">BillboardCollection</span></h5> </li> <li> <h5>opt_newBillboardCallback: <span class="tsd-signature-type">object</span></h5> <div class="tsd-comment tsd-typography"> <p>Called when the new billboard is added.</p> </div> <ul class="tsd-parameters"> </ul> </li> </ul> <h4 class="tsd-retur