Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
luke161 committed May 11, 2017
1 parent 8b20334 commit 8515a5e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# Unity-IMGUI-TreeView
Simple Tree View implementation for IMGUI (Editor GUI) in Unity. Includes a special type for working with asset paths, but base data structure and view can be easily extended to support anything.

Built and tested in **Unity 5.6.0**

## Usage
The Tree View is made up of two parts, a tree data structure [TreeNode](./Assets/TreeView/Scripts/TreeNode.cs) and an IMGUI control [TreeIMGUI](./Assets/TreeView/Editor/TreeIMGUI.cs). The project comes with a basic tree data structure which can be easily extended or wrapped in a container class (demonstrated with [AssetTree](./Assets/TreeView/Editor/AssetTree.cs)).

The IMGUI control produces a basic tree layout with foldout support, it can be easily extended to customise the appearance of rows by overriding `OnDrawTreeNode` and for more advanced layouts `OnDrawRow` and `OnGetLayoutHeight`.
For the standard IMGUI control to work data contained within a [TreeNode](./Assets/TreeView/Scripts/TreeNode.cs) must implement the [ITreeIMGUIData](./Assets/TreeView/Editor/TreeIMGUI.cs) interface.

## Example
The project contains an example implementation [AssetTreeWindow](./Assets/TreeView/Example/Editor/AssetTreeEditorWindow.cs) which demonstrates how a tree view can be used to list asset search results. The example can be loaded via the Unity editor window under `Tools/Tree View Example Window`.

0 comments on commit 8515a5e

Please sign in to comment.