An easy-to-use debug display.
Scope is hosted at Maven Central, you can get it by adding the following dependencies:
implementation("io.github.fourlastor.gdx:scope:$version")Create your settings class:
Java
public static class Settings {
public float characterSpeed = 12.3f;
// Optional - set a custom name for this field
@Scope.Lens(name = "Jump height")
public int tilesJumpHeight = 99;
}Kotlin
class Settings {
@JvmField // Mandatory in Kotlin
var characterSpeed: Float = 12.3f;
@JvmField
// Optional - set a custom name for this field
@field:Scope.Lens(name = "Jump height")
var tilesJumpHeight: Int = 99
}Fields must be public and non-final.
Create a Group to render your settings, and a ScopeRenderer (you can use multiple Groups with the same renderer):
class MyGame {
Settings settings;
Group group;
ScopeRenderer renderer;
public void create() {
settings = new Settings();
group = new Group(new ObjectScope("Settings", settings));
renderer = new ScopeRenderer(48);
}
public void render() {
// start/stop are optional when rendering a single group
renderer.start();
renderer.render(group);
renderer.end();
}
}ScopeRender in your game, multiple instances will mess with input detection.
2023-07-08_20-11-15.mp4
Clicking "Apply" will update the field values of the object.
You can pass a Runnable to Group to be notified when changed are applied:
new Group("Settings", settings, () -> System.out.println("settings changed!"));Custom adapters can be created to treat classes in a special way:
// ColorAdapter is part of the default adapters already, let's create one that shows also the alpha of the color
public class ColorAdapter implements Scope.Adapter {
@Override
public Scope create(String name, Object instance, Field field, Map<Class<?>, Scope.Adapter> adapters) {
return new ColorFieldScope(name, instance, field);
}
private static class ColorFieldScope extends Scope {
private final float[] value;
private final Color color;
ColorFieldScope(String name, Object instance, Field field) {
super(name);
try {
color = ((Color) field.get(instance));
this.value = new float[] {color.r, color.g, color.b, color.a};
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
}
}
@Override
public void display() {
// colorEdit4 has the alpha
ImGui.colorEdit4(name, value, ImGuiColorEditFlags.AlphaBar);
}
@Override
public void apply() {
color.set(value[0], value[1], value[2], value[3]);
}
}
}
public class Main {
public static void main(String[] args) {
// Create the default adapters
Map<Class<?>, Adapter> adapters = Scope.Adapter.createDefaultAdapters();
// Add a custom adapter to them
adapters.put(Color.class, new ColorAdapter());
// Use the custom map of adapters when creating ObjectScope
ObjectScope scope = new ObjectScope("Scope with custom adapters", settings, adapters);
}
}