-
Notifications
You must be signed in to change notification settings - Fork 31
/
ScrollComponent.kt
865 lines (715 loc) · 31.4 KB
/
ScrollComponent.kt
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
package gg.essential.elementa.components
import gg.essential.elementa.ElementaVersion
import gg.essential.elementa.UIComponent
import gg.essential.elementa.constraints.*
import gg.essential.elementa.constraints.animation.Animations
import gg.essential.elementa.constraints.resolution.ConstraintVisitor
import gg.essential.elementa.dsl.*
import gg.essential.elementa.effects.ScissorEffect
import gg.essential.elementa.events.UIScrollEvent
import gg.essential.elementa.utils.bindLast
import gg.essential.universal.UKeyboard
import gg.essential.universal.UMatrixStack
import gg.essential.universal.UMouse
import java.awt.Color
import java.util.concurrent.CopyOnWriteArrayList
import kotlin.math.abs
import kotlin.math.max
/**
* Basic scroll component that will only draw what is currently visible.
*
* Also prevents scrolling past what should be reasonable.
*/
class ScrollComponent constructor(
emptyString: String = "",
private val innerPadding: Float = 0f,
private val scrollIconColor: Color = Color.WHITE,
private val scrollDirection: Direction,
private val horizontalScrollOpposite: Boolean = false,
private val verticalScrollOpposite: Boolean = false,
private val pixelsPerScroll: Float = 15f,
private val scrollAcceleration: Float = 1.0f,
customScissorBoundingBox: UIComponent? = null,
private val passthroughScroll: Boolean = true,
) : UIContainer() {
@JvmOverloads constructor(
emptyString: String = "",
innerPadding: Float = 0f,
scrollIconColor: Color = Color.WHITE,
horizontalScrollEnabled: Boolean = false,
verticalScrollEnabled: Boolean = true,
horizontalScrollOpposite: Boolean = false,
verticalScrollOpposite: Boolean = false,
pixelsPerScroll: Float = 15f,
scrollAcceleration: Float = 1.0f,
customScissorBoundingBox: UIComponent? = null,
) : this (
emptyString,
innerPadding,
scrollIconColor,
when {
horizontalScrollEnabled && verticalScrollEnabled -> Direction.PreferVertical
horizontalScrollEnabled && !verticalScrollEnabled -> Direction.Horizontal
!horizontalScrollEnabled && verticalScrollEnabled -> Direction.Vertical
else -> throw IllegalArgumentException("ScrollComponent must have at least one direction of scrolling enabled")
},
horizontalScrollOpposite,
verticalScrollOpposite,
pixelsPerScroll,
scrollAcceleration,
customScissorBoundingBox,
)
private val primaryScrollDirection
get() = when (scrollDirection) {
Direction.Horizontal, Direction.PreferHorizontal -> Direction.Horizontal
Direction.Vertical, Direction.PreferVertical -> Direction.Vertical
}
private val secondaryScrollDirection
get() = when (scrollDirection) {
Direction.PreferHorizontal -> Direction.Vertical
Direction.PreferVertical -> Direction.Horizontal
else -> null
}
private val horizontalScrollEnabled
get() = primaryScrollDirection == Direction.Horizontal || secondaryScrollDirection == Direction.Horizontal
private val verticalScrollEnabled
get() = primaryScrollDirection == Direction.Vertical || secondaryScrollDirection == Direction.Vertical
private var animationFPS: Int? = null
private val actualHolder = UIContainer().constrain {
x = innerPadding.pixels()
y = innerPadding.pixels()
width = RelativeConstraint(1f) - innerPadding.pixels()
height = RelativeConstraint(1f)
}
//Exposed so its position and value can be adjusted by user
val emptyText = UIWrappedText(emptyString, centered = true).constrain {
x = CenterConstraint()
y = SiblingConstraint() + 4.pixels()
}
private val scrollIconComponent = getScrollImage().constrain {
width = 10.pixels()
height = 16.pixels()
color = scrollIconColor.toConstraint()
}
var horizontalOffset = innerPadding
private set
var verticalOffset = innerPadding
private set
private var horizontalScrollBarGrip: UIComponent? = null
private var horizontalHideScrollWhenUseless = false
private var verticalScrollBarGrip: UIComponent? = null
private var verticalHideScrollWhenUseless = false
private var horizontalDragBeginPos = -1f
private var verticalDragBeginPos = -1f
private val horizontalScrollAdjustEvents: MutableList<(Float, Float) -> Unit> =
mutableListOf(::updateScrollBar.bindLast(true))
private val verticalScrollAdjustEvents: MutableList<(Float, Float) -> Unit> =
mutableListOf(::updateScrollBar.bindLast(false))
private var needsUpdate = true
private var isAutoScrolling = false
private var autoScrollBegin: Pair<Float, Float> = -1f to -1f
private var currentScrollAcceleration: Float = 1.0f
val allChildren = CopyOnWriteArrayList<UIComponent>()
/**
* Difference between the ScrollComponent's width and its contents' width.
* Will not be less than zero, even if the contents' width is less than the
* component's width.
*/
val horizontalOverhang: Float
get() = max(0f, calculateActualWidth() - getWidth())
/**
* Difference between the ScrollComponent's height and its contents' height.
* Will not be less than zero, even if the contents' height is less than the
* component's height.
*/
val verticalOverhang: Float
get() = max(0f, calculateActualHeight() - getHeight())
private val mouseScrollLambda: UIComponent.(UIScrollEvent) -> Unit = {
if (Window.of(this).version >= ElementaVersion.v5) {
// new behavior
val scrollDirection = if (!UKeyboard.isShiftKeyDown()) primaryScrollDirection else secondaryScrollDirection
if (scrollDirection != null) {
if (onScroll(it.delta.toFloat(), isHorizontal = scrollDirection == Direction.Horizontal) || !passthroughScroll) {
it.stopPropagation()
}
}
} else {
// old behavior
if (UKeyboard.isShiftKeyDown() && horizontalScrollEnabled) {
onScroll(it.delta.toFloat(), isHorizontal = true)
} else if (!UKeyboard.isShiftKeyDown() && verticalScrollEnabled) {
onScroll(it.delta.toFloat(), isHorizontal = false)
}
it.stopPropagation()
}
}
init {
this.constrain {
width = ScrollChildConstraint() coerceAtMost 100.percentOfWindow()
height = ScrollChildConstraint() coerceAtMost 100.percentOfWindow()
}
super.addChild(actualHolder)
actualHolder.addChild(emptyText)
this.enableEffects(ScissorEffect(customScissorBoundingBox))
emptyText.setFontProvider(getFontProvider())
super.addChild(scrollIconComponent)
scrollIconComponent.hide(instantly = true)
onMouseScroll(mouseScrollLambda)
onMouseClick { event ->
onClick(event.relativeX, event.relativeY, event.mouseButton)
}
}
private var lastWidth = 0f
private var lastHeight = 0f
private var lastActualWidth = 0f
private var lastActualHeight = 0f
override fun draw(matrixStack: UMatrixStack) {
val width = getWidth()
val height = getHeight()
if (width != lastWidth || height != lastHeight) {
lastWidth = width
lastHeight = height
needsUpdate = true
}
val actualWidth = calculateActualWidth()
val actualHeight = calculateActualHeight()
if (actualWidth != lastActualWidth || actualHeight != lastActualHeight) {
lastActualWidth = actualWidth
lastActualHeight = actualHeight
needsUpdate = true
}
if (needsUpdate) {
needsUpdate = false
val horizontalRange = calculateOffsetRange(isHorizontal = true)
val verticalRange = calculateOffsetRange(isHorizontal = false)
// Recalculate our scroll box and move the content inside if needed.
actualHolder.animate {
horizontalOffset =
if (horizontalRange.isEmpty()) innerPadding else horizontalOffset.coerceIn(horizontalRange)
verticalOffset = if (verticalRange.isEmpty()) innerPadding else verticalOffset.coerceIn(verticalRange)
setXAnimation(Animations.IN_SIN, 0.1f, horizontalOffset.pixels())
setYAnimation(Animations.IN_SIN, 0.1f, verticalOffset.pixels())
}
// Run our scroll adjust event, normally updating [scrollBarGrip]
var percent = (innerPadding - horizontalOffset) / horizontalRange.width()
var percentageOfParent = width / actualWidth
horizontalScrollAdjustEvents.forEach { it(percent, percentageOfParent) }
percent = (innerPadding - verticalOffset) / verticalRange.width()
percentageOfParent = height / actualHeight
verticalScrollAdjustEvents.forEach { it(percent, percentageOfParent) }
}
super.draw(matrixStack)
}
override fun afterInitialization() {
super.afterInitialization()
animationFPS = Window.of(this).animationFPS
}
/**
* Sets the text that appears when no items are shown
*/
fun setEmptyText(text: String) {
emptyText.setText(text)
}
fun addScrollAdjustEvent(
isHorizontal: Boolean,
event: (scrollPercentage: Float, percentageOfParent: Float) -> Unit
) {
if (isHorizontal) horizontalScrollAdjustEvents.add(event) else verticalScrollAdjustEvents.add(event)
}
@JvmOverloads
fun setHorizontalScrollBarComponent(component: UIComponent, hideWhenUseless: Boolean = false) {
setScrollBarComponent(component, hideWhenUseless, isHorizontal = true)
}
@JvmOverloads
fun setVerticalScrollBarComponent(component: UIComponent, hideWhenUseless: Boolean = false) {
setScrollBarComponent(component, hideWhenUseless, isHorizontal = false)
}
/**
* A scroll bar component is an optional component that can visually display the scroll status
* of this scroll component (just like any scroll bar).
*
* The utility here is that it is automatically updated by this component with no extra work on the user-end.
*
* The hierarchy for this scrollbar grip component must be as follows:
* - Have a containing parent being the full height range of this scroll bar.
*
* [component]'s mouse events will all be overridden by this action.
*
* If [hideWhenUseless] is enabled, [component] will have [hide] called on it when the scrollbar is full height
* and dragging it would do nothing.
*/
fun setScrollBarComponent(component: UIComponent, hideWhenUseless: Boolean, isHorizontal: Boolean) {
if (isHorizontal) {
horizontalScrollBarGrip = component
horizontalHideScrollWhenUseless = hideWhenUseless
} else {
verticalScrollBarGrip = component
verticalHideScrollWhenUseless = hideWhenUseless
}
component.onMouseScroll(mouseScrollLambda)
component.onMouseClick { event ->
if (isHorizontal) {
horizontalDragBeginPos = event.relativeX
} else {
verticalDragBeginPos = event.relativeY
}
}
component.onMouseDrag { mouseX, mouseY, _ ->
if (isHorizontal) {
if (horizontalDragBeginPos == -1f)
return@onMouseDrag
updateGrip(component, mouseX, isHorizontal = true)
} else {
if (verticalDragBeginPos == -1f)
return@onMouseDrag
updateGrip(component, mouseY, isHorizontal = false)
}
}
component.onMouseRelease {
if (isHorizontal) {
horizontalDragBeginPos = -1f
} else {
verticalDragBeginPos = -1f
}
}
needsUpdate = true
}
fun scrollTo(
horizontalOffset: Float = this.horizontalOffset,
verticalOffset: Float = this.verticalOffset,
smoothScroll: Boolean = true
) {
val horizontalRange = calculateOffsetRange(isHorizontal = true)
val verticalRange = calculateOffsetRange(isHorizontal = false)
this.horizontalOffset =
if (horizontalRange.isEmpty()) innerPadding else horizontalOffset.coerceIn(horizontalRange)
this.verticalOffset = if (verticalRange.isEmpty()) {
innerPadding
} else {
verticalOffset.coerceIn(verticalRange)
}
if (smoothScroll) {
needsUpdate = true
return
}
actualHolder.setX(this.horizontalOffset.pixels())
actualHolder.setY(this.verticalOffset.pixels())
val horizontalFraction = (innerPadding - this.horizontalOffset) / horizontalRange
val verticalFraction = (innerPadding -this.verticalOffset) / verticalRange
horizontalScrollAdjustEvents.forEach { it(horizontalFraction, this.getWidth() / calculateActualWidth()) }
verticalScrollAdjustEvents.forEach { it(verticalFraction, this.getHeight() / calculateActualHeight()) }
}
private operator fun Float.div(range: ClosedFloatingPointRange<Float>): Float {
val width = range.width()
return if (width == 0f) 0f else this / width
}
fun scrollToLeft(smoothScroll: Boolean = true) {
scrollTo(horizontalOffset = Float.POSITIVE_INFINITY, smoothScroll = smoothScroll)
}
fun scrollToRight(smoothScroll: Boolean = true) {
scrollTo(horizontalOffset = Float.NEGATIVE_INFINITY, smoothScroll = smoothScroll)
}
fun scrollToTop(smoothScroll: Boolean = true) {
scrollTo(verticalOffset = Float.POSITIVE_INFINITY, smoothScroll = smoothScroll)
}
fun scrollToBottom(smoothScroll: Boolean = true) {
scrollTo(verticalOffset = Float.NEGATIVE_INFINITY, smoothScroll = smoothScroll)
}
fun filterChildren(filter: (component: UIComponent) -> Boolean) {
actualHolder.children.clear()
actualHolder.children.addAll(allChildren.filter(filter).ifEmpty { listOf(emptyText) })
actualHolder.children.forEach { it.parent = actualHolder }
needsUpdate = true
}
@JvmOverloads
fun <T : Comparable<T>> sortChildren(descending: Boolean = false, comparator: (UIComponent) -> T) {
if (descending) {
actualHolder.children.sortByDescending(comparator)
} else {
actualHolder.children.sortBy(comparator)
}
}
fun sortChildren(comparator: Comparator<UIComponent>) {
actualHolder.children.sortWith(comparator)
}
private fun updateGrip(component: UIComponent, mouseCoord: Float, isHorizontal: Boolean) {
if (isHorizontal) {
val minCoord = component.parent.getLeft()
val maxCoord = component.parent.getRight()
val dragDelta = mouseCoord - horizontalDragBeginPos
horizontalOffset = if (horizontalScrollOpposite) {
val newPos = maxCoord - component.getRight() - dragDelta
val percentage = newPos / (maxCoord - minCoord)
percentage * calculateActualWidth()
} else {
val newPos = component.getLeft() + dragDelta - minCoord
val percentage = newPos / (maxCoord - minCoord)
-(percentage * calculateActualWidth())
}
} else {
val minCoord = component.parent.getTop()
val maxCoord = component.parent.getBottom()
val dragDelta = mouseCoord - verticalDragBeginPos
verticalOffset = if (verticalScrollOpposite) {
val newPos = maxCoord - component.getBottom() - dragDelta
val percentage = newPos / (maxCoord - minCoord)
percentage * calculateActualHeight()
} else {
val newPos = component.getTop() + dragDelta - minCoord
val percentage = newPos / (maxCoord - minCoord)
-(percentage * calculateActualHeight())
}
}
needsUpdate = true
}
/**
* @return whether the offset changed
*/
private fun onScroll(delta: Float, isHorizontal: Boolean): Boolean {
var changed = false
val offset = if (isHorizontal) ::horizontalOffset else ::verticalOffset
val range = calculateOffsetRange(isHorizontal)
val newOffset = if(range.isEmpty()) innerPadding else (offset.get() + delta * pixelsPerScroll * currentScrollAcceleration).coerceIn(range)
if (newOffset != offset.get()) {
changed = true
offset.set(newOffset)
}
currentScrollAcceleration =
(currentScrollAcceleration + (scrollAcceleration - 1.0f) * 0.15f).coerceIn(0f, scrollAcceleration)
needsUpdate = true
return changed
}
private fun updateScrollBar(scrollPercentage: Float, percentageOfParent: Float, isHorizontal: Boolean) {
val component = if (isHorizontal) {
horizontalScrollBarGrip ?: return
} else {
verticalScrollBarGrip ?: return
}
val clampedPercentage = percentageOfParent.coerceAtMost(1f)
if ((isHorizontal && horizontalHideScrollWhenUseless) || (!isHorizontal && verticalHideScrollWhenUseless)) {
if (clampedPercentage == 1f) {
Window.enqueueRenderOperation(component::hide)
return
} else {
Window.enqueueRenderOperation(component::unhide)
}
}
val relativeConstraint = RelativeConstraint(clampedPercentage)
val desiredSizeConstraint = if (Window.of(this).version >= ElementaVersion.v6) {
ScrollBarGripMinSizeConstraint(relativeConstraint)
} else {
relativeConstraint
}
if (isHorizontal) {
component.setWidth(desiredSizeConstraint)
} else {
component.setHeight(desiredSizeConstraint)
}
component.animate {
if (isHorizontal) {
setXAnimation(
Animations.IN_SIN, 0.1f, basicXConstraint { component ->
val offset = (component.parent.getWidth() - component.getWidth()) * scrollPercentage
if (horizontalScrollOpposite) component.parent.getRight() - component.getHeight() + offset
else component.parent.getLeft() + offset
}
)
} else {
setYAnimation(
Animations.IN_SIN, 0.1f, basicYConstraint { component ->
val offset = (component.parent.getHeight() - component.getHeight()) * scrollPercentage
if (verticalScrollOpposite) component.parent.getBottom() - component.getHeight() + offset
else component.parent.getTop() + offset
}
)
}
}
}
private fun calculateActualWidth(): Float {
if (actualHolder.children.isEmpty()) return 0f
return actualHolder.children.let { c ->
c.maxOf { it.getRight() } - c.minOf { it.getLeft() }
}
}
private fun calculateActualHeight(): Float {
if (actualHolder.children.isEmpty()) return 0f
return actualHolder.children.let { c ->
c.maxOf { it.getBottom() } - c.minOf { it.getTop() }
}
}
private fun calculateOffsetRange(isHorizontal: Boolean): ClosedFloatingPointRange<Float> {
return if (isHorizontal) {
val actualWidth = calculateActualWidth()
val maxNegative = this.getWidth() - actualWidth - innerPadding
if (horizontalScrollOpposite) (-innerPadding)..-maxNegative else maxNegative..(innerPadding)
} else {
val actualHeight = calculateActualHeight()
val maxNegative = this.getHeight() - actualHeight - innerPadding
if (verticalScrollOpposite) (-innerPadding)..-maxNegative else maxNegative..(innerPadding)
}
}
private fun onClick(mouseX: Float, mouseY: Float, mouseButton: Int) {
if (isAutoScrolling) {
isAutoScrolling = false
scrollIconComponent.hide()
return
}
if (mouseButton == 2) {
// Middle click, begin the auto scroll
isAutoScrolling = true
autoScrollBegin = mouseX to mouseY
scrollIconComponent.constrain {
x = (mouseX - 5).pixels()
y = (mouseY - 8).pixels()
}
scrollIconComponent.unhide(useLastPosition = false)
}
}
override fun animationFrame() {
super.animationFrame()
currentScrollAcceleration =
(currentScrollAcceleration - ((scrollAcceleration - 1.0f) / (animationFPS ?: 244).toFloat()))
.coerceAtLeast(1.0f)
if (!isAutoScrolling) return
if (horizontalScrollEnabled) {
val xBegin = autoScrollBegin.first + getLeft()
val currentX = UMouse.Scaled.x
if (currentX in getLeft()..getRight()) {
val deltaX = currentX - xBegin
val percentX = deltaX / (-getWidth() / 2)
horizontalOffset += (percentX.toFloat() * 5f)
needsUpdate = true
}
}
if (verticalScrollEnabled) {
val yBegin = autoScrollBegin.second + getTop()
val currentY = UMouse.Scaled.y
if (currentY in getTop()..getBottom()) {
val deltaY = currentY - yBegin
val percentY = deltaY / (-getHeight() / 2)
verticalOffset += (percentY.toFloat() * 5f)
needsUpdate = true
}
}
needsUpdate = true
}
override fun addChild(component: UIComponent) = apply {
actualHolder.removeChild(emptyText)
actualHolder.addChild(component)
allChildren.add(component)
needsUpdate = true
}
override fun insertChildAt(component: UIComponent, index: Int) = apply {
if (index < 0 || index > allChildren.size) {
println("Bad index given to insertChildAt (index: $index, children size: ${allChildren.size}")
return@apply
}
actualHolder.removeChild(emptyText)
component.parent = actualHolder
actualHolder.children.add(index, component)
allChildren.add(index, component)
needsUpdate = true
}
override fun insertChildBefore(newComponent: UIComponent, targetComponent: UIComponent) = apply {
val indexOfExisting = allChildren.indexOf(targetComponent)
if (indexOfExisting == -1) {
println("targetComponent given to insertChildBefore is not a child of this component")
return@apply
}
insertChildAt(newComponent, indexOfExisting)
}
override fun insertChildAfter(newComponent: UIComponent, targetComponent: UIComponent) = apply {
val indexOfExisting = allChildren.indexOf(targetComponent)
if (indexOfExisting == -1) {
println("targetComponent given to insertChildAfter is not a child of this component")
return@apply
}
insertChildAt(newComponent, indexOfExisting + 1)
}
override fun replaceChild(newComponent: UIComponent, componentToReplace: UIComponent) = apply {
val indexOfExisting = allChildren.indexOf(componentToReplace)
if (indexOfExisting == -1) {
println("componentToReplace given to replaceChild is not a child of this component")
return@apply
}
actualHolder.removeChild(emptyText)
actualHolder.children.removeAt(indexOfExisting)
allChildren.removeAt(indexOfExisting)
newComponent.parent = actualHolder
actualHolder.children.add(indexOfExisting, newComponent)
allChildren.add(indexOfExisting, newComponent)
needsUpdate = true
}
override fun removeChild(component: UIComponent) = apply {
if (component == scrollIconComponent) {
super.removeChild(component)
return@apply
}
actualHolder.removeChild(component)
allChildren.remove(component)
if (actualHolder.children.isEmpty())
actualHolder.addChild(emptyText)
needsUpdate = true
}
override fun clearChildren() = apply {
allChildren.clear()
actualHolder.clearChildren()
actualHolder.addChild(emptyText)
needsUpdate = true
}
override fun alwaysDrawChildren(): Boolean {
return true
}
override fun <T> childrenOfType(clazz: Class<T>): List<T> {
return actualHolder.childrenOfType(clazz)
}
override fun mouseClick(mouseX: Double, mouseY: Double, button: Int) {
actualHolder.mouseClick(mouseX, mouseY, button)
}
override fun hitTest(x: Float, y: Float): UIComponent {
return actualHolder.hitTest(x, y)
}
fun searchAndInsert(components: List<UIComponent>, comparison: (UIComponent) -> Int) {
if (components.isEmpty()) return
actualHolder.children.remove(emptyText)
val searchIndex = actualHolder.children.binarySearch(comparison = comparison)
components.forEach { it.parent = actualHolder }
allChildren.addAll(components)
actualHolder.children.addAll(
if (searchIndex >= 0) searchIndex else -(searchIndex + 1),
components
)
needsUpdate = true
}
fun setChildren(components: List<UIComponent>) = apply {
actualHolder.children.clear()
actualHolder.children.addAll(components.ifEmpty { listOf(emptyText) })
actualHolder.children.forEach { it.parent = actualHolder }
allChildren.clear()
allChildren.addAll(actualHolder.children)
needsUpdate = true
}
private fun ClosedFloatingPointRange<Double>.width() = abs(this.start - this.endInclusive)
private fun ClosedFloatingPointRange<Float>.width() = abs(this.start - this.endInclusive)
class DefaultScrollBar(isHorizontal: Boolean) : UIContainer() {
val grip: UIComponent
init {
if (isHorizontal) {
constrain {
y = 2.pixels(alignOpposite = true)
width = 100.percent()
height = 10.pixels()
}
val container = UIContainer().constrain {
x = 2.pixels()
y = CenterConstraint()
width = RelativeConstraint() - 4.pixels()
height = 4.pixels()
} childOf this
grip = UIBlock(Color(70, 70, 70)).constrain {
x = 0.pixels(alignOpposite = true)
y = CenterConstraint()
width = 30.pixels()
height = 3.pixels()
} childOf container
} else {
constrain {
x = 2.pixels(alignOpposite = true)
width = 10.pixels()
height = 100.percent()
}
val container = UIContainer().constrain {
x = CenterConstraint()
y = 2.pixels()
width = 4.pixels()
height = RelativeConstraint() - 4.pixels()
} childOf this
grip = UIBlock(Color(70, 70, 70)).constrain {
x = CenterConstraint()
y = 0.pixels(alignOpposite = true)
width = 3.pixels()
height = 30.pixels()
} childOf container
}
}
}
/**
* Constrains a scroll component to either the widest/tallest child or to the sum of their widths/heights and
* padding. If [horizontalScrollEnabled] or [verticalScrollEnabled] are true, they will change the constraint to
* use the total of their children's corresponding measurements and padding. Otherwise, it will use the maximum
* measurement for the corresponding direction.
*
* This is the default width and height constraint for scroll components.
*
* @param padding Pixels of padding to add to each component
*/
inner class ScrollChildConstraint(val padding: Float = 0f) : WidthConstraint, HeightConstraint {
override var cachedValue = 0f
override var recalculate = true
override var constrainTo: UIComponent? = null
private val sumConstraint = ChildBasedSizeConstraint(padding)
private val maxConstraint = ChildBasedMaxSizeConstraint()
override fun getWidthImpl(component: UIComponent): Float {
val constraint = if (horizontalScrollEnabled) sumConstraint else maxConstraint
constraint.constrainTo = this.constrainTo ?: actualHolder
return constraint.getWidthImpl(component)
}
override fun getHeightImpl(component: UIComponent): Float {
val constraint = if (verticalScrollEnabled) sumConstraint else maxConstraint
constraint.constrainTo = this.constrainTo ?: actualHolder
return constraint.getHeightImpl(component)
}
override fun visitImpl(visitor: ConstraintVisitor, type: ConstraintType) {
when (type) {
ConstraintType.WIDTH -> visitor.visitChildren(ConstraintType.WIDTH)
ConstraintType.HEIGHT -> visitor.visitChildren(ConstraintType.HEIGHT)
else -> throw IllegalArgumentException(type.prettyName)
}
}
}
/**
* Constraints the scrollbar grip's size to be a certain minimum size, or the [desiredSize].
* This is the default constraint for horizontal scrollbar grips if [ElementaVersion.V6] is used.
*
* @param desiredSize The intended size for the scrollbar grip.
*/
private class ScrollBarGripMinSizeConstraint(
private val desiredSize: SizeConstraint
) : SizeConstraint {
override var cachedValue: Float = 0f
override var recalculate: Boolean = true
override var constrainTo: UIComponent? = null
override fun animationFrame() {
super.animationFrame()
desiredSize.animationFrame()
}
override fun getWidthImpl(component: UIComponent): Float {
val parent = component.parent
val minimumWidthPercentage = if (parent.getWidth() < 200) { 0.15f } else { 0.10f }
val minimumWidth = parent.getWidth() * minimumWidthPercentage
return desiredSize.getWidth(component).coerceAtLeast(minimumWidth)
}
override fun getHeightImpl(component: UIComponent): Float {
val parent = component.parent
val minimumHeightPercentage = if (parent.getHeight() < 200) { 0.15f } else { 0.10f }
val minimumHeight = parent.getHeight() * minimumHeightPercentage
return desiredSize.getHeight(component).coerceAtLeast(minimumHeight)
}
override fun visitImpl(visitor: ConstraintVisitor, type: ConstraintType) {
}
override fun getRadiusImpl(component: UIComponent): Float {
throw IllegalStateException("`ScrollBarGripMinSizeConstraint` does not support `getRadiusImpl`.")
}
}
enum class Direction {
Vertical,
Horizontal,
/*BothBut*/PreferVertical,
/*BothBut*/PreferHorizontal,
}
companion object {
fun getScrollImage(): UIImage {
return UIImage.ofResourceCached("/vertical-scroll.png")
}
}
}