stride3d / stride3d/stride

Deprecate Vector*.Normalize()

Open
#1,412 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
7.8k
Forks
1.2k
Avg merge
2d 17h
Merged PRs (30d)
49

Description

Is your feature request related to a problem? Please describe.
The Normalize() method on the vector classes modifies the vector in place. That may be convenient but can lead to issues when users don't realize they shouldn't call it for example on properties (because a copy of the value will be modified and discarded).

Describe the solution you'd like
Ensure each vector class has two static methods

  • vec Normalize(in vec vector)
  • void Normalize(ref vec vector)

Put the [Obsolete] attribute on existing Normalize method with a comment pointing at the recommended one.

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

No files or tests are named. Locate each vector class and its existing Normalize() implementation, then review how the vector APIs are tested. Done means every vector class has both requested static overloads and the existing instance method is marked obsolete with a comment directing users to the recommended method.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
game-dev
Issue type
Feature
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.