Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhurray/transform.swift
A Swiftier way to transform views
https://github.com/jhurray/transform.swift
Last synced: 2 months ago
JSON representation
A Swiftier way to transform views
- Host: GitHub
- URL: https://github.com/jhurray/transform.swift
- Owner: jhurray
- License: mit
- Created: 2016-05-22T22:07:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-09T03:00:37.000Z (over 8 years ago)
- Last Synced: 2024-09-25T03:21:12.943Z (3 months ago)
- Language: Swift
- Homepage:
- Size: 20.5 KB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Transform.swift
Transform.swift offers a *Swiftier* API for applying transforms to UIView and its subclasses.
```swift
let scale = Transform.scale(sx: 0.5, sy: 0.5)
let rotate = Transform.rotate(rotation: .degrees(45))
let scaleAndRotate = scale + rotate
myView.transform += scaleAndRotate
myView.transform3D = .translate(tx: 40, ty: 0, tz: 100)
```
##Installation
####[CocoaPods](https://cocoapods.org/)
Add the following to your **Podfile**:
```ruby
use_frameworks!
pod 'Transform.swift', '~> 0.1.2'
```
####[Carthage](https://github.com/Carthage/Carthage)
Add the following to your **Cartfile**:
```
gitub "jhurray/Transform.swift" ~> 0.1.2
```
##Usage
**Transform.swift** exposes 3 enums, `Transform`, `Transform3D`, and `Rotation`.
###Rotation
A convenience enum that allows the developer to easily define the rotation they want. The cases are pretty self explanitory.
* `.degrees(degrees: CGFloat)`
* `.radians(radians: Double)`
* Takes a double to make it easier to pass the `M_PI` definitions from `Darwin.C.Math`
###Transform
* `.identity`
* `.translate(tx: CGFloat, ty: CGFloat)`
* `.scale(sx: CGFloat, sy: CGFloat)`
* `.rotate(rotation: Rotation)`
* `.init(a: CGFloat, b: CGFloat, c: CGFloat, d: CGFloat, tx: CGFloat, ty: CGFloat)` for the adventurous type 😎
* `.custom(t: CGAffineTransform)`
####Methods
A group of methods that calculate how the transform affects a `CGRect`, `CGSize`, and `CGPoint` respectively.
```swift
public func transformedRect(rect: CGRect) -> CGRect
public func transformedSize(size: CGSize) -> CGSize
public func transformedPoint(point: CGPoint) -> CGPoint
```
Returns the underlying `CGAffineTransform`
```swift
public var CGATransform: CGAffineTransform { get }
```
###Transform3D
* `.identity`
* `.translate(tx: CGFloat, ty: CGFloat, tz: CGFloat)`
* `.scale(sx: CGFloat, sy: CGFloat, sz: CGFloat)`
* `.rotate(rotation: Rotation, x: CGFloat, y: CGFloat, z: CGFloat)`
* `.affine(t: CGAffineTransform)`
* `.custom(t: CATransform3D)`
####Methods
Returns the underlying `CATransform3D`
```swift
public var CATransform : CATransform3D { get }
```
Returns `true` if the 3d transform can be converted into an affine transform, `false` if it cannot.
```swift
public var isAffine: Bool { get }
```
Returns the underlying `CGAffineTransform`. Will throw an error if the 3D transform cannot be converted into an affine transform.
```swift
public func affineTransform() throws -> CGAffineTransform
```
###Shared Utilities
* Inverting: `let inverted = t.inverted`
* Identity Conformation: `let isIdentity = t.isIdentity`
* Concatenation: `let scaleAndMove = scale.concat(.translate(tx: 40, ty: -100))`
###Operators
* `==` Equality
* Returns `Bool`
* `Transform` == `Transform`
* `Transform` == `CGAffineTransform`
* `Transform3D` == `Transform3D`
* `Transform3D` == `CATransform3D`
* `+` Additive
* Returns the type being added
* `Transform` + `Transform`
* `CGAffineTransform` + `CGAffineTransform`
* `Transform3D` + `Transform3D`
* `CATransform3D` + `CATransform3D`
* `+=` Assignment
* Modifies the left variable of the operator
* `Transform` += `Transform`
* `CGAffineTransform` += `Transform`
* `Transform3D` += `Transform3D`
* `CATransform3D` += `Transform3D`
* `<-` Assignment
* Assigns a value to the left variable of the operator
* `CGAffineTransform` <- `Transform`
* `CATransform3D` <- `Transform3D`
* Semantics to assign the transform enum to the old API since you cant overload the `=` operator.
###UIView Extension
Two variables have been added to `UIView` to add settable and gettable interfaces for `Transform` and `Transform3D`.
```swift
var affineTransform: Transform
var transform3D: Transform3D
```
##Contact Info
Feel free to email me at [[email protected]](mailto:[email protected]?subject=Transform.swift). I'd love to hear your thoughts on this, or see examples where this has been used.
You can also hit me up on twitter [@JeffHurray](https://twitter.com/JeffHurray).
##Contributing
If you want to add functionality please open an issue and/or create a pull request.
##License
Transform.swift is available under the MIT license. See the LICENSE file for more information.