Skip to content

Commit

Permalink
Slightly improved readme (#259)
Browse files Browse the repository at this point in the history 
* Slightly improved readme

* Switched from tabs to spaces

* Added linebreak for improved readability
  • Loading branch information
@Zuzu-Typ
Zuzu-Typ authored Oct 14, 2024
1 parent 03ccf9b commit 3ac2777
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 32 deletions.
71 changes: 56 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,21 @@ At the same time, it has **great performance**, usually being **a lot faster tha
It can be installed from the [PyPI](https://pypi.python.org/pypi/PyGLM) using [pip](https://pip.pypa.io/en/stable/):
``` batch
pip install PyGLM
# please make sure to install "PyGLM" and not "glm", which is a different module
```
And finally imported and used:
``` python
from PyGLM import glm
```
*Changed in version 2\.8*
When using PyGLM version *2\.7\.3* or earlier, use
``` python
try:
from PyGLM import glm
except ImportError:
import glm
```

**Attention: Using ``` import glm ``` will be deprecated in PyGLM 3\.0\.**
### Using PyGLM
PyGLM's syntax is very similar to the original GLM's syntax\.
The module ``` glm ``` contains all of PyGLM's types and functions\.
Expand Down Expand Up @@ -103,22 +112,54 @@ I try adding them on a one\-by\-one basis\.

### Short example
``` Python
>>> from PyGLM import glm
>>> v = glm.vec3()
>>> v.x = 7
>>> print(v.xxy)
vec3( 7, 7, 0 )
from PyGLM import glm

# Create a 3D vector
v1 = glm.vec3(1, 2, 3)
v2 = glm.vec3(4, 5, 6)

# Vector addition
v3 = v1 + v2
print(f"Vector addition: {v3}")
# Vector addition: vec3( 5, 7, 9 )

# Vector cross product
# -> The resulting vector is perpendicular to v1 and v2.
cross_product = glm.cross(v1, v2)
print(f"Cross product: {cross_product}")
# Cross product: vec3( -3, 6, -3 )

# Vector dot product
# -> If the dot product is equal to 0, the two inputs are perpendicular.
dot_product = glm.dot(v1, cross_product)
print(f"Dot product: {dot_product}")
# Dot product: 0.0

# Create a 4x4 identity matrix
matrix = glm.mat4()
print(f"Identity matrix:\n{matrix}")
# Identity matrix:
# [ 1 ][ 0 ][ 0 ][ 0 ]
# [ 0 ][ 1 ][ 0 ][ 0 ]
# [ 0 ][ 0 ][ 1 ][ 0 ]
# [ 0 ][ 0 ][ 0 ][ 1 ]

>>> m = glm.mat4()
>>> print(m)
[ 1 | 0 | 0 | 0 ]
[ 0 | 1 | 0 | 0 ]
[ 0 | 0 | 1 | 0 ]
[ 0 | 0 | 0 | 1 ]
# Rotate the matrix around the Z-axis
angle_in_radians = glm.radians(45) # Convert 45 degrees to radians
rotation_matrix = glm.rotate(matrix, angle_in_radians, glm.vec3(0, 0, 1))
print(f"Rotation matrix (45 degrees around Z-axis):\n{rotation_matrix}")
# Rotation matrix (45 degrees around Z-axis):
# [ 0.707107 ][ -0.707107 ][ 0 ][ 0 ]
# [ 0.707107 ][ 0.707107 ][ 0 ][ 0 ]
# [ 0 ][ 0 ][ 1 ][ 0 ]
# [ 0 ][ 0 ][ 0 ][ 1 ]

>>> v = glm.vec4(1, 2, 3, 4)
>>> print(v + (8, 7, 6, 5))
vec4( 9, 9, 9, 9 )
# Apply the rotation to a vector
# -> We use a vec4 with the w-component (given vec4(x, y, z, w)) set to 1,
# to put v1 into homogenous coordinates.
rotated_vector = rotation_matrix * glm.vec4(v1, 1)
print(f"Rotated vector: {rotated_vector}")
# Rotated vector: vec4( -0.707107, 2.12132, 3, 1 )
```

### PyGLM in action
Expand Down
75 changes: 58 additions & 17 deletions README.sb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,21 @@ At the same time, it has \b \great performance\ b\, usually being \b \a lot fast
It can be installed from the \url https://pypi.python.org/pypi/PyGLM \PyPI\ url\ using \url https://pip.pypa.io/en/stable/ \pip\ url\:
\code batch\
pip install PyGLM
# please make sure to install "PyGLM" and not "glm", which is a different module
\ code\
And finally imported and used:
\code python \
from PyGLM import glm
\ code\
\i\Changed in version 2.8\i\
When using PyGLM version \i \2.7.3\ i\ or earlier, use
\code python \
try:
from PyGLM import glm
except ImportError:
import glm
\ code\

\b \Attention: Using \code \import glm\ code\ will be deprecated in PyGLM 3.0.\ b\
\h3 \Using PyGLM\ h3\
PyGLM's syntax is very similar to the original GLM's syntax.
The module \code \glm\ code\ contains all of PyGLM's types and functions.
Expand Down Expand Up @@ -101,22 +110,54 @@ I try adding them on a one-by-one basis.

\h3 \Short example\ h3\
\code Python \
>>> from PyGLM import glm
>>> v = glm.vec3()
>>> v.x = 7
>>> print(v.xxy)
vec3( 7, 7, 0 )

>>> m = glm.mat4()
>>> print(m)
[ 1 | 0 | 0 | 0 ]
[ 0 | 1 | 0 | 0 ]
[ 0 | 0 | 1 | 0 ]
[ 0 | 0 | 0 | 1 ]

>>> v = glm.vec4(1, 2, 3, 4)
>>> print(v + (8, 7, 6, 5))
vec4( 9, 9, 9, 9 )
from PyGLM import glm

# Create a 3D vector
v1 = glm.vec3(1, 2, 3)
v2 = glm.vec3(4, 5, 6)

# Vector addition
v3 = v1 + v2
print(f"Vector addition: {v3}")
# Vector addition: vec3( 5, 7, 9 )

# Vector cross product
# -> The resulting vector is perpendicular to v1 and v2.
cross_product = glm.cross(v1, v2)
print(f"Cross product: {cross_product}")
# Cross product: vec3( -3, 6, -3 )

# Vector dot product
# -> If the dot product is equal to 0, the two inputs are perpendicular.
dot_product = glm.dot(v1, cross_product)
print(f"Dot product: {dot_product}")
# Dot product: 0.0

# Create a 4x4 identity matrix
matrix = glm.mat4()
print(f"Identity matrix:\\n{matrix}")
# Identity matrix:
# [ 1 ][ 0 ][ 0 ][ 0 ]
# [ 0 ][ 1 ][ 0 ][ 0 ]
# [ 0 ][ 0 ][ 1 ][ 0 ]
# [ 0 ][ 0 ][ 0 ][ 1 ]

# Rotate the matrix around the Z-axis
angle_in_radians = glm.radians(45) # Convert 45 degrees to radians
rotation_matrix = glm.rotate(matrix, angle_in_radians, glm.vec3(0, 0, 1))
print(f"Rotation matrix (45 degrees around Z-axis):\\n{rotation_matrix}")
# Rotation matrix (45 degrees around Z-axis):
# [ 0.707107 ][ -0.707107 ][ 0 ][ 0 ]
# [ 0.707107 ][ 0.707107 ][ 0 ][ 0 ]
# [ 0 ][ 0 ][ 1 ][ 0 ]
# [ 0 ][ 0 ][ 0 ][ 1 ]

# Apply the rotation to a vector
# -> We use a vec4 with the w-component (given vec4(x, y, z, w)) set to 1,
# to put v1 into homogenous coordinates.
rotated_vector = rotation_matrix * glm.vec4(v1, 1)
print(f"Rotated vector: {rotated_vector}")
# Rotated vector: vec4( -0.707107, 2.12132, 3, 1 )
\ code\

\h3\PyGLM in action\h3\
Expand Down

0 comments on commit 3ac2777

Please sign in to comment.