pymomentum-cpu 0.1.93.post0__cp312-cp312-macosx_14_0_arm64.whl

include/momentum/character_sequence_solver/vertex_sequence_error_function.h

@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/character/character.h>
+#include <momentum/character/skeleton_state.h>
+#include <momentum/character_sequence_solver/fwd.h>
+#include <momentum/character_sequence_solver/sequence_error_function.h>
+#include <momentum/character_solver/vertex_error_function.h>
+#include <momentum/math/mesh.h>
+
+#include <span>
+
+namespace momentum {
+
+/// Constraint structure for vertex velocity.
+template <typename T>
+struct VertexVelocityConstraintT {
+  int vertexIndex = -1;
+  T weight = 1;
+  Eigen::Vector3<T> targetVelocity;
+
+  template <typename T2>
+  VertexVelocityConstraintT<T2> cast() const {
+    return {
+        this->vertexIndex, static_cast<T2>(this->weight), this->targetVelocity.template cast<T2>()};
+  }
+};
+
+/// Error function that penalizes differences in vertex velocity between source and target motion.
+/// This function computes vertex velocities by taking the difference between consecutive frames
+/// and penalizes deviations from target vertex velocities. It combines the sequence aspect of
+/// StateSequenceErrorFunction with vertex constraints from VertexErrorFunction.
+template <typename T>
+class VertexSequenceErrorFunctionT : public SequenceErrorFunctionT<T> {
+ public:
+  explicit VertexSequenceErrorFunctionT(const Character& character);
+
+  [[nodiscard]] size_t numFrames() const final {
+    return 2;
+  }
+
+  double getError(
+      std::span<const ModelParametersT<T>> modelParameters,
+      std::span<const SkeletonStateT<T>> skelStates,
+      std::span<const MeshStateT<T>> meshStates) const final;
+  double getGradient(
+      std::span<const ModelParametersT<T>> modelParameters,
+      std::span<const SkeletonStateT<T>> skelStates,
+      std::span<const MeshStateT<T>> meshStates,
+      Eigen::Ref<Eigen::VectorX<T>> gradient) const final;
+
+  // modelParameters: [numFrames() * parameterTransform] parameter vector
+  // skelStates: [numFrames()] array of skeleton states
+  // jacobian: [getJacobianSize()] x [numFrames() * parameterTransform] Jacobian matrix
+  // residual: [getJacobianSize()] residual vector.
+  double getJacobian(
+      std::span<const ModelParametersT<T>> modelParameters,
+      std::span<const SkeletonStateT<T>> skelStates,
+      std::span<const MeshStateT<T>> meshStates,
+      Eigen::Ref<Eigen::MatrixX<T>> jacobian,
+      Eigen::Ref<Eigen::VectorX<T>> residual,
+      int& usedRows) const final;
+
+  bool needsMesh() const final {
+    return true;
+  }
+
+  [[nodiscard]] size_t getJacobianSize() const final;
+
+  /// Add a vertex velocity constraint.
+  /// @param vertexIndex Index of the vertex to constrain.
+  /// @param weight Weight for this constraint.
+  /// @param targetVelocity Target velocity for the vertex.
+  void addConstraint(int vertexIndex, T weight, const Eigen::Vector3<T>& targetVelocity);
+
+  /// Clear all vertex velocity constraints.
+  void clearConstraints();
+
+  /// Get all vertex velocity constraints.
+  [[nodiscard]] const std::vector<VertexVelocityConstraintT<T>>& getConstraints() const {
+    return constraints_;
+  }
+
+  /// Get the number of constraints.
+  [[nodiscard]] size_t numConstraints() const {
+    return constraints_.size();
+  }
+
+  /// Get the character reference.
+  [[nodiscard]] const Character& getCharacter() const {
+    return character_;
+  }
+
+  static constexpr T kVelocityWeight = 1e-3f;
+
+ private:
+  /// Calculate gradient for a single vertex velocity constraint.
+  double calculateVelocityGradient(
+      std::span<const SkeletonStateT<T>> skelStates,
+      std::span<const MeshStateT<T>> meshStates,
+      const VertexVelocityConstraintT<T>& constraint,
+      Eigen::Ref<Eigen::VectorX<T>> gradient) const;
+
+  /// Calculate Jacobian for a single vertex velocity constraint.
+  double calculateVelocityJacobian(
+      std::span<const SkeletonStateT<T>> skelStates,
+      std::span<const MeshStateT<T>> meshStates,
+      const VertexVelocityConstraintT<T>& constraint,
+      Eigen::Ref<Eigen::MatrixX<T>> jacobian,
+      Eigen::Ref<Eigen::VectorX<T>> residual,
+      Eigen::Index startRow) const;
+
+  const Character& character_;
+  std::vector<VertexVelocityConstraintT<T>> constraints_;
+};
+
+} // namespace momentum

include/momentum/character_solver/aim_error_function.h

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/character_solver/constraint_error_function.h>
+
+namespace momentum {
+
+/// Aim constraint data: a local ray (point, dir) passes a global point target
+template <typename T>
+struct AimDataT : ConstraintData {
+  /// The origin of the local ray
+  Vector3<T> localPoint;
+  /// The direction of the local ray
+  Vector3<T> localDir;
+  /// The global aim target
+  Vector3<T> globalTarget;
+
+  explicit AimDataT(
+      const Vector3<T>& inLocalPt,
+      const Vector3<T>& inLocalDir,
+      const Vector3<T>& inTarget,
+      size_t pIndex,
+      float w,
+      const std::string& n = {})
+      : ConstraintData(pIndex, w, n),
+        localPoint(inLocalPt),
+        localDir(inLocalDir.normalized()),
+        globalTarget(inTarget) {}
+};
+
+/// The AimDistErrorFunction computes the distance from the aim target point to an aim ray (an
+/// original and a positive direction). The distance is minimized if the target lies on the ray (ie.
+/// on the positive direction), or when the target point is close to the ray origin. Another way to
+/// look at this loss is to minimize the element-wise differences between the aim vector's
+/// projection to the ray direction and the aim vector itself (therefore a shorter aim vector also
+/// has a smaller norm).
+template <typename T>
+class AimDistErrorFunctionT : public ConstraintErrorFunctionT<T, AimDataT<T>, 3, 2, 1> {
+ public:
+  explicit AimDistErrorFunctionT(
+      const Skeleton& skel,
+      const ParameterTransform& pt,
+      const T& lossAlpha = GeneralizedLossT<T>::kL2,
+      const T& lossC = T(1))
+      : ConstraintErrorFunctionT<T, AimDataT<T>, 3, 2, 1>(skel, pt, lossAlpha, lossC) {}
+
+  explicit AimDistErrorFunctionT(
+      const Character& character,
+      const T& lossAlpha = GeneralizedLossT<T>::kL2,
+      const T& lossC = T(1))
+      : AimDistErrorFunctionT<T>(
+            character.skeleton,
+            character.parameterTransform,
+            lossAlpha,
+            lossC) {}
+
+  /// Default constant weight in MarkerErrorFunction (same as fixed axis). This can be used for
+  /// backwards compatibility in setWeight().
+  static constexpr T kLegacyWeight = 1e-1f;
+
+ protected:
+  void evalFunction(
+      size_t constrIndex,
+      const JointStateT<T>& state,
+      Vector3<T>& f,
+      optional_ref<std::array<Vector3<T>, 2>> v = {},
+      optional_ref<std::array<Eigen::Matrix3<T>, 2>> dfdv = {}) const final;
+};
+
+/// The AimDirErrorFunction computes the element-wise differences between the normalized aim vector
+/// and the ray direction. Because the aim vector is normalized, the distance to the ray origin
+/// doesn't affect the loss as in AimDistErrorFunction. When the aim vector is close to zero length,
+/// we will clamp it to zero.
+template <typename T>
+class AimDirErrorFunctionT : public ConstraintErrorFunctionT<T, AimDataT<T>, 3, 2, 1> {
+ public:
+  explicit AimDirErrorFunctionT(
+      const Skeleton& skel,
+      const ParameterTransform& pt,
+      const T& lossAlpha = GeneralizedLossT<T>::kL2,
+      const T& lossC = T(1))
+      : ConstraintErrorFunctionT<T, AimDataT<T>, 3, 2, 1>(skel, pt, lossAlpha, lossC) {}
+
+  explicit AimDirErrorFunctionT(
+      const Character& character,
+      const T& lossAlpha = GeneralizedLossT<T>::kL2,
+      const T& lossC = T(1))
+      : AimDirErrorFunctionT<T>(
+            character.skeleton,
+            character.parameterTransform,
+            lossAlpha,
+            lossC) {}
+
+  /// Default constant weight in MarkerErrorFunction (same as fixed axis). This can be used for
+  /// backwards compatibility in setWeight().
+  static constexpr T kLegacyWeight = 1e-1f;
+
+ protected:
+  void evalFunction(
+      size_t constrIndex,
+      const JointStateT<T>& state,
+      Vector3<T>& f,
+      optional_ref<std::array<Vector3<T>, 2>> v = {},
+      optional_ref<std::array<Eigen::Matrix3<T>, 2>> dfdv = {}) const final;
+};
+} // namespace momentum

include/momentum/character_solver/collision_error_function.h

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/character/collision_geometry.h>
+#include <momentum/character/collision_geometry_state.h>
+#include <momentum/character_solver/fwd.h>
+#include <momentum/character_solver/skeleton_error_function.h>
+
+#include <axel/Bvh.h>
+
+#include <unordered_set>
+#include <vector>
+
+namespace momentum {
+
+template <typename T>
+class CollisionErrorFunctionT : public SkeletonErrorFunctionT<T> {
+ public:
+  explicit CollisionErrorFunctionT(
+      const Skeleton& skel,
+      const ParameterTransform& pt,
+      const CollisionGeometry& cg);
+
+  explicit CollisionErrorFunctionT(const Character& character);
+
+  [[nodiscard]] double getError(
+      const ModelParametersT<T>& params,
+      const SkeletonStateT<T>& state,
+      const MeshStateT<T>& meshState) final;
+
+  double getGradient(
+      const ModelParametersT<T>& params,
+      const SkeletonStateT<T>& state,
+      const MeshStateT<T>& meshState,
+      Ref<VectorX<T>> gradient) override;
+
+  double getJacobian(
+      const ModelParametersT<T>& /*unused*/,
+      const SkeletonStateT<T>& state,
+      const MeshStateT<T>& meshState,
+      Ref<MatrixX<T>> jacobian,
+      Ref<VectorX<T>> residual,
+      int& usedRows) override;
+
+  [[nodiscard]] size_t getJacobianSize() const final;
+
+  [[nodiscard]] std::vector<Vector2i> getCollisionPairs() const;
+
+ protected:
+  void updateCollisionPairs();
+
+  // Update collisionState_ and bvh_ given the new skeleton state.
+  void computeBroadPhase(const SkeletonStateT<T>& state);
+
+  using PairId = std::pair<size_t, size_t>;
+
+  struct PairHash {
+    std::size_t operator()(const std::pair<size_t, size_t>& p) const {
+      // Use the smaller value as the high-order bits and the larger value as the low-order bits
+      return (static_cast<uint64_t>(std::min(p.first, p.second)) << (sizeof(size_t) * 8 / 2)) |
+          std::max(p.first, p.second);
+    }
+  };
+
+  struct PairEqual {
+    bool operator()(const PairId& a, const PairId& b) const {
+      return (a.first == b.first && a.second == b.second) ||
+          (a.first == b.second && a.second == b.first);
+    }
+  };
+
+  const CollisionGeometry collisionGeometry_;
+
+  std::unordered_set<PairId, PairHash, PairEqual> excludingPairIds_;
+
+  size_t jacobianSize_ = 0;
+
+  CollisionGeometryStateT<T> collisionState_;
+
+  // weights for the error functions
+  static constexpr T kCollisionWeight = 5e-3f;
+
+  axel::Bvh<T> bvh_;
+};
+
+} // namespace momentum

include/momentum/character_solver/collision_error_function_stateless.h

@@ -0,0 +1,75 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/character/collision_geometry.h>
+#include <momentum/character/collision_geometry_state.h>
+#include <momentum/character_solver/fwd.h>
+#include <momentum/character_solver/skeleton_error_function.h>
+
+namespace momentum {
+
+/// NOTE: This is a resurrected version of the `CollisionErrorFunction` (previously updated by
+/// D50818775). Its stateless nature makes it ideal for testing in multi-threaded settings.
+///
+/// Represents an error function that penalizes self-intersections between collision geometries of
+/// the character.
+///
+/// The function pre-filters collision geometries to ignore those attached to the same joint, those
+/// intersecting in the rest pose, or those very close in the rest pose.
+template <typename T>
+class CollisionErrorFunctionStatelessT : public SkeletonErrorFunctionT<T> {
+ public:
+  explicit CollisionErrorFunctionStatelessT(
+      const Skeleton& skel,
+      const ParameterTransform& pt,
+      const CollisionGeometry& cg);
+
+  explicit CollisionErrorFunctionStatelessT(const Character& character);
+
+  [[nodiscard]] double getError(
+      const ModelParametersT<T>& params,
+      const SkeletonStateT<T>& state,
+      const MeshStateT<T>& meshState) final;
+
+  double getGradient(
+      const ModelParametersT<T>& params,
+      const SkeletonStateT<T>& state,
+      const MeshStateT<T>& meshState,
+      Ref<VectorX<T>> gradient) override;
+
+  double getJacobian(
+      const ModelParametersT<T>& /*unused*/,
+      const SkeletonStateT<T>& state,
+      const MeshStateT<T>& meshState,
+      Ref<MatrixX<T>> jacobian,
+      Ref<VectorX<T>> residual,
+      int& usedRows) override;
+
+  [[nodiscard]] size_t getJacobianSize() const final;
+
+  [[nodiscard]] std::vector<Vector2i> getCollisionPairs() const;
+
+ protected:
+  void updateCollisionPairs();
+
+  const CollisionGeometry collisionGeometry;
+
+  // [0] and [1] index the collision geometry, [2] indexes the joint after
+  // which we can stop comparing as it's parent to both
+  std::vector<Vector3i> collisionPairs;
+
+  VectorX<bool> collisionActive;
+
+  CollisionGeometryStateT<T> collisionState;
+
+  // weights for the error functions
+  static constexpr T kCollisionWeight = 5e-3f;
+};
+
+} // namespace momentum