Back to Home

ESO Lua File v101040

libraries/zo_tree/zo_tree.lua

[◄ back to folders ]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
local ZO_TreeNode
local RESELECTING_DURING_REBUILD = true
local USER_REQUESTED_OPEN = true
local SYSTEM_REQUESTED_OPEN = false
--Tree
---------------
ZO_Tree = ZO_Object:Subclass()
function ZO_Tree:New(control, defaultIndent, defaultSpacing, width)
    local tree = ZO_Object.New(self)
    tree.control = control
    tree.width = width
    tree.defaultIndent = defaultIndent
    tree.defaultSpacing = defaultSpacing
    tree.exclusive = false
    tree.autoSelectChildOnNodeOpen = false
    tree.enabled = true
    tree.templateInfo = {}
    tree.exclusiveCloseNodeFunction =   function(treeNode)
                                            for i = 1, #tree.exclusivePath do
                                                if(tree.exclusivePath[i] == treeNode) then
                                                    return
                                                end
                                            end
                                            treeNode:SetOpen(false, SYSTEM_REQUESTED_OPEN)
                                        end
    tree.childContainerPool = ZO_ControlPool:New("ZO_TreeChildContainer", control, "Container")
    tree.childContainerPool:SetCustomResetBehavior(function(container) container:SetAlpha(1) end)
    tree:Reset()
    TREES:Add(tree)
    tree:FindScrollControl()
    return tree
end
function ZO_Tree:OnScreenResized()
end
function ZO_Tree:Reset()
    local OPEN = true
    self.previousRoot = self.rootNode
    self.selectedNode = nil
    self.rootNode = ZO_TreeNode:New(self, nil, nil, nil, 0, self.defaultSpacing, OPEN)
    self.childContainerPool:ReleaseAllObjects()
    for template, templateInfo in pairs(self.templateInfo) do
        templateInfo.objectPool:ReleaseAllObjects()
    end
    if self.selectionHighlight then
        self.selectionHighlight:SetHidden(true)
    end
    if self.openAnimationPool then
        self.openAnimationPool:ReleaseAllObjects()
    end
    self:SetSuspendAnimations(true)
end
function ZO_Tree:GetTreeNodeByData(data)
    return self:GetTreeNodeInTreeByData(data, self.rootNode)
end
function ZO_Tree:GetTreeNodeInTreeByData(data, branchNode)
    if branchNode then
        if branchNode.equalityFunction then
            if branchNode.equalityFunction(branchNode.data, data) then
                return branchNode
            end
        elseif branchNode.data == data then
            return branchNode
        end
        local currentChildren = branchNode:GetChildren()
        if currentChildren then
            for _, currentChild in ipairs(currentChildren) do
                local foundNode = self:GetTreeNodeInTreeByData(data, currentChild)
                if foundNode then
                    return foundNode
                end
            end
        end
    end
    return nil
end
function ZO_Tree:SelectAnything()
    if not self.selectedNode or not self.selectedNode:IsEnabled() then
        local currentNode = self.rootNode
        while currentNode and not currentNode:IsLeaf() and currentNode:IsEnabled() do
            currentNode = currentNode:GetChildren()[1]
        end
        if currentNode and currentNode ~= self.rootNode then
            self:SelectNode(currentNode)
        end
    end
end
function ZO_Tree:SelectFirstChild(parentNode)
    local children = parentNode:GetChildren()
    if children then
        local firstChild = children[1]
        if firstChild then
            self:SelectNode(firstChild)
        end
    end
end
function ZO_Tree:SetSelectionHighlight(template)
    self.selectionHighlightTemplate = template
end
function ZO_Tree:SetOpenAnimation(animationTemplate)
    self.openAnimationPool = ZO_AnimationPool:New(animationTemplate)
    self.openAnimationPool:SetCustomFactoryBehavior(function(timeline)
        timeline:SetHandler("OnStop", function(currentTimeline) self:OnOpenAnimationStopped(currentTimeline) end)
    end)
    --populated on demand since it requires making an animation from the pool to know
    self.openAnimationDurationMS = nil
end
function ZO_Tree:GetOpenAnimationDuration()
    if self:IsAnimated() then
        if not self.openAnimationDurationMS then
            local timeline, key = self.openAnimationPool:AcquireObject()
            self.openAnimationDurationMS = timeline:GetDuration()
            self.openAnimationPool:ReleaseObject(key)
        end
        return self.openAnimationDurationMS
    else
        return 0
    end
end
function ZO_Tree:SetExclusive(exclusive)
    self.exclusive = exclusive
end
function ZO_Tree:SetAutoSelectChildOnNodeOpen(autoSelect)
    self.autoSelectChildOnNodeOpen = autoSelect
end
function ZO_Tree:SetSuspendAnimations(suspendAnimations)
    self.suspendAnimations = suspendAnimations
end
function ZO_Tree:GetWidth()
    return self.width
end
local function DefaultEqualityFunction(left, right)
    return left == right
end
function ZO_Tree:AddTemplate(template, setupFunction, selectionFunction, equalityFunction, childIndent, childSpacing, overrideName)
    self.templateInfo[template] =
    {
        template = template,
        childIndent = childIndent,
        childSpacing = childSpacing,
        setupFunction = setupFunction,
        selectionFunction = selectionFunction,
        objectPool = ZO_ControlPool:New(template, self.control, overrideName)
    }
end
function ZO_Tree:AddNode(template, data, parentNode, selectSoundOverride, open)
    if not parentNode then
        parentNode = self.rootNode
    end
    local templateInfo = self.templateInfo[template]
    local treeNode = ZO_TreeNode:New(self, templateInfo, parentNode, data, templateInfo.childIndent or self.defaultIndent, templateInfo.childSpacing or self.defaultSpacing, open == true)
    if selectSoundOverride ~= nil then
        treeNode.selectSound = selectSoundOverride
    elseif parentNode == self.rootNode then
        treeNode.selectSound = SOUNDS.TREE_HEADER_CLICK
    else
        treeNode.selectSound = SOUNDS.TREE_SUBCATEGORY_CLICK
    end
    parentNode:AddChild(treeNode)
    
    return treeNode
end
local function ReopenNodes(tree, currentNodeOfPreviousTree, currentNodeOfCurrentTree)
    if currentNodeOfPreviousTree and currentNodeOfCurrentTree then
        local previousChildren = currentNodeOfPreviousTree:GetChildren()
        local currentChildren = currentNodeOfCurrentTree:GetChildren()
        if previousChildren and currentChildren then
            for _, previousChild in ipairs(previousChildren) do
                for _, currentChild in ipairs(currentChildren) do
                    if previousChild.equalityFunction == currentChild.equalityFunction and previousChild.equalityFunction(previousChild.data, currentChild.data) then
                        if previousChild:IsLeaf() and currentChild:IsLeaf() then
                            if previousChild:IsSelected() ~= currentChild:IsSelected() then
                                tree:SelectNode(currentChild, RESELECTING_DURING_REBUILD)
                                if tree.exclusive then
                                    return
                                end
                            end
                        elseif not previousChild:IsLeaf() and not currentChild:IsLeaf() then
                            if currentChild:IsOpen() ~= previousChild:IsOpen() then
                                currentChild:SetOpen(previousChild:IsOpen(), SYSTEM_REQUESTED_OPEN)
                            end
                            ReopenNodes(tree, previousChild, currentChild)
                        end
                    end
                end
            end
        end
    end
end
function ZO_Tree:Commit(nodeToSelect, bringParentIntoView)
    if self.previousRoot then
        local currentNodeOfPreviousTree = self.previousRoot
        local currentNodeOfCurrentTree = self.rootNode
        ReopenNodes(self, currentNodeOfPreviousTree, currentNodeOfCurrentTree)
    end
    if nodeToSelect ~= nil and nodeToSelect:IsEnabled() then
        local NOT_REBUILDING = false
        self:SelectNode(nodeToSelect, NOT_REBUILDING, bringParentIntoView)
    elseif self.exclusive then
        self:SelectAnything()
    end
    self.previousRoot = nil
    self:SetSuspendAnimations(false)
end
function ZO_Tree:SetEnabled(enabled)
    if self.enabled ~= enabled then
        self.enabled = enabled
        self:RefreshVisible()
    end
end
function ZO_Tree:IsEnabled()
    return self.enabled
end
function ZO_Tree:RefreshVisible(userRequested)
    if userRequested == nil then
        userRequested = true
    end
    self.rootNode:RefreshVisible(userRequested)
end
--Computes the offset of the bottom of the control at the end of the path from the scroll child top
--Used to determine where a node control will end up after being selected. This simulates the layout logic.
function ZO_Tree:ComputeEndOfPathControlFinalBottomOffset(currentTreeNode, pathToSelectedNode)
    local offset = 0
    --Path goes from parents to children
    local nextNodeOnPathToSelectedNode = pathToSelectedNode[#pathToSelectedNode]
    for i, childTreeNode in ipairs(currentTreeNode:GetChildren()) do
        if childTreeNode == nextNodeOnPathToSelectedNode then
            --When we find a node on the path we add its height, then if we can recurse on its children we add the proper spacing for the child section (1/2 on top, 1/2 on bottom) then recurse.
            offset = offset + childTreeNode:GetControlHeight()
            if #pathToSelectedNode == 1 then
                return offset
            else
                offset = offset + childTreeNode:GetParent():GetChildSpacing()
                table.remove(pathToSelectedNode)
                return offset + self:ComputeEndOfPathControlFinalBottomOffset(childTreeNode, pathToSelectedNode)
            end
        else
            if self.exclusive then
                --In exclusive mode we will be closing every non-leaf node except for the ones on the path so just count their control height. Their children will be hidden.
                offset = offset + childTreeNode:GetControlHeight()
            else
                --In non-exlcusive mode we won't be touching the nodes off the path so use their actual height with children
                offset = offset + childTreeNode:GetHeight()
            end
            offset = offset + childTreeNode:GetParent():GetChildSpacing()
        end
    end
    return 0
end
function ZO_Tree:SetScrollToTargetNode(parentTreeNode, childNode)
    local pathToSelectedNode = {}
    local currentNode = parentTreeNode
    while currentNode and currentNode ~= self.rootNode do
        table.insert(pathToSelectedNode, currentNode)
        currentNode = currentNode:GetParent()
    end
    --Compute some metrics about the state of this tree after treeNode is selected. We use this so we can scroll to where the node WILL BE instead of where it is right now.
    local parentTreeNodeControlFinalBottomOffset = self:ComputeEndOfPathControlFinalBottomOffset(self.rootNode, pathToSelectedNode)
    local parentTreeNodeControlFinalTopOffset = parentTreeNodeControlFinalBottomOffset - parentTreeNode:GetControlHeight()
    local finalTopOffset = parentTreeNodeControlFinalTopOffset
    local childNodeControlFinalBottomOffset = 0
    local childNodeControlFinalTopOffset = 0
    if childNode then
        table.insert(pathToSelectedNode, 1, childNode)
        childNodeControlFinalBottomOffset = self:ComputeEndOfPathControlFinalBottomOffset(self.rootNode, pathToSelectedNode)
        childNodeControlFinalTopOffset = childNodeControlFinalBottomOffset - childNode:GetControlHeight()
        if childNodeControlFinalTopOffset - parentTreeNodeControlFinalTopOffset > self.scrollControl:GetHeight() then
            finalTopOffset = childNodeControlFinalBottomOffset + childNode:GetControlHeight() - self.scrollControl:GetHeight() * 0.5
        end
    end
    local finalTotalHeight
    if self.exclusive then
        local previouslyOpenSectionChildrenHeight = 0
        for _, rootChild in ipairs(self.rootNode:GetChildren()) do
            if not rootChild:IsLeaf() and rootChild:IsOpen() then
                previouslyOpenSectionChildrenHeight = rootChild:GetChildrenHeight()
                break
            end
        end
        -- new node's height subtracted from the previously opened nodes' heights
        -- this is the change in height the tree will have, which will be needed to calculate the scroll's animation
        finalTotalHeight = self.rootNode:GetCurrentChildrenHeight() + parentTreeNode:GetChildrenHeight() - previouslyOpenSectionChildrenHeight
    else
        finalTotalHeight = self.rootNode:GetCurrentChildrenHeight() + parentTreeNode:GetChildrenHeight()
    end
    ZO_Scroll_SetScrollToRealOffsetAccountingForGradients(self.scrollControl, finalTotalHeight, finalTopOffset, self:GetOpenAnimationDuration())
    self.scrollTargetNode = parentTreeNode
end
function ZO_Tree:ToggleNode(treeNode)
    if treeNode:IsEnabled() and (not self.exclusive or not treeNode:IsOpen()) then
        if self.scrollControl and not treeNode:IsOpen() then
            self:SetScrollToTargetNode(treeNode)
        end
        self:SetNodeOpen(treeNode, not treeNode:IsOpen(), USER_REQUESTED_OPEN)
    end
end
function ZO_Tree:SetNodeOpen(treeNode, open, userRequested)
    if open then
        treeNode:SetOpen(true, userRequested)
        --open the path to the root
        local currentNode = treeNode:GetParent()
        while currentNode do
            --because the tree is automatically opening a path, any opened nodes must be system requested opens
            currentNode:SetOpen(true, SYSTEM_REQUESTED_OPEN)
            currentNode = currentNode:GetParent()
        end
        if self.exclusive then
            self.exclusivePath = {}
            currentNode = treeNode
            while currentNode do
                table.insert(self.exclusivePath, currentNode)
                currentNode = currentNode:GetParent()
            end
            --close every node not on the newly opened path
            local rootChildren = self.rootNode:GetChildren()
            for i = 1, #rootChildren do
                local rootChild = rootChildren[i]
                self:ExecuteOnSubTree(rootChild, self.exclusiveCloseNodeFunction)
            end
        end
        if self.autoSelectChildOnNodeOpen and userRequested then
            self:SelectFirstChild(treeNode)
        end
    else
        treeNode:SetOpen(false, userRequested)
    end
end
function ZO_Tree:SelectNode(treeNode, reselectingDuringRebuild, bringParentIntoView)
    --Default to bringing the immediate parent of this node into view
    if bringParentIntoView == nil then
        bringParentIntoView = true
    end
    --Can only select leaf nodes
    if treeNode:IsLeaf() and treeNode:IsEnabled() then
        if self.selectedNode == treeNode then
            --If we already have this node selected we should still try to bring the parent into view anyway
            if not reselectingDuringRebuild and bringParentIntoView and self.scrollControl then
                local immediateParentNode = treeNode:GetParent()
                if immediateParentNode then
                    local immediateParentNodeControl = immediateParentNode:GetControl()
                    if immediateParentNodeControl then
                        if immediateParentNode:IsOpen() and not immediateParentNode == self.scrollTargetNode then
                            --If the parent is open then just scroll it to the top right now
                            ZO_Scroll_ScrollControlToTop(self.scrollControl, immediateParentNodeControl)
                            if not ZO_Scroll_IsControlFullyInView(self.scrollControl, self.selectedNode.control) then
                                ZO_Scroll_ScrollControlIntoCentralView(self.scrollControl, self.selectedNode.control)
                            end
                        else
                            --If the parent is closed we need to open it and set up the scroll to target node behavior
                            self:SetScrollToTargetNode(immediateParentNode, self.selectedNode)
                            self:SetNodeOpen(immediateParentNode, true, SYSTEM_REQUESTED_OPEN)
                        end
                    end
                end
            end
        else
            --Otherwise we need to select the node
            if self.selectedNode then
                self.selectedNode:OnUnselected()
            end
            self.selectedNode = treeNode
            if not reselectingDuringRebuild then
                if bringParentIntoView and self.scrollControl then
                    local immediateParentNode = treeNode:GetParent()
                    if immediateParentNode then
                        local immediateParentNodeControl = immediateParentNode:GetControl()
                        if immediateParentNodeControl then
                            if immediateParentNode:IsOpen() and not immediateParentNode == self.scrollTargetNode then
                                --If the parent is already open we can scroll to it right now
                                ZO_Scroll_ScrollControlToTop(self.scrollControl, immediateParentNodeControl)
                            else
                                --Otherwise we need to setup scroll over time since sections will be opening and closing
                                self:SetScrollToTargetNode(immediateParentNode, self.selectedNode)
                            end
                        end
                    end
                end
                self:SetNodeOpen(treeNode, true, USER_REQUESTED_OPEN)
            end
            treeNode:OnSelected(reselectingDuringRebuild)
            local selectionHighlight = self:GetSelectionHighlight()
            if selectionHighlight then
                selectionHighlight:ClearAnchors()
                local treeNodeControl = treeNode:GetControl()
                selectionHighlight:SetAnchorFill(treeNodeControl)
                selectionHighlight:SetParent(treeNode:GetParent():GetChildContainer())
                selectionHighlight:SetHidden(false)
            end
        end
    end
end
function ZO_Tree:ClearSelectedNode()
    if self.selectedNode then
        self.selectedNode:OnUnselected()
        self.selectedNode = nil
        if self.selectionHighlight then
            self.selectionHighlight:SetHidden(true)
        end
    end
end
function ZO_Tree:GetSelectedData()
    if self.selectedNode then
        return self.selectedNode.data
    end
end
function ZO_Tree:GetSelectedNode()
    return self.selectedNode
end
function ZO_Tree:GetSelectionHighlight()
    if self.selectionHighlight then
        return self.selectionHighlight
    elseif self.selectionHighlightTemplate then
        self.selectionHighlight = CreateControlFromVirtual(self.control:GetName() .. "Highlight", self.control, self.selectionHighlightTemplate)
        return self.selectionHighlight
    end
end
function ZO_Tree:ExecuteOnSubTree(treeRoot, func)
    if treeRoot then
        local stopIteration = func(treeRoot)
        if stopIteration then
            return
        end
    else
        treeRoot = self.rootNode
    end
    local children = treeRoot:GetChildren()
    if children then
        for i = 1, #children do
            self:ExecuteOnSubTree(children[i], func)
        end
    end
end
function ZO_Tree:AcquireNewChildContainer()
    return self.childContainerPool:AcquireObject()
end
function ZO_Tree:OnOpenAnimationStopped(timeline)
    local node = timeline.node
    if self.scrollTargetNode == node and self.scrollControl then
        self.scrollTargetNode = nil
    end
    node:ReleaseTimeline()
end
function ZO_Tree:GetOpenAnimationPool()
    return self.openAnimationPool
end
function ZO_Tree:GetControl()
    return self.control
end
function ZO_Tree:IsAnimated()
    return not self.suspendAnimations and self.openAnimationPool ~= nil
end
function ZO_Tree:FindScrollControl()
    local scrollControl = self.control:GetParent():GetParent()
    if scrollControl and scrollControl.scroll then
        self.scrollControl = scrollControl
    end
end
--TreeNode
---------------
ZO_TreeNode = ZO_Object:Subclass()
function ZO_TreeNode:New(tree, templateInfo, parentNode, data, childIndent, childSpacing, open)
    local node = ZO_Object.New(self)
    if templateInfo then
        node.templateInfo = templateInfo
        local control = templateInfo.objectPool:AcquireObject()
        node.control = control
        control.node = node
        node.setupFunction = templateInfo.setupFunction
        node.selectionFunction = templateInfo.selectionFunction
        node.equalityFunction = templateInfo.equalityFunction
        control:SetHidden(false)
    end
    node.tree = tree
    node.parentNode = parentNode
    node.data = data
    node.childIndent = childIndent
    node.childSpacing = childSpacing
    node.childrenHeight = 0
    node.childrenCurrentHeight = 0
    node.open = open
    node.openPercentage = open and 1 or 0
    node.selected = false
    node.enabled = true
    node:RefreshControl()
    return node
end
function ZO_TreeNode:ComputeTotalIndentFrom(treeNode)
    local total = 0
    while treeNode ~= nil do
        total = total + treeNode:GetChildIndent()
        treeNode = treeNode:GetParent()
    end
    return total
end
--Tree nodes have a control and a child section. The child section if it exists anchors to the control with half childSpacing above and half below to center it. Tree nodes
--within a child section anchor one after another with childSpacing between them. The first control anchors to the top left of the child section with no offset. The child spacing
--comes from the parent of the node that the child is being added to. This is likely wrong. It should come from the node the child is being added to.
function ZO_TreeNode:AddChild(treeNode)
    local previousNode = nil
    if not self.children then
        self.children = {}
        self.childContainer = self.tree:AcquireNewChildContainer()
        self.childContainer:SetHidden(false)
        local childContainerWidth = self.tree:GetWidth() - self:ComputeTotalIndentFrom(self.parentNode)
        if self.control then
            --split the child spacing evenly on either side of the child container
            self.childContainer:SetAnchor(TOPLEFT, self.control, BOTTOMLEFT, 0, self.parentNode:GetChildSpacing() * 0.5)
            self.childContainer:SetWidth(childContainerWidth)
        else
            --root node, anchor that to fill the tree control space
            self.childContainer:SetAnchor(TOPLEFT, self.tree:GetControl(), TOPLEFT, 0, 0)
            self.childContainer:SetWidth(childContainerWidth)
        end
        if self.parentNode then
            self.childContainer:SetParent(self.parentNode:GetChildContainer())
        end
        if self.nextNode then
            self:AttachNext(self.nextNode)
        end
    else
        previousNode = self.children[#self.children]
    end
    local childControl = treeNode:GetControl()
    childControl:SetParent(self.childContainer)
    if previousNode then
        previousNode:AttachNext(treeNode)
    else
        childControl:SetAnchor(TOPLEFT, self.childContainer, TOPLEFT, self.childIndent, 0)
    end
    table.insert(self.children, treeNode)
end
function ZO_TreeNode:AttachNext(nextTreeNode)
    local nextNodeControl = nextTreeNode:GetControl()
    nextNodeControl:ClearAnchors()
    if self.childContainer then
        --split the child spacing evenly on either side of the child container
        nextNodeControl:SetAnchor(TOPLEFT, self.childContainer, BOTTOMLEFT, 0, self.parentNode:GetChildSpacing() * 0.5)
    else
        nextNodeControl:SetAnchor(TOPLEFT, self.control, BOTTOMLEFT, 0, self.parentNode:GetChildSpacing())
    end
    self.nextNode = nextTreeNode
end
function ZO_TreeNode:IsAnimated()
    return self.tree:IsAnimated()
end
function ZO_TreeNode:IsSelected()
    return self:IsLeaf() and self.selected
end
--This functionality works in the context of a full refresh rather than arbitrarily deciding to disable a node manually
--So you'll want to control this in a setup/refresh, and ensure that the tree's Commit function is called after said refresh.
function ZO_TreeNode:SetEnabled(enabled)
    self.enabled = enabled
end
function ZO_TreeNode:IsEnabled()
    return self.enabled
end
function ZO_TreeNode:RefreshVisible(userRequested)
    self:RefreshControl(userRequested)
    if self.children then
        for i, child in ipairs(self.children) do
            child:RefreshVisible(userRequested)
        end
    end
end
function ZO_TreeNode:IsOpen()
    if self:IsLeaf() then
        return true
    else
        return self.open
    end
end
function ZO_TreeNode:GetOrAcquireTimeline()
    if not self.timeline then
        local pool = self.tree:GetOpenAnimationPool()
        self.timeline, self.poolKey = pool:AcquireObject()
        self.timeline.node = self
    end
    return self.timeline
end
function ZO_TreeNode:ReleaseTimeline()
    local pool = self.tree:GetOpenAnimationPool()
    pool:ReleaseObject(self.poolKey)
    self.timeline = nil
    self.poolKey = nil
end
function ZO_TreeNode:SetOpen(open, userRequested)
    if not self:IsLeaf() and self.enabled and self.open ~= open then
        self.open = open
        self:RefreshControl(userRequested)
        if self:IsAnimated() then
            local timeline = self:GetOrAcquireTimeline()
            if timeline:IsPlaying() then
                if open then
                    timeline:PlayForward()
                else
                    timeline:PlayBackward()
                end
            else
                --custom anim must always be first
                local customAnim = timeline:GetFirstAnimation()
                customAnim:SetUpdateFunction(function(animation, progress) self:SetOpenPercentage(progress) end)
                local numAnimations = timeline:GetNumAnimations()
                for i = 2, numAnimations do
                    local animation = timeline:GetAnimation(i)
                    animation:SetAnimatedControl(self.childContainer)
                end
                if open then
                    customAnim:SetEasingFunction(ZO_EaseOutQuadratic)
                    timeline:PlayFromStart()
                else
                    customAnim:SetEasingFunction(ZO_EaseInQuadratic)
                    timeline:PlayFromEnd()
                end
            end
        else
            if self.open then
                self:SetOpenPercentage(1)
            else
                self:SetOpenPercentage(0)
            end
        end
    end
end
function ZO_TreeNode:SetOpenPercentage(openPercentage)
    self.openPercentage = openPercentage
end
function ZO_TreeNode:OnSelected(reselectingDuringRebuild)
    if self.selectionFunction then
        self.selectionFunction(self.control, self.data, true, reselectingDuringRebuild)
    end
    self.selected = true
end
function ZO_TreeNode:OnUnselected()
    if self.selectionFunction then
        self.selectionFunction(self.control, self.data, false, false)
    end
    self.selected = false
end
function ZO_TreeNode:GetHeight()
    return self.control:GetHeight() + self.childrenHeight
end
function ZO_TreeNode:GetControlHeight()
    return self.control:GetHeight()
end
function ZO_TreeNode:GetChildrenHeight()
    return self.childrenHeight
end
function ZO_TreeNode:GetCurrentHeight()
    return self.control:GetHeight() + self.childrenCurrentHeight
end
function ZO_TreeNode:GetCurrentChildrenHeight()
    return self.childrenCurrentHeight
end
function ZO_TreeNode:GetWidth()
    return self.control and self.control:GetWidth() or 0
end
function ZO_TreeNode:GetTotalWidth()
    if self.parentNode and self.control then
        return self:GetControl():GetRight() - self.parentNode:GetChildContainer():GetLeft()
    end
    return self:GetWidth()
end
function ZO_TreeNode:GetChildContainer()
    return self.childContainer
end
function ZO_TreeNode:IsLeaf()
    return self:GetChildren() == nil
end
function ZO_TreeNode:GetTree()
    return self.tree
end
--The height of the children if this node was all the way open
function ZO_TreeNode:GetChildrenTotalHeight()
    if self.children then
        local height = 0
        for i = 1, #self.children do
            height = height + self.children[i]:GetHeight()
        end
        height = height + self.childSpacing * (#self.children - 1)
        return height
    else
        return 0
    end
end
function ZO_TreeNode:UpdateChildrenHeight()
    self.childrenHeight = self:GetChildrenTotalHeight()
end
function ZO_TreeNode:UpdateChildrenHeightsToRoot()
    if self.parentNode then
        self.parentNode:UpdateChildrenHeightsToRoot()
    end
end
--The height of the children taking into account how open they are
function ZO_TreeNode:GetChildrenTotalCurrentHeight()
    if self.children then
        local height = 0
        for i = 1, #self.children do
            height = height + self.children[i]:GetCurrentHeight()
        end
        height = height + self.childSpacing * (#self.children - 1)
        return height
    else
        return 0
    end
end
function ZO_TreeNode:UpdateChildrenCurrentHeight()
    local height = self:GetChildrenTotalCurrentHeight()
    height = height * self.openPercentage
    self.childrenCurrentHeight = height
    if self.childContainer then
        self.childContainer:SetHeight(self.childrenCurrentHeight)
    end
end
function ZO_TreeNode:UpdateCurrentChildrenHeightsToRoot()
    if self.parentNode then
        self.parentNode:UpdateCurrentChildrenHeightsToRoot()
    end
end
    if self.children then
        for _, child in ipairs(self.children) do
            child:UpdateAllChildrenHeightsAndCurrentHeights(child)
        end
    end
end
function ZO_TreeNode:GetControl()
    return self.control
end
function ZO_TreeNode:GetParent()
    return self.parentNode
end
function ZO_TreeNode:GetChildren()
    return self.children
end
function ZO_TreeNode:GetChild(index)
    if self.children then
        return self.children[index]
    else
        return nil
    end
end
function ZO_TreeNode:GetChildSpacing()
    return self.childSpacing
end
function ZO_TreeNode:GetChildIndent()
    return self.childIndent
end
function ZO_TreeNode:GetData()
    return self.data
end
function ZO_TreeNode:GetTemplate()
    return self.templateInfo.template
end
function ZO_TreeNode:RefreshControl(userRequested)
    if self.setupFunction then
        self.setupFunction(self, self.control, self.data, self.open, userRequested, self.tree:IsEnabled())
    end
end
function ZO_TreeNode:GetNextSiblingNode(includeDisabledNodes)
    if self.parentNode then
        local siblingNodes = self.parentNode.children
        local hasPassedCurrentNode = false
        for index, siblingNode in ipairs(siblingNodes) do
            if hasPassedCurrentNode then
                if includeDisabledNodes or siblingNode:IsEnabled() then
                    return siblingNode
                end
            elseif siblingNode == self then
                hasPassedCurrentNode = true
            end
        end
    end
end
function ZO_TreeNode:GetPreviousSiblingNode(includeDisabledNodes)
    if self.parentNode then
        local siblingNodes = self.parentNode.children
        local adjacentNode
        for index, siblingNode in ipairs(siblingNodes) do
            if siblingNode == self then
                return adjacentNode
            elseif includeDisabledNodes or siblingNode:IsEnabled() then
                adjacentNode = siblingNode
            end
        end
    end
end
function ZO_TreeNode:GetNextOrPreviousSiblingNode(includeDisabledNodes)
    if self.parentNode then
        local siblingNodes = self.parentNode.children
        local hasPassedCurrentNode = false
        local previousNode = nil
        for index, siblingNode in ipairs(siblingNodes) do
            if hasPassedCurrentNode then
                if includeDisabledNodes or siblingNode:IsEnabled() then
                    return siblingNode
                end
            else
                if siblingNode == self then
                    hasPassedCurrentNode = true
                elseif includeDisabledNodes or siblingNode:IsEnabled() then
                    previousNode = siblingNode
                end
            end
        end
        return previousNode
    end
end
--Global XML
function ZO_TreeHeader_OnMouseUp(self, upInside)
    if upInside and self.node.tree.enabled then
        -- Play the selected sound if not already opened
        if not self.node:IsEnabled() then
            PlaySound(SOUNDS.NEGATIVE_CLICK)
        elseif not self.node.open and self.node.selectSound then
            PlaySound(self.node.selectSound)
        end
        self.node:GetTree():ToggleNode(self.node)
    end
end
function ZO_TreeEntry_OnMouseUp(self, upInside)
    if upInside and self.node.tree.enabled then
        -- Play the selected sound if not already selected
        if not self.node:IsEnabled() then
            PlaySound(SOUNDS.NEGATIVE_CLICK)
        elseif not self.node.selected and self.node.selectSound then
            PlaySound(self.node.selectSound)
        end
        local NOT_REBUILDING = false
        local DONT_BRING_PARENT_INTO_VIEW = false
        self.node:GetTree():SelectNode(self.node, NOT_REBUILDING, DONT_BRING_PARENT_INTO_VIEW)
    end
end
--ZO_Trees
---------------
ZO_Trees = ZO_Object:Subclass()
function ZO_Trees:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_Trees:Initialize()
    self.trees = {}
    EVENT_MANAGER:RegisterForEvent("ZO_Trees", EVENT_ALL_GUI_SCREENS_RESIZED, function() self:OnScreenResized() end)
end
function ZO_Trees:Add(tree)
    table.insert(self.trees, tree)
end
function ZO_Trees:OnScreenResized()
    for _, tree in ipairs(self.trees) do
        tree:OnScreenResized()
    end
end
TREES = ZO_Trees:New()