Scene

Since 2.2.1

Scene renders an interactive 3D Minecraft world view inside a GUI element. It uses a WorldSceneRenderer to draw a set of blocks from a TrackedDummyWorld. The viewport supports:

• Drag to rotate — left-click and drag to orbit the camera.
• Scroll to zoom — mouse wheel changes the zoom level.
• Block interaction — clicking reports the hit block position and face.
• FBO mode — render at arbitrary resolution into a framebuffer object.

INFO

Everything documented on UIElement (layout, styles, events, data bindings, etc.) applies here too.

---

Usage

var scene = new Scene();

// Create the scene from a level:
scene.createScene(level); // or createScene(level, useFBO, size)

// Populate blocks to render:
var blocks = List.of(BlockPos.ZERO, new BlockPos(1, 0, 0));
scene.setRenderedCore(blocks);

// Listen for clicks:
scene.setOnSelected((pos, face) ->
    System.out.println("Clicked " + pos + " face " + face)
);

parent.addChild(scene);

scene({
    world(level)
    blocks(BlockPos.ZERO)
    onSelect { pos, face -> println("Clicked $pos $face") }
}) { }

let s = new Scene();
s.createScene(level);
s.setRenderedCore([BlockPos.ZERO]);
s.setOnSelected((pos, face) => { /* ... */ });
parent.addChild(s);

---

Fields

Name	Type	Access	Description
renderer	WorldSceneRenderer (nullable)	private (getter, client-only)	The underlying scene renderer.
dummyWorld	TrackedDummyWorld (nullable)	private (getter)	The virtual world holding rendered blocks.
draggable	boolean	getter/setter	Whether the camera can be rotated by dragging. Default: true.
scalable	boolean	getter/setter	Whether the mouse wheel changes the zoom. Default: true.
intractable	boolean	getter/setter	Whether block clicks are reported. Default: true.
renderFacing	boolean	getter/setter	Whether face highlights are drawn. Default: true.
renderSelect	boolean	getter/setter	Whether selected block highlights are drawn. Default: true.
showHoverBlockTips	boolean	getter/setter	Whether a tooltip is shown for the hovered block. Default: false.
tickWorld	boolean	getter/setter	Whether dummyWorld is ticked every frame. Default: true.
useOrtho	boolean	private (getter)	true when using orthographic projection.
useCache	boolean	private (getter)	true when using a cached buffer.
autoReleased	boolean	private (getter)	true to release renderer resources when removed. Default: true.
center	Vector3f	private (getter)	Camera look-at target (world space).
rotationPitch	float	private (getter)	Camera pitch in degrees. Default: 25.
rotationYaw	float	private (getter)	Camera yaw in degrees. Default: -135.
zoom	float	private (getter)	Camera distance. Default: 5.
onSelected	BiConsumer<BlockPos, Direction>	getter/setter	Callback invoked when a block is clicked.
lastHoverPosFace	BlockPosFace (nullable)	private (getter)	The block/face currently under the mouse.
lastClickPosFace	BlockPosFace (nullable)	private (getter)	The block/face that was last clicked.
lastSelectedPosFace	BlockPosFace (nullable)	private (getter)	The last selected block/face.

---

Methods

Method	Returns	Description
createScene(Level)	Scene	Initialises the renderer with the given level (immediate mode).
createScene(Level, boolean, Size)	Scene	Initialises with optional FBO rendering at the given resolution.
setRenderedCore(Collection<BlockPos>)	Scene	Sets the blocks to render; auto-adjusts the camera.
setRenderedCore(Collection<BlockPos>, ISceneBlockRenderHook)	Scene	Sets blocks with a custom render hook.
setRenderedCore(Collection<BlockPos>, ISceneBlockRenderHook, boolean)	Scene	Sets blocks; autoCamera controls whether the camera is repositioned.
useCacheBuffer(boolean)	Scene	Enables or disables compiled draw-call cache.
useOrtho(boolean)	Scene	Switches between perspective and orthographic projection.
setOrthoRange(float)	Scene	Sets the orthographic projection range (only effective when ortho is enabled).
setCenter(Vector3f)	Scene	Sets the camera look-at target in world space.
setZoom(float)	Scene	Sets the camera zoom distance.
setCameraYawAndPitch(float yaw, float pitch)	Scene	Sets the camera yaw and pitch immediately.
setCameraYawAndPitchAnima(float yaw, float pitch, int duration)	Scene	Animates the camera to the given yaw and pitch over duration ticks.
needCompileCache()	void	Flags the cache as dirty so it is recompiled on the next frame.
releaseRendererResource()	void	Releases GPU resources held by the renderer.
setBeforeWorldRender(Consumer<Scene>)	Scene	Sets a hook called before each world render pass (client-only).
setAfterWorldRender(Consumer<Scene>)	Scene	Sets a hook called after each world render pass.