Mark multiply and divide with two vectors as deprecated (Schur product and quotient) (#10329)

This commit is contained in:
DS 2020-09-01 20:18:10 +02:00 committed by GitHub
parent f5df70764d
commit 9ed84cfa85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -3080,7 +3080,8 @@ Internally, it is implemented as a table with the 3 fields
`x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`. `x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
For the following functions, `v`, `v1`, `v2` are vectors, For the following functions, `v`, `v1`, `v2` are vectors,
`p1`, `p2` are positions: `p1`, `p2` are positions,
`s` is a scalar (a number):
* `vector.new(a[, b, c])`: * `vector.new(a[, b, c])`:
* Returns a vector. * Returns a vector.
@ -3126,10 +3127,12 @@ For the following functions `x` can be either a vector or a number:
* Returns a vector. * Returns a vector.
* If `x` is a vector: Returns the difference of `v` subtracted by `x`. * If `x` is a vector: Returns the difference of `v` subtracted by `x`.
* If `x` is a number: Subtracts `x` from each component of `v`. * If `x` is a number: Subtracts `x` from each component of `v`.
* `vector.multiply(v, x)`: * `vector.multiply(v, s)`:
* Returns a scaled vector or Schur product. * Returns a scaled vector.
* `vector.divide(v, x)`: * Deprecated: If `s` is a vector: Returns the Schur product.
* Returns a scaled vector or Schur quotient. * `vector.divide(v, s)`:
* Returns a scaled vector.
* Deprecated: If `s` is a vector: Returns the Schur quotient.
For the following functions `a` is an angle in radians and `r` is a rotation For the following functions `a` is an angle in radians and `r` is a rotation
vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are