Scene System

The Scene System is McRogueFace’s core rendering and UI architecture. It manages the application window, organizes content into scenes, and provides UI components for building game interfaces.

Overview

Window
  └── Scene (active)
        └── children (UICollection)
              ├── Frame
              ├── Caption
              ├── Sprite
              └── Grid

Every McRogueFace application has one Window. The window displays one active Scene at a time. Scenes contain a collection of UI elements (their children), which are rendered in order from back to front.

Objects

Text Subsystem

The text subsystem handles all text rendering through Caption and Font objects.

Font Loading

Fonts are loaded from TTF files:

font = mcrfpy.Font("assets/fonts/DejaVuSans.ttf")

Creating Captions

Captions render text at a position:

caption = mcrfpy.Caption(pos=(100, 50), text="Hello, World!")
caption.font = font
caption.size = 24
caption.color = mcrfpy.Color(255, 255, 255)
scene.children.append(caption)

Text Measurement

Use Font’s measure() method to get text dimensions for layout:

width, height = font.measure("Hello", size=24)

Image Subsystem

The image subsystem handles sprite rendering through Texture and Sprite objects.

Loading Textures

Textures load sprite sheets with a specified tile size:

# Load a 16x16 tile sprite sheet
texture = mcrfpy.Texture("assets/sprites.png", 16, 16)

Creating Sprites

Sprites display a single tile from a texture:

sprite = mcrfpy.Sprite(pos=(200, 100), texture=texture, sprite_index=42)
sprite.scale = 2.0  # Double size
scene.children.append(sprite)

Texture Usage

Textures are shared across multiple objects:

• Sprite - Single sprite display
• Grid - Tile-based world rendering
• Entity - Game objects on grids

Children Collection Subsystem

Every Scene and Frame has a children property - a UICollection that holds UI elements.

Adding Elements

scene.children.append(frame)
scene.children.append(caption)
scene.children.append(grid)

Render Order

Elements render in order - first added is furthest back:

# Background frame (renders first, behind everything)
scene.children.append(background_frame)

# Game grid (renders on top of background)
scene.children.append(grid)

# UI overlay (renders on top of grid)
scene.children.append(ui_frame)

Nested Frames

Frames can contain their own children for hierarchical UI:

panel = mcrfpy.Frame(pos=(10, 10), size=(200, 300))
panel.children.append(title_caption)
panel.children.append(content_caption)
scene.children.append(panel)

Related Objects