Class HierarchyTreeView
Tree view GUI for the MARS Simulation View hierarchy Hierarchy to tree view starting code brought from
Inherited Members
Namespace: UnityEditor.MARS.Simulation
Assembly: Unity.MARS.Editor.dll
Syntax
[MovedFrom("Unity.MARS")]
public class HierarchyTreeView : TreeViewConstructors
HierarchyTreeView(TreeViewState, HierarchyState, bool, bool)
Creates the HierarchyTreeView for a simulation hierarchy
Declaration
public HierarchyTreeView(TreeViewState treeViewState, HierarchyState hierarchyState, bool isEnvironmentHierarchy, bool needsStateCached)Parameters
| Type | Name | Description |
|---|---|---|
| TreeViewState | treeViewState | The serializable state of the tree view |
| HierarchyState | hierarchyState | State of the tree view with extra data for the simulation |
| bool | isEnvironmentHierarchy | Is the tree view for the simulated environment |
| bool | needsStateCached | Is the cached state being cached or restored |
Properties
MaxHeight
The maximum height of the tree view's scroll area
Declaration
public float MaxHeight { get; set; }Property Value
| Type | Description |
|---|---|
| float |
StyleName
Sets the GUIStyle name for the tree view's container
Declaration
public string StyleName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
horizontalOffset
Offset for tree view GUI drawing, used for horizontal scrolling
Declaration
public float horizontalOffset { get; protected set; }Property Value
| Type | Description |
|---|---|
| float |
selectedRowY
The height of the selected row
Declaration
public float selectedRowY { get; set; }Property Value
| Type | Description |
|---|---|
| float |
Methods
BuildRoot()
Creates the full tree of the TreeViewItems and returns the root
Declaration
protected override TreeViewItem BuildRoot()Returns
| Type | Description |
|---|---|
| TreeViewItem | The root of the tree. This item can later be accessed by 'rootItem'. |
Overrides
BuildRows(TreeViewItem)
Generates the rows in the TreeView
Declaration
protected override IList<TreeViewItem> BuildRows(TreeViewItem treeRoot)Parameters
| Type | Name | Description |
|---|---|---|
| TreeViewItem | treeRoot | Root item that was created in the BuildRoot method. |
Returns
| Type | Description |
|---|---|
| IList<TreeViewItem> | The rows list shown in the TreeView. Can later be accessed using GetRows(). |
Overrides
CacheState()
Cache the state based on the transform so when they IDs change on re-simulation the state can be restored
Declaration
public void CacheState()DoubleClickedItem(int)
Method to handle double click events on an item.
Declaration
protected override void DoubleClickedItem(int id)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | ID of TreeViewItem that was double clicked. |
Overrides
DrawScrollingTreeView(Vector2, ref bool, bool)
Draw the hierarchy tree view the horizontal and vertical scrolling
Declaration
public Vector2 DrawScrollingTreeView(Vector2 scrollPosition, ref bool scrollToSelected, bool enabled)Parameters
| Type | Name | Description |
|---|---|---|
| Vector2 | scrollPosition | Scrolling position |
| bool | scrollToSelected | Scroll to the selected item in the hierarchy |
| bool | enabled | Is the simulation active to so the hierarchy can be displayed |
Returns
| Type | Description |
|---|---|
| Vector2 |
~HierarchyTreeView()
Declaration
protected ~HierarchyTreeView()GetAncestors(int)
This method is e.g. used for revealing items that are currently under a collapsed item.
Declaration
protected override IList<int> GetAncestors(int id)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | TreeViewItem ID. |
Returns
| Type | Description |
|---|---|
| IList<int> | List of all the ancestors of a given item with ID id. |
Overrides
GetDescendantsThatHaveChildren(int)
Returns all descendants for the item with ID id that have children.
Declaration
protected override IList<int> GetDescendantsThatHaveChildren(int id)Parameters
| Type | Name | Description |
|---|---|---|
| int | id | TreeViewItem ID. |
Returns
| Type | Description |
|---|---|
| IList<int> | Descendants that have children. |
Overrides
PingObjects(Transform[])
Ping the selected items in the hierarchy
Declaration
public static void PingObjects(Transform[] selection)Parameters
| Type | Name | Description |
|---|---|---|
| Transform[] | selection |
RestoreState()
Restore the previously cached state
Declaration
public void RestoreState()RowGUI(RowGUIArgs)
Method to add GUI content for the rows in the TreeView.
Declaration
protected override void RowGUI(TreeView.RowGUIArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| TreeView.RowGUIArgs | args | Row data. |
Overrides
SelectionChanged(IList<int>)
Method to get notified of selection changes.
Declaration
protected override void SelectionChanged(IList<int> selectedIds)Parameters
| Type | Name | Description |
|---|---|---|
| IList<int> | selectedIds | TreeViewItem IDs. |
Overrides
UnsetPing()
Clear the pinged items
Declaration
public static void UnsetPing()