Merge branch 'main' into experimental

README.md

@@ -1,92 +1,58 @@
-# Manigraph: Graficadora de variedades
+# Manigraph
-Diaz Camacho Pedro Emilio
+Manigraph is a cutting-edge tool for multidimentional surface visualization,
+capable of handling over a hundred dimensions. It allows users to interactively
+explore each dimension in an intuitive and dynamic way. 
+Import your .klein files, which represents multidimentional surface.
 
-# Resumen
+# Building
-manigraph es un graficador interactiva de variedades que lee archivos binarios, con la información de
+Manigraph is written in C99, and uses OpenGL 2.0 for the rendering. So you just
-una variedad multidimensional y grafica esta variedad en una proyección tridimensional.
+need a C compiler to build this project.
 
-# Dependencias
+## Source code
-Para poder compilar el proyecto hace falta lo siguiente.
-## Programas
-- `cc`: Cualquier compilador de C.
-- `git`: Gestor de dependencias. (Opcional)
-- `make`: Herramienta para compilar automáticamente. (Opcional) 
-
-## Librerías
-- `openGL`: A cross-platform API for rendering 2D and 3D graphics. (no incluida)
-- `glew`: The OpenGL Extension Wrangler Library (no incluida)
-- `glfw`: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input.
-- `cglm`: Highly Optimized 2D / 3D Graphics Math (glm) for C.
-### Linux
-Para compilar `glfw` en linux hacen falta las siguientes librerías. (no incluidas)
-- `x11`: libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
-- `wayland`: libwayland-dev libxkbcommon-dev wayland-protocols
-
-# Descargas
-- [git](https://git-scm.com/downloads/win)
-- [MinGW](https://github.com/niXman/mingw-builds-binaries/releases)
-- [glew](https://glew.sourceforge.net/)
-
-# Clonar el código fuente
 ```
-git clone https://gitea.adles.top/software/manigraph.git
+git clone https://gitea.axiolutions.top/software/manigraph.git
 cd manigraph
 git submodule update --init --recursive
 ```
 
-# Compilación
+##  Dependecies
-Para compilar manualmente el proyecto se puede usar `make` o ejecutar los comandos manualmente
+You may need system specific dependecies to build *Manigraph*. 
-en el código fuente de `manigraph`.
+[Reference](https://www.glfw.org/docs/3.3/compile.html#compile_deps)
 
-## Make
+### Linux
-Los siguientes comandos sirven para compilar `manigraph` deacuerdo al sistema operativo.
+- `x11`: libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
+- `wayland`: libwayland-dev libxkbcommon-dev wayland-protocols
+
+## Commands
+A C compiler is needed for building *Manigraph*. and any of those commands
 
 ```
 make windows
+./compile.bat
 make linux-x11
 make linux-wayland
 make cocoa
+make CC=emcc wasm
 ```
 
-## Manualmente
+# Design
-se pueden compilar el proyecto  manualmente sin necesidad del programa `make`.
+Manigraph is a program designed with sustainability in mind. It is built to be 
+portable, resource-efficient, and easy to maintain and scale. The program 
+follows a Data-Oriented Programming (DOP) paradigm, where each file is 
+responsible for a specific data type and manages its own dependencies. Each 
+function is named after the file it resides in, ensuring a clear organization
+and structure.
 
-### GLFW
+The independence of data types allows for efficient scaling and maintenance. 
-Si tienes problemas compilando `GLFW` puedes checar su página web oficial
+The main file is a special case in this design: it is responsible for combining
-explicando el tema: [Compiling GLFW](https://www.glfw.org/docs/3.3/compile.html).
+all the data types in a comprehensive manner, actng as the workflow of the program.
 
-#### Windows
+# Contributing
-```
+Before commiting use `clang-format`, for coding style consistency. Your 
-cc -fPIC -shared -D_GLFW_WIN32 -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o glfw.dll -lgdi32
+contribution must be whitin the design principles and the concept of Manigraph.
-```
 
-#### Linux
+The following diagram illustrates the relationships between files, showing how 
-```
+they are connected through dependencies. It also highlights the scenarios where
-cc -fPIC -shared -D_GLFW_X11 -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o libglfw.so
+files are not independent of one another,
-cc -fPIC -shared -D_GLFW_WAYLAND -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o libglfw.so
-```
 
-#### Mac
+![File layout](doc/file_layout.svg)
-```
-cc -fPIC -shared -D_GLFW_COCOA -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o libglfw.so
-```
-
-### Manigraph
-#### Windows
-```
-cc -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph -L. -lglfw -lopengl32 -lglew32
-```
-#### Linux
-```
-cc -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph -L. -lglfw -lGL -lGLEW
-```
-#### Mac
-```
-cc -framework GL -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph -L. -lglfw -lGLEW
-```
-
-# Ejecutar
-En linux se puede ejecutar el programa sin instalar la libreria de glfw usando:
-```
-LD_LIBRARY_PATH=. ./manigraph
-```

doc/es/dev/estructura-archivos.md

@@ -1,80 +0,0 @@
-# Estructura de archivos
-Díaz Camacho Pedro Emilio
-
-# Headers
-## main.h
-Este archivo incluye los prototipos internos, que va a usar el programa
-funge como api interna para los desarrolladores y debe estar bien documentada.
-
-# codigo fuente
-
-## main.c
-Este archivo debe configurar el programa antes de iniciarse, avisar de los problemas
-que eviten que el programa se ejecute correctamente, iniciar y terminar los objetos que use el
-programa, así como ejecutar la función principal
-### Depende de
-- <GL/gl.h>
-
-## context.c
-En este archivo se escoge un color para limpiar la pantalla y tiene una función para limpiar
-tanto lo dibujado en pantalla, como distintos buffers gráficos.
-### Depende de
-- <GL/gl.h>
-
-## input.c
-Incluye la función `poll_input`, que se ejecuta en cada ciclo del programa y devuelve un
-cuaternion de tipo `float *` que representa la rotación total del cubo, después de interactuar 
-con el programa.
-### Depende de
-- <GLFW/glfw3.h>
-- <cglm/quat.h>
-
-## matrix.c
-Incluye las funciónes para configurar y cargar en la GPU las 3 matrices principales.
-- `fix_matrix` esta matriz no cambia y se usa para configurar la perspectiva y la vista que
-va a usar el programa en todo momento.
-- `mdl_matrix` esta matriz depende de cada mesh y describe la rotación única de cada objeto,
-se usa para rotar los ejes ortogonamente con un indice.
-- `rot_matrix` esta matriz describe la rotación total de todos los objetos y se configura con
-un cuaternio
-### Depende de
-- <cglm/mat4.h>
-- <cglm/cam.h>
-- <cglm/quat.h>
-
-## mesh.c
-Este archivo se usa para crear, destruir y dibujar objetos de tipo `mesh`, un `mesh` es una
-colección de triángulos que describen un objeto multidimensional.
-### Depende de
-- <GL/gl.h>
-- <stdlib.h>
-
-## shader.c
-Debe crear, destruir y usar los shaders, estos shaders son programas para la gpu escritos en glsl para
-además aquí se carga memoria en gpu con las funciónes `gload_`
-### Depende de
-- <GL/gl.h>
-
-## texture.c
-Debe cargar, usar y destruir las texturas, que va a usar la gpu,  también crea una textura 
-para una paleta de colores definida, esto para manipular fácilmente los colores que usará el programa.
-### Depende de
-- <GL/gl.h>
-
-## window.c
-Crea, usa, limpie y cierra una ventana, una ventana tiene un contexto de OpenGL asociado para poder
-dibujar objetos en ella, tiene una función especial para avisar si la ventana está abierta para
-dibujar.
-### Depende de
-- <GLFW/glfw3.h>
-
-# Datos
-## data/cube.h
-Aquí esta la información del mesh de un cubo, este se va a borrar cuando podamos
-importar meshes para graficarlos.
-
-## data/axis.h
-Aquí está el mesh de un solo eje, este se va a rotar para hacer los otros 2 ejes.
-
-## data/shaders.h
-Aquí estan los shaders en glsl para dibujar en pantalla

doc/es/dev/tipos.md

@@ -1,43 +0,0 @@
-# Tipos de datos del proyecto
-Díaz Camacho Pedro Emilio
-
-# Introducción
-En este archivo vamos a detallar los tipos de datos únicos del programa, estos
-tipos de datos son estructuras que representan objetos computacionales y son
-necesarios para integrar las distintas partes del programa.
-
-## window_t
-En `window.c` tenemos una estructura que es la ventana y esta se representa por `window_t`,
-este tipo de dato es un pointer que es manejado por `glfw`.
-
-## id_t
-`id_t` es un tipo de dato que representa objetos de `OpenGL`, estos datos
-normalmente vienen enumerados, y en `manigraph` se usan para representar `shaders`, 
-`programs` y `texture`.
-
-## mesh_t
-Este es un tipo de dato usado para interactuar con `mesh.c`, este representa la triangulación de un
-objeto gráfico y funciona ocultando las variables que `OpenGL` necesita en un `void *`.
-
-## mat4_t
-`mat4_t` se usará para representar las matrices, se usará este tipo de dato exclusivamente
-en `matrix.c` y funcionará con el tipo de dato `mat4` de `cglm`.
-
-## quat_t
-Este tipo de dato sirve para representar un quaternio, este quaternio representa la rotación
-del objeto gráficado en la proyección tridimensional, y se usará para crear una matriz que
-pueda entender `glsl`.
-
-## narray
-`narray` es un tipo de dato que funciona como un `array` enumerado, esto significa que el primer
-elemento del `array` dice cuantos elementos tiene este, sin contar el primer elemento, y los demas elementos 
-funcionan como un `array` normal. 
-
-esta estructura nos ayuda a trabajar con arrays de tamaños arbitrario de forma óptima y sin tener que marcar el
-último elemento de forma especial.
-
-### narray_u8_t
-es un `narray` para `char` y `unsigned char`.
-### narray_float_t
-es un `narray` para `float`.
-

doc/es/tech/diseno.md

@@ -1,59 +0,0 @@
-# Manual de Diseño
-Diaz Camacho Pedro Emilio
-
-# Objetivos
-## Prioridad alta
-- [ ] El programa debe actualizarse cuando interactuan con el.
-- [ ] El usuario quiere:
-	- [X] Ver 3 ejes en todo momento.
-	- [ ] Ver que ejes esta viendo.
-	- [ ] Ver cuantos ejes hay.
-- [X] El usuario quiere:
-	- [X] Rotar estos ejes,
-	- [X] Ver donde quedan los ejes despues de la rotados.
-- [ ] El usuario experimentado quiere ejecutar el programa y pasar la variedad:
-	- [ ] Como argumento del programa.
-	- [ ] Desde la entrada estandar del programa.
-
-## Prioridad media
-
-- [ ] El usuario quiere:
-	- [ ] Cambiar los ejes que se ven por pares.
-	- [ ] Cambiar los ejes donde esta la informacion de los ejes.
-- [ ] El usuario quiere interactuar con el programa:
-	- [ ] Usando solo el mouse.
-	- [ ] Usando solo el teclado.
-
-## Prioridad baja
-- [ ] El usuario quiere guardar las transformaciones como un archivo GIF.
-
-# Camino
-
-0. Graficadora de un cubo.
-	1. Se hace un programa que muestre un cubo.
-	1. Se muestran los 3 ejes del cubo
-	1. Se rota el cubo en sus 3 ejes usando el teclado.
-	1. Se rota el cubo en sus 3 ejes usando el mouse.
-	1. Se muestran la etiqueta de los ejes.
-	1. Se hace el formato de objetos multidimensionales.
-0. Programa ejemplo
-	1. Se hace un programa que divida un cuadrado en triangulos.
-	1. Se mapea cada vertice del triangulo en un punto de la cinta de 
-	mobius usando una parametrizacion
-	1. Se mapea cada vertice del triangulo en un punto de la botella de
-		klein usando una parametrizacion
-	1. Se divide cada lado de un cubo de n dimensiones, en triangulos.
-
-0. Graficadora de variedades
-	1. Se generaliza el programa para usar este formato.
-	1. Se muestran la informacion de los ejes mostrados y cuantos hay.
-	1. Se pueden cambiar los ejes por pares
-		1. Usando el mouse.
-		1. Usando el teclado.
-0. Detalles.
-	1. Se anima el cambio de eje.
-	1. Se hace el generador de GIF.
-	1. Se puede cambiar el shader 
-	1. Documentacion
-
-

doc/es/tech/problemas.md

@@ -1,22 +0,0 @@
-# Problemas esperados al desarrollar
-Diaz Camacho Pedro Emilio
-
-## OpenGL esperan objetos tridimensionales, no de n dimensiones.
-
-Usando glVertexAttribPointer podemos pasar las coordenadas que 
-queramos de los puntos de las variedades, y con ello usar objetos 3D en
-el shader.
-
-## Rotar ejes por pares en una animacion continua.
-- Con glVertexAttribPointer podemos pasar las coordenadas del eje 
-seleccionado, al shader.
-- Con la funcion mix del shader y bloqueando el input, podemos hacer 
-una animacion pasando una variable con la cpu.
-- Cuando la animacion termine intercambiar los indices del layout, 
-usando glVertexAttribPointer otra vez.
-
-## Volumen de la variedad.
-Dado que la funcion parametrizadora es continua, mandamos la frontera
-de un n-cubo a la frontera de una variedad, por lo que solo basta 
-graficar la frontera de la variedad.
-

doc/es/user.md

@@ -1,19 +0,0 @@
-# Manual de usario para Manigraph
-Manigraph es un graficador interactivo de variedades que lee archivos
-binarios de una variedad multidimensional y los proyecta a 3 dimensiones.
-
-# Glosario
-Llamaremos a los 3 ejes de la proyección tridimensional `X`, `Y` y `Z`,
-este sistema de coordenadas es derecho con el eje `Z` apuntando afuera de la pantalla
-
-# Controles
-## Teclado
-- `Q` Rota el eje `X` de forma horaria.
-- `W` Rota el eje `X` de forma antihoraria.
-- `A` Rota el eje `Y` de forma horaria.
-- `S` Rota el eje `Y` de forma antihoraria.
-- `Z` Rota el eje `Z` de forma horaria.
-- `X` Rota el eje `Z` de forma antihoraria.
-## Mouse
-- Hacer `click` en un eje lo selecciona.
-- El `scroll` del mouse hace girar al eje seleccionado.

example/lens.c

@@ -0,0 +1,54 @@
+#include <math.h>
+#include <stdio.h>
+
+#define KLEIN_IMPLEMENT
+#include <klein/klein.h>
+#include <klein/norm.h>
+#include <klein/parm.h>
+
+int p = 37;
+int q = 1;
+
+void lens(float *d_surface, int *coord, unsigned char * grid)
+{
+
+	float norm = 0;
+	float sphere[4];
+
+	for (int i = 0; i < 4; i++)
+		sphere[i] = ((float)coord[i] / grid[i]) - 0.5;
+
+	for(int i = 0; i < 4; i++)
+		norm += sphere[i] * sphere[i];
+
+	for (int i = 0; i < 4; i++)
+		sphere[i] = sphere[i] / sqrt(norm);
+	
+	d_surface[0] = (sphere[0] * cos(2 * M_PI / p)) - (sphere[1] * sin(2 * M_PI / p));
+	d_surface[1] = (sphere[0] * sin(2 * M_PI / p)) + (sphere[1] * cos(2 * M_PI / p));
+	d_surface[2] = (sphere[2] * cos(2 * M_PI * q / p)) - (sphere[3] * sin(2 * M_PI * q / p));
+	d_surface[3] = (sphere[2] * sin(2 * M_PI * q / p)) + (sphere[3] * cos(2 * M_PI * q / p));
+}
+
+int main(void)
+{
+	char file_name[0xff];
+	struct klein klein;
+	struct parm parametrization = {
+		.grid = (unsigned char[]){8, 8,8,8},
+		.m = 4,
+		.n = 4,
+		.f = lens,
+	};
+
+	snprintf(file_name, 0xff, "%03d-%03d-cube.klein", p, q);
+	printf("writing %s\n", file_name);
+
+	klein_parametrize(&klein, parametrization);
+	klein_normalize(&klein);
+	klein_export_file(klein, file_name);
+
+	free(klein.vertex);
+	free(klein.normals);
+	return 0;
+}

include/klein/norm.h

@@ -1,3 +1,16 @@
+#ifdef KLEIN_NORM_H
+#error file included twice
+#endif
+#define KLEIN_NORM_H
+
+
+#ifndef KLEIN_H
+#warning Please include klein/klein.h
+#endif
+
+void klein_normalize(struct klein * klein);
+
+#ifdef KLEIN_IMPLEMENT
 static inline
 void __calculate_normal( float *p1, float *p2, float *p3, float *normal, unsigned char n)
 { unsigned char i;
@@ -116,3 +129,4 @@ void klein_normalize(struct klein * klein)
 
 	free(norm_vec);
 }
+#endif