Skip to content
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

Undocumented change in interface for setting vertex tangent bases? #243

Open
keenancrane opened this issue Nov 29, 2023 · 2 comments
Open

Comments

@keenancrane
Copy link

The current documentation for tangent vector fields says they should be specified using the methods setVertexTangentBasisX and addVertexIntrinsicVectorQuantity. See for instance the example on this page: https://polyscope.run/structures/surface_mesh/vector_quantities/#tangent-vectors

However, these methods seem to longer exist. Another method, addVertexTangentVectorQuantity, appears in the codebase but is not documented or used in the examples. (Note that gc-polyscope-project-template also uses the seemingly defunct methods.)

Thanks!

@nmwsharp
Copy link
Owner

nmwsharp commented Dec 4, 2023

(responding here in addition to some discussion we had over another channel)

Yes, these functions are changing in an upcoming version. (A) associating the bases with the mesh goes against the Polyscope philosophy, because it introduces additional state and makes it impossible to visualize multiple vector fields on the same mesh defined in different bases, and (B) Most users don't know what "intrinsic vector" means :)

They're modified in an upcoming version to change the names and also take the basis as an argument of the vector adder. As soon as I cut a new version with the changes (hopefully soon!) I will also update the public docs.

@nmwsharp
Copy link
Owner

nmwsharp commented Dec 4, 2023

The gc-polyscope-project-template submodule should be pinned to a specific versioned commit of Polyscope (always good practice!). For now it just doesn't compile against the latest version; I will update update that template project as soon as I can get the new Polyscope version out.

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

No branches or pull requests

2 participants