SwiftGraphics

IMPORTANT

All development happens on the develop branch. Code is merged back on master branch infrequently.

Also note this project has moved to Swift 2.0 which requires Xcode 7.0 and Mac OS X 10.10. A Swift 1.2 branch has been made available - but no development will be occurring on this branch.

Bringing Swift goodness to Quartz.

See "Help Wanted" section of this document for how you can contribute to SwiftGraphics.

Philosophy

Wrap Quartz (and other related Frameworks such as CoreImage) in a nice "Swifthonic" API.

Provide wrappers and operators to help make working with graphics primitives in swift as convenient as possible.

What's included

Pragmatic operator overloading for CoreGraphics types including: CGPoint, CGSize, CGRect, CGAffineTransform
Object Oriented extensions for CGContext (including easy creation of bitmap context), CGPath
A bezier curve object that can represent curves of any order (including quadratic and cubic of course)
A path object that represents a bezier path - can be used to create and manipulate paths in a more natural way than CGPath or NSBezierPath can do
Fleshed out Geometry objects (Triangle, Ellipse, etc) allowing creating and introspection.
Convex Hull Generation
QuadTree data structure
Metaballs (Marching Squares algorithm) implementation
CoreImage wrappers that implement all filters and attributes as classes and properties (see: this tweet)
More! (This README is badly out of date)

In Progress

All of this code is very much a work in progress. I'm adding and changing functionality as needed. As such I'm trying not to add code that isn't used (with some exceptions).

Project Structure

SwiftGraphics is made up of:

Two SwiftGraphics dynamic frameworks (one for iOS and one for Mac OS X),
A Mac OS X only SwiftGraphicsPlayground framework (containing code generally useful when using Playground)
A directory of Playground files
Unit Test Targets

Installation

You can add SwiftGraphics to your project in one of the following ways:

Add SwiftGraphics.xcodeproj to your project and set up your dependencies appropriately. You can add SwiftGraphics as a submodule by opening the Terminal, trying to enter the command:
```
git submodule add https://github.com/schwa/SwiftGraphics.git
```
Install with Carthage (Recommended):
1. Add github "schwa/SwiftGraphics" to your project Cartfile (alternatively add github "schwa/SwiftGraphics" develop if you want latest bits).
2. Run carthage update to download and build SwiftGraphics.
3. Drag SwiftGraphics.framework to your project and link it.

Install with CocoaPods v0.36.0+ and add the following to your project Podfile:

platform :ios, '8.0'
use_frameworks!
pod 'SwiftGraphics/iOS'

platform :osx, '10.9'
use_frameworks!
pod 'SwiftGraphics/OSX'

Usage

SwiftGraphics builds iOS and OS X frameworks. Just add SwiftGraphics.xcodeproj to your project and set up your dependencies appropriately.

You can play with SwiftGraphics in Xcode 6 Playgrounds. IMPORTANT just make sure you compile the SwiftGraphicsPlayground target before trying to run any Playgrounds.

Help Wanted

Your help wanted. I would definitely appreciate contributions from other members of the Swift/Cocoa community. Please fork this project and submit pull requests.

You can help by using Swift Graphics in your projects and discovering its shortcomings. I encourage you to file issues against this project. Alternatively see our TODO document

Contributions are always welcome in the following areas:

Header doc comments explaining what the functions do
Unit tests
Playgrounds showing graphically what SwiftGraphics can do
New graphical algorithms (take your pick from wikipedia)
New geometry structs

Code Life Cycle

All development occurs on the develop branch. New code starts either as a Playground or as a tab inside the houseSwiftGraphics_OSX_UITest application target.

As code proves itself to be useful it is added to the SwiftGraphicsPlayground target and shared with all Playgrounds.

If code is generally useful it is moved directly to the SwiftGraphics target.

License

See LICENSE for more information

tumtumtum / SwiftGraphics