Ani3D - Introduction

Download code base

• - https://github.com/drohmer/epita_ani3d_lab_code-2027
• • - Either clone it: git clone https://github.com/drohmer/epita_ani3d_lab_code-2027.git
  • - Or use the Github button "Code > Download ZIP"

• Make sure you can compile and run the scene in scenes_ani3d/00_introduction/.
• • If needed, you can follow these detailed instructions for Installation and Compilation.

• - Your C++ compiler should be compatible with C++17.
• - Glad is used to load function for OpenGL 3.3.
• - GLFW is used to create a window and handle mouse/key events.
• - ImGUI is used to handle GUI.

Introductory scene

• The first introductory scene is available in the directory scenes_ani3d/00_introduction/
• • - Each exercise is described as a unique program (with its own main) defined in its own directory in scenes_ani3d/.
  • - A CMakeLists.txt is associated to each program for its compilation (+ a Makefile for Unix systems). The generated executable is named project.
  • • (you need to adapt the path of the compilation instructions to the directory of the CMakeLists.txt for each exercise, see also the README.md of the Github repository)

• Once executed, you should observe a basic scene as seen below with rotating cylinder, cube, and curve (some details may vary).
• • - Note that the source code of the scene is described in the files src/main.cpp, src/application.cpp (and .hpp), src/environment.cpp (and .hpp), and src/scene.cpp (and src/scene.hpp).
  • main.cpp, application.cpp and environment.cpp contain common elements through all the exercises (general set up of the scene, animation loop, basic handling of the keyboard/mouse input). Usually you won't have to edit these files.
  • scene.cpp and (scene.hpp) describe the specific content of the scene exercise. You may have to do your edit in this file.

Information on the library (only general information, no exercise)

• - Structure for 3D vectors and matrices (and 2D, 4D).
• - Object structure ready to be displayed with OpenGL (Meshes, lines, etc) and their associated shaders.
• - Easy and secured storage for buffers of elements.
• - 3D scene manipulation: Mouse controlled camera

Use of the code library

• > In the function display_frame(), change the rotation parameters (axis and an angle) from some of the objects.
• • - Note: The pre-existing function rotation_axis_angle(axis_of_rotation, angle_of_rotation); from the CGP library can be used to generate a structure cgp::rotation_transform from a given 3D axis (cgp::vec3) and scalar angle (float) in radians.
  • - The structure cgp::vec3 implements a model of 3D vector with (x,y,z) coordinates.
  • • You can apply most of the basic operations between vec3 and mat3 using mathematical operators (+,-,*,/).
  • - The structure rotation_transform allowing to generate and manipulate a rotation. The rotation is stored internally as a quaternion, and can be manipulated similarly to a matrix when applied on a vector.
  • The rotation is stored in the variable "model" of a mesh_drawable structure. model stores an affine transformation which is used as uniform variable when the shape is displayed.

• Note that there are two types of "mesh" structures in use

• • - cgp::mesh storing buffer on data (per vertex: position, normal, uv, color, and triangle connectivity) on CPU
  • • This structure allows to conveniently access to all the data defining a mesh from the C++ code. However these data are not on the GPU, so a mesh cannot be directly displayed.

• • - cgp::mesh_drawable storing VBOs associated to these buffer once sent on the GPU memory as well as its VAO. The structure also stores uniform parameters that are sent to the shader at every draw call. A default shader and texture id are also stored with the structure.
  • • This structure only stores the index corresponding to elements on GPU. You cannot modify individual per-vertex elements easily from this structure.

• • Remark: a mesh_drawable can be automatically generated/initialized from a mesh structure in calling the construction mesh_drawable.initialize_data_on_gpu(meshName). However, you cannot create a mesh from a mesh_drawable.

Adding a sphere

• > Add the class variable to scene_structure class (in the file scene.hpp)

cgp::mesh_drawable sphere; 

• In this example, cgp:: is optional as the header file already indicated "using cgp::mesh_drawable;" in its beginning.

• > Initialize this variable in the file scene.cpp in the initialize() function as a sphere of radius 0.5

mesh sphere_mesh = mesh_primitive_sphere(0.5f);
sphere.initialize_data_on_gpu(sphere_mesh);

sphere.initialize_data_on_gpu(mesh_primitive_sphere(0.5f));

• > Display this sphere in the display_frame() function with the following code

draw(sphere, environment);

• > Compile, run, and observe the sphere in the 3D scene.

• Note: You can set geometric transformation using the uniform properties of the mesh_drawable structure (reminder: uniform are parameters passed to the shaders).
• • sphere.model.translation/rotation/scaling = ... (see example on the other displayed shapes)
• Note also that unless specified explicitly, the default shader associated to the mesh_drawable structure is used.
• The three transformations: translation, rotation, and scaling are simply variables that you can write on. By default, their values are respectively, (0,0,0), the identity, and 1. The content of the variables are used (as uniform values in the shader) when the draw call is used.

• > Add the following line before calling draw on the sphere and observe that the color (as well as any other uniform parameter) can be changed through time in modifying its value at every frame.

sphere.material.color = vec3(1+std::cos(time), 1+std::sin(time), 2.0)/2.0f;

Checkbox interface

• > Add the following variable in the definition of the structure struct gui_parameters (in the file scene.hpp) to store a boolean state indicating when the wireframe should be displayed or not

bool display_wireframe = false;

• > In the function display_gui() (in scene.cpp) add a Checkbox (handled by ImGui library) and link it (through its address) to the variable display_wireframe in adding this line of code

ImGui::Checkbox("Wireframe", &gui.display_wireframe);

• In running the code, the checkbox should appear. Every time you select/unselect it, the value of the variable display_wireframe change from true to false but doesn't change yet anything in the 3D display.

• > Add the following code in the display_frame function

	if (gui.display_wireframe)
		draw_wireframe(sphere, environment, { 1,1,0 });

• Check that you can now interactively display the wireframe representation of the sphere.