ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
10ee3b644ca94af66b05980908e85b35c74e6aca
openlayers/master/examples/CesiumViewerWidget.html
Éric Lemoine 5d14b9e2d4 Updated
2013-02-20 10:38:25 +01:00

4051 lines
80 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
<title>CesiumViewerWidget - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<script src="javascript/all.js"></script>
<!-- Syntax Highlighting -->
<link rel="stylesheet" href="styles/shCore.css" media="all"></link>
<link rel="stylesheet" href="styles/shThemeDefault.css" media="all"></link>
<script src="javascript/shCore.js"></script>
<script src="javascript/shBrushJScript.js"></script>
</head>
<body>
<div class="nav">
<div class="menu">
<a href="http://cesium.agi.com/"><img src="images/CesiumLogo.jpg" class="menuLogo"/></a>
<div class="rightLinks indexLinks">
<a href="index.html">top</a>
</div>
<div class="indexLinks">
<a id="allLink">all</a>
<a id="jsIndexLink">js</a>
<a id="glslIndexLink">glsl</a>
</div>
<div class="divider"></div>
<form name="filterForm" method="get" onsubmit="return false;">
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
<input type="hidden" id="filterType" value="all"/>
</form>
<ul id="ClassList"><div id="classItems"><li><a href="AnimationCollection.html">AnimationCollection</a></li><li><a href="AnimationController.html">AnimationController</a></li><li><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li><a href="Billboard.html">Billboard</a></li><li><a href="BillboardCollection.html">BillboardCollection</a></li><li><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li><a href="BoundingRectangle.html">BoundingRectangle</a></li><li><a href="BoundingSphere.html">BoundingSphere</a></li><li><a href="Buffer.html">Buffer</a></li><li><a href="Camera.html">Camera</a></li><li><a href="CameraController.html">CameraController</a></li><li><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li><a href="Cartesian2.html">Cartesian2</a></li><li><a href="Cartesian3.html">Cartesian3</a></li><li><a href="Cartesian4.html">Cartesian4</a></li><li><a href="Cartographic.html">Cartographic</a></li><li><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li><a href="CentralBody.html">CentralBody</a></li><li><a href="CesiumViewerWidget.html">CesiumViewerWidget</a></li><li><a href="Clock.html">Clock</a></li><li><a href="Color.html">Color</a></li><li><a href="Command.html">Command</a></li><li><a href="CommandLists.html">CommandLists</a></li><li><a href="ComplexConicSensorVolume.html">ComplexConicSensorVolume</a></li><li><a href="CompositeDynamicObjectCollection.html">CompositeDynamicObjectCollection</a></li><li><a href="CompositePrimitive.html">CompositePrimitive</a></li><li><a href="Context.html">Context</a></li><li><a href="CubeMap.html">CubeMap</a></li><li><a href="CubeMapFace.html">CubeMapFace</a></li><li><a href="CustomSensorVolume.html">CustomSensorVolume</a></li><li><a href="DefaultProxy.html">DefaultProxy</a></li><li><a href="Deferred.html">Deferred</a></li><li><a href="DeveloperError.html">DeveloperError</a></li><li><a href="DiscardMissingTileImagePolicy.html">DiscardMissingTileImagePolicy</a></li><li><a href="DynamicBillboard.html">DynamicBillboard</a></li><li><a href="DynamicBillboardVisualizer.html">DynamicBillboardVisualizer</a></li><li><a href="DynamicColorMaterial.html">DynamicColorMaterial</a></li><li><a href="DynamicCone.html">DynamicCone</a></li><li><a href="DynamicConeVisualizer.html">DynamicConeVisualizer</a></li><li><a href="DynamicConeVisualizerUsingCustomSensor.html">DynamicConeVisualizerUsingCustomSensor</a></li><li><a href="DynamicDirectionsProperty.html">DynamicDirectionsProperty</a></li><li><a href="DynamicEllipsoid.html">DynamicEllipsoid</a></li><li><a href="DynamicEllipsoidVisualizer.html">DynamicEllipsoidVisualizer</a></li><li><a href="DynamicImageMaterial.html">DynamicImageMaterial</a></li><li><a href="DynamicLabel.html">DynamicLabel</a></li><li><a href="DynamicLabelVisualizer.html">DynamicLabelVisualizer</a></li><li><a href="DynamicMaterialProperty.html">DynamicMaterialProperty</a></li><li><a href="DynamicObject.html">DynamicObject</a></li><li><a href="DynamicObjectCollection.html">DynamicObjectCollection</a></li><li><a href="DynamicPath.html">DynamicPath</a></li><li><a href="DynamicPathVisualizer.html">DynamicPathVisualizer</a></li><li><a href="DynamicPoint.html">DynamicPoint</a></li><li><a href="DynamicPointVisualizer.html">DynamicPointVisualizer</a></li><li><a href="DynamicPolygon.html">DynamicPolygon</a></li><li><a href="DynamicPolygonVisualizer.html">DynamicPolygonVisualizer</a></li><li><a href="DynamicPolyline.html">DynamicPolyline</a></li><li><a href="DynamicPolylineVisualizer.html">DynamicPolylineVisualizer</a></li><li><a href="DynamicPositionProperty.html">DynamicPositionProperty</a></li><li><a href="DynamicProperty.html">DynamicProperty</a></li><li><a href="DynamicPyramid.html">DynamicPyramid</a></li><li><a href="DynamicPyramidVisualizer.html">DynamicPyramidVisualizer</a></li><li><a href="DynamicVertexPositionsProperty.html">DynamicVertexPositionsProperty</a></li><li><a href="Ellipsoid.html">Ellipsoid</a></li><li><a href="EllipsoidalOccluder.html">EllipsoidalOccluder</a></li><li><a href="EllipsoidPrimitive.html">EllipsoidPrimitive</a></li><li><a href="EllipsoidTangentPlane.html">EllipsoidTangentPlane</a></li><li><a href="EncodedCartesian3.html">EncodedCartesian3</a></li><li><a href="Enumeration.html">Enumeration</a></li><li><a href="Event.html">Event</a></li><li><a href="Extent.html">Extent</a></li><li><a href="Framebuffer.html">Framebuffer</a></li><li><a href="FrameState.html">FrameState</a></li><li><a href="FrustumCommands.html">FrustumCommands</a></li><li><a href="GeographicProjection.html">GeographicProjection</a></li><li><a href="GeographicTilingScheme.html">GeographicTilingScheme</a></li><li><a href="GregorianDate.html">GregorianDate</a></li><li><a href="HermiteSpline.html">HermiteSpline</a></li><li><a href="ImageryLayer.html">ImageryLayer</a></li><li><a href="ImageryLayerCollection.html">ImageryLayerCollection</a></li><li><a href="ImageryProvider.html">ImageryProvider</a></li><li><a href="Interval.html">Interval</a></li><li><a href="JulianDate.html">JulianDate</a></li><li><a href="Label.html">Label</a></li><li><a href="LabelCollection.html">LabelCollection</a></li><li><a href="LeapSecond.html">LeapSecond</a></li><li><a href="Material.html">Material</a></li><li><a href="Matrix2.html">Matrix2</a></li><li><a href="Matrix3.html">Matrix3</a></li><li><a href="Matrix4.html">Matrix4</a></li><li><a href="NeverTileDiscardPolicy.html">NeverTileDiscardPolicy</a></li><li><a href="Occluder.html">Occluder</a></li><li><a href="OpenStreetMapImageryProvider.html">OpenStreetMapImageryProvider</a></li><li><a href="OrientationInterpolator.html">OrientationInterpolator</a></li><li><a href="OrthographicFrustum.html">OrthographicFrustum</a></li><li><a href="PerformanceDisplay.html">PerformanceDisplay</a></li><li><a href="PerspectiveFrustum.html">PerspectiveFrustum</a></li><li><a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a></li><li><a href="PickFramebuffer.html">PickFramebuffer</a></li><li><a href="Polygon.html">Polygon</a></li><li><a href="Polyline.html">Polyline</a></li><li><a href="PolylineCollection.html">PolylineCollection</a></li><li><a href="Promise.html">Promise</a></li><li><a href="Quaternion.html">Quaternion</a></li><li><a href="Queue.html">Queue</a></li><li><a href="Ray.html">Ray</a></li><li><a href="RectangularPyramidSensorVolume.html">RectangularPyramidSensorVolume</a></li><li><a href="ReferenceProperty.html">ReferenceProperty</a></li><li><a href="RequestErrorEvent.html">RequestErrorEvent</a></li><li><a href="RuntimeError.html">RuntimeError</a></li><li><a href="Scene.html">Scene</a></li><li><a href="SceneTransitioner.html">SceneTransitioner</a></li><li><a href="ScreenSpaceCameraController.html">ScreenSpaceCameraController</a></li><li><a href="ScreenSpaceEventHandler.html">ScreenSpaceEventHandler</a></li><li><a href="SensorVolumeCollection.html">SensorVolumeCollection</a></li><li><a href="ShaderCache.html">ShaderCache</a></li><li><a href="ShaderProgram.html">ShaderProgram</a></li><li><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li><li><a href="SkyAtmosphere.html">SkyAtmosphere</a></li><li><a href="SkyBox.html">SkyBox</a></li><li><a href="Spherical.html">Spherical</a></li><li><a href="TaskProcessor.html">TaskProcessor</a></li><li><a href="Texture.html">Texture</a></li><li><a href="Texture2DPool.html">Texture2DPool</a></li><li><a href="TextureAtlas.html">TextureAtlas</a></li><li><a href="TextureAtlasBuilder.html">TextureAtlasBuilder</a></li><li><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></li><li><a href="TileMapServiceImageryProvider.html">TileMapServiceImageryProvider</a></li><li><a href="TilingScheme.html">TilingScheme</a></li><li><a href="TimeInterval.html">TimeInterval</a></li><li><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></li><li><a href="Uniform.html">Uniform</a></li><li><a href="UniformArray.html">UniformArray</a></li><li><a href="UniformState.html">UniformState</a></li><li><a href="VertexArray.html">VertexArray</a></li><li><a href="VertexArrayFacade.html">VertexArrayFacade</a></li><li><a href="ViewportQuad.html">ViewportQuad</a></li><li><a href="VisualizerCollection.html">VisualizerCollection</a></li><li><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li><li><a href="WebMercatorProjection.html">WebMercatorProjection</a></li><li><a href="WebMercatorTilingScheme.html">WebMercatorTilingScheme</a></li><li><a href="binarySearch.html">binarySearch</a></li><li><a href="BingMapsStyle.html">BingMapsStyle</a></li><li><a href="BlendEquation.html">BlendEquation</a></li><li><a href="BlendFunction.html">BlendFunction</a></li><li><a href="BlendingState.html">BlendingState</a></li><li><a href="BoxTessellator.html">BoxTessellator</a></li><li><a href="BufferUsage.html">BufferUsage</a></li><li><a href="CameraColumbusViewMode.html">CameraColumbusViewMode</a></li><li><a href="CameraEventType.html">CameraEventType</a></li><li><a href="CameraFlightPath.html">CameraFlightPath</a></li><li><a href="CesiumMath.html">CesiumMath</a></li><li><a href="ClockRange.html">ClockRange</a></li><li><a href="ClockStep.html">ClockStep</a></li><li><a href="combine.html">combine</a></li><li><a href="computeSunPosition.html">computeSunPosition</a></li><li><a href="createGuid.html">createGuid</a></li><li><a href="createTaskProcessorWorker.html">createTaskProcessorWorker</a></li><li><a href="CubeMapEllipsoidTessellator.html">CubeMapEllipsoidTessellator</a></li><li><a href="CubicRealPolynomial.html">CubicRealPolynomial</a></li><li><a href="CullFace.html">CullFace</a></li><li><a href="CzmlBoolean.html">CzmlBoolean</a></li><li><a href="CzmlCartesian2.html">CzmlCartesian2</a></li><li><a href="CzmlCartesian3.html">CzmlCartesian3</a></li><li><a href="CzmlCartographic.html">CzmlCartographic</a></li><li><a href="CzmlColor.html">CzmlColor</a></li><li><a href="CzmlDefaults.html">CzmlDefaults</a></li><li><a href="CzmlHorizontalOrigin.html">CzmlHorizontalOrigin</a></li><li><a href="CzmlImage.html">CzmlImage</a></li><li><a href="CzmlLabelStyle.html">CzmlLabelStyle</a></li><li><a href="CzmlNumber.html">CzmlNumber</a></li><li><a href="CzmlString.html">CzmlString</a></li><li><a href="CzmlUnitCartesian3.html">CzmlUnitCartesian3</a></li><li><a href="CzmlUnitQuaternion.html">CzmlUnitQuaternion</a></li><li><a href="CzmlUnitSpherical.html">CzmlUnitSpherical</a></li><li><a href="CzmlVerticalOrigin.html">CzmlVerticalOrigin</a></li><li><a href="defaultValue.html">defaultValue</a></li><li><a href="DepthFunction.html">DepthFunction</a></li><li><a href="destroyObject.html">destroyObject</a></li><li><a href="ExtentTessellator.html">ExtentTessellator</a></li><li><a href="FAR.html">FAR</a></li><li><a href="FeatureDetection.html">FeatureDetection</a></li><li><a href="freezeObject.html">freezeObject</a></li><li><a href="Fullscreen.html">Fullscreen</a></li><li><a href="getImagePixels.html">getImagePixels</a></li><li><a href="HermitePolynomialApproximation.html">HermitePolynomialApproximation</a></li><li><a href="HorizontalOrigin.html">HorizontalOrigin</a></li><li><a href="IndexDatatype.html">IndexDatatype</a></li><li><a href="Intersect.html">Intersect</a></li><li><a href="IntersectionTests.html">IntersectionTests</a></li><li><a href="Iso8601.html">Iso8601</a></li><li><a href="jsonp.html">jsonp</a></li><li><a href="KeyboardEventModifier.html">KeyboardEventModifier</a></li><li><a href="LabelStyle.html">LabelStyle</a></li><li><a href="LagrangePolynomialApproximation.html">LagrangePolynomialApproximation</a></li><li><a href="LinearApproximation.html">LinearApproximation</a></li><li><a href="loadArrayBuffer.html">loadArrayBuffer</a></li><li><a href="loadCubeMap.html">loadCubeMap</a></li><li><a href="loadImage.html">loadImage</a></li><li><a href="loadJson.html">loadJson</a></li><li><a href="loadText.html">loadText</a></li><li><a href="loadXML.html">loadXML</a></li><li><a href="MeshFilters.html">MeshFilters</a></li><li><a href="MipmapHint.html">MipmapHint</a></li><li><a href="PixelDatatype.html">PixelDatatype</a></li><li><a href="PixelFormat.html">PixelFormat</a></li><li><a href="PlaneTessellator.html">PlaneTessellator</a></li><li><a href="pointInsideTriangle2D.html">pointInsideTriangle2D</a></li><li><a href="PolygonPipeline.html">PolygonPipeline</a></li><li><a href="PolylinePipeline.html">PolylinePipeline</a></li><li><a href="PrimitiveType.html">PrimitiveType</a></li><li><a href="processCzml.html">processCzml</a></li><li><a href="Projections.html">Projections</a></li><li><a href="QuadraticRealPolynomial.html">QuadraticRealPolynomial</a></li><li><a href="QuarticRealPolynomial.html">QuarticRealPolynomial</a></li><li><a href="RenderbufferFormat.html">RenderbufferFormat</a></li><li><a href="requestAnimationFrame.html">requestAnimationFrame</a></li><li><a href="SceneMode.html">SceneMode</a></li><li><a href="ScreenSpaceEventType.html">ScreenSpaceEventType</a></li><li><a href="Shapes.html">Shapes</a></li><li><a href="StencilFunction.html">StencilFunction</a></li><li><a href="StencilOperation.html">StencilOperation</a></li><li><a href="TextureMagnificationFilter.html">TextureMagnificationFilter</a></li><li><a href="TextureMinificationFilter.html">TextureMinificationFilter</a></li><li><a href="TextureWrap.html">TextureWrap</a></li><li><a href="TimeConstants.html">TimeConstants</a></li><li><a href="TimeStandard.html">TimeStandard</a></li><li><a href="Tipsify.html">Tipsify</a></li><li><a href="Transforms.html">Transforms</a></li><li><a href="TridiagonalSystemSolver.html">TridiagonalSystemSolver</a></li><li><a href="UniformDatatype.html">UniformDatatype</a></li><li><a href="VertexLayout.html">VertexLayout</a></li><li><a href="VerticalOrigin.html">VerticalOrigin</a></li><li><a href="Visibility.html">Visibility</a></li><li><a href="WindingOrder.html">WindingOrder</a></li><li><a href="ComponentDatatype.html">ComponentDatatype</a></li></div><div id="glslItems"><li><a href="czm_cellular.html">czm_cellular</a></li><li><a href="czm_columbusView.html">czm_columbusView</a></li><li><a href="czm_columbusViewMorph.html">czm_columbusViewMorph</a></li><li><a href="czm_complement.html">czm_complement</a></li><li><a href="czm_cone.html">czm_cone</a></li><li><a href="czm_coneContainsPoint.html">czm_coneContainsPoint</a></li><li><a href="czm_degreesPerRadian.html">czm_degreesPerRadian</a></li><li><a href="czm_eastNorthUpToEyeCoordinates.html">czm_eastNorthUpToEyeCoordinates</a></li><li><a href="czm_ellipsoid.html">czm_ellipsoid</a></li><li><a href="czm_ellipsoidContainsPoint.html">czm_ellipsoidContainsPoint</a></li><li><a href="czm_ellipsoidNew.html">czm_ellipsoidNew</a></li><li><a href="czm_ellipsoidSilhouetteCone.html">czm_ellipsoidSilhouetteCone</a></li><li><a href="czm_ellipsoidSilhouetteConeNew.html">czm_ellipsoidSilhouetteConeNew</a></li><li><a href="czm_ellipsoidSilhouetteConeNormal.html">czm_ellipsoidSilhouetteConeNormal</a></li><li><a href="czm_ellipsoidSilhouetteHalfspace.html">czm_ellipsoidSilhouetteHalfspace</a></li><li><a href="czm_ellipsoidSilhouetteHalfspaceNew.html">czm_ellipsoidSilhouetteHalfspaceNew</a></li><li><a href="czm_ellipsoidWgs84TextureCoordinates.html">czm_ellipsoidWgs84TextureCoordinates</a></li><li><a href="czm_emptyRaySegment.html">czm_emptyRaySegment</a></li><li><a href="czm_encodedCameraPositionMCHigh.html">czm_encodedCameraPositionMCHigh</a></li><li><a href="czm_encodedCameraPositionMCLow.html">czm_encodedCameraPositionMCLow</a></li><li><a href="czm_entireFrustum.html">czm_entireFrustum</a></li><li><a href="czm_epsilon1.html">czm_epsilon1</a></li><li><a href="czm_epsilon2.html">czm_epsilon2</a></li><li><a href="czm_epsilon3.html">czm_epsilon3</a></li><li><a href="czm_epsilon4.html">czm_epsilon4</a></li><li><a href="czm_epsilon5.html">czm_epsilon5</a></li><li><a href="czm_epsilon6.html">czm_epsilon6</a></li><li><a href="czm_epsilon7.html">czm_epsilon7</a></li><li><a href="czm_equalsEpsilon.html">czm_equalsEpsilon</a></li><li><a href="czm_eyeOffset.html">czm_eyeOffset</a></li><li><a href="czm_eyeToWindowCoordinates.html">czm_eyeToWindowCoordinates</a></li><li><a href="czm_frameNumber.html">czm_frameNumber</a></li><li><a href="czm_fullRaySegment.html">czm_fullRaySegment</a></li><li><a href="czm_geodeticSurfaceNormal.html">czm_geodeticSurfaceNormal</a></li><li><a href="czm_getDefaultMaterial.html">czm_getDefaultMaterial</a></li><li><a href="czm_getWgs84EllipsoidEC.html">czm_getWgs84EllipsoidEC</a></li><li><a href="czm_halfspace.html">czm_halfspace</a></li><li><a href="czm_infiniteProjection.html">czm_infiniteProjection</a></li><li><a href="czm_infinity.html">czm_infinity</a></li><li><a href="czm_insertAt.html">czm_insertAt</a></li><li><a href="czm_intersection.html">czm_intersection</a></li><li><a href="czm_inverseModel.html">czm_inverseModel</a></li><li><a href="czm_inverseModelView.html">czm_inverseModelView</a></li><li><a href="czm_inverseNormal.html">czm_inverseNormal</a></li><li><a href="czm_inverseProjection.html">czm_inverseProjection</a></li><li><a href="czm_inverseView.html">czm_inverseView</a></li><li><a href="czm_inverseViewRotation.html">czm_inverseViewRotation</a></li><li><a href="czm_isEmpty.html">czm_isEmpty</a></li><li><a href="czm_isFull.html">czm_isFull</a></li><li><a href="czm_latitudeToWebMercatorFraction.html">czm_latitudeToWebMercatorFraction</a></li><li><a href="czm_luminance.html">czm_luminance</a></li><li><a href="czm_material.html">czm_material</a></li><li><a href="czm_materialInput.html">czm_materialInput</a></li><li><a href="czm_model.html">czm_model</a></li><li><a href="czm_modelToWindowCoordinates.html">czm_modelToWindowCoordinates</a></li><li><a href="czm_modelView.html">czm_modelView</a></li><li><a href="czm_modelViewInfiniteProjection.html">czm_modelViewInfiniteProjection</a></li><li><a href="czm_modelViewProjection.html">czm_modelViewProjection</a></li><li><a href="czm_modelViewProjectionRelativeToEye.html">czm_modelViewProjectionRelativeToEye</a></li><li><a href="czm_modelViewRelativeToEye.html">czm_modelViewRelativeToEye</a></li><li><a href="czm_moonDirectionEC.html">czm_moonDirectionEC</a></li><li><a href="czm_morphing.html">czm_morphing</a></li><li><a href="czm_multiplyWithColorBalance.html">czm_multiplyWithColorBalance</a></li><li><a href="czm_normal.html">czm_normal</a></li><li><a href="czm_oneOverPi.html">czm_oneOverPi</a></li><li><a href="czm_oneOverTwoPi.html">czm_oneOverTwoPi</a></li><li><a href="czm_phong.html">czm_phong</a></li><li><a href="czm_pi.html">czm_pi</a></li><li><a href="czm_piOverFour.html">czm_piOverFour</a></li><li><a href="czm_piOverSix.html">czm_piOverSix</a></li><li><a href="czm_piOverThree.html">czm_piOverThree</a></li><li><a href="czm_piOverTwo.html">czm_piOverTwo</a></li><li><a href="czm_pointAlongRay.html">czm_pointAlongRay</a></li><li><a href="czm_projection.html">czm_projection</a></li><li><a href="czm_quadraticRealPolynomialRealRoots.html">czm_quadraticRealPolynomialRealRoots</a></li><li><a href="czm_quadraticRoots.html">czm_quadraticRoots</a></li><li><a href="czm_radiansPerDegree.html">czm_radiansPerDegree</a></li><li><a href="czm_ray.html">czm_ray</a></li><li><a href="czm_rayConeIntersectionInterval.html">czm_rayConeIntersectionInterval</a></li><li><a href="czm_rayConeIntersectNormal.html">czm_rayConeIntersectNormal</a></li><li><a href="czm_rayEllipsoidIntersectionInterval.html">czm_rayEllipsoidIntersectionInterval</a></li><li><a href="czm_rayEllipsoidSilhouetteConeIntersectionInterval.html">czm_rayEllipsoidSilhouetteConeIntersectionInterval</a></li><li><a href="czm_rayEllipsoidSilhouetteHalfspaceIntersectionInterval.html">czm_rayEllipsoidSilhouetteHalfspaceIntersectionInterval</a></li><li><a href="czm_rayHalfspaceIntersectionInterval.html">czm_rayHalfspaceIntersectionInterval</a></li><li><a href="czm_raySegment.html">czm_raySegment</a></li><li><a href="czm_raySegmentCollection.html">czm_raySegmentCollection</a></li><li><a href="czm_raySegmentCollectionCapacity.html">czm_raySegmentCollectionCapacity</a></li><li><a href="czm_raySegmentCollectionNew.html">czm_raySegmentCollectionNew</a></li><li><a href="czm_raySphereIntersectionInterval.html">czm_raySphereIntersectionInterval</a></li><li><a href="czm_removeAt.html">czm_removeAt</a></li><li><a href="czm_scene2D.html">czm_scene2D</a></li><li><a href="czm_scene3D.html">czm_scene3D</a></li><li><a href="czm_snoise.html">czm_snoise</a></li><li><a href="czm_sphere.html">czm_sphere</a></li><li><a href="czm_sphereNormal.html">czm_sphereNormal</a></li><li><a href="global.html#czm_subtraction">czm_subtraction</a></li><li><a href="czm_sunDirectionEC.html">czm_sunDirectionEC</a></li><li><a href="czm_sunDirectionWC.html">czm_sunDirectionWC</a></li><li><a href="czm_temeToPseudoFixed.html">czm_temeToPseudoFixed</a></li><li><a href="czm_threePiOver2.html">czm_threePiOver2</a></li><li><a href="czm_translateRelativeToEye.html">czm_translateRelativeToEye</a></li><li><a href="czm_transpose.html">czm_transpose</a></li><li><a href="czm_twoPi.html">czm_twoPi</a></li><li><a href="czm_view.html">czm_view</a></li><li><a href="czm_viewerPositionWC.html">czm_viewerPositionWC</a></li><li><a href="czm_viewport.html">czm_viewport</a></li><li><a href="czm_viewportOrthographic.html">czm_viewportOrthographic</a></li><li><a href="czm_viewportTransformation.html">czm_viewportTransformation</a></li><li><a href="czm_viewProjection.html">czm_viewProjection</a></li><li><a href="czm_viewRotation.html">czm_viewRotation</a></li><li><a href="czm_webMercatorMaxLatitude.html">czm_webMercatorMaxLatitude</a></li><li><a href="czm_windowToEyeCoordinates.html">czm_windowToEyeCoordinates</a></li></div></ul>
</div>
</div>
<div class="nav navStatic"></div>
<div id="main">
<h1 class="page-title">CesiumViewerWidget</h1>
<section>
<header>
<h2>
CesiumViewerWidget
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="CesiumViewerWidget"><span class="type-signature"></span>new CesiumViewerWidget</h4>
</dt>
<dd>
<p class="description">
This Dojo widget wraps the full functionality of Cesium Viewer.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
Object
</td>
<td class="description last">A list of options to pre-configure the widget. Names matching member fields/functions will override the default values.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 120</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="autoStartRenderLoop"><span class="type-signature"></span>autoStartRenderLoop<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
If true, <a href="CesiumViewerWidget.html#startRenderLoop">CesiumViewerWidget#startRenderLoop</a> will be called automatically
at the end of <a href="CesiumViewerWidget.html#startup">CesiumViewerWidget#startup</a>.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1158</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="dayImageUrl"><span class="type-signature"></span>dayImageUrl<span class="type-signature"> :String</span></h4>
</dt>
<dd>
<div class="description">
The URL for a daytime image on the globe.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 156</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="enableDragDrop"><span class="type-signature"></span>enableDragDrop<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
Allow the user to drag-and-drop CZML files into this widget.
This is read-only after construction.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 208</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="enableWebGLDebugging"><span class="type-signature"></span>enableWebGLDebugging<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
Check for WebGL errors after every WebGL API call. Enabling this debugging feature
comes at a substantial performance cost, halting and restarting the graphics
pipeline hundreds of times per frame. But it can uncover problems that are otherwise
very difficult to diagnose.
This property is read-only after construction.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 199</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="endUserOptions"><span class="type-signature"></span>endUserOptions<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
An object containing settings supplied by the end user, typically from the query string
of the URL of the page with the widget.
</div>
<h5>Examples</h5>
<pre class="code brush: js">var ioQuery = require('dojo/io-query');
var endUserOptions = {};
if (window.location.search) {
endUserOptions = ioQuery.queryToObject(window.location.search.substring(1));
}</pre>
<pre class="code brush: js">var endUserOptions = {
'source' : 'file.czml', // The relative URL of the CZML file to load at startup.
'lookAt' : '123abc', // The CZML ID of the object to track at startup.
'stats' : 1, // Enable the FPS performance display.
'debug' : 1, // Full WebGL error reporting at substantial performance cost.
};</pre>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 187</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="fullscreenElement"><span class="type-signature"></span>fullscreenElement<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
The HTML element to place into fullscreen mode when the corresponding
button is pressed. If undefined, only the widget itself will
go into fullscreen mode. By specifying another container, such
as document.body, this property allows an application to retain
any overlaid or surrounding elements when in fullscreen.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>undefined</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 239</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="mapStyle"><span class="type-signature"></span>mapStyle<span class="type-signature"> :<a href="BingMapsStyle.html">BingMapsStyle</a></span></h4>
</dt>
<dd>
<div class="description">
The map style for streaming imagery. This is read-only after construction.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li><a href="BingMapsStyle.html#AERIAL">BingMapsStyle.AERIAL</a></li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 149</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#setStreamingImageryMapStyle">CesiumViewerWidget#setStreamingImageryMapStyle</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="resizeWidgetOnWindowResize"><span class="type-signature"></span>resizeWidgetOnWindowResize<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
Register this widget's resize handler to get called every time the browser window
resize event fires. This is read-only after construction. Generally this should
be true for full-screen widgets, and true for
fluid layouts where the widget is likely to change size at the same time as the
window. The exception is, if you use a Dojo layout where this widget exists inside
a Dojo ContentPane or similar, you should set this to false, because Dojo will perform
its own layout calculations and call this widget's resize handler automatically.
This can also be false for a fixed-size widget.
If unsure, test the widget with this set to false, and if window resizes cause the
globe to stretch, change this to true.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 227</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#resize">CesiumViewerWidget#resize</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="showSkyBox"><span class="type-signature"></span>showSkyBox<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
Determines if a sky box with stars is drawn around the globe. This is read-only after construction.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 165</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="SkyBox.html">SkyBox</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="showSkyBox"><span class="type-signature"></span>showSkyBox<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
Determines if a sky box with stars is drawn around the globe. This is read-only after construction.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumWidget.js, line 78</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="SkyBox.html">SkyBox</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="useStreamingImagery"><span class="type-signature"></span>useStreamingImagery<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
Enable streaming Imagery. This is read-only after construction.
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 140</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#enableStreamingImagery">CesiumViewerWidget#enableStreamingImagery</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="addCzml"><span class="type-signature"></span>addCzml</h4>
</dt>
<dd>
<p class="description">
Add CZML data to the viewer.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>czml</code></td>
<td class="type">
CZML
</td>
<td class="description last">The CZML (as objects) to be processed and added to the viewer.</td>
</tr>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
string
</td>
<td class="description last">The filename or URI that was the source of the CZML collection.</td>
</tr>
<tr>
<td class="name"><code>lookAt</code></td>
<td class="type">
string
</td>
<td class="description last">Optional. The ID of the object to center the camera on.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 540</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#loadCzml">CesiumViewerWidget#loadCzml</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="centerCameraOnObject"><span class="type-signature"></span>centerCameraOnObject</h4>
</dt>
<dd>
<p class="description">
Have the camera track a particular object.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object to track, or <code>undefined</code> to stop tracking.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 306</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="centerCameraOnPick"><span class="type-signature"></span>centerCameraOnPick</h4>
</dt>
<dd>
<p class="description">
Have the camera track a particular object based on the result of a pick.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object to track, or <code>undefined</code> to stop tracking.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 293</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="enableStatistics"><span class="type-signature"></span>enableStatistics</h4>
</dt>
<dd>
<p class="description">
Enable or disable the FPS (Frames Per Second) perfomance display.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>showStatistics</code></td>
<td class="type">
Boolean
</td>
<td class="description last"><code>true</code> to enable it.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 957</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="enableStreamingImagery"><span class="type-signature"></span>enableStreamingImagery</h4>
</dt>
<dd>
<p class="description">
Enable or disable streaming imagery, and update the globe.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
Boolean
</td>
<td class="description last"><code>true</code> to enable streaming imagery.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 987</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#useStreamingImagery">CesiumViewerWidget#useStreamingImagery</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="handleDrop"><span class="type-signature"></span>handleDrop</h4>
</dt>
<dd>
<p class="description">
This function is called when files are dropped on the widget, if drag-and-drop is enabled.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
Object
</td>
<td class="description last">The drag-and-drop event containing the dropped file(s).</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 579</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="highlightObject"><span class="type-signature"></span>highlightObject</h4>
</dt>
<dd>
<p class="description">
Highlight an object in the scene, usually in response to a click or hover.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object to highlight, or <code>undefined</code> to un-highlight.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1030</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="initializeFrame"><span class="type-signature"></span>initializeFrame</h4>
</dt>
<dd>
<p class="description">
Initialize the current frame.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>currentTime</code></td>
<td class="type">
<a href="JulianDate.html">JulianDate</a>
</td>
<td class="description last">The date and time in the scene of the frame to be rendered</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1064</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="loadCzml"><span class="type-signature"></span>loadCzml</h4>
</dt>
<dd>
<p class="description">
Asynchronously load and add CZML data to the viewer.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
string
</td>
<td class="description last">The URI to load the CZML from.</td>
</tr>
<tr>
<td class="name"><code>lookAt</code></td>
<td class="type">
string
</td>
<td class="description last">Optional. The ID of the object to center the camera on.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 558</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#addCzml">CesiumViewerWidget#addCzml</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onLeftDrag"><span class="type-signature"></span>onLeftDrag</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when the left mouse button is dragged.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
Object
</td>
<td class="description last">object with the start and end position of the mouse.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 390</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onLeftMouseDown"><span class="type-signature"></span>onLeftMouseDown</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when the left mouse button is pressed down.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
Object
</td>
<td class="description last">object with the position of the mouse.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 358</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onLeftMouseUp"><span class="type-signature"></span>onLeftMouseUp</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when the left mouse button is released.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
Object
</td>
<td class="description last">object with the position of the mouse.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 366</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onObjectLeftDoubleClickSelected"><span class="type-signature"></span>onObjectLeftDoubleClickSelected</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when an object is left-double-clicked.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object that was selected, or <code>undefined</code> to de-select.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 342</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onObjectMousedOver"><span class="type-signature"></span>onObjectMousedOver</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when an object hovered by the mouse.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object that was hovered, or <code>undefined</code> if the mouse moved off.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 350</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onObjectRightClickSelected"><span class="type-signature"></span>onObjectRightClickSelected</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when an object is right-clicked.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object that was selected, or <code>undefined</code> to de-select.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 334</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onObjectSelected"><span class="type-signature"></span>onObjectSelected</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when an object is selected (left-click).
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>selectedObject</code></td>
<td class="type">
Object
</td>
<td class="description last">The object that was selected, or <code>undefined</code> to de-select.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 326</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onRightMouseDown"><span class="type-signature"></span>onRightMouseDown</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when the right mouse button is pressed down.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
Object
</td>
<td class="description last">object with the position of the mouse.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 374</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onRightMouseUp"><span class="type-signature"></span>onRightMouseUp</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when the right mouse button is released.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
Object
</td>
<td class="description last">object with the position of the mouse.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 382</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onSetupError"><span class="type-signature"></span>onSetupError</h4>
</dt>
<dd>
<p class="description">
This function will get a callback in the event of setup failure, likely indicating
a problem with WebGL support or the availability of a GL context.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>widget</code></td>
<td class="type">
Object
</td>
<td class="description last">A reference to this widget</td>
</tr>
<tr>
<td class="name"><code>error</code></td>
<td class="type">
Object
</td>
<td class="description last">The exception that was thrown during setup</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 255</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="onZoom"><span class="type-signature"></span>onZoom</h4>
</dt>
<dd>
<p class="description">
Override this function to be notified when the right mouse button is dragged or mouse wheel is zoomed.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>The</code></td>
<td class="type">
Object
</td>
<td class="description last">object with the start and end position of the mouse.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 398</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="removeAllCzml"><span class="type-signature"></span>removeAllCzml</h4>
</dt>
<dd>
<p class="description">
Removes all CZML data from the viewer.
</p>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 521</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="render"><span class="type-signature"></span>render</h4>
</dt>
<dd>
<p class="description">
Render the widget's scene.
</p>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1101</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="resize"><span class="type-signature"></span>resize</h4>
</dt>
<dd>
<p class="description">
This function must be called when the widget changes size. It updates the canvas
size, camera aspect ratio, and viewport size.
</p>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 267</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#resizeWidgetOnWindowResize">CesiumViewerWidget#resizeWidgetOnWindowResize</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="setLogoOffset"><span class="type-signature"></span>setLogoOffset</h4>
</dt>
<dd>
<p class="description">
Set the positional offset of the logo of the streaming imagery provider.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>logoOffsetX</code></td>
<td class="type">
Integer
</td>
<td class="description last">The horizontal offset in screen space</td>
</tr>
<tr>
<td class="name"><code>logoOffsetY</code></td>
<td class="type">
Integer
</td>
<td class="description last">The vertical offset in screen space</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1016</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="setStreamingImageryMapStyle"><span class="type-signature"></span>setStreamingImageryMapStyle</h4>
</dt>
<dd>
<p class="description">
Change the streaming imagery type, and update the globe.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<a href="BingMapsStyle.html">BingMapsStyle</a>
</td>
<td class="description last">the new map style to use.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1000</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#mapStyle">CesiumViewerWidget#mapStyle</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="setTimeFromBuffer"><span class="type-signature"></span>setTimeFromBuffer</h4>
</dt>
<dd>
<p class="description">
Apply the animation settings from a CZML buffer.
</p>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 492</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="showSkyAtmosphere"><span class="type-signature"></span>showSkyAtmosphere</h4>
</dt>
<dd>
<p class="description">
Enable or disable the "sky atmosphere" effect, which displays the limb
of the Earth (seen from space) or blue sky (seen from inside the atmosphere).
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
Boolean
</td>
<td class="description last"><code>true</code> to enable the effect.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 975</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="startRenderLoop"><span class="type-signature"></span>startRenderLoop</h4>
</dt>
<dd>
<p class="description">
This is a simple render loop that can be started if there is only one <code>CesiumViewerWidget</code>
on your page. If you wish to customize your render loop, avoid this function and instead
use code similar to one of the following examples.
</p>
<h5>Examples</h5>
<pre class="code brush: js">// This takes the place of startRenderLoop for a single widget.
var animationController = widget.animationController;
function updateAndRender() {
var currentTime = animationController.update();
widget.initializeFrame(currentTime);
widget.update(currentTime);
widget.render();
requestAnimationFrame(updateAndRender);
}
requestAnimationFrame(updateAndRender);</pre>
<pre class="code brush: js">// This example requires widget1 and widget2 to share an animationController
// (for example, widget2's constructor was called with a copy of widget1's
// animationController).
function updateAndRender() {
var currentTime = animationController.update();
widget1.initializeFrame(currentTime);
widget2.initializeFrame(currentTime);
widget1.update(currentTime);
widget2.update(currentTime);
widget1.render();
widget2.render();
requestAnimationFrame(updateAndRender);
}
requestAnimationFrame(updateAndRender);</pre>
<pre class="code brush: js">// This example uses separate animationControllers for widget1 and widget2.
// These widgets can animate at different rates and pause individually.
function updateAndRender() {
var time1 = widget1.animationController.update();
var time2 = widget2.animationController.update();
widget1.initializeFrame(time1);
widget2.initializeFrame(time2);
widget1.update(time1);
widget2.update(time2);
widget1.render();
widget2.render();
requestAnimationFrame(updateAndRender);
}
requestAnimationFrame(updateAndRender);</pre>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1214</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="requestAnimationFrame.html">requestAnimationFrame</a></li>
<li><a href="CesiumViewerWidget.html#autoStartRenderLoop">CesiumViewerWidget#autoStartRenderLoop</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="startup"><span class="type-signature"></span>startup</h4>
</dt>
<dd>
<p class="description">
Call this after placing the widget in the DOM, to initialize the WebGL context,
wire up event callbacks, begin requesting CZML, imagery, etc.
</p>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 607</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CesiumViewerWidget.html#autoStartRenderLoop">CesiumViewerWidget#autoStartRenderLoop</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature"></span>update</h4>
</dt>
<dd>
<p class="description">
Call this function prior to rendering each animation frame, to prepare
all CZML objects and other settings for the next frame.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>currentTime</code></td>
<td class="type">
<a href="JulianDate.html">JulianDate</a>
</td>
<td class="description last">The date and time in the scene of the frame to be rendered</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 1076</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="viewHome"><span class="type-signature"></span>viewHome</h4>
</dt>
<dd>
<p class="description">
Reset the camera to the home view for the current scene mode.
</p>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Widgets/Dojo/CesiumViewerWidget.js, line 898</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Fri Jan 18 2013 11:21:08 GMT-0500 (EST)
</footer>
</div>
<br clear="both">
<script type="text/javascript">
codeview.classFilter.Init();
if (window.frameElement) {
document.body.className = "embedded";
var ele = document.createElement('a');
ele.className = "popout";
ele.target = "_blank";
ele.href = window.location.href;
ele.innerHTML = "&raquo;";
ele.title = "Pop out";
document.getElementById('main').appendChild(ele);
}
var searchTerm = (document.URL.split('='))[1];
var show = (document.URL.split('='))[2];
if (show) {
document.getElementById("filterType").value = show;
}
if(searchTerm){
searchTerm = searchTerm.split('&')[0] || '';
document.filterForm.classFilter.value = searchTerm;
}
else {
searchTerm="";
}
codeview.filter(searchTerm);
SyntaxHighlighter.all();
</script>
<script src="javascript/indexLinks.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink