Introduce SVGPath

Author: wisniewskij

apps/common-app/src/apps/css/examples/animations/routes/properties/svg.ts

@@ -18,6 +18,10 @@ export const svgPropertiesRoutes = {
     name: 'Line',
     Component: svgAnimatedProperties.Line,
   },
+  Path: {
+    name: 'Path',
+    Component: svgAnimatedProperties.Path,
+  },
   Common: {
     name: 'Common',
     routes: {

apps/common-app/src/apps/css/examples/animations/screens/animatedProperties/svg/Path.tsx

@@ -3,11 +3,13 @@ import common from './common';
 import Ellipse from './Ellipse';
 import Line from './Line';
 import Rect from './Rect';
+import Path from './Path';
 
 export default {
   Circle,
   Ellipse,
   Line,
+  Path,
   common,
   Rect,
 };

apps/common-app/src/apps/css/examples/animations/screens/animatedProperties/svg/index.ts

@@ -15,6 +15,7 @@
 
 #include <reanimated/CSS/svg/values/SVGBrush.h>
 #include <reanimated/CSS/svg/values/SVGLength.h>
+#include <reanimated/CSS/svg/values/SVGPath.h>
 #include <reanimated/CSS/svg/values/SVGStrokeDashArray.h>
 
 #include <reanimated/CSS/interpolation/InterpolatorFactory.h>
@@ -341,7 +342,8 @@ const InterpolatorFactoriesRecord SVG_RECT_INTERPOLATORS = mergeInterpolators(
 const InterpolatorFactoriesRecord SVG_PATH_INTERPOLATORS = mergeInterpolators(
     {SVG_COMMON_INTERPOLATORS,
      InterpolatorFactoriesRecord{
-         // TODO - add more properties
+         {"d", value<SVGPath>("")},
+         {"opacity", value<CSSDouble>(1)},
      }});
 
 // ==================

packages/react-native-reanimated/Common/cpp/reanimated/CSS/InterpolatorRegistry.cpp

@@ -9,6 +9,7 @@
 #include <reanimated/CSS/common/values/complex/CSSBoxShadow.h>
 #include <reanimated/CSS/svg/values/SVGBrush.h>
 #include <reanimated/CSS/svg/values/SVGLength.h>
+#include <reanimated/CSS/svg/values/SVGPath.h>
 #include <reanimated/CSS/svg/values/SVGStrokeDashArray.h>
 
 #include <worklets/Tools/JSISerializer.h>
@@ -168,6 +169,7 @@ template class CSSValueVariant<CSSDiscreteArray<CSSKeyword>>;
 
 template class CSSValueVariant<SVGLength>;
 template class CSSValueVariant<SVGLength, CSSKeyword>;
+template class CSSValueVariant<SVGPath>;
 template class CSSValueVariant<SVGStrokeDashArray, CSSKeyword>;
 template class CSSValueVariant<SVGBrush>;
 

packages/react-native-reanimated/Common/cpp/reanimated/CSS/common/values/CSSValueVariant.cpp

@@ -13,6 +13,7 @@
 #include <reanimated/CSS/common/values/complex/CSSBoxShadow.h>
 #include <reanimated/CSS/svg/values/SVGBrush.h>
 #include <reanimated/CSS/svg/values/SVGLength.h>
+#include <reanimated/CSS/svg/values/SVGPath.h>
 #include <reanimated/CSS/svg/values/SVGStrokeDashArray.h>
 
 #include <memory>
@@ -64,6 +65,7 @@ template class SimpleValueInterpolator<CSSDiscreteArray<CSSKeyword>>;
 
 template class SimpleValueInterpolator<SVGLength>;
 template class SimpleValueInterpolator<SVGLength, CSSKeyword>;
+template class SimpleValueInterpolator<SVGPath>;
 template class SimpleValueInterpolator<SVGStrokeDashArray, CSSKeyword>;
 template class SimpleValueInterpolator<SVGBrush>;
 

packages/react-native-reanimated/Common/cpp/reanimated/CSS/interpolation/values/SimpleValueInterpolator.cpp

@@ -0,0 +1,281 @@
+#include <SVGPath.h>
+#include <reanimated/CSS/svg/values/SVGPath.h>
+
+#include <reanimated/CSS/common/transforms/vectors.h>
+
+#include <cstddef>
+#include <functional>
+#include <optional>
+#include <string>
+
+namespace reanimated::css {
+
+using Point = Vector2D;
+using Cubic = std::array<Vector2D, 4>;
+using SubPath = SVGPath::SubPath;
+
+SVGPath::SVGPath() : subPaths() {}
+
+SVGPath::SVGPath(std::vector<SubPath> &&subPaths) : subPaths(std::move(subPaths)) {}
+
+SVGPath::SVGPath(jsi::Runtime &rt, const jsi::Value &jsiValue) : SVGPath(jsiValue.getString(rt).utf8(rt)) {}
+
+SVGPath::SVGPath(const folly::dynamic &value) : SVGPath(value.getString()) {}
+
+bool SVGPath::canConstruct(jsi::Runtime &rt, const jsi::Value &jsiValue) {
+  return jsiValue.isString();
+}
+
+bool SVGPath::canConstruct(const folly::dynamic &value) {
+  return value.isString();
+}
+
+folly::dynamic SVGPath::toDynamic() const {
+  return toString();
+}
+
+std::string SVGPath::toString() const {
+  std::ostringstream oss;
+  oss << std::defaultfloat;
+  for (size_t i = 0; i < subPaths.size(); ++i) {
+    const auto &segment = subPaths[i];
+
+    if (i > 0) {
+      oss << " ";
+    }
+
+    oss << "M" << segment.M[0] << " " << segment.M[1];
+
+    for (const auto &point : segment.C) {
+      oss << " C";
+      for (int j = 1; j < 4; ++j) {
+        // In SVGPath C command start point is implicit
+        oss << " " << point[j][0] << " " << point[j][1];
+      }
+    }
+
+    if (segment.Z) {
+      oss << " Z";
+    }
+  }
+  return oss.str();
+}
+
+SVGPath SVGPath::interpolate(const double progress, const SVGPath &to) const {
+  const auto &longerPath = (subPaths.size() >= to.subPaths.size()) ? subPaths : to.subPaths;
+  const auto &shorterPath = (subPaths.size() < to.subPaths.size()) ? subPaths : to.subPaths;
+
+  size_t longerSize = longerPath.size();
+  size_t shorterSize = shorterPath.size();
+
+  std::vector<std::reference_wrapper<const SubPath>> fromRef;
+  std::vector<std::reference_wrapper<const SubPath>> toRef;
+
+  fromRef.reserve(longerSize);
+  toRef.reserve(longerSize);
+
+  if (shorterSize == 0) {
+    return to;
+  }
+
+  size_t baseGroupSize = longerSize / shorterSize;
+  size_t remainder = longerSize % shorterSize;
+
+  size_t longerPathIndex = 0;
+
+  for (size_t i = 0; i < shorterSize; ++i) {
+    size_t currentGroupSize = baseGroupSize + (i < remainder ? 1 : 0);
+
+    for (size_t j = 0; j < currentGroupSize; ++j) {
+      if (subPaths.size() <= to.subPaths.size()) {
+        fromRef.push_back(std::cref(subPaths[i]));
+        toRef.push_back(std::cref(to.subPaths[longerPathIndex]));
+      } else {
+        fromRef.push_back(std::cref(subPaths[longerPathIndex]));
+        toRef.push_back(std::cref(to.subPaths[i]));
+      }
+      longerPathIndex++;
+    }
+  }
+
+  std::vector<SubPath> interpolatedSubPaths;
+  interpolatedSubPaths.reserve(longerSize);
+
+  for (size_t i = 0; i < longerSize; ++i) {
+    interpolatedSubPaths.push_back(interpolateSubPaths(fromRef[i], toRef[i], progress));
+  }
+
+  return SVGPath(std::move(interpolatedSubPaths));
+}
+
+bool SVGPath::operator==(const SVGPath &other) const {
+  return toString() == other.toString();
+}
+
+#ifndef NDEBUG
+
+std::ostream &operator<<(std::ostream &os, const SVGPath &value) {
+  os << "SVGPath(" << value.toString() << ")";
+  return os;
+}
+
+#endif // NDEBUG
+
+std::vector<SubPath> SVGPath::parseSVGPath(const std::string &value) const {
+  std::vector<SubPath> result;
+  std::stringstream ss(value);
+  Point currPos;
+
+  // Format of input: (M num num |C num num num num num num |Z)*
+  while (ss >> std::ws && !ss.eof()) {
+    char cmd;
+    ss >> cmd;
+
+    switch (cmd) {
+      case 'M':
+        double x, y;
+        ss >> x >> y;
+        result.emplace_back(Point(x, y));
+        currPos = Point(x, y);
+        break;
+      case 'C':
+        if (!result.empty()) {
+          Point p0(currPos), p1, p2, p3;
+          ss >> p1[0] >> p1[1] >> p2[0] >> p2[1] >> p3[0] >> p3[1];
+          result.back().C.push_back({p0, p1, p2, p3});
+          currPos = p3;
+          break;
+        }
+      // Fallthrough
+      case 'Z':
+        if (!result.empty()) {
+          result.back().Z = true;
+          currPos = result.back().M;
+          break;
+        }
+      // Fallthrough
+      default:
+        std::invalid_argument("[Reanimated] Invalid SVGPath string format.");
+    }
+  }
+
+  return result;
+}
+
+std::vector<Cubic> SVGPath::splitCubic(Cubic cubic, int count) const {
+  std::vector<Cubic> result;
+  for (int i = 0; i < count; i++) {
+    double t = 1.0 / (count - i);
+    auto [st, nd] = singleSplitCubic(cubic, t);
+    result.push_back(st);
+    cubic = nd;
+  }
+  return result;
+}
+
+SubPath SVGPath::interpolateSubPaths(const SubPath &from, const SubPath &to, double t) const {
+  Point newM = from.M.interpolate(t, to.M);
+  SubPath result(newM);
+
+  result.Z = to.Z;
+
+  size_t longerSize = std::max(from.C.size(), to.C.size());
+  size_t shorterSize = std::min(from.C.size(), to.C.size());
+
+  if (shorterSize == 0) {
+    return result;
+  }
+
+  size_t baseGroupSize = longerSize / shorterSize;
+  size_t remainder = longerSize % shorterSize;
+
+  std::vector<Cubic> prolongatedShorter;
+  prolongatedShorter.reserve(longerSize);
+
+  for (size_t i = 0; i < shorterSize; ++i) {
+    size_t currentGroupSize = baseGroupSize + (i < remainder ? 1 : 0);
+    std::vector<Cubic> x =
+        from.C.size() <= to.C.size() ? splitCubic(from.C[i], currentGroupSize) : splitCubic(to.C[i], currentGroupSize);
+    prolongatedShorter.insert(prolongatedShorter.end(), x.begin(), x.end());
+  }
+
+  auto &fromRef = from.C.size() <= to.C.size() ? prolongatedShorter : from.C;
+  auto &toRef = from.C.size() <= to.C.size() ? to.C : prolongatedShorter;
+
+  for (size_t i = 0; i < longerSize; ++i) {
+    const auto &c1 = fromRef[i];
+    const auto &c2 = toRef[i];
+
+    Cubic newCubic;
+
+    for (size_t j = 0; j < 4; ++j) {
+      newCubic[j] = c1[j].interpolate(t, c2[j]);
+    }
+
+    // ensure continuity
+    if (i == 0) {
+      newCubic[0] = result.M;
+    } else {
+      newCubic[0] = result.C.back()[3];
+    }
+
+    // Ensure tangent differs from 0
+    {
+      constexpr double NUDGE_EPS = 5e-1;
+      newCubic[1] = applyDirectionalNudge(newCubic[1], newCubic[0], newCubic[2], newCubic[3], NUDGE_EPS);
+      newCubic[2] = applyDirectionalNudge(newCubic[2], newCubic[3], newCubic[1], newCubic[0], NUDGE_EPS);
+    }
+
+    result.C.push_back(newCubic);
+  }
+
+  return result;
+}
+
+Point SVGPath::lineAt(Point p0, Point p1, double t) const {
+  return Point(p0[0] + t * (p1[0] - p0[0]), p0[1] + t * (p1[1] - p0[1]));
+}
+
+Point SVGPath::applyDirectionalNudge(
+    Point target,
+    const Point &anchor,
+    const Point &guide,
+    const Point &altGuide,
+    double epsilon) const {
+  double dx0 = target[0] - anchor[0];
+  double dy0 = target[1] - anchor[1];
+
+  if (dx0 * dx0 + dy0 * dy0 < epsilon * epsilon) {
+
+    Point v = Point(guide[0] - anchor[0], guide[1] - anchor[1]);
+    double vLen = v.length();
+
+    if (vLen < epsilon) {
+      v = Point(altGuide[0] - anchor[0], altGuide[1] - anchor[1]);
+      vLen = v.length();
+    }
+
+    if (vLen < epsilon) {
+      target[0] += epsilon;
+      return target;
+    }
+
+    v.normalize();
+    return Point(target[0] + v[0] * epsilon, target[1] + v[1] * epsilon);
+  }
+
+  return target;
+}
+
+std::pair<Cubic, Cubic> SVGPath::singleSplitCubic(const Cubic &p, double t) const {
+  Point p01 = lineAt(p[0], p[1], t);
+  Point p12 = lineAt(p[1], p[2], t);
+  Point p23 = lineAt(p[2], p[3], t);
+  Point c0 = lineAt(p01, p12, t);
+  Point c1 = lineAt(p12, p23, t);
+  Point q = lineAt(c0, c1, t);
+
+  return {{p[0], p01, c0, q}, {q, c1, p23, p[3]}};
+}
+
+} // namespace reanimated::css