Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 2.54 KB

README.md

File metadata and controls

96 lines (67 loc) · 2.54 KB
Raw

PolarKit

CI Status

Bring the polar coordinate system into your iOS project!

What is the PolarKit

As you know, UIView uses Cartesian Coordinate System. PolarKit is a project that brings Polar Coordinate System into the iOS world!

With the PolarKit, you can place your view with angle & radius.

CircularScrollView

Goal

The goal of PolarKit is to provide UI components that has benefits when presented with the polar coordinate system.

PolarKit currently provides following components.

  • CircularScrollView: Polar coordinated version of UIScrollView
  • RotatableView: Simple rotatable view

How to use

CircularScrollView

import PolarKit
...
let circular = CircularScrollView(frame: frame)

// PolarCoordinatedView is just a subclass of UIView
let subview = PolarCoordinatedView(radius: 100, angle: Double.pi, frame: anotherFrame)

// Wrap your view with PolarCoordinatedView
subview.addSubview(yourView)

circular.addSubview(subview)
circular.contentLength = 2 * Double.pi

CircularScrollView2

Once you remind UIScrollView, you can find out it has similar look-and-feel.

let scrollView = UIScrollView(frame: frame)
let subview = UIView(frame: anotherFrame)
scrollView.addSubview(subview)
scrollView.contentSize = CGSizeMake(width, height)

RotatableView

import PolarKit
...
let rotatable = RotatableView(frame: frame)
rotatable.addSubview(yourViewToRotate)

// Setting the offset
rotatable.offset = Double.pi

// Adding an animation
// Unfortunately, `UIView.animateWithDuration()` is not supported
let anim = CABasicAnimation(keyPath: "offset")
anim.toValue = 2 * Double.pi
rotatable.layer.addAnimation(anim, forKey: "your-key")

RotatableView

Requirements

  • Swift 2.2

Example

To run the example project,

  1. Clone the repo
  2. Run pod install from the Example directory
  3. Open Example/PolarKit.xcworkspace
  4. Run the target named PolarKit-Example

Installation

PolarKit is going to available through CocoaPods soon. To install it, simply add the following line to your Podfile:

pod "PolarKit"

Author

Jeong Yong-uk, [email protected]

License

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