Skip to content

ShapeOp binding #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged

Conversation

petrasvestartas
Copy link
Collaborator

@petrasvestartas petrasvestartas commented May 4, 2025

Most important files, related to API are these ones:

  • src/compas_shapeop/shapeop.py
  • src/shapeop.cpp

The rest is documentation, examples, test, github actions and building.

Features:

  • Zero-copy integration between Python (NumPy) and C++ (Eigen/ShapeOp). Python is reading directly from memory of ShapOp solver. By zero copy, I mean retrieving data from solver during iterations.
  • Constraints: ClosenessConstraint (with target position variant), EdgeStrainConstraint, ShrinkingEdgeConstraint, CircleConstraint, PlaneConstraint, BendingConstraint, SimilarityConstraint, RegularPolygonConstraint, ShapeConstraint
  • Forces: VertexForce, NormalForce, GravityForce
  • From source code I removed all the old binders as it took long time to compile without any use.
  • Solver can be run both statically by calling fast solve method or dynamically (barely used option for animation).

Repositories that helped to reverse engineer this library:

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

Copy link
Member

@tomvanmele tomvanmele left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as discussed, it is great to have a one-to-one python binding of the C++ code, but i think we need an easier to use API as well.

let's already merge this one and work on the API in a next round. otherwise things will get to complicated and difficult to review...

@tomvanmele tomvanmele merged commit 20dd333 into compas-dev:main May 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants