Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update #3047

Merged
merged 2 commits into from
Sep 28, 2015
Merged

Documentation update #3047

merged 2 commits into from
Sep 28, 2015

Conversation

klim705
Copy link
Contributor

@klim705 klim705 commented Sep 28, 2015

No description provided.

@@ -2376,7 +2376,7 @@ define([
* @param {Object} [options.orientation] An object that contains either direction and up properties or heading, pith and roll properties. 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. The up direction will point towards local north in 3D and in the positive
* y direction in Columbus view or 2D.
* @param {Number} [options.duration=3.0] The duration of the flight in seconds.
* @param {Number} [options.duration=3.0] The max duration of the flight in seconds.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @klim705 but this is not actually correct. If you specify a duration the flight always lasts that exact amount of time, it's only when you don't specify a value that the time varies. Let's change it to something like:

The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight.

I would also get rid of the =3.0 default value since it's incorrect since #2825. We should probably eventually add a maxDuration property to make this less confusing, but let's just leave it as is for now and improve the doc.

@klim705
Copy link
Contributor Author

klim705 commented Sep 28, 2015

Sorry about that; I've updated appropriately.

@mramato
Copy link
Contributor

mramato commented Sep 28, 2015

No problem. Thanks!

mramato added a commit that referenced this pull request Sep 28, 2015
@mramato mramato merged commit 034f7b1 into CesiumGS:master Sep 28, 2015
@pjcozzi
Copy link
Contributor

pjcozzi commented Sep 28, 2015

@mramato can you update CONTRIBUTORS.md in master?

@mramato
Copy link
Contributor

mramato commented Sep 28, 2015

Thanks for the reminder, done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants