https://github.com/bellapplab/orientation

A Swifty way to deal with and normalize orientations on iOS.
https://github.com/bellapplab/orientation

Last synced: about 2 months ago
JSON representation

A Swifty way to deal with and normalize orientations on iOS.

• Host: GitHub
• URL: https://github.com/bellapplab/orientation
• Owner: BellAppLab
• License: mit
• Created: 2015-11-19T09:44:03.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-17T05:58:46.000Z (over 7 years ago)
• Last Synced: 2024-10-31T15:30:57.621Z (2 months ago)
• Language: Swift
• Size: 42 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Orientation

A Swifty way to deal with and normalize orientations on iOS.

_v0.4.0_

## Usage

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**:

```swift

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.

## Requirements

* iOS 8+

* Swift 3.0

## Installation

### Cocoapods

Because of [this](http://stackoverflow.com/questions/39637123/cocoapods-app-xcworkspace-does-not-exists), I've dropped support for Cocoapods on this repo. I cannot have production code rely on a dependency manager that breaks this badly. 

### Git Submodules

**Why submodules, you ask?**

Following [this thread](http://stackoverflow.com/questions/31080284/adding-several-pods-increases-ios-app-launch-time-by-10-seconds#31573908) 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. :wink:

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.

## Author

Bell App Lab, [email protected]

## License

Orientation is available under the MIT license. See the LICENSE file for more info.