CameraFlightPath

Methods

staticCameraFlightPath.createAnimation(scene) → Object

Creates an animation to fly the camera from it's current position to a position given by a Cartesian. All arguments should be given in world coordinates.

Name	Type	Default	Description
scene	Scene		The scene instance to use.
options.destination	Cartesian3		The final position of the camera.
options.direction	Cartesian3		optional The final direction of the camera. By default, the direction will point towards the center of the frame in 3D and in the negative z direction in Columbus view or 2D.
options.up	Cartesian3		optional The final up direction. By default, the up direction will point towards local north in 3D and in the positive y direction in Columbus view or 2D.
options.duration	Number	3000	optional The duration of the animation in milliseconds.
options.onComplete	function		optional The function to execute when the animation has completed.
options.onCancel	function		optional The function to execute if the animation is cancelled.
options.endReferenceFrame	Matrix4		optional The reference frame the camera will be in when the flight is completed.
options.convert	Boolean	true	optional When true, the destination is converted to the correct coordinate system for each scene mode. When false, the destination is expected to be in the correct coordinate system.

Returns:

An Object that can be added to an AnimationCollection for animation.

Throws:

• DeveloperError : If either direction or up is given, then both are required.

See:

• Scene#animations

Source: Scene/CameraFlightPath.js, line 412

staticCameraFlightPath.createAnimationRectangle(scene, onComplete, onCancel, endReferenceFrame) → Object

Creates an animation to fly the camera from it's current position to a position in which the entire rectangle will be visible. All arguments should be given in world coordinates.

Name	Type	Default	Description
scene	Scene		The scene instance to use.
options.destination	Rectangle		The final position of the camera.
options.duration	Number	3000	optional The duration of the animation in milliseconds.
onComplete	function		optional The function to execute when the animation has completed.
onCancel	function		optional The function to execute if the animation is cancelled.
endReferenceFrame	Matrix4		optional The reference frame the camera will be in when the flight is completed.

Returns:

An Object that can be added to an AnimationCollection for animation.

See:

• Scene#animations

Source: Scene/CameraFlightPath.js, line 577