MyouProject/vmath
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve docs and use unix line endings (#2)

Browse source 
* use unix line endings
* improving some docs
* add mddoc dep
This commit is contained in:
guzba 2020-03-05 19:44:26 -06:00 committed by GitHub
parent b84d23be05
commit c212d3d95b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 481 additions and 481 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
.github/workflows/build.yml vendored
View file

@ -1,37 +1,36 @@
name: Build name: Build
on: [push] on: [push]
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- name: Cache choosenim - name: Cache choosenim
id: cache-choosenim id: cache-choosenim
uses: actions/cache@v1 uses: actions/cache@v1
with: with:
path: ~/.choosenim path: ~/.choosenim
key: ${{ runner.os }}-choosenim-1.0.2 key: ${{ runner.os }}-choosenim-1.0.2
- name: Cache nimble - name: Cache nimble
id: cache-nimble id: cache-nimble
uses: actions/cache@v1 uses: actions/cache@v1
with: with:
path: ~/.nimble path: ~/.nimble
key: ${{ runner.os }}-nimble-1.0.2 key: ${{ runner.os }}-nimble-1.0.2
- name: Install Nim - name: Install Nim
if: steps.cache-choosenim.outputs.cache-hit != 'true' || steps.cache-nimble.outputs.cache-hit != 'true' if: steps.cache-choosenim.outputs.cache-hit != 'true' || steps.cache-nimble.outputs.cache-hit != 'true'
run: | run: |
export CHOOSENIM_CHOOSE_VERSION="1.0.2" export CHOOSENIM_CHOOSE_VERSION="1.0.2"
curl https://nim-lang.org/choosenim/init.sh -sSf > init.sh curl https://nim-lang.org/choosenim/init.sh -sSf > init.sh
sh init.sh -y sh init.sh -y
- name: Build project - name: Build project
run: | run: |
export PATH=$HOME/.nimble/bin:$PATH export PATH=$HOME/.nimble/bin:$PATH
echo $PATH echo $PATH
nimble install -y nimble install -y
nim c src/vmath.nim nim c src/vmath.nim

16
.gitignore vendored
View file

@ -1,8 +1,8 @@
# ignore files with no extention: # ignore files with no extention:
* *
!*/ !*/
!*.* !*.*
# normal ignores: # normal ignores:
*.exe *.exe
nimcache nimcache

386
README.md
View file

File diff suppressed because it is too large Load diff

40
src/vmath.nim
View file

@ -5,7 +5,7 @@ export math
proc clamp*(n, min, max: float32): float32 = proc clamp*(n, min, max: float32): float32 =
## Clamps n to min or max if its over. ## Clamps n to min, else returns max if n is higher.
if n < min: if n < min:
return min return min
if n > max: if n > max:
@ -19,7 +19,7 @@ proc sign*(v: float32): float32 =
return -1.0 return -1.0
proc quantize*(v: float32, n: float32): float32 = proc quantize*(v: float32, n: float32): float32 =
## Makes v be multipe of n. Rounding to intger quantize by 1.0. ## Makes v be multipe of n. Rounding to integer quantize by 1.0.
result = sign(v) * floor(abs(v) / n) * n result = sign(v) * floor(abs(v) / n) * n
proc lerp*(a: float32, b: float32, v: float32): float32 = proc lerp*(a: float32, b: float32, v: float32): float32 =
@ -161,19 +161,19 @@ proc fixAngle*(angle: float32): float32 =
return angle return angle
proc angle*(a: Vec2): float32 = proc angle*(a: Vec2): float32 =
## Angle of a vec2. ## Angle of a Vec2.
math.arctan2(a.y, a.x) math.arctan2(a.y, a.x)
proc angleBetween*(a: Vec2, b: Vec2): float32 = proc angleBetween*(a: Vec2, b: Vec2): float32 =
## Angle between 2 vec ## Angle between 2 Vec2.
fixAngle(math.arctan2(a.y - b.y, a.x - b.x)) fixAngle(math.arctan2(a.y - b.y, a.x - b.x))
proc angleBetween*(a, b: float32): float32 = proc angleBetween*(a, b: float32): float32 =
## Angle between angle a and angle b ## Angle between angle a and angle b.
(b - a).fixAngle (b - a).fixAngle
proc turnAngle*(a, b, speed: float32): float32 = proc turnAngle*(a, b, speed: float32): float32 =
## Move from angle a to angle b with step of v ## Move from angle a to angle b with step of v.
var var
turn = fixAngle(b - a) turn = fixAngle(b - a)
if abs(turn) < speed: if abs(turn) < speed:
@ -349,7 +349,7 @@ proc almostEquals*(a, b: Vec3, precision = 1e-6): bool =
return abs(c.x) < precision and abs(c.y) < precision and abs(c.z) < precision return abs(c.x) < precision and abs(c.y) < precision and abs(c.z) < precision
proc randVec3*(): Vec3 = proc randVec3*(): Vec3 =
## Generates a random vector based on: http://mathworld.wolfram.com/SpherePointPicking.html . ## Generates a random vector based on http://mathworld.wolfram.com/SpherePointPicking.html
let let
u = rand(0.0 .. 1.0) u = rand(0.0 .. 1.0)
v = rand(0.0 .. 1.0) v = rand(0.0 .. 1.0)
@ -596,7 +596,7 @@ proc scale*(a: Mat3, v: Vec3): Mat3 =
proc rotationMat3*(angle: float32): Mat3 = proc rotationMat3*(angle: float32): Mat3 =
# create a matrix from an angle # Create a matrix from an angle.
let let
sin = sin(angle) sin = sin(angle)
cos = cos(angle) cos = cos(angle)
@ -614,7 +614,7 @@ proc rotationMat3*(angle: float32): Mat3 =
proc rotate*(a: Mat3, angle: float32): Mat3 = proc rotate*(a: Mat3, angle: float32): Mat3 =
# rotates a matrix by an angle # Rotates a matrix by an angle.
a * rotationMat3(angle) a * rotationMat3(angle)
@ -964,7 +964,7 @@ proc hrp*(m: Mat4): Vec3 =
heading = arctan2(m[2], m[10]) heading = arctan2(m[2], m[10])
pitch = PI / 2 pitch = PI / 2
roll = 0 roll = 0
elif m[1] < -0.998: # singularity at sresulth pole elif m[1] < -0.998: # singularity at south pole
heading = arctan2(m[2], m[10]) heading = arctan2(m[2], m[10])
pitch = -PI / 2 pitch = -PI / 2
roll = 0 roll = 0
@ -1187,7 +1187,7 @@ proc `xyz=`*(q: var Quat, v: Vec3) =
proc `*`*(a, b: Quat): Quat = proc `*`*(a, b: Quat): Quat =
## Multiply the quaternion by a quaternion ## Multiply the quaternion by a quaternion.
#[ #[
var q = quat(0,0,0,0) var q = quat(0,0,0,0)
q.w = dot(a.xyz, b.xyz) q.w = dot(a.xyz, b.xyz)
@ -1205,7 +1205,7 @@ proc `*`*(a, b: Quat): Quat =
result.w = a.w * b.w - a.x * b.x - a.y * b.y - a.z * b.z result.w = a.w * b.w - a.x * b.x - a.y * b.y - a.z * b.z
proc `*`*(q: Quat, v: float32): Quat = proc `*`*(q: Quat, v: float32): Quat =
## Multiply the quaternion by a float32 ## Multiply the quaternion by a float32.
result.x = q.x * v result.x = q.x * v
result.y = q.y * v result.y = q.y * v
result.z = q.z * v result.z = q.z * v
@ -1213,7 +1213,7 @@ proc `*`*(q: Quat, v: float32): Quat =
proc `*`*(q: Quat, v: Vec3): Vec3 = proc `*`*(q: Quat, v: Vec3): Vec3 =
## Multiply the quaternion by a vector ## Multiply the quaternion by a vector.
var var
x = v.x x = v.x
y = v.y y = v.y
@ -1446,33 +1446,33 @@ proc rect*(pos, size: Vec2): Rect =
result.h = size.y result.h = size.y
proc xy*(rect: Rect): Vec2 = proc xy*(rect: Rect): Vec2 =
## Gets the xy as a vec2 ## Gets the xy as a Vec2.
vec2(rect.x, rect.y) vec2(rect.x, rect.y)
proc `xy=`*(rect: var Rect, v: Vec2) = proc `xy=`*(rect: var Rect, v: Vec2) =
## Sets the xy from vec2 ## Sets the xy from Vec2.
rect.x = v.x rect.x = v.x
rect.y = v.y rect.y = v.y
proc wh*(rect: Rect): Vec2 = proc wh*(rect: Rect): Vec2 =
## Gets the wh as a vec2 ## Gets the wh as a Vec2.
vec2(rect.w, rect.h) vec2(rect.w, rect.h)
proc `wh=`*(rect: var Rect, v: Vec2) = proc `wh=`*(rect: var Rect, v: Vec2) =
## Sets the wh from vec2 ## Sets the wh from Vec2.
rect.w = v.x rect.w = v.x
rect.h = v.y rect.h = v.y
proc `*`*(r: Rect, v: float): Rect = proc `*`*(r: Rect, v: float): Rect =
## * all elements of a rect ## * all elements of a Rect.
rect(r.x * v, r.y * v, r.w * v, r.h * v) rect(r.x * v, r.y * v, r.w * v, r.h * v)
proc `/`*(r: Rect, v: float): Rect = proc `/`*(r: Rect, v: float): Rect =
## / all elements of a rect ## / all elements of a Rect.
rect(r.x / v, r.y / v, r.w / v, r.h / v) rect(r.x / v, r.y / v, r.w / v, r.h / v)
proc intersects*(rect: Rect, pos: Vec2): bool = proc intersects*(rect: Rect, pos: Vec2): bool =
## Checks if point is inside the rectangle ## Checks if pos is inside rect.
(rect.x <= pos.x and pos.x <= rect.x + rect.w) and ( (rect.x <= pos.x and pos.x <= rect.x + rect.w) and (
rect.y <= pos.y and pos.y <= rect.y + rect.h) rect.y <= pos.y and pos.y <= rect.y + rect.h)

444
tests/vmathtest.nim
View file

@ -1,222 +1,222 @@
# nim c -r --verbosity:0 tests\vmathtest > tests\vmathtest.test.txt; dos2unix tests\vmathtest.test.txt; git diff tests\vmathtest.test.txt # nim c -r --verbosity:0 tests\vmathtest > tests\vmathtest.test.txt; dos2unix tests\vmathtest.test.txt; git diff tests\vmathtest.test.txt
include ../src/vmath include ../src/vmath
randomize(1234) randomize(1234)
block: block:
echo "# angle stuff" echo "# angle stuff"
echo angleBetween(0.1, 0.2), " should be: ", 0.1 echo angleBetween(0.1, 0.2), " should be: ", 0.1
echo angleBetween(0.1, 0.2 + PI*2), " should be: ", 0.1 echo angleBetween(0.1, 0.2 + PI*2), " should be: ", 0.1
echo angleBetween(0.1, 0.2 - PI*2), " should be: ", 0.1 echo angleBetween(0.1, 0.2 - PI*2), " should be: ", 0.1
echo angleBetween(0.1 + PI*2, 0.2), " should be: ", 0.1 echo angleBetween(0.1 + PI*2, 0.2), " should be: ", 0.1
echo angleBetween(0.1 - PI*2, 0.2), " should be: ", 0.1 echo angleBetween(0.1 - PI*2, 0.2), " should be: ", 0.1
echo angleBetween(0.2, 0.1), " should be: ", -0.1 echo angleBetween(0.2, 0.1), " should be: ", -0.1
echo angleBetween(0.2, 0.1 - PI*2), " should be: ", -0.1 echo angleBetween(0.2, 0.1 - PI*2), " should be: ", -0.1
echo angleBetween(0.2, 0.1 + PI*2), " should be: ", -0.1 echo angleBetween(0.2, 0.1 + PI*2), " should be: ", -0.1
echo angleBetween(0.2 + PI*2, 0.1), " should be: ", -0.1 echo angleBetween(0.2 + PI*2, 0.1), " should be: ", -0.1
echo angleBetween(0.2 - PI*2, 0.1), " should be: ", -0.1 echo angleBetween(0.2 - PI*2, 0.1), " should be: ", -0.1
block: block:
echo "# basic vector vec2" echo "# basic vector vec2"
var a = vec2(1, 2) var a = vec2(1, 2)
var b = vec2(7, 6) var b = vec2(7, 6)
var n = 13.7 var n = 13.7
echo a + b echo a + b
echo a - b echo a - b
echo a * n echo a * n
echo a / n echo a / n
a += b a += b
echo a echo a
a -= b a -= b
echo a echo a
a *= n a *= n
echo a echo a
a /= n a /= n
echo a echo a
block: block:
echo "# basic vector vec3" echo "# basic vector vec3"
var a = vec3(1, 2, 3) var a = vec3(1, 2, 3)
var b = vec3(7, 6, 5) var b = vec3(7, 6, 5)
var n = 13.7 var n = 13.7
echo a + b echo a + b
echo a - b echo a - b
echo a * n echo a * n
echo a / n echo a / n
a += b a += b
echo a echo a
a -= b a -= b
echo a echo a
a *= n a *= n
echo a echo a
a /= n a /= n
echo a echo a
block: block:
echo "# basic vector vec4" echo "# basic vector vec4"
var a = vec4(1, 2, 3, 4) var a = vec4(1, 2, 3, 4)
var b = vec4(7, 6, 5, 4) var b = vec4(7, 6, 5, 4)
var n = 13.7 var n = 13.7
echo a + b echo a + b
echo a - b echo a - b
echo a * n echo a * n
echo a / n echo a / n
a += b a += b
echo a echo a
a -= b a -= b
echo a echo a
a *= n a *= n
echo a echo a
a /= n a /= n
echo a echo a
block: block:
echo "# basic vector mat4" echo "# basic vector mat4"
var m1 = mat4( var m1 = mat4(
1, 0, 0, 0, 1, 0, 0, 0,
0, 1, 0, 0, 0, 1, 0, 0,
0, 0, 1, 0, 0, 0, 1, 0,
0, 0, 0, 1) 0, 0, 0, 1)
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# basic vector mat4 -1" echo "# basic vector mat4 -1"
var m1 = mat4( var m1 = mat4(
1, 0, 0, 0, 1, 0, 0, 0,
0, 0, -1, 0, 0, 0, -1, 0,
0, 1, 0, 0, 0, 1, 0, 0,
0, 0, 0, 1) 0, 0, 0, 1)
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# Y 90" echo "# Y 90"
var m1 = rotate(PI/2, vec3(0, 1, 0)) var m1 = rotate(PI/2, vec3(0, 1, 0))
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# -Y 90" echo "# -Y 90"
var m1 = rotate(PI/2, vec3(0, -1, 0)) var m1 = rotate(PI/2, vec3(0, -1, 0))
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# X 90" echo "# X 90"
var m1 = rotate(PI/2, vec3(1, 0, 0)) var m1 = rotate(PI/2, vec3(1, 0, 0))
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
echo m1.close(m2) echo m1.close(m2)
block: block:
echo "# Y 90" echo "# Y 90"
var m1 = rotate(PI/2, vec3(1, 0, 0)) var m1 = rotate(PI/2, vec3(1, 0, 0))
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
echo m1.close(m2) echo m1.close(m2)
block: block:
echo "# 1,1,1 1.11rad" echo "# 1,1,1 1.11rad"
var m1 = rotate(PI*1.11, vec3(1, 1, 1).normalize()) var m1 = rotate(PI*1.11, vec3(1, 1, 1).normalize())
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# 1,1,1 1.11rad" echo "# 1,1,1 1.11rad"
var m1 = rotate(PI*1.11, vec3(-1, 1, 1).normalize()) var m1 = rotate(PI*1.11, vec3(-1, 1, 1).normalize())
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# 1,1,1 1.11rad" echo "# 1,1,1 1.11rad"
var m1 = rotate(PI*1.11, vec3(-1, 0.34, 1.123).normalize()) var m1 = rotate(PI*1.11, vec3(-1, 0.34, 1.123).normalize())
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# super random" echo "# super random"
for i in 0..100: for i in 0..100:
var m1 = rotate(PI*rand(2.0), vec3(rand(2.0)-0.5, rand(2.0)-0.5, rand(2.0)-0.5).normalize()) var m1 = rotate(PI*rand(2.0), vec3(rand(2.0)-0.5, rand(2.0)-0.5, rand(2.0)-0.5).normalize())
echo m1 echo m1
var q1 = m1.quat() var q1 = m1.quat()
echo q1 echo q1
var m2 = q1.mat4() var m2 = q1.mat4()
echo m2 echo m2
assert m1.close(m2) assert m1.close(m2)
block: block:
echo "# matrix to quat test" echo "# matrix to quat test"
# TODO: Fix this test # TODO: Fix this test
# var m1 = mat4( # var m1 = mat4(
# -0.33089, -0.51266, -0.79227, 0.00000, # -0.33089, -0.51266, -0.79227, 0.00000,
# 0, -1.0, 0, 0.00000, # 0, -1.0, 0, 0.00000,
# 0, 0, 1.0, 0.00000, # 0, 0, 1.0, 0.00000,
# 0.00000, 0.00000, 0.00000, 1.00000) # 0.00000, 0.00000, 0.00000, 1.00000)
# echo m1 # echo m1
# var q1 = m1.quat() # var q1 = m1.quat()
# echo q1 # echo q1
# var m2 = q1.mat4() # var m2 = q1.mat4()
# echo m2 # echo m2
# assert m1.close(m2) # assert m1.close(m2)
block: block:
echo "# matrix to quat test" echo "# matrix to quat test"
# TODO: Fix this test # TODO: Fix this test
# var m1 = mat4( # var m1 = mat4(
# -0.33089, -0.51266, -0.79227, 0.00000, # -0.33089, -0.51266, -0.79227, 0.00000,
# -0.44681, 0.82460, -0.34697, 0.00000, # -0.44681, 0.82460, -0.34697, 0.00000,
# -0.83119, -0.23918, 0.50191, 0.00000, # -0.83119, -0.23918, 0.50191, 0.00000,
# 0.00000, 0.00000, 0.00000, 1.00000) # 0.00000, 0.00000, 0.00000, 1.00000)
# echo vec3( -0.33089, -0.51266, -0.79227).length # echo vec3( -0.33089, -0.51266, -0.79227).length
# echo vec3( -0.44681, 0.82460, -0.34697).length # echo vec3( -0.44681, 0.82460, -0.34697).length
# echo vec3( -0.83119, -0.23918, 0.50191).length # echo vec3( -0.83119, -0.23918, 0.50191).length
# echo m1 # echo m1
# var q1 = m1.quat().normalize() # var q1 = m1.quat().normalize()
# echo q1 # echo q1
# var m2 = q1.mat4() # var m2 = q1.mat4()
# echo m2 # echo m2
# assert m1.close(m2) # assert m1.close(m2)

2
tests/vmathtest.nims
View file

@ -1 +1 @@
switch("path", "$projectDir/../src") switch("path", "$projectDir/../src")

1
vmath.nimble
View file

@ -9,3 +9,4 @@ srcDir = "src"
# Dependencies # Dependencies
requires "nim >= 0.19.1" requires "nim >= 0.19.1"
requires "mddoc >= 0.0.2"