Skip to content

Commit 34d2359

Browse files
committed
Finished documentation for controls (with gifs)
1 parent 4c77a6f commit 34d2359

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111

1212
### Features
1313

14-
* **3D snapshot view implemented in SceneKit**: Gesture controls zooming, panning, and rotating
14+
* **3D snapshot view implemented in SceneKit**: Gesture controls for zooming, panning, and rotating.
1515
* **Hierarchy (tree) view that synchronizes its selection with the 3D view**: This is a feature I really wanted in Xcode, to be able to visually find a view and see where it is in the hierarchy view
16-
* **Support for iPad and iPhone**: Layouts are designed specifically for each form factor.
16+
* **Support for [iPad](images/main.png) and [iPhone](images/iphone1.png)**: Layouts are designed specifically for each form factor.
1717
* **Extensible:** The base implementation supports `UIView` hierarchies, but this is easily extensible to support any kind of UI framework (e.g. CoreAnimation or SpriteKit)
1818

1919
### Requirements
@@ -74,10 +74,42 @@ The `present` function shows the UI hierarchy for your application's key window,
7474

7575
### Controls
7676

77+
#### Focusing on an Element
78+
79+
To focus on the subhierarchy of a particular element, **long press on the element** to bring up the action menu and tap "Focus". The "Log Description" action will log the description of the element to the console, so that if you're attached to Xcode you can copy the address of the object for further debugging.
80+
81+
<p align="center">
82+
<img alt="Focusing on an Element" src="images/focus.gif" width="700">
83+
</p>
84+
7785
#### Adjusting Distance Between Levels
7886

7987
The slider on the bottom left of the snapshot view can be used to adjust the spacing between levels of the hierarchy:
8088

8189
<p align="center">
82-
<img alt="InAppViewDebugger" src="images/distance.gif" width="700">
83-
</p>
90+
<img alt="Adjusting Distance Between Levels" src="images/distance.gif" width="700">
91+
</p>
92+
93+
#### Adjusting Visible Levels
94+
95+
The range slider on the bottom right of the snapshot view can be used to adjust the range of levels in the hierarchy that are visible:
96+
97+
<p align="center">
98+
<img alt="Adjusting Visible Levels" src="images/slicing.gif" width="700">
99+
</p>
100+
101+
#### Showing/Hiding Headers
102+
103+
Each UI element has a header above it that shows its class name. These headers can be hidden or shown by **long pressing on an empty area of the snapshot view** to bring up the action menu:
104+
105+
<p align="center">
106+
<img alt="Showing/Hiding Headers" src="images/headers.gif" width="700">
107+
</p>
108+
109+
#### Showing/Hiding Borders
110+
111+
Similarly to the headers, the borders drawn around each element can also be shown or hidden:
112+
113+
<p align="center">
114+
<img alt="Showing/Hiding Borders" src="images/borders.gif" width="700">
115+
</p>

0 commit comments

Comments
 (0)