mirrors/Unciv
1
0
Fork 0
mirror of https://github.com/yairm210/Unciv.git synced 2025-07-09 23:39:40 +07:00
Code Issues Packages Projects Releases Wiki Activity

Tweak FasterUIDevelopment to offer normal Scene2D debugging, and some linting (#10263)

Browse Source
This commit is contained in:
SomeTroglodyte
2023-10-07 20:58:19 +02:00
committed by GitHub
parent 459b00ee22
commit 5db8489bcb
2 changed files with 38 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Developers/UI-development.md
View File

@ -12,6 +12,11 @@ It sets up the very basics of Unciv, so that you can then show one single UI com
To use it, you change the `DevElement` class within the `FasterUIDevelopment.kt` file so that the `actor` field is set to the UI element you want to develop. A very basic usage is there by default, just showing a label, but you can put any UI element there instead.
Once it's up and running, your UI element is centered in the window and gets an orange border. You can toggle Scene2D debugging with the middle mouse button (click the wheel).
Note that the parent your UI element will get doesn't set the size (which in reactive nested layouts would be its responsibility), so if your element is a WidgetGroup like Table, just pack() it. Or ignore the orange dot left over from the border. Also please do not resize the window - there's no support for that at the moment and no guarantees can be given for the results.
```kotlin
class DevElement(
val screen: UIDevScreen
@ -33,6 +38,7 @@ There's two ways to do so:
* Create a Run Configuration similar to [the desktop one described here](./Building-Locally.md#with-android-studio), but with classpath `Unciv.tests.test` and main class `com.unciv.dev.FasterUIDevelopment`.
![image](/Unciv/assets/FasterUIDevelopment.png)
## The 'Gdx Scene2D debug' option
This option (on the secret 'Debug' page) turns on several UI debug features:

60
tests/src/com/unciv/dev/FasterUIDevelopment.kt
View File

@ -9,11 +9,11 @@ import com.badlogic.gdx.graphics.Pixmap
import com.badlogic.gdx.math.Vector2
import com.badlogic.gdx.scenes.scene2d.Actor
import com.badlogic.gdx.scenes.scene2d.InputEvent
import com.badlogic.gdx.scenes.scene2d.InputListener
import com.badlogic.gdx.scenes.scene2d.utils.ClickListener
import com.badlogic.gdx.scenes.scene2d.utils.Layout
import com.unciv.UncivGame
import com.unciv.dev.FasterUIDevelopment.DevElement
import com.unciv.logic.files.UncivFiles
import com.unciv.logic.multiplayer.throttle
import com.unciv.ui.components.FontFamilyData
import com.unciv.ui.components.FontImplementation
import com.unciv.ui.components.Fonts
@ -22,22 +22,27 @@ import com.unciv.ui.components.extensions.toLabel
import com.unciv.ui.images.ImageGetter
import com.unciv.ui.images.ImageWithCustomSize
import com.unciv.ui.screens.basescreen.BaseScreen
import com.unciv.utils.Concurrency
import com.unciv.ui.screens.basescreen.UncivStage
import java.awt.Font
import java.awt.RenderingHints
import java.awt.image.BufferedImage
import java.time.Duration
import java.time.Instant
import java.util.Locale
import java.util.concurrent.atomic.AtomicReference
/** Creates a basic GDX application that mimics [UncivGame] as closely as possible, starts up fast and shows one UI element, to be returned by [DevElement.createDevElement] */
/** Creates a basic GDX application that mimics [UncivGame] as closely as possible,
* starts up fast and shows one UI element, to be returned by [DevElement.createDevElement].
*
* * The parent will not size your Widget as the Gdx [Layout] contract promises,
* you'll need to do it yourself. E.g, if you're a [WidgetGroup], call [pack()][WidgetGroup.pack].
* If you forget, you'll see an orange dot in the window center.
* * Resizing the window is not supported. You might lose interactivity.
* * The middle mouse button toggles Scene2D debug mode, like the full game offers in the Debug Options.
*/
object FasterUIDevelopment {
class DevElement(
val screen: UIDevScreen
@Suppress("unused") val screen: UIDevScreen
) {
lateinit var actor: Actor
fun createDevElement() {
actor = "This could be your UI element in development!".toLabel()
}
@ -81,36 +86,26 @@ object FasterUIDevelopment {
override fun render() {
game.render()
}
}
class UIDevScreen : BaseScreen() {
val devElement = DevElement(this)
private val devElement = DevElement(this)
init {
devElement.createDevElement()
val actor = devElement.actor
actor.center(stage)
addBorder(actor, Color.ORANGE)
actor.zIndex = Int.MAX_VALUE
stage.addActor(actor)
devElement.afterAdd()
stage.addListener(object : InputListener() {
val lastPrint = AtomicReference<Instant?>()
override fun mouseMoved(event: InputEvent?, x: Float, y: Float): Boolean {
Concurrency.run {
throttle(lastPrint, Duration.ofMillis(500), {}) {
println(String.format(Locale.US,"x: %.1f\ty: %.1f", x, y))
}
}
return false
}
})
stage.addListener(ToggleDebugListener(stage as UncivStage))
}
private var curBorderZ = 0
fun addBorder(actor: Actor, color: Color) {
private fun addBorder(actor: Actor, color: Color) {
val stageCoords = actor.localToStageCoordinates(Vector2())
// Z-Order works because we're called _before_ the DevElement is added
val border = ImageWithCustomSize(skinStrings.getUiBackground("", tintColor = color))
border.zIndex = curBorderZ++
val stageCoords = actor.localToStageCoordinates(Vector2.Zero.cpy())
border.x = stageCoords.x - 1
border.y = stageCoords.y - 1
border.width = actor.width + 2
@ -118,13 +113,22 @@ object FasterUIDevelopment {
stage.addActor(border)
val background = ImageWithCustomSize(skinStrings.getUiBackground("", tintColor = clearColor))
background.zIndex = curBorderZ++
background.x = stageCoords.x
background.y = stageCoords.y
background.width = actor.width
background.height = actor.height
stage.addActor(background)
}
private class ToggleDebugListener(private val stage: UncivStage) : ClickListener(2) {
override fun clicked(event: InputEvent?, x: Float, y: Float) {
enableSceneDebug = !enableSceneDebug
stage.setDebugUnderMouse(enableSceneDebug)
stage.setDebugTableUnderMouse(enableSceneDebug)
stage.setDebugParentUnderMouse(enableSceneDebug)
stage.mouseOverDebug = enableSceneDebug
}
}
}
}