Refactor UI/Simulation to west-const

src/OpenSimCreator/Documents/Model/BasicModelStatePair.cpp

@@ -19,8 +19,7 @@ class osc::BasicModelStatePair::Impl final {
 
     explicit Impl(IConstModelStatePair const& p) :
         Impl{p.getModel(), p.getState(), p.getFixupScaleFactor()}
-    {
-    }
+    {}
 
     explicit Impl(std::filesystem::path const& osimPath) :
         m_Model{std::make_unique<OpenSim::Model>(osimPath.string())}
@@ -31,8 +30,7 @@ class osc::BasicModelStatePair::Impl final {
 
     Impl(OpenSim::Model const& m, SimTK::State const& st) :
         Impl{m, st, 1.0f}
-    {
-    }
+    {}
 
     Impl(OpenSim::Model const& m, SimTK::State const& st, float fixupScaleFactor) :
         m_Model(std::make_unique<OpenSim::Model>(m)),
@@ -88,8 +86,6 @@ class osc::BasicModelStatePair::Impl final {
 };
 
 
-// public API
-
 osc::BasicModelStatePair::BasicModelStatePair() :
     m_Impl{std::make_unique<Impl>()}
 {}
@@ -104,8 +100,7 @@ osc::BasicModelStatePair::BasicModelStatePair(std::filesystem::path const& p) :
 
 osc::BasicModelStatePair::BasicModelStatePair(OpenSim::Model const& model, SimTK::State const& state) :
     m_Impl{std::make_unique<Impl>(model, state)}
-{
-}
+{}
 osc::BasicModelStatePair::BasicModelStatePair(BasicModelStatePair const&) = default;
 osc::BasicModelStatePair::BasicModelStatePair(BasicModelStatePair&&) noexcept = default;
 osc::BasicModelStatePair& osc::BasicModelStatePair::operator=(BasicModelStatePair const&) = default;

src/OpenSimCreator/Documents/Model/BasicModelStatePair.h

@@ -30,6 +30,7 @@ namespace osc
         BasicModelStatePair& operator=(BasicModelStatePair const&);
         BasicModelStatePair& operator=(BasicModelStatePair&&) noexcept;
         ~BasicModelStatePair() noexcept override;
+
     private:
         OpenSim::Model const& implGetModel() const final;
         SimTK::State const& implGetState() const final;

src/OpenSimCreator/Documents/Model/ModelStateCommit.cpp

@@ -20,8 +20,7 @@ class osc::ModelStateCommit::Impl final {
 public:
     Impl(IConstModelStatePair const& msp, std::string_view message) :
         Impl{msp, message, UID::empty()}
-    {
-    }
+    {}
 
     Impl(IConstModelStatePair const& msp, std::string_view message, UID parent) :
         m_MaybeParentID{parent},
@@ -87,23 +86,12 @@ class osc::ModelStateCommit::Impl final {
 };
 
 
-// public API (PIMPL)
-
 osc::ModelStateCommit::ModelStateCommit(IConstModelStatePair const& p, std::string_view message) :
     m_Impl{std::make_shared<Impl>(p, message)}
-{
-}
-
+{}
 osc::ModelStateCommit::ModelStateCommit(IConstModelStatePair const& p, std::string_view message, UID parent) :
     m_Impl{std::make_shared<Impl>(p, message, parent)}
-{
-}
-
-osc::ModelStateCommit::ModelStateCommit(ModelStateCommit const&) = default;
-osc::ModelStateCommit::ModelStateCommit(ModelStateCommit&&) noexcept = default;
-osc::ModelStateCommit& osc::ModelStateCommit::operator=(ModelStateCommit const&) = default;
-osc::ModelStateCommit& osc::ModelStateCommit::operator=(ModelStateCommit&&) noexcept = default;
-osc::ModelStateCommit::~ModelStateCommit() noexcept = default;
+{}
 
 UID osc::ModelStateCommit::getID() const
 {

src/OpenSimCreator/Documents/Model/ModelStateCommit.h

@@ -20,11 +20,6 @@ namespace osc
     public:
         ModelStateCommit(IConstModelStatePair const&, std::string_view message);
         ModelStateCommit(IConstModelStatePair const&, std::string_view message, UID parent);
-        ModelStateCommit(ModelStateCommit const&);
-        ModelStateCommit(ModelStateCommit&&) noexcept;
-        ModelStateCommit& operator=(ModelStateCommit const&);
-        ModelStateCommit& operator=(ModelStateCommit&&) noexcept;
-        ~ModelStateCommit() noexcept;
 
         UID getID() const;
         bool hasParent() const;

src/OpenSimCreator/Documents/Model/ModelStatePairInfo.cpp

@@ -4,11 +4,11 @@
 #include <OpenSimCreator/Utils/OpenSimHelpers.h>
 
 osc::ModelStatePairInfo::ModelStatePairInfo() = default;
+
 osc::ModelStatePairInfo::ModelStatePairInfo(IConstModelStatePair const& msp) :
     m_ModelVersion{msp.getModelVersion()},
     m_StateVersion{msp.getStateVersion()},
     m_Selection{GetAbsolutePathOrEmpty(msp.getSelected())},
     m_Hover{GetAbsolutePathOrEmpty(msp.getHovered())},
     m_FixupScaleFactor{msp.getFixupScaleFactor()}
-{
-}
+{}

src/OpenSimCreator/Documents/Model/ObjectPropertyEdit.cpp

@@ -18,12 +18,10 @@ namespace
     // an empty string
     std::string GetAbsPathOrEmptyIfNotAComponent(OpenSim::Object const& obj)
     {
-        if (auto const* c = dynamic_cast<OpenSim::Component const*>(&obj))
-        {
+        if (auto const* c = dynamic_cast<OpenSim::Component const*>(&obj)) {
             return GetAbsolutePathString(*c);
         }
-        else
-        {
+        else {
             return std::string{};
         }
     }
@@ -35,9 +33,7 @@ osc::ObjectPropertyEdit::ObjectPropertyEdit(
 
     m_PropertyName{prop.getName()},
     m_Updater{std::move(updater)}
-{
-}
-
+{}
 osc::ObjectPropertyEdit::ObjectPropertyEdit(
     OpenSim::Object const& obj,
     OpenSim::AbstractProperty const& prop,
@@ -46,9 +42,7 @@ osc::ObjectPropertyEdit::ObjectPropertyEdit(
     m_ComponentAbsPath{GetAbsPathOrEmptyIfNotAComponent(obj)},
     m_PropertyName{prop.getName()},
     m_Updater{std::move(updater)}
-{
-}
-
+{}
 std::string const& osc::ObjectPropertyEdit::getComponentAbsPath() const
 {
     return m_ComponentAbsPath;

src/OpenSimCreator/Documents/Model/UndoableModelStatePair.cpp

@@ -233,7 +233,7 @@ class osc::UndoableModelStatePair::Impl final {
         }
     }
 
-    std::filesystem::path const& getFilesystemPath() const
+    std::filesystem::path getFilesystemPath() const
     {
         return getFilesystemLocation();
     }
@@ -259,7 +259,7 @@ class osc::UndoableModelStatePair::Impl final {
         return m_MaybeFilesystemTimestamp;
     }
 
-    ModelStateCommit const& getLatestCommit() const
+    ModelStateCommit getLatestCommit() const
     {
         return getHeadCommit();
     }
@@ -651,7 +651,7 @@ class osc::UndoableModelStatePair::Impl final {
         m_CurrentHead = c->getID();
     }
 
-    std::filesystem::path const& getFilesystemLocation() const
+    std::filesystem::path getFilesystemLocation() const
     {
         return m_MaybeFilesystemLocation;
     }
@@ -742,7 +742,7 @@ std::string osc::UndoableModelStatePair::recommendedDocumentName() const
     return m_Impl->recommendedDocumentName();
 }
 
-std::filesystem::path const& osc::UndoableModelStatePair::getFilesystemPath() const
+std::filesystem::path osc::UndoableModelStatePair::getFilesystemPath() const
 {
     return m_Impl->getFilesystemPath();
 }
@@ -768,7 +768,7 @@ std::filesystem::file_time_type osc::UndoableModelStatePair::getLastFilesystemWr
 }
 
 
-ModelStateCommit const& osc::UndoableModelStatePair::getLatestCommit() const
+ModelStateCommit osc::UndoableModelStatePair::getLatestCommit() const
 {
     return m_Impl->getLatestCommit();
 }

src/OpenSimCreator/Documents/Model/UndoableModelStatePair.h

@@ -15,8 +15,18 @@ namespace SimTK { class State; }
 
 namespace osc
 {
-    // a model + state pair that automatically reinitializes (i.e. like `AutoFinalizingModelStatePair`),
-    // but it also has support for snapshotting with .commit()
+    // `UndoableModelStatePair` is an `IModelStatePair` that's designed for immediate UI usage.
+    //
+    // Key features:
+    //
+    // - supports deferred (queued) undo/redo/rollback
+    // - supports deferred (queued) model mutation
+    // - all deferred changes can be applied by calling `applyQueuedMutations`
+    //
+    // The reason why all mutations are deferred is so that the UI and associated systems can
+    // safely get references to elements inside the `OpenSim::Model` and `SimTK::State` without
+    // having to tiptoe around reference invalidation due to mid-drawcall mutations (a
+    // drawback/benefit of immediate UIs)
     class UndoableModelStatePair final : public IModelStatePair {
     public:
 
@@ -56,7 +66,7 @@ namespace osc
         // returns the full filesystem path of the model's on-disk location, if applicable
         //
         // returns an empty path if the model has not been saved to disk
-        std::filesystem::path const& getFilesystemPath() const;
+        std::filesystem::path getFilesystemPath() const;
 
         // sets the full filesystem path of the model's on-disk location
         //
@@ -76,7 +86,7 @@ namespace osc
 
         // returns latest *comitted* model state (i.e. not the one being actively edited, but the one saved into
         // the safer undo/redo buffer)
-        ModelStateCommit const& getLatestCommit() const;
+        ModelStateCommit getLatestCommit() const;
 
         // manipulate undo/redo state
         bool canUndo() const;

src/OpenSimCreator/UI/ModelEditor/ModelMusclePlotPanel.cpp

@@ -1941,7 +1941,7 @@ namespace
 
                     // trick: we "know" that the last edit to the model was a coordinate edit in this plot's
                     //        independent variable, so we can skip recomputing it
-                    ModelStateCommit const& commitAfter = getShared().getModel().getLatestCommit();
+                    ModelStateCommit commitAfter = getShared().getModel().getLatestCommit();
                     m_Lines.setActivePlotCommit(commitAfter);
                 }
             }

src/OpenSimCreator/UI/Simulation/ISimulatorUIAPI.cpp

@@ -59,7 +59,7 @@ std::vector<OutputExtractor> osc::ISimulatorUIAPI::getAllUserOutputExtractors()
     return rv;
 }
 
-std::optional<std::filesystem::path> osc::ISimulatorUIAPI::tryPromptToSaveOutputsAsCSV(std::span<OutputExtractor const> outputs) const
+std::optional<std::filesystem::path> osc::ISimulatorUIAPI::tryPromptToSaveOutputsAsCSV(std::span<const OutputExtractor> outputs) const
 {
     return TryExportOutputsToCSV(getSimulation(), outputs);
 }

src/OpenSimCreator/UI/Simulation/ISimulatorUIAPI.h

@@ -24,14 +24,14 @@ namespace osc
     class ISimulatorUIAPI {
     protected:
         ISimulatorUIAPI() = default;
-        ISimulatorUIAPI(ISimulatorUIAPI const&) = default;
+        ISimulatorUIAPI(const ISimulatorUIAPI&) = default;
         ISimulatorUIAPI(ISimulatorUIAPI&&) noexcept = default;
-        ISimulatorUIAPI& operator=(ISimulatorUIAPI const&) = default;
+        ISimulatorUIAPI& operator=(const ISimulatorUIAPI&) = default;
         ISimulatorUIAPI& operator=(ISimulatorUIAPI&&) noexcept = default;
     public:
         virtual ~ISimulatorUIAPI() noexcept = default;
 
-        ISimulation const& getSimulation() const { return implGetSimulation(); }
+        const ISimulation& getSimulation() const { return implGetSimulation(); }
         ISimulation& updSimulation() { return implUpdSimulation(); }
 
         SimulationUIPlaybackState getSimulationPlaybackState() { return implGetSimulationPlaybackState(); }
@@ -53,24 +53,24 @@ namespace osc
         std::optional<SimulationReport> trySelectReportBasedOnScrubbing() { return implTrySelectReportBasedOnScrubbing(); }
 
         int getNumUserOutputExtractors() const { return implGetNumUserOutputExtractors(); }
-        OutputExtractor const& getUserOutputExtractor(int i) const { return implGetUserOutputExtractor(i); }
+        const OutputExtractor& getUserOutputExtractor(int i) const { return implGetUserOutputExtractor(i); }
         std::vector<OutputExtractor> getAllUserOutputExtractors() const;
-        void addUserOutputExtractor(OutputExtractor const& o) { implAddUserOutputExtractor(o); }
+        void addUserOutputExtractor(const OutputExtractor& o) { implAddUserOutputExtractor(o); }
         void removeUserOutputExtractor(int i) { implRemoveUserOutputExtractor(i); }
-        bool hasUserOutputExtractor(OutputExtractor const& o) { return implHasUserOutputExtractor(o); }
-        bool removeUserOutputExtractor(OutputExtractor const& o) { return implRemoveUserOutputExtractor(o); }
-        bool overwriteOrAddNewUserOutputExtractor(OutputExtractor const& old, OutputExtractor const& newer) { return implOverwriteOrAddNewUserOutputExtractor(old, newer); }
-        std::optional<std::filesystem::path> tryPromptToSaveOutputsAsCSV(std::span<OutputExtractor const>) const;
+        bool hasUserOutputExtractor(const OutputExtractor& o) { return implHasUserOutputExtractor(o); }
+        bool removeUserOutputExtractor(const OutputExtractor& o) { return implRemoveUserOutputExtractor(o); }
+        bool overwriteOrAddNewUserOutputExtractor(const OutputExtractor& old, const OutputExtractor& newer) { return implOverwriteOrAddNewUserOutputExtractor(old, newer); }
+        std::optional<std::filesystem::path> tryPromptToSaveOutputsAsCSV(std::span<const OutputExtractor>) const;
         std::optional<std::filesystem::path> tryPromptToSaveOutputsAsCSV(std::initializer_list<OutputExtractor> il) const
         {
-            return tryPromptToSaveOutputsAsCSV(std::span<OutputExtractor const>{il});
+            return tryPromptToSaveOutputsAsCSV(std::span<const OutputExtractor>{il});
         }
         std::optional<std::filesystem::path> tryPromptToSaveAllOutputsAsCSV() const;
 
         SimulationModelStatePair* tryGetCurrentSimulationState() { return implTryGetCurrentSimulationState(); }
 
     private:
-        virtual ISimulation const& implGetSimulation() const = 0;
+        virtual const ISimulation& implGetSimulation() const = 0;
         virtual ISimulation& implUpdSimulation() = 0;
 
         virtual SimulationUIPlaybackState implGetSimulationPlaybackState() = 0;
@@ -86,12 +86,12 @@ namespace osc
         virtual std::optional<SimulationReport> implTrySelectReportBasedOnScrubbing() = 0;
 
         virtual int implGetNumUserOutputExtractors() const = 0;
-        virtual OutputExtractor const& implGetUserOutputExtractor(int) const = 0;
-        virtual void implAddUserOutputExtractor(OutputExtractor const&) = 0;
+        virtual const OutputExtractor& implGetUserOutputExtractor(int) const = 0;
+        virtual void implAddUserOutputExtractor(const OutputExtractor&) = 0;
         virtual void implRemoveUserOutputExtractor(int) = 0;
-        virtual bool implHasUserOutputExtractor(OutputExtractor const&) const = 0;
-        virtual bool implRemoveUserOutputExtractor(OutputExtractor const&) = 0;
-        virtual bool implOverwriteOrAddNewUserOutputExtractor(OutputExtractor const&, OutputExtractor const&) = 0;
+        virtual bool implHasUserOutputExtractor(const OutputExtractor&) const = 0;
+        virtual bool implRemoveUserOutputExtractor(const OutputExtractor&) = 0;
+        virtual bool implOverwriteOrAddNewUserOutputExtractor(const OutputExtractor&, const OutputExtractor&) = 0;
 
         virtual SimulationModelStatePair* implTryGetCurrentSimulationState() = 0;
     };

src/OpenSimCreator/UI/Simulation/ModelStatePairContextMenu.cpp

@@ -23,7 +23,7 @@ class osc::ModelStatePairContextMenu::Impl final : public StandardPopup {
     Impl(
         std::string_view panelName_,
         std::shared_ptr<IModelStatePair> model_,
-        ParentPtr<IMainUIStateAPI> const& api_,
+        const ParentPtr<IMainUIStateAPI>& api_,
         std::optional<std::string> maybeComponentAbsPath_) :
 
         StandardPopup{panelName_, {10.0f, 10.0f}, ImGuiWindowFlags_NoMove},
@@ -36,16 +36,13 @@ class osc::ModelStatePairContextMenu::Impl final : public StandardPopup {
 
     void impl_draw_content() override
     {
-        if (!m_MaybeComponentAbsPath)
-        {
+        if (!m_MaybeComponentAbsPath) {
             drawRightClickedNothingContextMenu();
         }
-        else if (OpenSim::Component const* c = FindComponent(m_Model->getModel(), *m_MaybeComponentAbsPath))
-        {
+        else if (const OpenSim::Component* c = FindComponent(m_Model->getModel(), *m_MaybeComponentAbsPath)) {
             drawRightClickedSomethingContextMenu(*c);
         }
-        else
-        {
+        else {
             drawRightClickedNothingContextMenu();
         }
     }
@@ -55,7 +52,7 @@ class osc::ModelStatePairContextMenu::Impl final : public StandardPopup {
         ui::draw_text_disabled("(clicked nothing)");
     }
 
-    void drawRightClickedSomethingContextMenu(OpenSim::Component const& c)
+    void drawRightClickedSomethingContextMenu(const OpenSim::Component& c)
     {
         // draw context menu for whatever's selected
         ui::draw_text_unformatted(c.getName());
@@ -65,7 +62,7 @@ class osc::ModelStatePairContextMenu::Impl final : public StandardPopup {
         ui::draw_dummy({0.0f, 3.0f});
 
         DrawSelectOwnerMenu(*m_Model, c);
-        DrawWatchOutputMenu(c, [this](OpenSim::AbstractOutput const& output, std::optional<ComponentOutputSubfield> subfield)
+        DrawWatchOutputMenu(c, [this](const OpenSim::AbstractOutput& output, std::optional<ComponentOutputSubfield> subfield)
         {
             if (subfield) {
                 m_API->addUserOutputExtractor(OutputExtractor{ComponentOutputExtractor{output, *subfield}});
@@ -90,12 +87,10 @@ class osc::ModelStatePairContextMenu::Impl final : public StandardPopup {
 };
 
 
-// public API
-
 osc::ModelStatePairContextMenu::ModelStatePairContextMenu(
     std::string_view panelName_,
     std::shared_ptr<IModelStatePair> model_,
-    ParentPtr<IMainUIStateAPI> const& api_,
+    const ParentPtr<IMainUIStateAPI>& api_,
     std::optional<std::string> maybeComponentAbsPath_) :
 
     m_Impl{std::make_unique<Impl>(panelName_, std::move(model_), api_, std::move(maybeComponentAbsPath_))}

src/OpenSimCreator/UI/Simulation/ModelStatePairContextMenu.h

@@ -18,12 +18,12 @@ namespace osc
         ModelStatePairContextMenu(
             std::string_view panelName,
             std::shared_ptr<IModelStatePair>,
-            ParentPtr<IMainUIStateAPI> const&,
+            const ParentPtr<IMainUIStateAPI>&,
             std::optional<std::string> maybeComponentAbsPath
         );
-        ModelStatePairContextMenu(ModelStatePairContextMenu const&) = delete;
+        ModelStatePairContextMenu(const ModelStatePairContextMenu&) = delete;
         ModelStatePairContextMenu(ModelStatePairContextMenu&&) noexcept;
-        ModelStatePairContextMenu& operator=(ModelStatePairContextMenu const&) = delete;
+        ModelStatePairContextMenu& operator=(const ModelStatePairContextMenu&) = delete;
         ModelStatePairContextMenu& operator=(ModelStatePairContextMenu&&) noexcept;
         ~ModelStatePairContextMenu() noexcept;