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

Rename speedup to multiplier #7393

Merged
merged 8 commits into from
Dec 6, 2018
Merged

Rename speedup to multiplier #7393

merged 8 commits into from
Dec 6, 2018

Conversation

OmarShehata
Copy link
Contributor

From the discussion here: #7361 (comment)

This renames ModelAnimation.speedup to ModelAnimation.timeMultiplier and adds a deprecation warning that it will be removed in one more version. I kept the old property and added a @deprecated doc tag. I also tweaked the doc HTML slightly to make sure there's a newline after the deprecated statement so that it looks better.

I was initially going to just call it ModelAnimation.rate but that felt like it was referring to "Frame rate" but glTF animations are based on real time, not a fixed frame rate. I thought about scale or timeScale but just went with timeMultiplier because I it made the most sense to me.

@hpinkos @lilleyse do either of you want to review?

@cesium-concierge
Copy link

Thanks for the pull request @OmarShehata!

  • ✔️ Signed CLA found.

Reviewers, don't forget to make sure that:

  • Cesium Viewer works.
  • Works in 2D/CV.
  • Works (or fails gracefully) in IE11.

I am a bot who helps you make Cesium awesome! Contributions to my configuration are welcome.

🌍 🌎 🌏

@hpinkos
Copy link
Contributor

hpinkos commented Dec 6, 2018

Changes look good to me! Should it maybe be named just multiplier instead? @lilleyse what's your opinion?

@OmarShehata
Copy link
Contributor Author

I was worried multiplier on its own might be confused with something about how many times the animation loops but I could just be paranoid. I'm open to suggestions.

@lilleyse
Copy link
Contributor

lilleyse commented Dec 6, 2018

Just multiplier is nice because it matches Clock.multiplier.

@OmarShehata
Copy link
Contributor Author

Should be good now @lilleyse !

@lilleyse lilleyse changed the title Rename speedup to timeMultiplier Rename speedup to multiplier Dec 6, 2018
@lilleyse
Copy link
Contributor

lilleyse commented Dec 6, 2018

Cool, thanks!

@lilleyse lilleyse merged commit 47deb4c into CesiumGS:master Dec 6, 2018
@lilleyse
Copy link
Contributor

lilleyse commented Dec 6, 2018

@OmarShehata make sure to open an issue to remove the deprecated functionality in 1.54. Someone can then assign it the remove in 1.54 label.

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.

4 participants