/README.md

 1
 2# PSTreeGraph
 3
 4PSTreeGraph is a treegraph view control implementation for Cocoa Touch.
 5
 6This is a port of the sample code from Max OS X to iOS (iPad). 
 7WWDC 2010 Session 141, “Crafting Custom Cocoa Views”
 8
 9![](http://farm7.static.flickr.com/6193/6055022105_ab831b2d8e.jpg)
10
11
12# Example Project
13
14There is an iPad example application to demonstrate the features of PSTreeGraph.
15
16
17# Status
18
19PSTreeGraph should be considered an viable solution for displaying single parent tree data in an interactive hierarchy.
20
21This project follows the [SemVer](http://semver.org/) standard. The API may change in backwards-incompatible ways before the 1.0 release.
22
23The goal of PSTreeGraph is to build a high-quality UI control designed specifically for the iPad.  The inspiration / structure comes from WWDC 2010 Session 141, “Crafting Custom Cocoa Views”, an extremely valuable and informative presentation that has proven to be applicable (see this project) to other platforms.
24
25
26# Known Improvements
27
28See [Milestones](https://github.com/epreston/PSTreeGraph/issues/milestones?with_issues=no).
29
30There are many places where PSTreeGraph could be improved:
31
32* Use GCD to load model data asyncronously.  This control uses a simple protocol implemented by each node in the data model so the control can walk the tree. This can be loaded asynchronously to avoid blocking the main thread when displaying large graphs.
33
34* Cache the bezier path used to render lines in each subtree.  The bezier path used to render the lines between each node in the graph can be cached to improve performance.
35
36* Use CATiledLayer to support much larger graphs.  Investigate using a CATiledLayer to further reduce drawing and memory usage, support scaling, etc. This feature will make it possible support graphs of unlimited size and scale. Rendering time and resource usage would be constant regardless of the number of nodes in the graph.
37
38
39# Documentation
40
41You can generate documentation with [doxygen](http://www.doxygen.org). The example project includes a documentation build target to do this within Xcode.    For more details, see the [Documentation](https://github.com/epreston/PSTreeGraph/wiki/Documentation) page in this projects wiki.
42
43
44# Copyright and License
45
46Copyright 2010 Preston Software.
47
48   Licensed under the Apache License, Version 2.0 (the "License");
49   you may not use this work except in compliance with the License.
50   You may obtain a copy of the License in the LICENSE file, or at:
51
52       http://www.apache.org/licenses/LICENSE-2.0
53
54   Unless required by applicable law or agreed to in writing, software
55   distributed under the License is distributed on an "AS IS" BASIS,
56   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
57   See the License for the specific language governing permissions and
58   limitations under the License.
59
60