Skip to content

Change function names (quaternions) #1210

@phkahler

Description

@phkahler

This would be strictly a change of naming convention in the code.

Quaternions currently have 3 functions called RotationU, RotationV, and RotationN.

What would you expect they do based on the names? What if I then told you they return a vector? Now what you think they do? There are no comments in the code documenting these (adding some might also be a solution)

A quaternion can be used to apply a rotation to a vector or another quaternion. They can also be used as a compact representation of a coordinate systems orientation. As such, these 3 functions can be used to extract 3 basis vectors from a quaternion. RotationU returns the U axis (I think x) as if the vector (1,0,0) were rotated by the quaternion. Similar for V and N (y and z). With this understanding, the naming makes more sense. The problem is that the naming is not self explanitory. Maybe GetU()? UAxis() or VectorU()?

I'm wanting to use BasisU in place of RotationU, but I'm not sure what others think about that. Other suggestions are welcome too. I just dont like the current situation.

Something similar is done with "normals" which are stored as quaternions, and have similar functions with different names that just call the quaternion functions.

Thoughts on this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions