nmwsharp / nmwsharp/polyscope

Undocumented change in interface for setting vertex tangent bases?

Open
#243 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
2.2k
Forks
242
Avg merge
11m
Merged PRs (30d)
1

Description

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!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the tangent vector documentation at the linked surface-mesh page and compare its examples with the current codebase. Check the status of setVertexTangentBasisX, addVertexIntrinsicVectorQuantity, and addVertexTangentVectorQuantity, then update the documentation and examples so they use the current interface consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.