Make doc directory

doc/design.nr

@@ -0,0 +1,310 @@
+.PP CB
+manigraph: Manual de Diseno ( ver 1.0 )
+.PP C
+Diaz Camacho Pedro Emilio
+
+.SH 1
+Resumen
+.PP
+manigraph es un graficador de variedades que lee archivos binarios con un forma
+to espacial, este viene con un manual explicando como correr el programa, como
+interactuar con el programa y las especificaciones del archivo binario.
+
+.NH 1
+Tecnologias
+.NH 2
+Lenguajes:
+.QS *
+	.IP 
+	C89
+.QE
+
+.NH 2
+Librerias:
+.QS *
+	.IP 
+	OpenGL
+	.IP
+	GLFW
+	.IP
+	cglm
+.QE
+
+.NH 1
+Archivos
+.QS *
+	.IP 
+	Ejecutable.
+	.IP 
+	Ejemplo.
+	.QS *
+		.IP 
+		Una libreria tipo STB, con las funciones para hacer variedades con una
+		funcion parametrizadora.
+		.IP 
+		LA PARAMETRIZACION DEBE SER CONTINUA.
+		.IP
+		El codigo fuente de un programa que cree la variedad de una botella 
+		de klein usando esta libreria.
+	.QE
+	.IP 
+	Manual
+	.QS *
+		.IP 
+		Explicando como correr el programa desde la terminal.
+		.IP 
+		Explicando como interactuar con el programa con el teclado y mouse.
+		.IP 
+		Explicando el formato binario de las variedaedes.
+		.IP 
+		Explicando la libreria STB.
+	.QE
+.QE
+
+.NH 1
+Objetivos
+.NH 2
+Prioridad alta
+.QS _
+	.IP
+	El programa debe actualizarse cuando interactuan con el.
+	.IP
+	El usuario quiere:
+	.QS _
+		.IP X
+		Ver 3 ejes en todo momento.
+		.IP
+		Ver que ejes esta viendo.
+		.IP
+		Ver cuantos ejes hay.
+	.QE
+	.IP X
+	El usuario quiere:
+	.QS X
+		.IP
+		Rotar estos ejes,
+		.IP
+		Ver donde quedan los ejes despues de la rotados.
+	.QE
+	.IP
+	El usuario experimentado quiere ejecutar el programa y pasar la variedad:
+	.QS  _
+		.IP
+		Como argumento del programa.
+		.IP
+		Desde la entrada standar del programa.
+	.QE
+.QE
+
+.NH 2	
+Prioridad media
+
+.QS _
+	.IP
+	El usuario quiere:
+	.QS _
+		.IP
+		Cambiar los ejes que se ven por pares.
+		.IP
+		Cambiar los ejes donde esta la informacion de los ejes.
+	.QE
+	.IP
+	El usuario quiere interactuar con el programa:
+	.QS _
+		.IP
+		Usando solo el mouse.
+		.IP X
+		Usando solo el teclado.
+	.QE
+.QE
+
+.NH 2	
+Prioridad baja
+.QS _
+	.IP 
+	El usuario quiere guardar las transformaciones como un archivo GIF.
+.QE
+
+.NH 1
+Camino
+
+.QS
+	.IP 0
+	Graficadora de un cubo.
+	.QS
+		.IP
+		Se hace un programa que muestre un cubo.
+		.IP
+		Se muestran los 3 ejes del cubo
+		.IP
+		Se rota el cubo en sus 3 ejes usando el teclado.
+		.IP 
+		Se rota el cubo en sus 3 ejes usando el mouse.
+		.IP
+		Se muestran la etiqueta de los ejes.
+		.IP
+		Se hace el formato de objetos multidimensionales.
+	.QE
+	.IP
+	Programa ejemplo
+	.QS
+		.IP
+		Se hace un programa que divida un cuadrado en triangulos.
+		.IP
+		Se mapea cada vertice del triangulo en un punto de la cinta de 
+		mobius usando una parametrizacion
+		.IP
+		Se mapea cada vertice del triangulo en un punto de la botella de
+		klein usando una parametrizacion
+		.IP
+		Se divide cada lado de un cubo de n dimensiones, en triangulos.
+	.QE
+
+	.IP
+	Graficadora de variedades
+	.QS
+		.IP
+		Se generaliza el programa para usar este formato.
+		.IP
+		Se muestran la informacion de los ejes mostrados y cuantos hay.
+		.IP
+		Se pueden cambiar los ejes por pares
+		.QS
+			.IP
+			Usando el mouse.
+			.IP
+			Usando el teclado.
+		.QE
+	.QE
+
+	.IP
+	Detalles.
+	.QS
+		.IP
+		Se anima el cambio de eje.
+		.IP
+		Se hace el generador de GIF.
+		.IP
+		Se puede cambiar el shader 
+		.IP
+		Documentacion
+	.QE
+
+.QE
+
+.NH 1
+Cronograma
+.PP
+.TS lclc
+	.CS
+		.CL
+		Persona
+		.CL
+		Ver
+		.CL
+		Objetivo
+		.CL
+		Fecha
+	.CE
+	.CS
+		.CL		
+		Alan
+		.CL
+		.CL
+		Familiarizarse con el codigo
+		.CL
+		15-Sep-2024
+	.CE
+	.CS
+		.CL
+		.CL
+		3.1
+		.CL
+		Sombreado
+		.CL
+		17-Nov-2024
+	.CE
+	.CS
+		.CL
+		Francisco
+		.CL
+		.CL
+		Familiarizarse con el codigo
+		.CL
+		15-Sep-2024
+	.CE
+	.CS
+		.CL
+		.CL
+		0.4	
+		.CL
+		Seleccionar ejes con el mouse
+		.CL
+		29-Sep-2024
+	.CE
+	.CS
+		.CL
+		.CL
+		0.4
+		.CL
+		Rotar ejes con el scroll del mouse
+		.CL
+		13-Oct-2024	
+	.CE
+	.CS
+		.CL
+		Roberto
+		.CL
+		.CL
+		Familiarizarse con el codigo
+		.CL
+		15-Sep-2024
+	.CE
+		.CL
+		.CL
+		1.2
+		.CL
+		Programa ejemplo mobius
+		.CL
+		13-Oct-2024
+	.CS
+		.CL
+		.CL
+		1.3
+		.CL
+		Programa ejemplo klein
+		.CL
+		20-Oct-2024
+	.CE
+.TE
+
+.NH 1
+Problemas
+.NH 2
+OpenGL esperan objetos tridimensionales, no de n dimensiones.
+.PP
+Usando glVertexAttribPointer podemos pasar las coordenadas que 
+queramos de los puntos de las variedades, y con ello usar objetos 3D en
+el shader.
+
+.NH 2
+Rotar ejes por pares en una animacion continua.
+.QS
+	.IP
+	Con glVertexAttribPointer podemos pasar las coordenadas del eje 
+	seleccionado, al shader.
+	.IP
+	Con la funcion mix del shader y bloqueando el input, podemos hacer 
+	una animacion pasando una variable con la cpu.
+	.IP
+	Cuando la animacion termine intercambiar los indices del layout, 
+	usando glVertexAttribPointer otra vez.
+.QE
+
+.NH 2
+Volumen de la variedad.
+.PP
+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.
+