README needs an update for the C++ interface

[TheFamousRat]

Hello,

Thanks for this great repo, it is so rare to have open-source code of this quality produced from research work.

I am currently playing around with the C++ code and trying to flatten a mesh on my own. But I am getting a bit confused since some methods seem interesting, but do not really have documentation on how to use them. BFF::flattenToShape is one such example without documentation. Other methods, like BFF::flatten do have documentation, but since their prototype is outdated in the README, I suspect that they do not work exactly as was specified at the time of writing there. An update to this part of the README would be really great.

[rohan-sawhney]

Thanks! Bff::flattenToShape takes an input a target curve with 2D vertex positions in the plane. You can find more details about how it works in Section 6.6 of the BFF paper. The current implementation can at times produce maps with high distortion, that's why it's not currently exposed in the GUI.

Can you point me to what parts of the README are outdated? That would be appreciated. Thanks!

[TheFamousRat]

Dear Rohan,

Thanks for the quick answer. I hadn't had a close enough look at the repo, actually, it seems like the comments in the Bff.h file are up to date on most methods. Nevertheless, I found two small things that would need updating:

• The prototype for BFF::flatten has different argument names for one overload: one in the header reads flatten(DenseMatrix& boundaryData, bool givenScaleFactors), while the one in the .cpp file reads BFF::flatten(DenseMatrix& target, bool givenScaleFactors)
• flattenToShape(const std::vector<Vector>& gamma) has a short explanation comment in the header, but no explanation for its parameters. Additionally, it seems to be absent from the README.