john/McRogueFace
1
0
Fork 0
Code Issues 32 Pull requests Projects Releases Wiki Activity

Grid Point Animation #124

New issue
Open
opened 2025-07-12 19:11:49 +00:00 by john · 1 comment
john commented 2025-07-12 19:11:49 +00:00
Owner
Copy link

Enable animating individual grid tiles (color, tilesprite animations).
Definition of Done:

  • Can animate tile colors independently
  • Sprite index animation for effects
  • Efficient batch animation support
  • Matrix-style demo effects possible
Enable animating individual grid tiles (color, tilesprite animations). Definition of Done: - Can animate tile colors independently - Sprite index animation for effects - Efficient batch animation support - Matrix-style demo effects possible
john commented 2025-12-28 18:53:03 +00:00
Author
Owner
Copy link

Current Architecture

Animation System:

  • Targets either UIDrawable (Frame, Caption, Sprite, Grid) or UIEntity
  • Uses std::weak_ptr for RAII-safe target tracking
  • Properties applied via target->setProperty(name, value)

Grid Cells:

  • Grid points are raw storage: std::vector<UIGridPoint>
  • Layer data is raw arrays: std::vector<sf::Color> or std::vector<int>
  • Layers themselves ARE shared_ptr wrapped
  • markDirty(x, y) mechanism already exists for efficient per-cell updates

The Core Challenge

The animation system fundamentally requires shared_ptr targets for:

  1. RAII safety (detecting destroyed targets via weak_ptr::expired())
  2. Property locking (#120 - conflict detection)
Approach Description
A: Cell Reference Wrapper New GridCellRef class wrapping (layer, x, y) with getProperty/setProperty
B: startCell() Method Add anim.startCell(layer, x, y) to Animation class
C: Batch Animation New GridAnimation class for multi-cell animations
D: Layer Methods Add layer.animate_cell(x, y, value, duration)

Recommended Approach: B + C Hybrid

  1. Primary: Add startCell(layer, x, y) to Animation class (4-5 hours)
  • New target tracking: weak_ptr or weak_ptr
  • New applyValue() overloads for layer cells
  • Property locking uses key: (layer_ptr, "cell[x,y].property")
  1. Optional Enhancement: Batch helper for Matrix effects (3-4 hours)
  • Simple Python helper function, not new C++ class
  • Creates multiple animations efficiently

We won't be implementing for 1.0, this is getting deferred for a while

## Current Architecture Animation System: - Targets either `UIDrawable` (`Frame`, `Caption`, `Sprite`, `Grid`) or `UIEntity` - Uses `std::weak_ptr` for RAII-safe target tracking - Properties applied via `target->setProperty(name, value)` Grid Cells: - Grid points are raw storage: `std::vector<UIGridPoint>` - Layer data is raw arrays: `std::vector<sf::Color>` or `std::vector<int>` - Layers themselves ARE `shared_ptr` wrapped - `markDirty(x, y)` mechanism already exists for efficient per-cell updates ## The Core Challenge The animation system fundamentally requires `shared_ptr` targets for: 1. RAII safety (detecting destroyed targets via `weak_ptr::expired()`) 2. Property locking (#120 - conflict detection) | Approach | Description | |---------------------------|---------------------------------------------------------------------------| | A: Cell Reference Wrapper | New GridCellRef class wrapping (layer, x, y) with getProperty/setProperty | | B: startCell() Method | Add anim.startCell(layer, x, y) to Animation class | | C: Batch Animation | New GridAnimation class for multi-cell animations | | D: Layer Methods | Add layer.animate_cell(x, y, value, duration) | Recommended Approach: B + C Hybrid 1. Primary: Add startCell(layer, x, y) to Animation class (4-5 hours) - New target tracking: weak_ptr<ColorLayer> or weak_ptr<TileLayer> - New applyValue() overloads for layer cells - Property locking uses key: (layer_ptr, "cell[x,y].property") 2. Optional Enhancement: Batch helper for Matrix effects (3-4 hours) - Simple Python helper function, not new C++ class - Creates multiple animations efficiently We won't be implementing for 1.0, this is getting deferred for a while
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
threedee
emscripten-mcrogueface
rogueliketutorial25
alpha_presentable
alpha_streamline_2
alpha_streamline_1
interpreter_mode
grid_entity_integration
reprs_and_member_names
break_up_ui_h
standardize_font_handling
standardize_vector_handling
standardize_color_handling
standardize_texture_handling
raii_pyobjects
rebase-for-7DRL_Feb-2024
engjam_uicollection
engjam_ui_overhaul
0.2.3-prerelease-7drl2026-emscripten
Labels
Clear labels   
Alpha Release Requirement

This issue is a blocker to 0.1 Alpha release of McRogueFace.

  
Bugfix

   
Demo Target

Functionality to demonstrate; Depends on new features, but this issue isn't for writing them.

  
Documentation

   
Major Feature

Significant time and effort required.

  
Minor Feature

Some effort required to create or overhaul functionality.

  
priority:tier1-active

Current development focus - critical path to v1.0

  
priority:tier2-foundation

Important foundation work - not blocking v1.0

  
priority:tier3-future

Future features - deferred until after v1.0

  
priority:tier4-deferred

   
Refactoring & Cleanup

no new functionality, just improving the codebase.

  
system:animation

Animation and property interpolation

  
system:documentation

Documentation infrastructure

  
system:grid

Grid system and spatial containers

  
system:input

Input handling and events

  
system:performance

Performance optimization and profiling

  
system:procgen

Procedural Generation (Noise, BSP, Heightmap)

  
system:python-binding

Python/C++ binding layer

  
system:rendering

Rendering pipeline and visuals

  
system:ui-hierarchy

UI component hierarchy and composition

  
Tiny Feature

quick and easy - a few lines or with little interconnection around the codebase

  
workflow:blocked

Blocked by other work - waiting on dependencies

  
workflow:needs-benchmark

Needs performance testing and benchmarks

  
workflow:needs-documentation

Needs documentation before or after implementation

No labels
Alpha Release Requirement
Bugfix
Demo Target
Documentation
Major Feature
Minor Feature
priority:tier1-active
priority:tier2-foundation
priority:tier3-future
priority:tier4-deferred
Refactoring & Cleanup
system:animation
system:documentation
system:grid
system:input
system:performance
system:procgen
system:python-binding
system:rendering
system:ui-hierarchy
Tiny Feature
workflow:blocked
workflow:needs-benchmark
workflow:needs-documentation
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
john/McRogueFace#124
No description provided.