ol-cesium
Version:
OpenLayers Cesium integration library
908 lines • 46.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OLCesium | 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_olcesium_.html">"olcs/OLCesium"</a>
</li>
<li>
<a href="_olcs_olcesium_.olcesium.html">OLCesium</a>
</li>
</ul>
<h1>Class OLCesium</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} OLCesiumOptions</p>
</dd>
<dt>property</dt>
<dd><p>{import('ol/Map.js').default} map The OpenLayers map we want to show on a Cesium scene.</p>
</dd>
<dt>property</dt>
<dd><p>{Element|string} [target] Target element for the Cesium scene.</p>
</dd>
<dt>property</dt>
<dd><p>{function(!import('ol/Map.js').default, !Cesium.Scene, !Cesium.DataSourceCollection): Array<import('olcs/AbstractSynchronizer.js').default>}
[createSynchronizers] Callback function which will be called by the {@link olcs.OLCesium}
constructor to create custom synchronizers. Receives an <code>ol.Map</code> and a <code>Cesium.Scene</code> as arguments,
and needs to return an array of {@link import('olcs/AbstractSynchronizer.js').default}.</p>
</dd>
<dt>property</dt>
<dd><p>{function(): Cesium.JulianDate} [time] Control the current time used by Cesium.</p>
</dd>
<dt>property</dt>
<dd><p>{boolean} [stopOpenLayersEventsPropagation] Prevent propagation of mouse/touch events to
OpenLayers when Cesium is active.</p>
</dd>
<dt>property</dt>
<dd><p>{Cesium.SceneOptions} [sceneOptions] Allows the passing of property value to the
<code>Cesium.Scene</code>.</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">OLCesium</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_olcesium_.olcesium.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"><a href="_olcs_olcesium_.olcesium.html#enableautorenderloop" class="tsd-kind-icon">enable<wbr>Auto<wbr>Render<wbr>Loop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getautorenderloop" class="tsd-kind-icon">get<wbr>Auto<wbr>Render<wbr>Loop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getcamera" class="tsd-kind-icon">get<wbr>Camera</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getcesiumscene" class="tsd-kind-icon">get<wbr>Cesium<wbr>Scene</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getdatasourcedisplay" class="tsd-kind-icon">get<wbr>Data<wbr>Source<wbr>Display</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getdatasources" class="tsd-kind-icon">get<wbr>Data<wbr>Sources</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getenabled" class="tsd-kind-icon">get<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getolmap" class="tsd-kind-icon">get<wbr>OlMap</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#getolview" class="tsd-kind-icon">get<wbr>OlView</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_olcs_olcesium_.olcesium.html#handleresize_" class="tsd-kind-icon">handle<wbr>Resize_</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_olcs_olcesium_.olcesium.html#onanimationframe_" class="tsd-kind-icon">on<wbr>Animation<wbr>Frame_</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_olcs_olcesium_.olcesium.html#render_" class="tsd-kind-icon">render_</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#setblockcesiumrendering" class="tsd-kind-icon">set<wbr>Block<wbr>Cesium<wbr>Rendering</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#setenabled" class="tsd-kind-icon">set<wbr>Enabled</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#setresolutionscale" class="tsd-kind-icon">set<wbr>Resolution<wbr>Scale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#settargetframerate" class="tsd-kind-icon">set<wbr>Target<wbr>Frame<wbr>Rate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_olcs_olcesium_.olcesium.html#throwonunitializedmap_" class="tsd-kind-icon">throw<wbr>OnUnitialized<wbr>Map_</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_olcs_olcesium_.olcesium.html#updatetrackedentity_" class="tsd-kind-icon">update<wbr>Tracked<wbr>Entity_</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_olcs_olcesium_.olcesium.html#warmup" class="tsd-kind-icon">warm<wbr>Up</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 OLCesium<span class="tsd-signature-symbol">(</span>options<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><a href="_olcs_olcesium_.olcesium.html" class="tsd-signature-type">OLCesium</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/OLCesium.js#L31">olcs/OLCesium.js:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<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>options: <span class="tsd-signature-type">object</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Options.</p>
</div>
</div>
<ul class="tsd-parameters">
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_olcs_olcesium_.olcesium.html" class="tsd-signature-type">OLCesium</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">
<a name="enableautorenderloop" class="tsd-anchor"></a>
<h3>enable<wbr>Auto<wbr>Render<wbr>Loop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Auto<wbr>Render<wbr>Loop<span class="tsd-signature-symbol">(</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/OLCesium.js#L603">olcs/OLCesium.js:603</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Render the globe only when necessary in order to save resources.
Experimental.</p>
</div>
<dl class="tsd-comment-tags">
<dt>api</dt>
<dd></dd>
</dl>
</div>
<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">
<a name="getautorenderloop" class="tsd-anchor"></a>
<h3>get<wbr>Auto<wbr>Render<wbr>Loop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Auto<wbr>Render<wbr>Loop<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/OLCesium.js#L614">olcs/OLCesium.js:614</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the autorender loop.</p>
</div>
<dl class="tsd-comment-tags">
<dt>api</dt>
<dd></dd>
</dl>
</div>
<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="getcamera" class="tsd-anchor"></a>
<h3>get<wbr>Camera</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Camera<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/OLCesium.js#L437">olcs/OLCesium.js:437</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-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="getcesiumscene" class="tsd-anchor"></a>
<h3>get<wbr>Cesium<wbr>Scene</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Cesium<wbr>Scene<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Scene</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/OLCesium.js#L463">olcs/OLCesium.js:463</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-returns-title">Returns <span class="tsd-signature-type">Scene</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdatasourcedisplay" class="tsd-anchor"></a>
<h3>get<wbr>Data<wbr>Source<wbr>Display</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Data<wbr>Source<wbr>Display<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DataSourceDisplay</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/OLCesium.js#L479">olcs/OLCesium.js:479</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-returns-title">Returns <span class="tsd-signature-type">DataSourceDisplay</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getdatasources" class="tsd-anchor"></a>
<h3>get<wbr>Data<wbr>Sources</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Data<wbr>Sources<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DataSourceCollection</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/OLCesium.js#L471">olcs/OLCesium.js:471</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-returns-title">Returns <span class="tsd-signature-type">DataSourceCollection</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getenabled" class="tsd-anchor"></a>
<h3>get<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Enabled<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/OLCesium.js#L487">olcs/OLCesium.js:487</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-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getolmap" class="tsd-anchor"></a>
<h3>get<wbr>OlMap</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>OlMap<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/OLCesium.js#L445">olcs/OLCesium.js:445</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-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="getolview" class="tsd-anchor"></a>
<h3>get<wbr>OlView</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>OlView<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/OLCesium.js#L453">olcs/OLCesium.js:453</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-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 tsd-is-private">
<a name="handleresize_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr>Resize_</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Resize_<span class="tsd-signature-symbol">(</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/OLCesium.js#L401">olcs/OLCesium.js:401</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<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-private">
<a name="onanimationframe_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> on<wbr>Animation<wbr>Frame_</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">on<wbr>Animation<wbr>Frame_<span class="tsd-signature-symbol">(</span>frameTime<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">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/OLCesium.js#L334">olcs/OLCesium.js:334</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Callback for <code>requestAnimationFrame</code>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>frameTime: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The frame time, from <code>performance.now()</code>.</p>
</div>
</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-private">
<a name="render_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> render_</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">render_<span class="tsd-signature-symbol">(</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/OLCesium.js#L316">olcs/OLCesium.js:316</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Render the Cesium scene.</p>
</div>
</div>
<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">
<a name="setblockcesiumrendering" class="tsd-anchor"></a>
<h3>set<wbr>Block<wbr>Cesium<wbr>Rendering</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Block<wbr>Cesium<wbr>Rendering<span class="tsd-signature-symbol">(</span>block<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">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/OLCesium.js#L589">olcs/OLCesium.js:589</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Block Cesium rendering to save resources.</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>block: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>True to block.</p>
</div>
</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">
<a name="setenabled" class="tsd-anchor"></a>
<h3>set<wbr>Enabled</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Enabled<span class="tsd-signature-symbol">(</span>enable<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">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/OLCesium.js#L497">olcs/OLCesium.js:497</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables/disables the Cesium.
This modifies the visibility style of the container element.</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>enable: <span class="tsd-signature-type">boolean</span></h5>
</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">
<a name="setresolutionscale" class="tsd-anchor"></a>
<h3>set<wbr>Resolution<wbr>Scale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Resolution<wbr>Scale<span class="tsd-signature-symbol">(</span>value<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">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/OLCesium.js#L635">olcs/OLCesium.js:635</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The 3D Cesium globe is rendered in a canvas with two different dimensions:
clientWidth and clientHeight which are the dimension on the screen and
width and height which are the dimensions of the drawing buffer.</p>
</div>
<p>By using a resolution scale lower than 1.0, it is possible to render the
globe in a buffer smaller than the canvas client dimensions and improve
performance, at the cost of quality.</p>
<p>Pixel ratio should also be taken into account; by default, a device with
pixel ratio of 2.0 will have a buffer surface 4 times bigger than the client
surface.</p>
<dl class="tsd-comment-tags">
<dt>this</dt>
<dd><p>{olcs.OLCesium}</p>
</dd>
<dt>api</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
</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">
<a name="settargetframerate" class="tsd-anchor"></a>
<h3>set<wbr>Target<wbr>Frame<wbr>Rate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Target<wbr>Frame<wbr>Rate<span class="tsd-signature-symbol">(</span>value<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">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/OLCesium.js#L652">olcs/OLCesium.js:652</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the target frame rate for the renderer. Set to <code>Number.POSITIVE_INFINITY</code>
to render as quickly as possible.</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>value: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The frame rate, in frames per second.</p>
</div>
</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-private">
<a name="throwonunitializedmap_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> throw<wbr>OnUnitialized<wbr>Map_</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">throw<wbr>OnUnitialized<wbr>Map_<span class="tsd-signature-symbol">(</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/OLCesium.js#L665">olcs/OLCesium.js:665</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if OpenLayers map is not properly initialized.</p>
</div>
</div>
<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-private">
<a name="updatetrackedentity_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> update<wbr>Tracked<wbr>Entity_</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">update<wbr>Tracked<wbr>Entity_<span class="tsd-signature-symbol">(</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/OLCesium.js#L374">olcs/OLCesium.js:374</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<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">
<a name="warmup" class="tsd-anchor"></a>
<h3>warm<wbr>Up</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">warm<wbr>Up<span class="tsd-signature-symbol">(</span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, timeout<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">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/OLCesium.js#L561">olcs/OLCesium.js:561</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Preload Cesium so that it is ready when transitioning from 2D to 3D.</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>height: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Target height of the camera</p>
</div>
</li>
<li>
<h5>timeout: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Milliseconds after which the warming will stop</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_index_library_.html">"index.library"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_abstractsynchronizer_.html">"olcs/<wbr>Abstract<wbr>Synchronizer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_autorenderloop_.html">"olcs/<wbr>Auto<wbr>Render<wbr>Loop"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_camera_.html">"olcs/<wbr>Camera"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_featureconverter_.html">"olcs/<wbr>Feature<wbr>Converter"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_olcs_olcesium_.html">"olcs/OLCesium"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_overlaysynchronizer_.html">"olcs/<wbr>Overlay<wbr>Synchronizer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_rastersynchronizer_.html">"olcs/<wbr>Raster<wbr>Synchronizer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_synchronizedoverlay_.html">"olcs/<wbr>Synchronized<wbr>Overlay"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_vectorsynchronizer_.html">"olcs/<wbr>Vector<wbr>Synchronizer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_contrib_lazyloader_.html">"olcs/contrib/<wbr>Lazy<wbr>Loader"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_contrib_manager_.html">"olcs/contrib/<wbr>Manager"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_core_.html">"olcs/core"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_core_olimageryprovider_.html">"olcs/core/OLImagery<wbr>Provider"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_core_vectorlayercounterpart_.html">"olcs/core/<wbr>Vector<wbr>Layer<wbr>Counterpart"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_math_.html">"olcs/math"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_olcs_util_.html">"olcs/util"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_olcs_olcesium_.olcesium.html" class="tsd-kind-icon">OLCesium</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#enableautorenderloop" class="tsd-kind-icon">enable<wbr>Auto<wbr>Render<wbr>Loop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getautorenderloop" class="tsd-kind-icon">get<wbr>Auto<wbr>Render<wbr>Loop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getcamera" class="tsd-kind-icon">get<wbr>Camera</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getcesiumscene" class="tsd-kind-icon">get<wbr>Cesium<wbr>Scene</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getdatasourcedisplay" class="tsd-kind-icon">get<wbr>Data<wbr>Source<wbr>Display</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getdatasources" class="tsd-kind-icon">get<wbr>Data<wbr>Sources</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getenabled" class="tsd-kind-icon">get<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getolmap" class="tsd-kind-icon">get<wbr>OlMap</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#getolview" class="tsd-kind-icon">get<wbr>OlView</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_olcs_olcesium_.olcesium.html#handleresize_" class="tsd-kind-icon">handle<wbr>Resize_</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_olcs_olcesium_.olcesium.html#onanimationframe_" class="tsd-kind-icon">on<wbr>Animation<wbr>Frame_</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_olcs_olcesium_.olcesium.html#render_" class="tsd-kind-icon">render_</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#setblockcesiumrendering" class="tsd-kind-icon">set<wbr>Block<wbr>Cesium<wbr>Rendering</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#setenabled" class="tsd-kind-icon">set<wbr>Enabled</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#setresolutionscale" class="tsd-kind-icon">set<wbr>Resolution<wbr>Scale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#settargetframerate" class="tsd-kind-icon">set<wbr>Target<wbr>Frame<wbr>Rate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_olcs_olcesium_.olcesium.html#throwonunitializedmap_" class="tsd-kind-icon">throw<wbr>OnUnitialized<wbr>Map_</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_olcs_olcesium_.olcesium.html#updatetrackedentity_" class="tsd-kind-icon">update<wbr>Tracked<wbr>Entity_</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_olcs_olcesium_.olcesium.html#warmup" class="tsd-kind-icon">warm<wbr>Up</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>