Caffeine

🔧 Inspector Panel

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

Visão Geral#

O InspectorPanel é a ferramenta de edição de propriedades por excelência. Ele permite ao utilizador visualizar e modificar em tempo real todos os componentes associados à entidade selecionada no EditorContext. É aqui que se definem as coordenadas de transformação, se alteram as texturas dos sprites e se configuram as propriedades físicas dos objetos.

O painel deve ser dinâmico, detetando automaticamente quais os componentes que a entidade possui e apresentando os interfaces de edição (drawers) correspondentes. No M1, focamos nos componentes básicos do motor e num sistema de fallback para componentes desconhecidos.


Implementação#

Estrutura do Painel#

O InspectorPanel utiliza uma série de funções auxiliares de desenho para cada tipo de dado.

cpp
class InspectorPanel {
    EditorContext* m_context;

public:
    InspectorPanel(EditorContext* ctx) : m_context(ctx) {}

    void onImGuiRender() {
        ImGui::Begin("Inspector");

        ECS::EntityID selected = m_context->selectedEntity;
        if (selected == ECS::INVALID_ENTITY) {
            ImGui::Text("Nenhuma entidade selecionada.");
            ImGui::End();
            return;
        }

        // Desenhar NameComponent sempre no topo
        drawNameComponent(selected);
        ImGui::Separator();

        // Iterar sobre componentes conhecidos
        drawComponent<TransformComponent>("Transform", selected, [](auto& component) {
            drawVec2Control("Position", component.position);
            drawFloatControl("Rotation", component.rotation);
            drawVec2Control("Scale", component.scale, 1.0f);
        });

        drawComponent<SpriteRenderer>("Sprite Renderer", selected, [](auto& component) {
            ImGui::ColorEdit4("Color", &component.color.r);
            drawAssetHandleControl("Texture", component.texture);
            ImGui::Checkbox("Flip X", &component.flipX);
            ImGui::Checkbox("Flip Y", &component.flipY);
        });

        // Botão para adicionar novos componentes
        renderAddComponentButton(selected);

        ImGui::End();
    }

private:
    template<typename T, typename UIFunction>
    void drawComponent(const std::string& name, ECS::EntityID entity, UIFunction uiFunction) {
        if (!m_world->has<T>(entity)) return;

        const ImGuiTreeNodeFlags treeNodeFlags = ImGuiTreeNodeFlags_DefaultOpen | ImGuiTreeNodeFlags_Framed | ImGuiTreeNodeFlags_SpanAvailWidth | ImGuiTreeNodeFlags_AllowItemOverlap | ImGuiTreeNodeFlags_FramePadding;
        
        auto& component = m_world->get<T>(entity);
        ImVec2 contentRegionAvailable = ImGui::GetContentRegionAvail();

        ImGui::PushStyleVar(ImGuiStyleVar_FramePadding, ImVec2{ 4, 4 });
        float lineHeight = GImGui->Font->FontSize + GImGui->Style.FramePadding.y * 2.0f;
        ImGui::Separator();
        bool open = ImGui::TreeNodeEx((void*)typeid(T).hash_code(), treeNodeFlags, name.c_str());
        ImGui::PopStyleVar();

        ImGui::SameLine(contentRegionAvailable.x - lineHeight * 0.5f);
        if (ImGui::Button("+", ImVec2{ lineHeight, lineHeight })) {
            ImGui::OpenPopup("ComponentSettings");
        }

        bool removeComponent = false;
        if (ImGui::BeginPopup("ComponentSettings")) {
            if (ImGui::MenuItem("Remove Component")) removeComponent = true;
            ImGui::EndPopup();
        }

        if (open) {
            uiFunction(component);
            ImGui::TreePop();
        }

        if (removeComponent) m_world->remove<T>(entity);
    }
};

Controlos UI Customizados#

Para manter a consistência, utilizamos wrappers para tipos comuns como Vec2 e Vec3.

cpp
void drawVec2Control(const std::string& label, Vec2& values, float resetValue = 0.0f) {
    ImGui::PushID(label.c_str());
    ImGui::Columns(2);
    ImGui::Text(label.c_str());
    ImGui::NextColumn();

    ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2{ 0, 0 });
    float lineHeight = GImGui->Font->FontSize + GImGui->Style.FramePadding.y * 2.0f;
    ImVec2 buttonSize = { lineHeight + 3.0f, lineHeight };

    // X
    if (ImGui::Button("X", buttonSize)) values.x = resetValue;
    ImGui::SameLine();
    ImGui::DragFloat("##X", &values.x, 0.1f);
    
    // Y
    if (ImGui::Button("Y", buttonSize)) values.y = resetValue;
    ImGui::SameLine();
    ImGui::DragFloat("##Y", &values.y, 0.1f);

    ImGui::PopStyleVar();
    ImGui::Columns(1);
    ImGui::PopID();
}

Decisões de Design#

Decisão Justificativa
Templates para Drawers Garante que a lógica de cabeçalho (expandir/remover) seja idêntica para todos os componentes.
Colunas para Propriedades Mantém os labels alinhados à esquerda e os inputs à direita, facilitando a leitura.
Botões de Reset (X, Y) Permite ao utilizador voltar rapidamente ao estado inicial sem digitar valores.

Critério de Aceitação#

  • [ ] Apresenta os componentes da entidade selecionada no EditorContext.
  • [ ] Permite editar Transform (posição, rotação, escala) com sliders ou inputs numéricos.
  • [ ] Permite editar SpriteRenderer (cor, flips, textura).
  • [ ] Inclui um menu "Add Component" com os componentes registados.
  • [ ] Cada componente tem um botão "X" ou menu para ser removido da entidade.
  • [ ] Mudanças de valores disparam a Dirty Flag no EditorContext.

Dependências#

  • Upstream: 1.1-editor-context-undo-redo.md, 1.2-hierarchy-panel.md
  • Downstream: 1.6-scene-editor-orchestrator.md

🔗 Tópicos Relacionados#

Tópico Descrição
Componentes ECS Definição das structs de dados que o Inspector edita.
ImGui Integration Base tecnológica para a renderização do painel.

Referências#