Fire button and shield button animations #476
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| // | ||
| // AnimationView.swift | ||
| // | ||
| // Copyright © 2022 DuckDuckGo. All rights reserved. | ||
| // | ||
| // 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. | ||
| // | ||
|
|
||
| import Foundation | ||
| import Lottie | ||
|
|
||
| extension AnimationView { | ||
|
|
||
| convenience init?(named animationName: String, imageProvider: AnimationImageProvider? = nil) { | ||
| guard let animation = Animation.named(animationName, animationCache: LottieAnimationCache.shared) else { | ||
| return nil | ||
| } | ||
|
|
||
| self.init(animation: animation, imageProvider: imageProvider) | ||
| identifier = NSUserInterfaceItemIdentifier(rawValue: animationName) | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| // | ||
| // MouseOverAnimationButton.swift | ||
| // | ||
| // Copyright © 2022 DuckDuckGo. All rights reserved. | ||
| // | ||
| // 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. | ||
| // | ||
|
|
||
| import Foundation | ||
| import Lottie | ||
| import Combine | ||
|
|
||
| final class MouseOverAnimationButton: AddressBarButton { | ||
|
There was a problem hiding this comment. This class encapsulates the mouse over animation. Developer only sets |
||
|
|
||
| // MARK: - Events | ||
|
|
||
| override func awakeFromNib() { | ||
| super.awakeFromNib() | ||
|
|
||
| subscribeToIsMouseOver() | ||
| subscribeToEffectiveAppearance() | ||
| } | ||
|
|
||
| private var isMouseOverCancellable: AnyCancellable? | ||
|
|
||
| private func subscribeToIsMouseOver() { | ||
| isMouseOverCancellable = $isMouseOver | ||
| .dropFirst() | ||
| .sink { [weak self] isMouseOver in | ||
| if isMouseOver { | ||
| self?.animate() | ||
| } else { | ||
| self?.stopAnimation() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private var effectiveAppearanceCancellable: AnyCancellable? | ||
|
|
||
| private func subscribeToEffectiveAppearance() { | ||
| effectiveAppearanceCancellable = NSApp.publisher(for: \.effectiveAppearance) | ||
| .dropFirst() | ||
| .receive(on: DispatchQueue.main) | ||
| .sink { [weak self] _ in | ||
| self?.updateAnimationView() | ||
| } | ||
| } | ||
|
|
||
| // MARK: - Loading & Updating of Animation Views | ||
|
|
||
| struct AnimationNames: Equatable { | ||
| let aqua: String | ||
| let dark: String | ||
| } | ||
|
|
||
| var animationNames: AnimationNames? { | ||
| didSet { | ||
| if oldValue != animationNames { | ||
| loadAnimationViews() | ||
| updateAnimationView() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| struct AnimationViews { | ||
| let aqua: AnimationView | ||
| let dark: AnimationView | ||
| } | ||
|
|
||
| private var animationViewCache: AnimationViews? | ||
|
|
||
| private func loadAnimationViews() { | ||
| guard let animationNames = animationNames, | ||
| let aquaAnimationView = AnimationView(named: animationNames.aqua), | ||
| let darkAnimationView = AnimationView(named: animationNames.dark) else { | ||
| assertionFailure("Missing animation names or animation files in the bundle") | ||
| return | ||
| } | ||
|
|
||
| animationViewCache = AnimationViews( | ||
| aqua: aquaAnimationView, | ||
| dark: darkAnimationView) | ||
| } | ||
|
|
||
| private var currentAnimationView: AnimationView? | ||
|
|
||
| private func updateAnimationView() { | ||
| guard let animationViewCache = animationViewCache else { | ||
| assertionFailure("No animations loaded") | ||
| return | ||
| } | ||
|
|
||
| let isAquaMode = NSApp.effectiveAppearance.name == NSAppearance.Name.aqua | ||
| let newAnimationView: AnimationView | ||
| // Animation view causes problems in tests | ||
| if AppDelegate.isRunningTests { | ||
| newAnimationView = AnimationView() | ||
| } else { | ||
| newAnimationView = isAquaMode ? animationViewCache.aqua : animationViewCache.dark | ||
| } | ||
|
|
||
| guard currentAnimationView?.identifier != newAnimationView.identifier else { | ||
| // No need to update | ||
| return | ||
| } | ||
|
|
||
| currentAnimationView?.removeFromSuperview() | ||
| currentAnimationView = newAnimationView | ||
|
|
||
| newAnimationView.isHidden = true | ||
| addAndLayout(newAnimationView) | ||
| } | ||
|
|
||
| // MARK: - Animating | ||
|
|
||
| @Published var isAnimationViewVisible = false | ||
|
|
||
| override var image: NSImage? { | ||
|
There was a problem hiding this comment. In case something sets the image while animation is in progress |
||
| get { | ||
| return super.image | ||
| } | ||
|
|
||
| set { | ||
| if isAnimationViewVisible { | ||
| imageCache = newValue | ||
| } else { | ||
| super.image = newValue | ||
| } | ||
| } | ||
| } | ||
|
|
||
| var imageCache: NSImage? | ||
|
|
||
| private func hideImage() { | ||
| imageCache = image | ||
| super.image = nil | ||
| } | ||
|
|
||
| private func showImage() { | ||
| if let imageCache = imageCache { | ||
| NSAppearance.withAppAppearance { | ||
| image = imageCache | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func hideAnimation() { | ||
| currentAnimationView?.isHidden = true | ||
| isAnimationViewVisible = false | ||
| } | ||
|
|
||
| private func showAnimation() { | ||
| currentAnimationView?.isHidden = false | ||
| isAnimationViewVisible = true | ||
| } | ||
|
|
||
| private func animate() { | ||
| hideImage() | ||
| showAnimation() | ||
| currentAnimationView?.play() | ||
| } | ||
|
|
||
| private func stopAnimation() { | ||
| hideAnimation() | ||
| showImage() | ||
| currentAnimationView?.stop() | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved animations to their own subfolder. My apology for the harder readability of this PR because of this