HierarchyFlattened
Represents a read-only array of HierarchyFlattenedNode over a HierarchyFlattened.Hierarchy. Used as an acceleration structure for query purposes.
Read time 1 minuteLast updated a month ago
Definition
- Type: Class
- Namespace: Unity.Hierarchy
- Assembly: UnityEngine.HierarchyCoreModule
- Implements: IDisposable
public sealed class HierarchyFlattened : IDisposable
Remarks
Querying information about nodes completes much faster than the same methods on HierarchyFlattened.Hierarchy because they are stored during the updates.
Constructors
Constructor | Description |
|---|---|
| HierarchyFlattened(Unity.Hierarchy.Hierarchy) | Cosntructs a new HierarchyFlattened. |
Properties
Property | Description |
|---|---|
| Count | The total number of nodes. |
| Hierarchy | Accesses the hierarchy. |
| IsCreated | Whether this object is valid and uses memory or not. |
| this[] | Gets the HierarchyFlattenedNode at a specified index. |
| UpdateNeeded | Determines if the flattened hierarchy needs an update. |
| Updating | Whether the flattened hierarchy is currently updating. |
Methods
Method | Description |
|---|---|
| Contains | Determines if a specified node is in the hierarchy flattened. |
| Dispose | Disposes this object to release its memory. |
| EnumerateChildren | Gets an enumerable of children HierarchyNode for the specified node. |
| GetChildrenCount | Gets the number of child nodes that a hierarchy node has. |
| GetChildrenCountRecursive | Gets the number of child nodes that a hierarchy node has, including children of children. |
| GetDepth | Determines the depth of a node. |
| GetEnumerator | Gets the HierarchyFlattenedNode enumerator. |
| GetNextSibling | Gets the next sibling of a node. |
| GetParent | Gets the parent of a hierarchy node. |
| IndexOf | Gets the zero-based index of a specified node. |
| Update | Updates the flattened hierarchy and requests a rebuild of the list of HierarchyFlattenedNode from the HierarchyFlattened.Hierarchy topology. |
| UpdateIncremental | Updates the flattened hierarchy incrementally. |
| UpdateIncrementalTimed | Incrementally updates the flattened hierarchy until a time limit is reached. |
Structs
Struct | Description |
|---|---|
| HierarchyFlattened.Enumerator | An enumerator of HierarchyFlattenedNode. |