library-mirrors/hump
1
0
Fork 0
mirror of https://github.com/vrld/hump.git synced 2024-11-23 12:24:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'grunkgrunk-randvector-docs'

Browse Source
This commit is contained in:
Matthias Richter 2017-11-19 21:02:47 +01:00
commit 704895896b
2 changed files with 19 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/vector-light.rst
View File

@ -65,7 +65,7 @@ Useful for debugging.
.. function:: vector.fromPolar(angle, radius)
:param number angle: Angle of the vector in radians.
:param number radius: Length of the vector.
:param number radius: Length of the vector (optional, default = 1).
:returns: ``x``, ``y``: The vector in cartesian coordinates.
@ -94,19 +94,17 @@ Convert the vector to polar coordinates, i.e., the angle and the radius/lenth.
.. function:: vector.randomDirection(len_min, len_max)
:param number len_min: Minimum length of the vector.
:param number len_max: Maximum length of the vector.
:returns: ``x``, ``y``: A vector pointing in a random direction with a random length between len_min and len_max.
:param number len_min: Minimum length of the vector (optional, default = 1).
:param number len_max: Maximum length of the vector (optional, default = ``len_min``).
:returns: ``x``, ``y``: A vector pointing in a random direction with a random length between ``len_min`` and ``len_max``.
Sample a vector with random direction and (optional) length.
**Examples**::
-- length is a random value between 1 and 5
x,y = vector.randomDirection(1,5)
-- length is 1
x,y = vector.randomDirection()
-- length is 100
x,y = vector.randomDirection(100)
x,y = vector.randomDirection() -- length is 1
x,y = vector.randomDirection(1,5) -- length is a random value between 1 and 5
x,y = vector.randomDirection(100) -- length is 100
.. function:: vector.mul(s, x,y)
@ -433,7 +431,7 @@ i.e. the function returns the angle to the coordinate system.
.. function:: vector.trim(max_length, x,y)
:param number max_length: Maximum allowed length of the vector.
:param numbers x,y: Vector to trum.
:param numbers x,y: Vector to trim.
:returns: The trimmed vector.
Trim the vector to ``max_length``, i.e. return a vector that points in the same

18
docs/vector.rst
View File

@ -103,7 +103,7 @@ Create a new vector.
.. function:: vector.fromPolar(angle, radius)
:param number angle: Angle of the vector in radians.
:param number radius: Length of the vector.
:param number radius: Length of the vector (optional, default = 1).
:returns: The vector in cartesian coordinates.
@ -116,19 +116,17 @@ The ``angle`` is measured against the vector (1,0), i.e., the x axis.
.. function:: vector.randomDirection(len_min, len_max)
:param number len_min: Minimum length of the vector.
:param number len_max: Maximum length of the vector.
:returns: A vector pointing in a random direction with a random length between len_min and len_max.
:param number len_min: Minimum length of the vector (optional, default = 1).
:param number len_max: Maximum length of the vector (optional, default = ``len_min``).
:returns: A vector pointing in a random direction with a random length between ``len_min`` and ``len_max``.
**Examples**::
-- length is a random value between 1 and 5
rnd = vector.randomDirection(1,5)
-- length is 1
rnd = vector.randomDirection()
rnd = vector.randomDirection() -- length is 1
rnd = vector.randomDirection(100) -- length is 100
rnd = vector.randomDirection(1,5) -- length is a random value between 1 and 5
-- length is 100
rnd = vector.randomDirection(100)
Sample a vector with random direction and (optional) length.
.. function:: vector.isvector(v)