EditorMaterialStudio.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include "graphics/material/editor/EditorMaterialPreview.h"
#include "editor/EditorTransactionService.h"
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace eve::editor {
 
struct MaterialStudioState {
    bool                          interactionActive = false;
    bool                          previewDirty      = true;
    PropertyPath                  activeProperty;
    Revision                      documentRevision = 0;
    Revision                      previewRevision  = 0;
    std::string                   previewArtifact;
    std::vector<EditorDiagnostic> diagnostics;
};
 
class EVENGINE_API_EDITORS MaterialStudioController {
public:
    MaterialStudioController(DocumentId document, MaterialPublishingTarget& target,
                             IEditorTransactionBackend& transactions, MaterialPreviewService& previews,
                             IMaterialPreviewRenderer& renderer);
 
    [[nodiscard]] Result<void> setPreviewSettings(MaterialPreviewSettings settings);
    [[nodiscard]] Result<void> beginInteraction(PropertyPath path);
    [[nodiscard]] Result<void> updateInteraction(EditorValue value);
    [[nodiscard]] Result<TransactionReceipt> commitInteraction();
    [[nodiscard]] Result<void> cancelInteraction();
    [[nodiscard]] Result<void> tick(std::uint64_t monotonicMilliseconds);
    [[nodiscard]] Result<void> refreshPreview();
    [[nodiscard]] Result<void> setPreviewRate(double framesPerSecond);
    [[nodiscard]] MaterialStudioState state() const;
 
private:
    [[nodiscard]] SelectionSnapshot  selectionFor(const MaterialDocumentTarget& material) const;
    [[nodiscard]] Result<void> renderPreview(const MaterialDocumentTarget& material);
    void                             clearInteraction();
 
    DocumentId                              document_;
    MaterialPublishingTarget&               target_;
    IEditorTransactionBackend&              transactions_;
    MaterialPreviewService&                 previews_;
    IMaterialPreviewRenderer&               renderer_;
    MaterialPreviewSettings                 settings_;
    std::unique_ptr<MaterialDocumentTarget> draft_;
    std::optional<PropertyPath>             activeProperty_;
    std::optional<EditorValue>              finalValue_;
    std::uint64_t                           transactionSequence_         = 0;
    std::uint64_t                           lastPreviewMilliseconds_     = 0;
    std::uint64_t                           previewIntervalMilliseconds_ = 33;
    bool                                    hasPreviewTimestamp_         = false;
    bool                                    previewDirty_                = true;
    Revision                                previewRevision_             = 0;
    std::string                             previewArtifact_;
    std::vector<EditorDiagnostic>           diagnostics_;
};
 
}  // namespace eve::editor