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

4556 lines
91 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>CameraController - 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">CameraController</h1>
<section>
<header>
<h2>
CameraController
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="CameraController"><span class="type-signature"></span>new CameraController</h4>
</dt>
<dd>
<p class="description">
Provides methods for common camera manipulations.
</p>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: camera is required.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 46</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="constrainedAxis"><span class="type-signature"></span>constrainedAxis<span class="type-signature"> :<a href="Cartesian3.html">Cartesian3</a></span></h4>
</dt>
<dd>
<div class="description">
If set, the camera will not be able to rotate past this axis in either direction.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 83</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="defaultLookAmount"><span class="type-signature"></span>defaultLookAmount<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
The default amount to rotate the camera when an argument is not
provided to the look methods.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 66</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="defaultMoveAmount"><span class="type-signature"></span>defaultMoveAmount<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
The default amount to move the camera when an argument is not
provided to the move methods.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 60</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="defaultRotateAmount"><span class="type-signature"></span>defaultRotateAmount<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
The default amount to rotate the camera when an argument is not
provided to the rotate methods.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 72</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="defaultZoomAmount"><span class="type-signature"></span>defaultZoomAmount<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
The default amount to move the camera when an argument is not
provided to the zoom methods.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 78</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="maximumTranslateFactor"><span class="type-signature"></span>maximumTranslateFactor<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
The factor multiplied by the the map size used to determine where to clamp the camera position
when translating across the surface. The default is 1.5. Only valid for 2D and Columbus view.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 89</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="maximumZoomFactor"><span class="type-signature"></span>maximumZoomFactor<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
The factor multiplied by the the map size used to determine where to clamp the camera position
when zooming out from the surface. The default is 2.5. Only valid for 2D.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 95</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="createCorrectPositionAnimation"><span class="type-signature"></span>createCorrectPositionAnimation</h4>
</dt>
<dd>
<p class="description">
Create an animation to move the map into view. This method is only valid for 2D and Columbus modes.
</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>duration</code></td>
<td class="type">
Number
</td>
<td class="description last">The duration, in milliseconds, of the animation.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">DeveloperException</span>
: duration is required.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<span class="param-type">Object</span>
The animation or undefined if the scene mode is 3D or the map is already ion view.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 1243</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="getMagnitude"><span class="type-signature"></span>getMagnitude</h4>
</dt>
<dd>
<p class="description">
Gets the magnitude of the camera position. In 3D, this is the vector magnitude. In 2D and
Columbus view, this is the distance to the map.
</p>
<h5>Returns:</h5>
<div class="param-desc">
<span class="param-type">Number</span>
The magnitude of the position.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 667</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="getPickRay"><span class="type-signature"></span>getPickRay</h4>
</dt>
<dd>
<p class="description">
Create a ray from the camera position through the pixel at <code>windowPosition</code>
in world coordinates.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>windowPosition</code></td>
<td class="type">
<a href="Cartesian2.html">Cartesian2</a>
</td>
<td class="attributes">
</td>
<td class="description last">The x and y coordinates of a pixel.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<a href="Ray.html">Ray</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: windowPosition is required.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<span class="param-type">Object</span>
Returns the <a href="Cartesian3.html">Cartesian3</a> position and direction of the ray.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 1086</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="look"><span class="type-signature"></span>look</h4>
</dt>
<dd>
<p class="description">
Rotate each of the camera's orientation vectors around <code>axis</code> by <code>angle</code>
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>axis</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="attributes">
</td>
<td class="description last">The axis to rotate around.</td>
</tr>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The angle, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: axis is required.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 347</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#lookUp">CameraController#lookUp</a></li>
<li><a href="CameraController.html#lookDown">CameraController#lookDown</a></li>
<li><a href="CameraController.html#lookLeft">CameraController#lookLeft</a></li>
<li><a href="CameraController.html#lookRight">CameraController#lookRight</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="lookAt"><span class="type-signature"></span>lookAt</h4>
</dt>
<dd>
<p class="description">
Sets the camera position and orientation with an eye position, target, and up vector.
This method is not supported in 2D mode because there is only one direction to look.
</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>eye</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="description last">The position of the camera.</td>
</tr>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="description last">The position to look at.</td>
</tr>
<tr>
<td class="name"><code>up</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="description last">The up vector.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: eye is required.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: target is required.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: up is required.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: lookAt is not supported in 2D mode because there is only one direction to look.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: lookAt is not supported while morphing.
</div>
</li>
</ul>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 758</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="lookDown"><span class="type-signature"></span>lookDown</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around its right vector by amount, in radians, in the opposite direction
of its up vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 325</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#lookUp">CameraController#lookUp</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="lookLeft"><span class="type-signature"></span>lookLeft</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around its up vector by amount, in radians, in the opposite direction
of its right vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 280</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#lookRight">CameraController#lookRight</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="lookRight"><span class="type-signature"></span>lookRight</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around its up vector by amount, in radians, in the direction
of its right vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 295</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#lookLeft">CameraController#lookLeft</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="lookUp"><span class="type-signature"></span>lookUp</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around its right vector by amount, in radians, in the direction
of its up vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 310</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#lookDown">CameraController#lookDown</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="move"><span class="type-signature"></span>move</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along <code>direction</code>.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>direction</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="attributes">
</td>
<td class="description last">The direction to move.</td>
</tr>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: direction is required.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 169</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveBackward">CameraController#moveBackward</a></li>
<li><a href="CameraController.html#moveForward">CameraController#moveForward</a></li>
<li><a href="CameraController.html#moveLeft">CameraController#moveLeft</a></li>
<li><a href="CameraController.html#moveRight">CameraController#moveRight</a></li>
<li><a href="CameraController.html#moveUp">CameraController#moveUp</a></li>
<li><a href="CameraController.html#moveDown">CameraController#moveDown</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="moveBackward"><span class="type-signature"></span>moveBackward</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along the opposite direction
of the camera's view vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 207</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveForward">CameraController#moveForward</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="moveDown"><span class="type-signature"></span>moveDown</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along the opposite direction
of the camera's up vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 236</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveUp">CameraController#moveUp</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="moveForward"><span class="type-signature"></span>moveForward</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along the camera's view vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 192</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveBackward">CameraController#moveBackward</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="moveLeft"><span class="type-signature"></span>moveLeft</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along the opposite direction
of the camera's right vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 265</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveRight">CameraController#moveRight</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="moveRight"><span class="type-signature"></span>moveRight</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along the camera's right vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 250</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveLeft">CameraController#moveLeft</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="moveUp"><span class="type-signature"></span>moveUp</h4>
</dt>
<dd>
<p class="description">
Translates the camera's position by <code>amount</code> along the camera's up vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 221</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#moveDown">CameraController#moveDown</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="pickEllipsoid"><span class="type-signature"></span>pickEllipsoid</h4>
</dt>
<dd>
<p class="description">
Pick an ellipsoid or map.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>windowPosition</code></td>
<td class="type">
<a href="Cartesian2.html">Cartesian2</a>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The x and y coordinates of a pixel.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<a href="Ellipsoid.html">Ellipsoid</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Ellipsoid.WGS84
</td>
<td class="description last">The ellipsoid to pick.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: windowPosition is required.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
If the ellipsoid or map was picked, returns the point on the surface of the ellipsoid or map
in world coordinates. If the ellipsoid or map was not picked, returns undefined.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 1003</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="rotate"><span class="type-signature"></span>rotate</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around <code>axis</code> by <code>angle</code>. The distance
of the camera's position to the center of the camera's reference frame remains the same.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>axis</code></td>
<td class="type">
<a href="Cartesian3.html">Cartesian3</a>
</td>
<td class="attributes">
</td>
<td class="description last">The axis to rotate around given in world coordinates.</td>
</tr>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<a href="Matrix4.html">Matrix4</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A transform to append to the camera transform before the rotation. Does not alter the camera's transform.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: axis is required.
</div>
<h5>Example</h5>
<pre class="code brush: js">// Rotate about a point on the earth.
var center = ellipsoid.cartographicToCartesian(cartographic);
var transform = Matrix4.fromTranslation(center);
controller.rotate(axis, angle, transform);</pre>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 464</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#rotateUp">CameraController#rotateUp</a></li>
<li><a href="CameraController.html#rotateDown">CameraController#rotateDown</a></li>
<li><a href="CameraController.html#rotateLeft">CameraController#rotateLeft</a></li>
<li><a href="CameraController.html#rotateRight">CameraController#rotateRight</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="rotateDown"><span class="type-signature"></span>rotateDown</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around the center of the camera's reference frame by angle downwards.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<a href="Matrix4.html">Matrix4</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A transform to append to the camera transform before the rotation. Does not alter the camera's transform.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 494</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#rotateUp">CameraController#rotateUp</a></li>
<li><a href="CameraController.html#rotate">CameraController#rotate</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="rotateLeft"><span class="type-signature"></span>rotateLeft</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around the center of the camera's reference frame by angle to the left.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<a href="Matrix4.html">Matrix4</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A transform to append to the camera transform before the rotation. Does not alter the camera's transform.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 581</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#rotateRight">CameraController#rotateRight</a></li>
<li><a href="CameraController.html#rotate">CameraController#rotate</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="rotateRight"><span class="type-signature"></span>rotateRight</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around the center of the camera's reference frame by angle to the right.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<a href="Matrix4.html">Matrix4</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A transform to append to the camera transform before the rotation. Does not alter the camera's transform.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 565</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#rotateLeft">CameraController#rotateLeft</a></li>
<li><a href="CameraController.html#rotate">CameraController#rotate</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="rotateUp"><span class="type-signature"></span>rotateUp</h4>
</dt>
<dd>
<p class="description">
Rotates the camera around the center of the camera's reference frame by angle upwards.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<a href="Matrix4.html">Matrix4</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">A transform to append to the camera transform before the rotation. Does not alter the camera's transform.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 510</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#rotateDown">CameraController#rotateDown</a></li>
<li><a href="CameraController.html#rotate">CameraController#rotate</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="setPositionCartographic"><span class="type-signature"></span>setPositionCartographic</h4>
</dt>
<dd>
<p class="description">
Moves the camera to the provided cartographic position.
</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>cartographic</code></td>
<td class="type">
<a href="Cartographic.html">Cartographic</a>
</td>
<td class="description last">The new camera position.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: cartographic is required.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 728</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="twistLeft"><span class="type-signature"></span>twistLeft</h4>
</dt>
<dd>
<p class="description">
Rotate the camera counter-clockwise around its direction vector by amount, in radians.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 373</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#twistRight">CameraController#twistRight</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="twistRight"><span class="type-signature"></span>twistRight</h4>
</dt>
<dd>
<p class="description">
Rotate the camera clockwise around its direction vector by amount, in radians.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 387</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#twistLeft">CameraController#twistLeft</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="viewExtent"><span class="type-signature"></span>viewExtent</h4>
</dt>
<dd>
<p class="description">
View an extent on an ellipsoid or map.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>extent</code></td>
<td class="type">
<a href="Extent.html">Extent</a>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The extent to view.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<a href="Ellipsoid.html">Ellipsoid</a>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Ellipsoid.WGS84
</td>
<td class="description last">The ellipsoid to view.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: extent is required.
</div>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 932</li></ul></dd>
-->
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="zoomIn"><span class="type-signature"></span>zoomIn</h4>
</dt>
<dd>
<p class="description">
Zooms <code>amount</code> along the camera's view vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount to move. Defaults to <code>defaultZoomAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 633</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#zoomOut">CameraController#zoomOut</a></li>
</ul>
</dl>
<div class="hr"></div>
</dd>
<dt>
<h4 class="name" id="zoomOut"><span class="type-signature"></span>zoomOut</h4>
</dt>
<dd>
<p class="description">
Zooms <code>amount</code> along the opposite direction of
the camera's view vector.
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
Number
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">The amount to move. Defaults to <code>defaultZoomAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<!--
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>../../Source/Scene/CameraController.js, line 652</li></ul></dd>
-->
<h5>See:</h5>
<ul class="see-list">
<li><a href="CameraController.html#zoomIn">CameraController#zoomIn</a></li>
</ul>
</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:20:44 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