CameraFlightPath

Creates animations for camera flights.

Source:

/Source/Scene/CameraFlightPath.js

Methods

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

Parameters:

Name	Type	Argument	Default	Description
`frameState`	FrameState			The current frame state.
`description.destination`	Cartesian3			The final position of the camera.
`description.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.
`description.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.
`description.duration`	Number	<optional>	3000	The duration of the animation in milliseconds.
`onComplete`	Function	<optional>		The function to execute when the animation has completed.

Throws:

DeveloperError : frameState is required.
DeveloperError : description.destination is required.
DeveloperError : frameState.mode cannot be SceneMode.MORPHING

Returns:

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

See:

<static> createAnimationCartographic

Creates an animation to fly the camera from it's current position to a position given by a Cartographic. Keep in mind that the animation will happen in the camera's current reference frame.

Parameters:

Name	Type	Argument	Default	Description
`frameState`	FrameState			The current frame state.
`description.destination`	Cartographic			The final position of the camera.
`description.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.
`description.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.
`description.duration`	Number	<optional>	3000	The duration of the animation in milliseconds.
`onComplete`	Function	<optional>		The function to execute when the animation has completed.

Throws:

DeveloperError : frameState is required.
DeveloperError : description.destination is required.
DeveloperError : frameState.mode cannot be SceneMode.MORPHING

Returns:

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

See:

<static> createAnimationExtent

Creates an animation to fly the camera from it's current position to a position in which the entire extent will be visible. Keep in mind that the animation will happen in the camera's current reference frame.

Parameters:

Name	Type	Argument	Default	Description
`frameState`	FrameState			The current frame state.
`description.destination`	Extent			The final position of the camera.
`description.duration`	Number	<optional>	3000	The duration of the animation in milliseconds.
`onComplete`	Function	<optional>		The function to execute when the animation has completed.