A Swifty way to deal with and normalize orientations on iOS.
v0.4.0
According to the docs on UIDevice.currentDevice().orientation:
The value of this property always returns 0 unless orientation notifications have been enabled by calling
beginGeneratingDeviceOrientationNotifications.
Also, calling endGeneratingDeviceOrientationNotifications seems to be a good idea, to preserve batery life.
Thus, this library not only normalizes the various types of orientations iOS works with (UIDeviceOrientation, UIInterfaceOrientation, UIImageOrientation and optionally AVCaptureVideoOrientation), but also attempts to optimize the generation of such rotation notifications by creating a shared weak singleton that will only stay alive as long as there's an object needing it (ie. holding a strong reference to it) and that will end the generation of orientation notifications when it's deinit'ed.
Here's how to use it:
class ViewController: UIViewController {
let orientation = Orientation.shared()
override public func viewWillTransitionToSize(size: CGSize, withTransitionCoordinator coordinator: UIViewControllerTransitionCoordinator) {
/*
We need to call `check()`, because iOS only produces the `UIDeviceOrientationDidChangeNotification` and not its `UIDeviceOrientationWillChangeNotification` counterpart. So the current orientation will only by updated automatically when the rotation finishes.
How is this better than checking for `UIDevice.currentDevice().orientation`? Because if the device moves from `UIDeviceOrientationPortrait` to `UIDeviceOrientationFaceUp`, we maintain it as `UIDeviceOrientationPortrait`. After all, your UI doesn't really need to change when the device is sitting on its back, does it?
Also, you may simply disregard `UIInterfaceOrientation`. Neat, huh?
*/
let currentOrientation = self.orientation.check()
switch currentOrientation
{
case .Portrait: //do something if we are portrait
default: //else case
}
coordinator.notifyWhenInteractionEndsUsingBlock { [unowned self] (ctx: UIViewControllerTransitionCoordinatorContext) -> Void in
if !ctx.isInteractive() {
//no need to call check, because now it's been checked automatically
let currentOrientation = self.orientation.current
/* ... */
}
}
super.viewWillTransitionToSize(size, withTransitionCoordinator: coordinator)
}
}
To run the example project, clone the repo, and run pod install from the Example directory first.
- iOS 8+
- Swift 3.0
Because of this, I've dropped support for Cocoapods on this repo. I cannot have production code rely on a dependency manager that breaks this badly.
Why submodules, you ask?
Following this thread and other similar to it, and given that Cocoapods only works with Swift by adding the use_frameworks! directive, there's a strong case for not bloating the app up with too many frameworks. Although git submodules are a bit trickier to work with, the burden of adding dependencies should weigh on the developer, not on the user. 😉
To install Orientation using git submodules:
cd toYourProjectsFolder
git submodule add -b submodule --name Orientation https://github.com/BellAppLab/Orientation.git
Navigate to the new Orientation folder and drag the Source folder to your Xcode project.
**Note: ** If you're not using AVFoundation on your project, just remove the reference to the Video folder.
Bell App Lab, [email protected]
Orientation is available under the MIT license. See the LICENSE file for more info.