Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • windows-port
2 results
Compare
Pascal Engeler's avatar
format
Pascal Engeler authored
3f1e10af
History
Pascal Engeler's avatar 3f1e10af
History
Name Last commit Last update
.vs
FocusTerra
WindowsSDL/SDL2-2.0.14
acheron_transfer
build
ft_top
include
lib
resource
shaders
src
.DS_Store
.gitignore
README.md
README.md

FocusTerra Realtime Wave Simulator

This repository contains all files that make up the realtime wave simulator exhibit at FocusTerra.

While the project was originally developed on macOS, it was later ported to Windows (Visual Studio 2019).

Dependencies are OpenGL, ImGui and SDL, and all of them are contained in this repository.

Table of Contents

Project Organization

The repo is organized in the following folders:

  • src (and subfolders) contains all .cpp
  • include (and subfolders) contains all headers
  • shaders contains all GLSL shaders
  • lib contains libraries
  • FocusTerra contains the Visual Studio project file
  • FocusTerra\x64\Release and FocusTerra\x64\Debug contain the executables
  • build is left over from the macOS days (contains a currently broken Makefile)

Resources

Resources are organized in a single folder called ft_top. It contains the following:

  • A folder bin that contains the executable and SDL2.dll
  • A folder fonts that contains the font used by the GUI, namely Cousine-Regular.ttf
  • A folder resource that contains
    • The colour palette in ft_palette.conf, ft_palette.texture
    • The Image Button images in the folder images
    • A folder textures that contains the predefined structure textures. There are two versions, one for the FocusTerra resolution (in rocket), and one for Pascal's resolution (in home).
  • A folder shaders that contains the used GLSL shaders.

The program accesses these resources at runtime.

Building the Project

Windows

In order to build the project, the following steps must be followed

  • Open the project in Visual Studio 2019
  • Make sure the following files are excluded from the build (Rightclick, Properties, Excluded from Build, Yes:
    • block.hpp
    • blockchain_handler.hpp
    • block.cpp
    • blockchain_handler.cpp
    • imgui_example_sdl_opengl3.cpp
    • main.cpp
    • main_3d.cpp
    • main_refactored.cpp
  • There should be a lot of include-errors reported. To fix this, adjust the paths:
    • In the Solution Explorer, right click on FocusTerra and select Properties
    • Navigate to VCC Directories and adjust the Include Directories. They should point to
      • include
      • include\imgui
      • SDL2-2.0.14\include (e.g. in WindowsSDL, or vclib (not in project))
    • Also adjust the Library Directories. They should point to SDL2-2.0.14\lib\x64.
    • The linked libraries can be seen in Linker, Input, Additional Dependencies. They should not require change, and should include SDL2.lib, SDL2main.lib and opengl32.lib.
  • Open main_testing.cpp. This contains the main function. Adjust it for the target system:
    • Adjust the screen resolution using the #defines at the top. Predefined are the resolutions for the FocusTerra screen and for Pascal's screen.
    • Adjust the top_path to point to the resource folder (i.e. ft_top).
    • Adjust the Derived paths, where necessary. Potentially the tex_path may need adjustment.
    • Adjust the tex_offscreen_* variables to reflect the used texture dimensions.
  • Open input_handler.cpp.
    • For a touchscreen, send an event after the SDL_FINGER* cases. On non-touch devices, send events after the SDL_MOUSE* events.
  • Open slim_blockchain_handler.cpp
    • Depending on the system, uncomment or comment out the section marked Uncomment on a touchscreen.
  • Open drawing_handler.cpp
    • Depending on the system, uncomment or comment out the section marked Uncomment on a touchscreen.
  • Open gui_handler.cpp
    • Depending on the system, change the gui drawcall towards the end in GuiHandler::update.
    • Depending on the system, comment out or uncomment the two sections marked Uncomment on a touchscreen.
  • Rightclick on FocusTerra, select Build.
  • When the building is finished, create a ft_top folder according to the specifications above, and place the executable in the bin folder. If there are library issues, also place a copy of SDL2.dll in the bin folder.
  • Now the application is ready to be run.

macOS

Building on macOS is currently not supported.

User Manual

Todo

Documentation

The following is a documentation for all the code used in the project. As the project is currently at development halt, there are a few known issues that can not be addressed for the time being. They are pointed out in their respective sections.

Architecture

Todo

Classes

Drawer (drawer.hpp, drawer.cpp)

Description

A Drawer is an object that can draw a single line of segments to the screen. It handles single touch of the Zeichnen functionality. Note that this class relies on the caller to its methods to take care of the Opengl state (using shaders, binding buffers, etc.). See DrawingHandler for more information on how this class is to be used. The coordinates used are typically OpenGL coordinates, i.e. in the range [-1, 1].

Usage

  • Construct object (e.g. when new finger goes down)
  • start_drawing with initial position (e.g. with finger down position)
  • Upon new location (e.g. finger motion to new position), setup Opengl state (use shader draw, bind FBO, bind VAO, bind VBO, set viewport, bind textures) and call draw. Call redraw with all required FBO/texture combinations.
  • Destruct when drawing this line is finished (e.g. finger is lifted)

Constructors and Destructors

  • Drawer(Toolbox&)

  • Drawer(const Drawer&)

  • ~Drawer()

Public Function Members

  • void start_drawing(const float x, const float y):

    • Description

      Start drawing at coordinates (x, y) (typically fingerdown location). Doesn't draw anything.

    • Preconditions

    • Postconditions

      Drawing start is set to (x, y).

    • Notes

      Nothing is drawn by this function. (x, y) are typically the fingerdown coordinates.

  • bool draw(const float x, const float y, Toolbox& tb, bool drawing)

    • DESCRIPTION

      Draw a stroke from the last position to (x, y), with strokewidth controlled by drawing (true->tb.drawing_width, false->tb.erasing_width).

    • PRECONDITIONS

      A GL_ARRAY_BUFFER is bound and the Opengl state is set as desired

    • POSTCONDITIONS

      The points of the new segment have been calculated, a call to glDrawArrays has been done to draw the segment.

      Returns true if something was drawn, and false else (typically when new point is same as last point).

    • NOTES

  • void redraw(Toolbox&)

    • Desc: Redraws the last drawn stroke.
    • Pre: Since the last call to draw, the then-bound GL_ARRAY_BUFFER has not been modified.
    • Post: A drawcall glDrawArrays has been issued.
    • Notes: Undefined behaviour if draw has never been called, or the precondition is violated.

  • void erase(const float x, const float y, Toolbox& tb) DEPRECATED

    • Desc:
    • Pre:
    • Post:
    • Notes: Use draw(x, y, tb, false) instead.

  • int num_drawn()

    • Desc: Returns the number of calls to draw and erase that have been performed by this object.
    • Pre:
    • Post:
    • Notes:

Private Function Members

  • bool calculate_points_(Toolbox& tb, bool drawing)

    Calculates the triangulation of the stroke represented by the internal parameters and stores them in points_. The drawing argument switches the stroke width (true->tb.drawing_width, false->tb.erasing_width). Uses tb.texture_w.

    Returns true if new points were calculated, and false else (typically if the internal state represents an equal new and old point).

Public Data Members

N/A

Private Data Members

  • float x0_, y0_, x1_, y1_

    Internal representation of old ('0') and new ('1') points.

  • int num_drawn_

    Number of calls to draw and erase.

  • std::vector<float> points_

    Vertex coordinates that represent the stroke between old and new points, as calculated by calculate_points_.

Notes

N/A

DrawingHandler (drawing_handler.hpp, drawing_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

EfficientBlock (efficient_block.hpp, efficient_block.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

EventLogger (event_logger.hpp, event_logger.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

GuiHandler (gui_handler.hpp, gui_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

Infrastructure (infrastructure.hpp, infrastructure.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

InputHandler (input_handler.hpp, input_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

Message (message.hpp, message.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

PatternHandler (pattern_handler.hpp, pattern_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

Pevent (pevent.hpp, pevent.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

Shader (shader.hpp, shader.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

SlimBlockchainHandler (slim_blockchain_handler.hpp, slim_blockchain_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

TimeoutHandler (timeout_handler.hpp, timeout_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

Toolbox (toolbox.hpp, toolbox.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

WaveHandler (wave_handler.hpp, wave_handler.cpp)

Description

Todo

Usage

Todo

Constructors and Destructors

Todo

Public Function Members

Todo

Private Function Members

Todo

Public Data Members

Todo

Private Data Members

Todo

Notes

Todo

Enums (enums.hpp)

MSTATE

SSTATE

GSTATE

MESSAGETARGET

BLOCKCHAINMESSAGE

PATTERNMESSAGE

DRAWERMESSAGE

GUIMESSAGE

WAVEMESSAGE

PEVENTTYPE

ImGui Customization

The ImGui library has been customized in the following way:

  • imgui_widgets.cpp:
    • ImGui::PlotEx: Removed tooltip
  • imgui_impl_sdl.h:
    • ImGui_ImplSDL2_Touch_ProcessEvent: Added declaration
    • ImGui_ImplSDL2_Touch_UpdateMousePosAndButtons: Added declaration
  • imgui_impl_sdl.cpp:
    • ImGui_ImplSDL2_Touch_ProcessEvent: Added implementation
    • ImGui_ImplSDL2_Touch_UpdateMousePosAndButtons: Added implementation
    • ImGui_ImplSDL2_NewFrame: Changed to call ImGui_ImplSDL2_Touch_UpdateMousePosAndButtons instead of ImGui_ImplSDL2_UpdateMousePosAndButtons
  • Notes:
    • On touch devices, one should generally call ImGui_ImplSDL2_Touch_ProcessEvent rather than ImGui_ImplSDL2_ProcessEvent
    • To run ImGui demos, one must revert the change to ImGui_ImplSDL2_NewFrame (see comments).

GLSL Shaders

combine_damping

copy_texture

draw

draw_blocks

render2d

stepwave

Workflow: Sample main function

Todo