Orbit camera around object

View on GitHub
Sample viewer app

Fix the camera to point at and rotate around a target object.

Image of orbit camera around object

Use case

The orbit geoelement camera controller provides control over the following camera behaviors:

  • automatically track the target
  • stay near the target by setting a minimum and maximum distance offset
  • restrict where you can rotate around the target
  • automatically rotate the camera when the target's heading and pitch changes
  • disable user interactions for rotating the camera
  • animate camera movement over a specified duration
  • control the vertical positioning of the target on the screen
  • set a target offset (e.g.to orbit around the tail of the plane) instead of defaulting to orbiting the center of the object

How to use the sample

The sample loads with the camera orbiting an aeroplane model. The camera is preset with a restricted camera heading and pitch, and a limited minimum and maximum camera distance set from the plane. The position of the plane on the screen is also set just below center.

Use the "Camera Heading" slider to adjust the camera heading. Select the "Allow camera distance interaction" checkbox to allow zooming in and out with the mouse/keyboard: when the checkbox is deselected the user will be unable to adjust with the camera distance.

Use the "Plane Pitch" slider to adjust the plane's pitch. When not in Cockpit view, the plane's pitch will change independently to that of the camera pitch.

Use the "Cockpit view" button to offset and fix the camera into the cockpit of the aeroplane. Use the "Plane pitch" slider to control the pitch of aeroplane: the camera will follow the pitch of the plane in this mode. In this view adjusting the camera distance is disabled. Hit the "Center view" button to exit cockpit view mode and fix the camera controller on the center of the plane.

How it works

  1. Instantiate an OrbitGeoElementCameraController, with GeoElement and camera distance as parameters.
  2. Use sceneView.setCameraController(OrbitCameraController) to set the camera to the scene view.
  3. Set the heading, pitch and distance camera properties with:

    • orbitCameraController.setCameraHeadingOffset(double)
    • orbitCameraController.setCameraPitchOffset(double)
    • orbitCameraController.setCameraDistance(double)
  4. Set the minimum and maximum angle of heading and pitch, and minimum and maximum distance for the camera with:

    • orbitCameraController.setMin or setMaxCameraHeadingOffset(double).
    • orbitCameraController.setMin or setMaxCameraPitchOffset(double).
    • orbitCameraController.setMin or setMaxCameraDistance(double).
  5. Set the distance from which the camera is offset from the plane with:

    • orbitCameraController.setTargetOffsetsAsync(x, y, z, duration)
    • orbitCameraController.setTargetOffsetX(double)
    • orbitCameraController.setTargetOffsetY(double)
    • orbitCameraController.setTargetOffsetZ(double)
  6. Set the vertical screen factor to determine where the plane appears in the scene:

    • orbitCameraController.setTargetVerticalScreenFactor(float)
  7. Animate the camera to the cockpit using orbitCameraController.setTargetOffsetsAsync(x, y, z, duration)
  8. Set if the camera distance will adjust when zooming or panning using mouse or keyboard (default is true):

    • orbitCameraController.setCameraDistanceInteractive(boolean)
  9. Set if the camera will follow the pitch of the plane (default is true):

    • orbitCameraController.setAutoPitchEnabled(boolean)

Relevant API

  • OrbitGeoElementCameraController

Tags

3D, camera, object, orbit, rotate, scene

Sample Code

OrbitTheCameraAroundAnObjectController.javaOrbitTheCameraAroundAnObjectSample.javamain.fxml
                                                                                                                                                                                                                       
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/*
 * Copyright 2019 Esri.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.esri.samples.orbit_the_camera_around_an_object;

import java.io.File;

import com.esri.arcgisruntime.mapping.view.DrawStatus;
import com.esri.arcgisruntime.mapping.view.DrawStatusChangedEvent;
import com.esri.arcgisruntime.mapping.view.DrawStatusChangedListener;
import javafx.fxml.FXML;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Slider;

import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.mapping.ArcGISScene;
import com.esri.arcgisruntime.mapping.ArcGISTiledElevationSource;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.Surface;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.mapping.view.LayerSceneProperties;
import com.esri.arcgisruntime.mapping.view.OrbitGeoElementCameraController;
import com.esri.arcgisruntime.mapping.view.SceneView;
import com.esri.arcgisruntime.symbology.ModelSceneSymbol;
import com.esri.arcgisruntime.symbology.SimpleRenderer;

public class OrbitTheCameraAroundAnObjectController {

  @FXML
  private SceneView sceneView;
  @FXML
  private CheckBox allowDistanceInteractionCheckBox;
  @FXML
  private Slider cameraHeadingSlider;
  @FXML
  private Slider planePitchSlider;

  private OrbitGeoElementCameraController orbitCameraController;


  public void initialize() {

    try {

      // create a scene and add a basemap to it
      ArcGISScene scene = new ArcGISScene();
      scene.setBasemap(Basemap.createImagery());
      sceneView.setArcGISScene(scene);

      // add a base surface with elevation data
      Surface surface = new Surface();
      ArcGISTiledElevationSource elevationSource = new ArcGISTiledElevationSource("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer");
      surface.getElevationSources().add(elevationSource);
      scene.setBaseSurface(surface);

      // create a graphics overlay for the scene
      GraphicsOverlay sceneGraphicsOverlay = new GraphicsOverlay();
      sceneGraphicsOverlay.getSceneProperties().setSurfacePlacement(LayerSceneProperties.SurfacePlacement.RELATIVE);
      sceneView.getGraphicsOverlays().add(sceneGraphicsOverlay);

      // create a renderer to control the plane's orientation by its attributes
      SimpleRenderer renderer = new SimpleRenderer();
      renderer.getSceneProperties().setHeadingExpression("[HEADING]");
      renderer.getSceneProperties().setPitchExpression("[PITCH]");
      sceneGraphicsOverlay.setRenderer(renderer);

      // create a graphic of a plane model
      String modelURI = new File(System.getProperty("data.dir"), "./samples-data/bristol/Collada/Bristol.dae").getAbsolutePath();
      ModelSceneSymbol plane3DSymbol = new ModelSceneSymbol(modelURI, 1.0);
      plane3DSymbol.loadAsync();
      // position the plane over a runway
      Graphic plane = new Graphic(new Point(6.637, 45.399, 100, SpatialReferences.getWgs84()), plane3DSymbol);
      // initialize the plane's heading to line up with the runway
      plane.getAttributes().put("HEADING", 45.0);
      sceneGraphicsOverlay.getGraphics().add(plane);

      // control the plane's pitch with a slider
      planePitchSlider.valueProperty().addListener(o -> plane.getAttributes().put("PITCH", planePitchSlider.getValue()));

      // listener for the view to stop loading and to add the camera controller
      DrawStatusChangedListener listener = new DrawStatusChangedListener() {

        @Override
        public void drawStatusChanged(DrawStatusChangedEvent drawStatusChangedEvent) {
          if (drawStatusChangedEvent.getDrawStatus() == DrawStatus.COMPLETED) {

              // create an orbit geoelement camera controller with the plane as the target
              orbitCameraController = new OrbitGeoElementCameraController(plane, 50.0);

              // restrict the camera's heading to stay behind the plane
              orbitCameraController.setMinCameraHeadingOffset(-45);
              orbitCameraController.setMaxCameraHeadingOffset(45);

              // restrict the camera's pitch so it doesn't go completely vertical or collide with the ground
              orbitCameraController.setMinCameraPitchOffset(10);
              orbitCameraController.setMaxCameraPitchOffset(100);

              // restrict the camera to stay between 10 and 1000 meters from the plane
              orbitCameraController.setMinCameraDistance(10);
              orbitCameraController.setMaxCameraDistance(100);

              // position the plane a third from the bottom of the screen
              orbitCameraController.setTargetVerticalScreenFactor(0.33f);

              // don't pitch the camera when the plane pitches
              orbitCameraController.setAutoPitchEnabled(false);

              // set the orbit camera controller to the scene view
              sceneView.setCameraController(orbitCameraController);

              // set the camera's heading using a slider
              cameraHeadingSlider.valueProperty().addListener(o -> orbitCameraController.setCameraHeadingOffset(cameraHeadingSlider.getValue()));

              // update camera heading slider position whilst interacting with the camera heading
              sceneView.addViewpointChangedListener( event -> cameraHeadingSlider.setValue(orbitCameraController.getCameraHeadingOffset()));

            // stop listening for the view to load
            sceneView.removeDrawStatusChangedListener(this);
          }
        }
      };

      sceneView.addDrawStatusChangedListener(listener);

    } catch (Exception e) {
      // on any exception, print the stack trace
      e.printStackTrace();
    }
  }

  /**
   * Animates the camera to a cockpit view. The camera's target is offset to the cockpit (instead of the plane's
   * center). The camera is moved onto the target position to create a swivelling camera effect. Auto pitch is
   * enabled so the camera pitches when the plane pitches.
   */
  @FXML
  private void handleCockpitViewButtonClicked() {
    // disable camera distance interaction checkbox
    allowDistanceInteractionCheckBox.setDisable(true);

    // allow the camera to get closer to the target
    orbitCameraController.setMinCameraDistance(0);

    // pitch the camera when the plane pitches
    orbitCameraController.setAutoPitchEnabled(true);

    // animate the camera target to the cockpit instead of the center of the plane
    orbitCameraController.setTargetOffsetsAsync(0, -2, 1.1, 1);

    // animate the camera so that it is 0.01m from the target (cockpit), facing forward (0 deg heading), and aligned
    // with the horizon (90 deg pitch)
    orbitCameraController.moveCameraAsync(0 - orbitCameraController.getCameraDistance(),
        0 - orbitCameraController.getCameraHeadingOffset(), 90 - orbitCameraController.getCameraPitchOffset(), 1).addDoneListener(() -> {
      // once the camera is in the cockpit, only allow the camera's heading to change
      orbitCameraController.setMinCameraPitchOffset(90);
      orbitCameraController.setMaxCameraPitchOffset(90);
    });
  }

  /**
   * Configures the camera controller for a "follow" view. The camera targets the center of the plane with a default
   * position directly behind and slightly above the plane. Auto pitch is disabled so the camera does not pitch when
   * the plane pitches.
   */
  @FXML
  private void handleCenterViewButtonClicked() {
    allowDistanceInteractionCheckBox.setDisable(false);

    orbitCameraController.setAutoPitchEnabled(false);
    orbitCameraController.setTargetOffsetX(0);
    orbitCameraController.setTargetOffsetY(0);
    orbitCameraController.setTargetOffsetZ(0);
    orbitCameraController.setCameraHeadingOffset(0);
    orbitCameraController.setCameraPitchOffset(45);
    orbitCameraController.setMinCameraPitchOffset(10);
    orbitCameraController.setMaxCameraPitchOffset(100);
    orbitCameraController.setMinCameraDistance(10.0);
    orbitCameraController.setCameraDistance(50.0);
  }

  /**
   * Toggle interactive distance. When distance interaction is disabled, the user cannot zoom in with the mouse.
   */
  @FXML
  private void handleDistanceInteractionCheckBoxToggle() {
    orbitCameraController.setCameraDistanceInteractive(allowDistanceInteractionCheckBox.isSelected());
  }

  /**
   * Disposes of application resources.
   */
  void terminate() {

    // release resources when the application closes
    if (sceneView != null) {
      sceneView.dispose();
    }
  }

}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.