Caffeine

🔧 Scene Viewport

Planned Milestone: M1 — Scene Editor Foundation Namespace: `Caffeine::Editor` Arquivos: `doppio-archived/src/doppio/editor/SceneViewport.hpp`, `doppio-archived/src/doppio/editor/SceneViewport.cpp` RF: RF6.4 Last updated:

Visão Geral#

O SceneViewport é a janela principal de visualização do mundo de jogo. Ao contrário de uma aplicação de jogo comum que renderiza diretamente para o backbuffer da janela, o editor renderiza a cena para um Framebuffer (FBO) separado. Este FBO é depois apresentado como uma imagem dentro de uma janela ImGui.

Esta abordagem permite que a interface do editor (menus, painéis) seja independente da resolução ou rácio de aspeto da cena, além de possibilitar a sobreposição de ferramentas de edição (gizmos, grelhas, indicadores de debug) sem sujar a renderização final do jogo.


Implementação#

Estrutura da Classe#

O Viewport gere o seu próprio Framebuffer e uma câmara de editor separada da câmara de jogo.

cpp
class SceneViewport {
    RHI::TextureHandle m_viewportTexture;
    RHI::FramebufferHandle m_fbo;
    EditorCamera m_editorCamera;
    Vec2 m_viewportSize = { 0, 0 };
    bool m_viewportFocused = false;
    bool m_viewportHovered = false;

public:
    void onUpdate(float dt) {
        if (m_viewportFocused) {
            m_editorCamera.onUpdate(dt);
        }
    }

    void onImGuiRender() {
        ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2{ 0, 0 });
        ImGui::Begin("Scene Viewport");

        m_viewportFocused = ImGui::IsWindowFocused();
        m_viewportHovered = ImGui::IsWindowHovered();

        ImVec2 viewportPanelSize = ImGui::GetContentRegionAvail();
        if (m_viewportSize.x != viewportPanelSize.x || m_viewportSize.y != viewportPanelSize.y) {
            resizeViewport(viewportPanelSize.x, viewportPanelSize.y);
        }

        // Renderizar a textura do FBO
        u64 textureID = (u64)m_viewportTexture;
        ImGui::Image((void*)textureID, viewportPanelSize, { 0, 1 }, { 1, 0 });

        // Toolbar sobreposta (overlay)
        renderToolbar();

        ImGui::End();
        ImGui::PopStyleVar();
    }

private:
    void resizeViewport(float width, float height) {
        m_viewportSize = { width, height };
        RHI::resizeFramebuffer(m_fbo, (u32)width, (u32)height);
        m_editorCamera.setViewportSize(width, height);
    }

    void renderToolbar() {
        ImGui::SetCursorPos({ 10, 10 });
        if (ImGui::Button("2D/3D")) { /* Toggle mode */ }
        ImGui::SameLine();
        if (ImGui::Button("Grid")) { /* Toggle grid */ }
    }
};

Renderização Offscreen#

O ciclo de renderização do editor deve seguir esta sequência:

cpp
// No Main Loop do Editor
void renderScene() {
    RHI::bindFramebuffer(viewport.getFBO());
    RHI::clear({ 0.1f, 0.1f, 0.1f, 1.0f });

    // Configurar câmara do editor
    auto viewProj = viewport.getCamera().getViewProjection();
    BatchRenderer::begin(viewProj);

    // Renderizar entidades
    auto view = world->view<TransformComponent, SpriteRenderer>();
    for (auto entity : view) {
        auto& transform = view.get<TransformComponent>(entity);
        auto& sprite = view.get<SpriteRenderer>(entity);
        BatchRenderer::drawQuad(transform, sprite);
    }

    // Desenhar Grelha de Editor
    drawEditorGrid();

    BatchRenderer::end();
    RHI::unbindFramebuffer();
}

Controlos da Câmara de Editor#

  • Zoom: Roda do rato (Scroll).
  • Pan (Mover): Botão central do rato (Middle Click) + Arrastar.
  • Snap: Tecla F para focar na entidade selecionada.

Decisões de Design#

Decisão Justificativa
Framebuffer Separado Permite isolar a resolução da cena da resolução da UI e aplicar pós-processamento específico.
Inversão de UVs no ImGui::Image O OpenGL utiliza a origem no canto inferior esquerdo, enquanto o ImGui utiliza o superior esquerdo.
Window Padding a Zero Garante que a cena ocupe todo o espaço disponível na janela do viewport sem margens brancas.

Critério de Aceitação#

  • [ ] A cena é renderizada dentro de uma janela ImGui via ImGui::Image.
  • [ ] O redimensionamento da janela do editor atualiza corretamente o tamanho do Framebuffer.
  • [ ] O scroll do rato aproxima ou afasta a câmara (Zoom).
  • [ ] O botão central do rato permite mover a vista (Pan).
  • [ ] Uma grelha 2D é visível como referência de escala.
  • [ ] A taxa de frames (FPS) no viewport é independente da complexidade da UI.

Dependências#

  • Upstream: docs/rendering/rhi.md, docs/rendering/batch-renderer.md
  • Downstream: 1.6-scene-editor-orchestrator.md

🔗 Tópicos Relacionados#

Tópico Descrição
Framebuffers Gestão de alvos de renderização no RHI.
Batch Rendering Sistema de desenho otimizado para múltiplos sprites.

Referências#