DrawNode: API improvement: supporting 'closed' Splines; Update UserDefault.cpp/h (fix typo) (#2476)

aismann · web-flow · commit 739f6416e22d · 2025-03-28T22:01:05.000+08:00
* DrawNode: API improvement: supporting 'closed' Splines

* Color4B (back to Axmol 2.x)

* Update DrawNodeTest.cpp

* Update DrawNodeTest.cpp

* Update DrawNodeTest.cpp

* Update DrawNodeTest.cpp

* Update UserDefault.h (fix typo)

* Update UserDefault.cpp (fix typo)
diff --git a/core/2d/DrawNode.cpp b/core/2d/DrawNode.cpp
@@ -468,28 +468,40 @@ void DrawNode::drawCubicBezier(const Vec2& origin,
     _drawPoly(_vertices.data(), segments + 1, false, color, thickness, true);
 }
 
-void DrawNode::drawCardinalSpline(PointArray* config,
+void DrawNode::drawCardinalSpline(const PointArray* configIn,
                                   float tension,
                                   unsigned int segments,
                                   const Color4B& color,
-                                  float thickness)
+                                  float thickness,
+                                  bool closed)
 {
     if (thickness <= 0.0f)
     {
         AXLOGW("{}: thickness <= 0", __FUNCTION__);
         return;
     }
 
-    axstd::pod_vector<Vec2> _vertices{static_cast<size_t>(segments)};
+    // Don't change the original PointArray
+    PointArray* config = configIn->clone();
+
+    if (closed && config->count() > 2)
+    {
+        config->addControlPoint(config->getControlPointAtIndex(0));
+        config->addControlPoint(config->getControlPointAtIndex(1));
+        config->insertControlPoint(config->getControlPointAtIndex(config->count() - 3), 0);
+        config->insertControlPoint(config->getControlPointAtIndex(config->count() - 4), 0);
+    }
 
     ssize_t p;
     float lt;
     float deltaT = 1.0f / config->count();
 
+    axstd::pod_vector<Vec2> _vertices{static_cast<size_t>(segments)};
+
     for (unsigned int i = 0; i < segments; i++)
     {
         float dt = (float)i / segments;
-        p  = static_cast<ssize_t>(dt / deltaT);
+        p        = static_cast<ssize_t>(dt / deltaT);
 
         // Check last control point reached
         if (p >= (config->count() - 1))
@@ -510,17 +522,25 @@ void DrawNode::drawCardinalSpline(PointArray* config,
         _vertices[i] = ccCardinalSplineAt(pp0, pp1, pp2, pp3, tension, lt);
     }
 
+    // Dont draw the first and the last point
+    if (closed && config->count() > 2)
+    {
+        auto seg = segments / (config->count() - 2);
+        for (int i = seg; i < segments - seg; i++)
+            _vertices[i - seg] = _vertices[i];
+        segments -= (seg + seg);
+    }
     _drawPoly(_vertices.data(), segments, false, color, thickness, true);
 }
 
-void DrawNode::drawCatmullRom(PointArray* points, unsigned int segments, const Color4B& color, float thickness)
+void DrawNode::drawCatmullRom(const PointArray* pointsIn, unsigned int segments, const Color4B& color, float thickness, bool closed)
 {
     if (thickness <= 0.0f)
     {
         AXLOGW("{}: thickness <= 0", __FUNCTION__);
         return;
     }
-    drawCardinalSpline(points, 0.5f, segments, color, thickness);
+    drawCardinalSpline(pointsIn, 0.5f, segments, color, thickness, closed);
 }
 
 void DrawNode::drawDot(const Vec2& pos, float radius, const Color4B& color)
diff --git a/core/2d/DrawNode.h b/core/2d/DrawNode.h
@@ -279,19 +279,24 @@ class AX_DLL DrawNode : public Node
      * @param segments The number of segments.
      * @param color Set the Spline color.
      */
-    void drawCardinalSpline(PointArray* config,
+    void drawCardinalSpline(const PointArray* configIn,
                             float tension,
                             unsigned int segments,
                             const Color4B& color,
-                            float thickness = 1.0f);
+                            float thickness = 1.0f,
+                            bool closed = false);
 
     /** Draws a Catmull Rom path.
      *
      * @param points A point array  of control point.
      * @param segments The number of segments.
      * @param color The Catmull Rom color.
      */
-    void drawCatmullRom(PointArray* points, unsigned int segments, const Color4B& color, float thickness = 1.0f);
+    void drawCatmullRom(const PointArray* pointsIn,
+                        unsigned int segments,
+                        const Color4B& color,
+                        float thickness = 1.0f,
+                        bool closed = false);
 
     /** draw a dot at a position, with a given radius and color.
      *
diff --git a/core/base/UserDefault.cpp b/core/base/UserDefault.cpp
@@ -64,9 +64,9 @@ namespace ax
 
 UserDefault* UserDefault::_userDefault = nullptr;
 #if !USER_DEFAULT_PLAIN_MODE
-std::string UserDefault::_userDefalutFileName = "UserDefault.bin";
+std::string UserDefault::_userDefaultFileName = "UserDefault.bin";
 #else
-std::string UserDefault::_userDefalutFileName = "UserDefault.xml";
+std::string UserDefault::_userDefaultFileName = "UserDefault.xml";
 #endif
 
 static void ud_setkey(std::string& lhs, const cxx17::string_view& rhs)
@@ -375,7 +375,7 @@ void UserDefault::lazyInit()
         return;
 
 #if !USER_DEFAULT_PLAIN_MODE
-    _filePath = FileUtils::getInstance()->getNativeWritableAbsolutePath() + _userDefalutFileName;
+    _filePath = FileUtils::getInstance()->getNativeWritableAbsolutePath() + _userDefaultFileName;
 
     // construct file mapping
     if (!_fileStream.open(_filePath, IFileStream::Mode::OVERLAPPED))
@@ -438,7 +438,7 @@ void UserDefault::lazyInit()
 #else
     pugi::xml_document doc;
 
-    _filePath = FileUtils::getInstance()->getWritablePath() + _userDefalutFileName;
+    _filePath = FileUtils::getInstance()->getWritablePath() + _userDefaultFileName;
 
     if (FileUtils::getInstance()->isFileExist(_filePath))
     {
@@ -529,9 +529,9 @@ void UserDefault::deleteValueForKey(const char* key)
 void UserDefault::setFileName(std::string_view nameFile)
 {
     if (USER_DEFAULT_PLAIN_MODE)
-        _userDefalutFileName.assign(nameFile).append("UserDefault.xml"sv);
+        _userDefaultFileName.assign(nameFile).append("UserDefault.xml"sv);
     else
-        _userDefalutFileName.assign(nameFile).append("UserDefault.bin"sv);
+        _userDefaultFileName.assign(nameFile).append("UserDefault.bin"sv);
 }
 
 }
diff --git a/core/base/UserDefault.h b/core/base/UserDefault.h
@@ -284,7 +284,7 @@ class AX_DLL UserDefault
     hlookup::string_map<std::string> _values;
 
     static UserDefault* _userDefault;
-    static std::string  _userDefalutFileName;
+    static std::string  _userDefaultFileName;
 
     std::string _filePath;
     FileStream _fileStream;  // the file handle for data persistence
diff --git a/tests/cpp-tests/Source/DrawNodeTest/DrawNodeTest.cpp b/tests/cpp-tests/Source/DrawNodeTest/DrawNodeTest.cpp
@@ -1333,6 +1333,7 @@ DrawNodeTests::DrawNodeTests()
 {
     ADD_TEST_CASE(DrawNodeMethodsTest);
     ADD_TEST_CASE(DrawNodeSpLinesTest);
+	ADD_TEST_CASE(DrawNodeSpLinesOpenClosedTest);
     ADD_TEST_CASE(DrawNodeAxmolTest2);
 
 #if defined(AX_PLATFORM_PC)
@@ -3462,9 +3463,74 @@ string DrawNodeIssueTester::subtitle() const
 }
 
 DrawNodeSpLinesTest::DrawNodeSpLinesTest()
+{
+    drawNode = DrawNode::create();
+    drawNode->properties.setTransform(true);
+    addChild(drawNode, 30);
+
+    screen = Director::getInstance()->getVisibleSize();
+    origin = Director::getInstance()->getVisibleOrigin();
+    center = Vec2(screen.width / 2, screen.height / 2);
+    sixth  = Vec2(screen.width / 6, screen.height / 6);
+    sixth.y;
+
+    defY  = (int)(center.y + sixth.y);
+    defY2 = (int)(center.y - sixth.y);
+    dev   = sixth.y;
+
+    pts  = PointArray::create(n);
+    pts2 = PointArray::create(n);
+    pts->retain();
+    pts2->retain();
+    for (int i = 0; i < n; ++i)
+    {
+        pts->insertControlPoint(Vec2(0, 0), i);
+        pts2->insertControlPoint(Vec2(0, 0), i);
+    }
+
+    DrawNodeBaseTest::generateDataPoints();
+    scheduleUpdate();
+}
+
+std::string DrawNodeSpLinesTest::title() const
+{
+    return "Testing SpLines";
+}
+
+std::string DrawNodeSpLinesTest::subtitle() const
+{
+    return "";
+}
+
+void DrawNodeSpLinesTest::update(float dt)
+{
+    drawNode->clear();
+
+    // Issue #2302
+    auto array = PointArray::create(20);
+    for (int i = 0; i < 10; i++)
+    {
+        array->addControlPoint(Vec2((i % 2) ? 20 : screen.width - 20, 50 + i * 20));
+        drawNode->drawPoint(array->getControlPointAtIndex(i), 10, Color4F::BLUE);
+    }
+    drawNode->drawCardinalSpline(array, 0.1, 20, Color4F::ORANGE);
+
+    drawNode->drawCardinalSpline(pts, 0.5f, 360, Color4F::RED, 5.0f);
+    drawNode->drawCardinalSpline(pts2, 0.5f, 360, Color4F::GREEN, 2.0f);
+
+    int i1 = RandomHelper::random_int(0, n - 1);
+    int i2 = RandomHelper::random_int(0, n - 1);
+    drawNode->drawDot(pts->getControlPointAtIndex(i1), 7, Color4F(0, 1, 0, 0.3));
+    drawNode->drawDot(pts->getControlPointAtIndex(i1), 4, Color4F::GREEN);
+
+    drawNode->drawDot(pts2->getControlPointAtIndex(i2), 7, Color4F(0, 1, 0, 0.3));
+    drawNode->drawDot(pts2->getControlPointAtIndex(i2), 4, Color4F::GREEN);
+}
+
+DrawNodeSpLinesOpenClosedTest::DrawNodeSpLinesOpenClosedTest()
 {
     auto listener            = EventListenerTouchAllAtOnce::create();
-    listener->onTouchesEnded = AX_CALLBACK_2(DrawNodeSpLinesTest::onTouchesEnded, this);
+    listener->onTouchesEnded = AX_CALLBACK_2(DrawNodeSpLinesOpenClosedTest::onTouchesEnded, this);
     _eventDispatcher->addEventListenerWithSceneGraphPriority(listener, this);
 
     drawNodeCP = DrawNode::create();
@@ -3496,18 +3562,15 @@ DrawNodeSpLinesTest::DrawNodeSpLinesTest()
     }
 
     DrawNodeBaseTest::generateDataPoints();
-
-    addNewControlPoint(VisibleRect::center());
-
     scheduleUpdate();
 }
 
-void DrawNodeSpLinesTest::addNewControlPoint(Vec2 p)
+void DrawNodeSpLinesOpenClosedTest::addNewControlPoint(Vec2 p)
 {
     points.emplace_back(Vec2(p.x, p.y));
 }
 
-void DrawNodeSpLinesTest::onTouchesEnded(const std::vector<Touch*>& touches, Event* event)
+void DrawNodeSpLinesOpenClosedTest::onTouchesEnded(const std::vector<Touch*>& touches, Event* event)
 {
     for (auto& touch : touches)
     {
@@ -3516,66 +3579,39 @@ void DrawNodeSpLinesTest::onTouchesEnded(const std::vector<Touch*>& touches, Eve
     }
 }
 
-std::string DrawNodeSpLinesTest::title() const
+std::string DrawNodeSpLinesOpenClosedTest::title() const
 {
-    return "Testing SpLines";
+    return "Testing open/closed SpLines";
 }
 
-std::string DrawNodeSpLinesTest::subtitle() const
+std::string DrawNodeSpLinesOpenClosedTest::subtitle() const
 {
-    return "Tap screen to add more (control) points";
+    return "Tap screen to add (more) control points";
 }
 
-void DrawNodeSpLinesTest::update(float dt)
+void DrawNodeSpLinesOpenClosedTest::update(float dt)
 {
     if (points.size() == 0)
         return;
-
-    array = PointArray::create(points.size());
+    if (points.size() > 2)
+        array = PointArray::create(points.size() + 4);
+    else
+        array = PointArray::create(points.size());
 
     drawNodeCP->clear();
-
-    drawNode->clear();
     drawNode->clear();
 
     int boxSize = 3;
     for (auto&& p : points)
     {
+
         drawNodeCP->drawRect(Vec2(p.x - boxSize, p.y - boxSize), Vec2(p.x + boxSize, p.y + boxSize), Color4F::BLUE);
         array->addControlPoint(Vec2(p.x, p.y));
     }
 
-    drawNode->drawCardinalSpline(array, 0.2f, points.size() * 8, Color4F::GREEN, 20.0f);
-    drawNode->drawCardinalSpline(array, 0.2f, points.size() * 8, Color4F::BLUE);
-    drawNode->drawCardinalSpline(array, 0.2f, points.size() * 16, Color4F(1.0f, 1.0f, 0.5f, 1.0f), 10.0f);
-
-    // Issue #2302
-    auto array3 = PointArray::create(20);
-    for (int i = 0; i < 10; i++)
-    {
-        array3->addControlPoint(Vec2((i % 2) ? 20 : screen.width - 20, 50 + i * 20));
-        drawNode->drawPoint(array3->getControlPointAtIndex(i), 10, Color4F::BLUE);
-    }
-    drawNode->drawCardinalSpline(array3, 0.1, 20, Color4F::ORANGE);
-
-    //  drawNode->drawCatmullRom(array, points.size() * 8, Color4F::YELLOW,5);
-    // if (points.size()>3)
-    //{
-    //    int step = points.size()/4;
-    //    drawNode->drawCubicBezier(points.at(0), points.at(step),points.at(step*2),points.at(points.size()-1),
-    //    points.size(), Color4F::BLUE);
-    //}
-
-    drawNode->drawCardinalSpline(pts, 0.5f, 360, Color4F::RED, 5.0f);
-    drawNode->drawCardinalSpline(pts2, 0.5f, 360, Color4F::GREEN, 2.0f);
+    drawNode->drawCardinalSpline(array, 0.0f, points.size() * 20, Color4F::GREEN, 1.0f, true);
+    drawNode->drawCardinalSpline(array, 0.0f, points.size() * 20, Color4F::RED, 1.0f, false);
 
-    int i1 = RandomHelper::random_int(0, n - 1);
-    int i2 = RandomHelper::random_int(0, n - 1);
-    drawNode->drawDot(pts->getControlPointAtIndex(i1), 7, Color4F(0, 1, 0, 0.3));
-    drawNode->drawDot(pts->getControlPointAtIndex(i1), 4, Color4F::GREEN);
-
-    drawNode->drawDot(pts2->getControlPointAtIndex(i2), 7, Color4F(0, 1, 0, 0.3));
-    drawNode->drawDot(pts2->getControlPointAtIndex(i2), 4, Color4F::GREEN);
 }
 
 #if defined(AX_PLATFORM_PC)
diff --git a/tests/cpp-tests/Source/DrawNodeTest/DrawNodeTest.h b/tests/cpp-tests/Source/DrawNodeTest/DrawNodeTest.h
@@ -405,17 +405,25 @@ class DrawNodeThicknessStressTest : public DrawNodeBaseTest
     float threshold = 0;
 };
 
+class DrawNodeSpLinesTest : public DrawNodeBaseTest
+{
+public:
+    CREATE_FUNC(DrawNodeSpLinesTest);
 
+    DrawNodeSpLinesTest();
 
+    virtual std::string title() const override;
+    virtual std::string subtitle() const override;
 
+    void update(float dt);
+};
 
-
-class DrawNodeSpLinesTest : public DrawNodeBaseTest
+class DrawNodeSpLinesOpenClosedTest : public DrawNodeBaseTest
 {
 public:
-    CREATE_FUNC(DrawNodeSpLinesTest);
+    CREATE_FUNC(DrawNodeSpLinesOpenClosedTest);
 
-    DrawNodeSpLinesTest();
+    DrawNodeSpLinesOpenClosedTest();
 
     virtual std::string title() const override;
     virtual std::string subtitle() const override;
