Doing some improvements to continuity. (#395)

Breaking Continuity related objects into their own namespace.
Adding unit tests for some math utilities.
Putting constants as enum classes in a more central place.

Author: rmpowell77

src/AnimationCanvas.cpp

@@ -95,11 +95,11 @@ static auto CalcUserScaleAndOffset(std::pair<wxPoint, wxPoint> const& sizeAndOff
     // always choose x when the new aspect ratio is smaller than the show.
     // This will keep the whole field on in the canvas
     if (newSizeRatio < showAspectRatio) {
-        newvalue = newX / (float)CoordUnits2Int(x);
+        newvalue = newX / (float)CalChart::CoordUnits2Int(x);
     } else {
-        newvalue = newY / (float)CoordUnits2Int(y);
+        newvalue = newY / (float)CalChart::CoordUnits2Int(y);
     }
-    auto userScale = newvalue * (CoordUnits2Int(1 << 16) / 65536.0);
+    auto userScale = newvalue * (CalChart::CoordUnits2Int(1 << 16) / 65536.0);
 
     auto offsetx = sizeAndOffset.second.x + sizeAndOffset.first.x / 2;
     auto offsety = sizeAndOffset.second.y + sizeAndOffset.first.y / 2;
@@ -167,7 +167,7 @@ void AnimationCanvas::OnLeftUpMouseEvent(wxMouseEvent& event)
 
     // if mouse lifted very close to where clicked, then it is a previous beat
     // move
-    if ((std::abs(mMouseEnd.x - mMouseStart.x) < Int2CoordUnits(1) / 2) && (std::abs(mMouseEnd.y - mMouseStart.y) < Int2CoordUnits(1) / 2)) {
+    if ((std::abs(mMouseEnd.x - mMouseStart.x) < CalChart::Int2CoordUnits(1) / 2) && (std::abs(mMouseEnd.y - mMouseStart.y) < CalChart::Int2CoordUnits(1) / 2)) {
         mView->ToggleTimer();
     } else {
         mView->SelectMarchersInBox(mMouseStart, mMouseEnd, event.AltDown());
@@ -217,7 +217,7 @@ void AnimationCanvas::UpdateScaleAndOrigin()
     auto window_size = GetSize();
     auto boundingBox = mZoomOnMarchers ? mView->GetMarcherSizeAndOffset() : mView->GetShowSizeAndOffset();
     if (mZoomOnMarchers) {
-        auto amount = Int2CoordUnits(mStepsOutForMarcherZoom);
+        auto amount = CalChart::Int2CoordUnits(mStepsOutForMarcherZoom);
         boundingBox.first += wxPoint(amount, amount) * 2;
         boundingBox.second -= wxPoint(amount, amount);
     }

src/AnimationErrorsPanel.cpp

@@ -101,7 +101,7 @@ void AnimationErrorsPanel::OnItemActivated(wxTreeListEvent& event)
 }
 
 // Implementation details
-void AnimationErrorsPanel::UpdateErrors(std::vector<CalChart::AnimationErrors> const& errors, std::map<int, SelectionList> const& collisions)
+void AnimationErrorsPanel::UpdateErrors(std::vector<CalChart::AnimationErrors> const& errors, std::map<int, CalChart::SelectionList> const& collisions)
 {
     if (errors == mCurrentErrors) {
         return;
@@ -114,7 +114,7 @@ void AnimationErrorsPanel::UpdateErrors(std::vector<CalChart::AnimationErrors> c
 
     // we create a mapping between the generated errors and the items we've put in the list
     // categorize by animation error, mapping them to the sheet and ErrorMarker
-    std::map<CalChart::AnimateError, std::vector<std::tuple<int, SelectionList>>> allErrors;
+    std::map<CalChart::AnimateError, std::vector<std::tuple<int, CalChart::SelectionList>>> allErrors;
     for (auto i = 0ul; i < mCurrentErrors.size(); ++i) {
         for (auto&& error : mCurrentErrors[i].GetErrors()) {
             allErrors[error.first].push_back({ i, error.second.pntgroup });

src/AnimationErrorsPanel.h

@@ -50,10 +50,10 @@ class AnimationErrorsPanel : public wxPanel {
     void OnItemActivated(wxTreeListEvent& event);
 
     // Internals
-    void UpdateErrors(std::vector<CalChart::AnimationErrors> const& errors, std::map<int, SelectionList> const& collisions);
+    void UpdateErrors(std::vector<CalChart::AnimationErrors> const& errors, std::map<int, CalChart::SelectionList> const& collisions);
 
     CalChartView* mView{};
     wxTreeListCtrl* mTreeCtrl{};
     std::vector<CalChart::AnimationErrors> mCurrentErrors{};
-    std::map<wxTreeListItem, std::tuple<int, SelectionList>> mErrorLookup{};
+    std::map<wxTreeListItem, std::tuple<int, CalChart::SelectionList>> mErrorLookup{};
 };

src/AnimationView.cpp

@@ -29,9 +29,9 @@
 #include "CalChartSheet.h"
 #include "CalChartShowMode.h"
 #include "CalChartSizes.h"
+#include "CalChartUtils.h"
 #include "CalChartView.h"
 #include "draw.h"
-#include "math_utils.h"
 #include "platconf.h"
 
 #include <wx/dcbuffer.h>
@@ -106,17 +106,17 @@ void AnimationView::OnDrawDots(wxDC& dc, CalChartConfiguration const& config)
                 dc.SetPen(brushAndPen.second);
             }
         } else if (mView->IsSelected(info.index)) {
-            switch (info.mDirection) {
-            case CalChart::AnimateDir::SW:
-            case CalChart::AnimateDir::W:
-            case CalChart::AnimateDir::NW: {
+            switch (AngleToDirection(info.mFacingDirection)) {
+            case CalChart::Direction::SouthWest:
+            case CalChart::Direction::West:
+            case CalChart::Direction::NorthWest: {
                 auto brushAndPen = config.Get_CalChartBrushAndPen(COLOR_POINT_ANIM_HILIT_BACK);
                 dc.SetBrush(brushAndPen.first);
                 dc.SetPen(brushAndPen.second);
             } break;
-            case CalChart::AnimateDir::SE:
-            case CalChart::AnimateDir::E:
-            case CalChart::AnimateDir::NE: {
+            case CalChart::Direction::SouthEast:
+            case CalChart::Direction::East:
+            case CalChart::Direction::NorthEast: {
                 auto brushAndPen = config.Get_CalChartBrushAndPen(COLOR_POINT_ANIM_HILIT_FRONT);
                 dc.SetBrush(brushAndPen.first);
                 dc.SetPen(brushAndPen.second);
@@ -128,17 +128,17 @@ void AnimationView::OnDrawDots(wxDC& dc, CalChartConfiguration const& config)
             }
             }
         } else {
-            switch (info.mDirection) {
-            case CalChart::AnimateDir::SW:
-            case CalChart::AnimateDir::W:
-            case CalChart::AnimateDir::NW: {
+            switch (AngleToDirection(info.mFacingDirection)) {
+            case CalChart::Direction::SouthWest:
+            case CalChart::Direction::West:
+            case CalChart::Direction::NorthWest: {
                 auto brushAndPen = config.Get_CalChartBrushAndPen(COLOR_POINT_ANIM_BACK);
                 dc.SetBrush(brushAndPen.first);
                 dc.SetPen(brushAndPen.second);
             } break;
-            case CalChart::AnimateDir::SE:
-            case CalChart::AnimateDir::E:
-            case CalChart::AnimateDir::NE: {
+            case CalChart::Direction::SouthEast:
+            case CalChart::Direction::East:
+            case CalChart::Direction::NorthEast: {
                 auto brushAndPen = config.Get_CalChartBrushAndPen(COLOR_POINT_ANIM_FRONT);
                 dc.SetBrush(brushAndPen.first);
                 dc.SetPen(brushAndPen.second);
@@ -154,7 +154,7 @@ void AnimationView::OnDrawDots(wxDC& dc, CalChartConfiguration const& config)
         auto x = position.x + mView->GetShowMode().Offset().x;
         auto y = position.y + mView->GetShowMode().Offset().y;
         auto drawPosition = fDIP(wxPoint(x, y));
-        auto rectangleSize = fDIP(wxSize(Int2CoordUnits(1), Int2CoordUnits(1)));
+        auto rectangleSize = fDIP(wxSize(CalChart::Int2CoordUnits(1), CalChart::Int2CoordUnits(1)));
 
         dc.DrawRectangle(drawPosition - rectangleSize / 2, rectangleSize);
     }
@@ -169,7 +169,7 @@ void AnimationView::OnDrawSprites(wxDC& dc, CalChartConfiguration const& config)
     for (auto info : mAnimation->GetAllAnimateInfo()) {
         auto image_offset = !GetAnimationFrame()->TimerOn() ? 0 : OnBeat() ? 1
                                                                            : 2;
-        auto image_index = static_cast<int>(info.mDirection) + image_offset * 8;
+        auto image_index = AngleToQuadrant(info.mFacingDirection) + image_offset * 8;
         auto image = mSpriteImages[image_index];
         image = image.Scale(image.GetWidth() * scale, image.GetHeight() * scale);
         if (mView->IsSelected(info.index)) {
@@ -331,13 +331,13 @@ MarcherInfo AnimationView::GetMarcherInfo(int which) const
     MarcherInfo info{};
     if (mAnimation) {
         auto anim_info = mAnimation->GetAnimateInfo(which);
-        info.direction = NormalizeAngleRad((anim_info.mRealDirection * M_PI / 180.0));
+        info.direction = NormalizeAngleRad((anim_info.mFacingDirection * M_PI / 180.0));
 
         auto position = anim_info.mPosition;
-        info.x = CoordUnits2Float(position.x);
+        info.x = CalChart::CoordUnits2Float(position.x);
         // because the coordinate system for continuity and OpenGL are different,
         // correct here.
-        info.y = -1.0 * CoordUnits2Float(position.y);
+        info.y = -1.0 * CalChart::CoordUnits2Float(position.y);
     }
     return info;
 }

src/BackgroundImages.cpp

@@ -22,6 +22,7 @@
 
 #include "BackgroundImages.h"
 #include "CalChartImage.h"
+#include "CalChartTypes.h"
 #include <algorithm>
 
 class BackgroundImage {
@@ -80,12 +81,6 @@ BackgroundImage::BackgroundImage(const wxImage& image, int x, int y, int scaled_
     mBitmap = wxBitmap(mImage.Scale(scaled_width, scaled_height, wxIMAGE_QUALITY_HIGH));
 }
 
-template <typename E>
-constexpr auto toUType(E enumerator)
-{
-    return static_cast<std::underlying_type_t<E>>(enumerator);
-}
-
 bool BackgroundImage::MouseClickIsHit(const wxMouseEvent& event, const wxDC& dc) const
 {
     auto point = event.GetPosition();

src/CCOmniviewCanvas.cpp

@@ -29,10 +29,10 @@
 #include "CalChartConfiguration.h"
 #include "CalChartDoc.h"
 #include "CalChartShowMode.h"
+#include "CalChartUtils.h"
 #include "basic_ui.h"
 #include "cc_omniview_constants.h"
 #include "draw.h"
-#include "math_utils.h"
 #include "platconf.h"
 
 #include <wx/dcbuffer.h>
@@ -689,8 +689,8 @@ void CCOmniviewCanvas::OnPaint(wxPaintEvent&)
     glViewport(0, 0, ClientSize.x, ClientSize.y);
 
     CalChart::Coord fieldSize = mView ? mView->GetShowMode().FieldSize() : CalChart::Coord(160, 80);
-    float FieldEW = CoordUnits2Float(fieldSize.y);
-    float FieldNS = CoordUnits2Float(fieldSize.x);
+    float FieldEW = CalChart::CoordUnits2Float(fieldSize.y);
+    float FieldNS = CalChart::CoordUnits2Float(fieldSize.x);
 
     glClear(GL_COLOR_BUFFER_BIT);
     // set our view point:

src/CalChartDoc.cpp

@@ -28,9 +28,9 @@
 #include "CalChartShapes.h"
 #include "CalChartSheet.h"
 #include "CalChartShowMode.h"
+#include "CalChartUtils.h"
 #include "ContinuityEditorPopup.h"
 #include "draw.h"
-#include "math_utils.h"
 #include "platconf.h"
 #include "print_ps.h"
 

src/CalChartDoc.h

@@ -162,15 +162,15 @@ class CalChartDoc : public wxDocument {
     // Then you push the selection list with the Create_SetSelectionListCommand
     auto MakeSelectAll() const { return mShow->MakeSelectAll(); }
     auto MakeUnselectAll() const { return mShow->MakeUnselectAll(); }
-    auto MakeAddToSelection(const SelectionList& sl) const { return mShow->MakeAddToSelection(sl); }
-    auto MakeRemoveFromSelection(const SelectionList& sl) const { return mShow->MakeRemoveFromSelection(sl); }
-    auto MakeToggleSelection(const SelectionList& sl) const { return mShow->MakeToggleSelection(sl); }
+    auto MakeAddToSelection(const CalChart::SelectionList& sl) const { return mShow->MakeAddToSelection(sl); }
+    auto MakeRemoveFromSelection(const CalChart::SelectionList& sl) const { return mShow->MakeRemoveFromSelection(sl); }
+    auto MakeToggleSelection(const CalChart::SelectionList& sl) const { return mShow->MakeToggleSelection(sl); }
     auto MakeSelectWithinPolygon(CalChart::RawPolygon_t const& polygon) const { return mShow->MakeSelectWithinPolygon(polygon, mCurrentReferencePoint); }
-    auto MakeSelectBySymbol(SYMBOL_TYPE symbol) const { return mShow->MakeSelectBySymbol(symbol); }
+    auto MakeSelectBySymbol(CalChart::SYMBOL_TYPE symbol) const { return mShow->MakeSelectBySymbol(symbol); }
     auto MakeSelectByInstrument(std::string const& instrument) const { return mShow->MakeSelectByInstrument(instrument); }
     auto MakeSelectByLabel(std::string const& label) const { return mShow->MakeSelectByLabel(label); }
 
-    void SetSelectionList(SelectionList const& sl);
+    void SetSelectionList(CalChart::SelectionList const& sl);
 
     auto IsSelected(int i) const { return mShow->IsSelected(i); }
     auto GetSelectionList() const { return mShow->GetSelectionList(); }
@@ -201,8 +201,8 @@ class CalChartDoc : public wxDocument {
 
     // create a set of commands to apply to the document.  This is the best way to interact with the doc.
     std::unique_ptr<wxCommand> Create_SetCurrentSheetCommand(int n);
-    std::unique_ptr<wxCommand> Create_SetSelectionListCommand(const SelectionList& sl);
-    std::unique_ptr<wxCommand> Create_SetCurrentSheetAndSelectionCommand(int n, const SelectionList& sl);
+    std::unique_ptr<wxCommand> Create_SetSelectionListCommand(const CalChart::SelectionList& sl);
+    std::unique_ptr<wxCommand> Create_SetCurrentSheetAndSelectionCommand(int n, const CalChart::SelectionList& sl);
     std::unique_ptr<wxCommand> Create_SetShowModeCommand(CalChart::ShowMode const& newmode);
     std::unique_ptr<wxCommand> Create_SetupMarchersCommand(std::vector<std::pair<std::string, std::string>> const& labels, int numColumns);
     std::unique_ptr<wxCommand> Create_SetInstrumentsCommand(std::map<int, std::string> const& dotToInstrument);
@@ -218,16 +218,16 @@ class CalChartDoc : public wxDocument {
     std::unique_ptr<wxCommand> Create_DeletePointsCommand();
     std::unique_ptr<wxCommand> Create_RotatePointPositionsCommand(int rotateAmount);
     std::unique_ptr<wxCommand> Create_ResetReferencePointToRef0();
-    std::unique_ptr<wxCommand> Create_SetSymbolCommand(SYMBOL_TYPE sym);
-    std::unique_ptr<wxCommand> Create_SetContinuityCommand(SYMBOL_TYPE i, CalChart::Continuity const& new_cont);
+    std::unique_ptr<wxCommand> Create_SetSymbolCommand(CalChart::SYMBOL_TYPE sym);
+    std::unique_ptr<wxCommand> Create_SetContinuityCommand(CalChart::SYMBOL_TYPE i, CalChart::Continuity const& new_cont);
     std::unique_ptr<wxCommand> Create_SetLabelRightCommand(bool right);
     std::unique_ptr<wxCommand> Create_ToggleLabelFlipCommand();
     std::unique_ptr<wxCommand> Create_SetLabelVisibleCommand(bool isVisible);
     std::unique_ptr<wxCommand> Create_ToggleLabelVisibilityCommand();
     std::unique_ptr<wxCommand> Create_AddNewBackgroundImageCommand(int left, int top, int image_width, int image_height, std::vector<unsigned char> const& data, std::vector<unsigned char> const& alpha);
     std::unique_ptr<wxCommand> Create_RemoveBackgroundImageCommand(int which);
     std::unique_ptr<wxCommand> Create_MoveBackgroundImageCommand(int which, int left, int top, int scaled_width, int scaled_height);
-    std::unique_ptr<wxCommand> Create_SetTransitionCommand(const std::vector<CalChart::Coord>& finalPositions, const std::map<SYMBOL_TYPE, std::string>& continuities, const std::vector<SYMBOL_TYPE>& marcherDotTypes);
+    std::unique_ptr<wxCommand> Create_SetTransitionCommand(const std::vector<CalChart::Coord>& finalPositions, const std::map<CalChart::SYMBOL_TYPE, std::string>& continuities, const std::vector<CalChart::SYMBOL_TYPE>& marcherDotTypes);
 
 private:
     static CC_doc_command_pair Inject_CalChartDocArg(CalChart::Show_command_pair);

src/CalChartFrame.cpp

@@ -82,12 +82,6 @@ static std::map<int, std::string> kAUIEnumToString = {
     { CALCHART__ViewMarcherToolBar, "Marcher ToolBar" },
 };
 
-template <typename E>
-constexpr auto toUType(E enumerator)
-{
-    return static_cast<std::underlying_type_t<E>>(enumerator);
-}
-
 BEGIN_EVENT_TABLE(CalChartFrame, wxDocChildFrame)
 EVT_CHAR(CalChartFrame::OnChar)
 EVT_MENU(CALCHART__APPEND_FILE, CalChartFrame::OnCmdAppend)
@@ -876,42 +870,42 @@ void CalChartFrame::OnCmd_label_visibility_toggle(wxCommandEvent&)
 
 void CalChartFrame::OnCmd_setsym0(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_PLAIN);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_PLAIN);
 }
 
 void CalChartFrame::OnCmd_setsym1(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_SOL);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_SOL);
 }
 
 void CalChartFrame::OnCmd_setsym2(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_BKSL);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_BKSL);
 }
 
 void CalChartFrame::OnCmd_setsym3(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_SL);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_SL);
 }
 
 void CalChartFrame::OnCmd_setsym4(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_X);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_X);
 }
 
 void CalChartFrame::OnCmd_setsym5(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_SOLBKSL);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_SOLBKSL);
 }
 
 void CalChartFrame::OnCmd_setsym6(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_SOLSL);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_SOLSL);
 }
 
 void CalChartFrame::OnCmd_setsym7(wxCommandEvent&)
 {
-    GetFieldView()->DoSetPointsSymbol(SYMBOL_SOLX);
+    GetFieldView()->DoSetPointsSymbol(CalChart::SYMBOL_SOLX);
 }
 
 void CalChartFrame::OnChar(wxKeyEvent& event) { mCanvas->OnChar(event); }

src/CalChartSplash.cpp

@@ -55,7 +55,7 @@ struct CalChartSplashDropTarget : public wxFileDropTarget {
 };
 
 CalChartSplash::CalChartSplash(wxDocManager* manager, wxFrame* frame, wxString const& title)
-    : super(manager, frame, wxID_ANY, title)//, wxDefaultPosition, wxSize(154, 174))
+    : super(manager, frame, wxID_ANY, title)
 {
     // Give it an icon
     SetBandIcon(this);