nfrechette / nfrechette/rtm

Rename `qvs` types and related functions to `vqs`

Open
#233 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
799
Forks
51
PR merge metrics
No merged PRs in 30d

Description

In the mathematics literature, transform-like types of the vqs form (and friends) are named according to the order of operations: from right-to-left as is typically the convention. And so, vqs would have us apply scale first, followed by rotation, and last with translation. Although RTM uses the opposite order of operation, from left-to-right, we should keep the naming consistent with the mathematics community to facilitate searching for these and related types/concepts.

Types to rename:

  • qv -> vq
  • qvs -> vqs
  • qvv -> vqv

This will be in-line with the new vqm type and later vqvs if we wish to support it.

qvv was originally named according to the storage layout which isn't great. Other commonly used types in gamedev would mirror the order of operations but from left-to-right, such as sqt. However, it would be best not to attempt to rename common mathematical objects and concepts (e.g. we call a matrix a matrix, not some other non-math name).

Contributor guide

Open the contributing guide

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

Search the repository for the qv, qvs, and qvv type names and their related functions to map every affected reference. Rename the specified types consistently, update all references, and verify that the repository still builds and its existing checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
computer-graphics
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.