docs/html/graphics__app_8h_source.html

 /*

-  This file is part of the MinGfx Project.

-

-  Copyright (c) 2017,2018 Regents of the University of Minnesota.

-  All Rights Reserved.

-

-  Original Author(s) of this File:

-     Dan Keefe, 2017, University of Minnesota

-

-  Author(s) of Significant Updates/Modifications to the File:

-     ...

-  */

-

-

- #ifndef SRC_GRAPHICS_APP_H_

- #define SRC_GRAPHICS_APP_H_

-

- // disable warnings for this 3rd party code

- #pragma warning ( push, 0 )

- #include <nanogui/nanogui.h>

- #pragma warning ( pop )

-

- #include <iostream>

-

- #include "point2.h"

- #include "vector2.h"

-

- namespace mingfx {

-

-

- class GraphicsApp {

- public:

-

-     GraphicsApp(int width, int height, const std::string &caption);

-

-

-     virtual ~GraphicsApp();

-

-

-     // Callback methods -- override these and fill in to respond to user

-     // input events.

-

-     virtual void OnMouseMove(const Point2 &pos, const Vector2 &delta) {}

-

-     virtual void OnLeftMouseDown(const Point2 &pos) {}

-

-     virtual void OnLeftMouseDrag(const Point2 &pos, const Vector2 &delta) {}

-

-     virtual void OnLeftMouseUp(const Point2 &pos) {}

-

-

-     virtual void OnMiddleMouseDown(const Point2 &pos) {}

-

-     virtual void OnMiddleMouseDrag(const Point2 &pos, const Vector2 &delta) {}

-

-     virtual void OnMiddleMouseUp(const Point2 &pos) {}

-

-

-     virtual void OnRightMouseDown(const Point2 &pos) {}

-

-     virtual void OnRightMouseDrag(const Point2 &pos, const Vector2 &delta) {}

-

-     virtual void OnRightMouseUp(const Point2 &pos) {}

-

-

-     virtual void OnKeyDown(const char *c, int modifiers) {}

-

-     virtual void OnKeyRepeat(const char *c, int modifiers) {}

-

-     virtual void OnKeyUp(const char *c, int modifiers) {}

-

-

-

-     virtual void OnSpecialKeyDown(int key, int scancode, int modifiers) {}

-

-     virtual void OnSpecialKeyRepeat(int key, int scancode, int modifiers) {}

-

-     virtual void OnSpecialKeyUp(int key, int scancode, int modifiers) {}

-

-

-     virtual void OnWindowResize(int new_width, int new_height) {}

-

-

-     virtual void Run();

-

-

-     virtual void InitNanoGUI() {}

-

-     virtual void InitOpenGL() {}

-

-

-     virtual void UpdateSimulation(double dt) {}

-

-

-     virtual void DrawUsingNanoVG(NVGcontext *ctx) {}

-

-

-

-     virtual void DrawUsingOpenGL() {}

-

-

-     virtual bool IsKeyDown(int key);

-

-     virtual bool IsLeftMouseDown();

-

-     virtual bool IsMiddleMouseDown();

-

-     virtual bool IsRightMouseDown();

-

-     virtual int window_width();

-

-     virtual int window_height();

-

-     virtual int framebuffer_width();

-

-     virtual  int framebuffer_height();

-

-     virtual float aspect_ratio();

-

-

-     virtual Point2 PixelsToNormalizedDeviceCoords(const Point2 &pointInPixels);

-

-     virtual Point2 NormalizedDeviceCoordsToPixels(const Point2 &pointInNDC);

-

-

-     virtual Vector2 PixelsToNormalizedDeviceCoords(const Vector2 &vectorInPixels);

-

-     virtual Vector2 NormalizedDeviceCoordsToPixels(const Vector2 &pointInNDC);

-

-     virtual float ReadZValueAtPixel(const Point2 &pointInPixels, unsigned int whichBuffer = GL_BACK);

-

-     virtual nanogui::Screen* screen();

-

-     virtual GLFWwindow* window();

-

-

-     virtual void ResizeWindow(int new_width, int new_height);

-

-

-     virtual void InitGraphicsContext();

-

- private:

-

-     bool cursor_pos_glfw_cb(double x, double y);

-     bool mouse_button_glfw_cb(int button, int action, int modifiers);

-     bool key_glfw_cb(int key, int scancode, int action, int mods);

-     bool char_glfw_cb(unsigned int codepoint);

-     bool drop_glfw_cb(int count, const char **filenames);

-     bool scroll_glfw_cb(double x, double y);

-     bool resize_glfw_cb(int width, int height);

-

-     virtual void mouse_move(const Point2 &pos, const Vector2 &delta) {

-         OnMouseMove(pos, delta);

-     }

-     virtual void left_mouse_down(const Point2 &pos) {

-         OnLeftMouseDown(pos);

-     }

-     virtual void left_mouse_drag(const Point2 &pos, const Vector2 &delta) {

-         OnLeftMouseDrag(pos, delta);

-     }

-     virtual void left_mouse_up(const Point2 &pos) {

-         OnLeftMouseUp(pos);

-     }

-     virtual void middle_mouse_down(const Point2 &pos) {

-         OnMiddleMouseDown(pos);

-     }

-     virtual void middle_mouse_drag(const Point2 &pos, const Vector2 &delta) {

-         OnMiddleMouseDrag(pos, delta);

-     }

-     virtual void middle_mouse_up(const Point2 &pos) {

-         OnMiddleMouseUp(pos);

-     }

-     virtual void right_mouse_down(const Point2 &pos) {

-         OnRightMouseDown(pos);

-     }

-     virtual void right_mouse_drag(const Point2 &pos, const Vector2 &delta) {

-         OnRightMouseDrag(pos, delta);

-     }

-     virtual void right_mouse_up(const Point2 &pos) {

-         OnRightMouseUp(pos);

-     }

-     virtual void key_down(const char *c, int modifiers) {

-         OnKeyDown(c, modifiers);

-     }

-     virtual void key_repeat(const char *c, int modifiers) {

-         OnKeyRepeat(c, modifiers);

-     }

-     virtual void key_up(const char *c, int modifiers) {

-         OnKeyUp(c, modifiers);

-     }

-     virtual void special_key_down(int key, int scancode, int modifiers) {

-         OnSpecialKeyDown(key, scancode, modifiers);

-     }

-     virtual void special_key_repeat(int key, int scancode, int modifiers) {

-         OnSpecialKeyRepeat(key, scancode, modifiers);

-     }

-     virtual void special_key_up(int key, int scancode, int modifiers) {

-         OnSpecialKeyUp(key, scancode, modifiers);

-     }

-

-     bool graphicsInitialized_;

-     int width_;

-     int height_;

-     const std::string caption_;

-     nanogui::Screen *screen_;

-     GLFWwindow* window_;

-     double lastDrawT_;

-     Point2 lastMouse_;

-     bool leftDown_;

-     bool middleDown_;

-     bool rightDown_;

- };

-

-

- } // end namespace

-

- #endif

-

-mingfx::GraphicsApp
This is the main application base class for the MinGfx Toolkit.
Definition: graphics_app.h:135

-mingfx::GraphicsApp::OnKeyDown
virtual void OnKeyDown(const char *c, int modifiers)
Transforms a keyboard down event into the actual character typed.
Definition: graphics_app.h:225

-mingfx::GraphicsApp::OnRightMouseDrag
virtual void OnRightMouseDrag(const Point2 &pos, const Vector2 &delta)
If the mouse button is held down and the mouse has moved in the past frame then this function will be...
Definition: graphics_app.h:213

-mingfx::GraphicsApp::InitGraphicsContext
virtual void InitGraphicsContext()
Users cannot make any graphics calls (e.g., setting the clear color, saving mesh data to the GPU) unt...

-mingfx::GraphicsApp::ResizeWindow
virtual void ResizeWindow(int new_width, int new_height)
Cause the graphics windows to resize programmatically rather than by dragging on the corner manually.

-mingfx::GraphicsApp::OnSpecialKeyUp
virtual void OnSpecialKeyUp(int key, int scancode, int modifiers)
The values for key, scancode, and modifiers are documented here: http://www.glfw.org/docs/latest/grou...
Definition: graphics_app.h:255

-mingfx::GraphicsApp::window_width
virtual int window_width()
Returns the current width of the client area of the window in pixels.

-mingfx::GraphicsApp::OnKeyRepeat
virtual void OnKeyRepeat(const char *c, int modifiers)
Transforms a keyboard repeat event into the actual character typed.
Definition: graphics_app.h:233

-mingfx::GraphicsApp::OnMouseMove
virtual void OnMouseMove(const Point2 &pos, const Vector2 &delta)
If the mouse has moved in the past frame and no mouse buttons are currently pressed,...
Definition: graphics_app.h:165

-mingfx::GraphicsApp::OnMiddleMouseUp
virtual void OnMiddleMouseUp(const Point2 &pos)
If the mouse button was released since the last frame, then this function will be called to notify yo...
Definition: graphics_app.h:206

-mingfx::GraphicsApp::NormalizedDeviceCoordsToPixels
virtual Vector2 NormalizedDeviceCoordsToPixels(const Vector2 &pointInNDC)
Transforms a vector in normalized device coordinates (top left = (-1,1) bottom right (1,...

-mingfx::GraphicsApp::ReadZValueAtPixel
virtual float ReadZValueAtPixel(const Point2 &pointInPixels, unsigned int whichBuffer=GL_BACK)
Returns the z buffer value under the specified pixel. z will be 0 at the near plane and +1 at the far...

-mingfx::GraphicsApp::IsRightMouseDown
virtual bool IsRightMouseDown()
True if the right mouse button is currently held down.

-mingfx::GraphicsApp::PixelsToNormalizedDeviceCoords
virtual Vector2 PixelsToNormalizedDeviceCoords(const Vector2 &vectorInPixels)
Transforms a vector in viewport coordinates (pixels where top left = (0,0) and bottom right = (window...

-mingfx::GraphicsApp::OnLeftMouseUp
virtual void OnLeftMouseUp(const Point2 &pos)
If the mouse button was released since the last frame, then this function will be called to notify yo...
Definition: graphics_app.h:196

-mingfx::GraphicsApp::OnLeftMouseDrag
virtual void OnLeftMouseDrag(const Point2 &pos, const Vector2 &delta)
If the mouse button is held down and the mouse has moved in the past frame then this function will be...
Definition: graphics_app.h:187

-mingfx::GraphicsApp::OnMiddleMouseDown
virtual void OnMiddleMouseDown(const Point2 &pos)
If the mouse button was pressed down since the last frame, then this function will be called to notif...
Definition: graphics_app.h:200

-mingfx::GraphicsApp::DrawUsingOpenGL
virtual void DrawUsingOpenGL()
Override this to draw graphics using raw OpenGL 2D or 3D graphics calls.
Definition: graphics_app.h:317

-mingfx::GraphicsApp::IsLeftMouseDown
virtual bool IsLeftMouseDown()
True if the left mouse button is currently held down.

-mingfx::GraphicsApp::Run
virtual void Run()
After creating a new GraphicsApp, call this to start the app's mainloop.

-mingfx::GraphicsApp::IsKeyDown
virtual bool IsKeyDown(int key)
True if the specified is is currently held down. Uses the GLFW key codes found here: http://www....

-mingfx::GraphicsApp::NormalizedDeviceCoordsToPixels
virtual Point2 NormalizedDeviceCoordsToPixels(const Point2 &pointInNDC)
Transforms a point in normalized device coordinates (top left = (-1,1) bottom right (1,...

-mingfx::GraphicsApp::DrawUsingNanoVG
virtual void DrawUsingNanoVG(NVGcontext *ctx)
Override this to draw graphics using the nanovg vector graphics library, which provides an easy way t...
Definition: graphics_app.h:311

-mingfx::GraphicsApp::OnSpecialKeyRepeat
virtual void OnSpecialKeyRepeat(int key, int scancode, int modifiers)
The values for key, scancode, and modifiers are documented here: http://www.glfw.org/docs/latest/grou...
Definition: graphics_app.h:251

-mingfx::GraphicsApp::OnKeyUp
virtual void OnKeyUp(const char *c, int modifiers)
Transforms a keyboard up event into the actual character typed.
Definition: graphics_app.h:241

-mingfx::GraphicsApp::OnRightMouseDown
virtual void OnRightMouseDown(const Point2 &pos)
If the mouse button was pressed down since the last frame, then this function will be called to notif...
Definition: graphics_app.h:210

-mingfx::GraphicsApp::IsMiddleMouseDown
virtual bool IsMiddleMouseDown()
True if the middle mouse button is currently held down.

-mingfx::GraphicsApp::PixelsToNormalizedDeviceCoords
virtual Point2 PixelsToNormalizedDeviceCoords(const Point2 &pointInPixels)
Transforms a point in viewport coordinates (pixels where top left = (0,0) and bottom right = (window_...

-mingfx::GraphicsApp::InitOpenGL
virtual void InitOpenGL()
Override this to initialize the OpenGL context with textures, vertex buffers, etc.
Definition: graphics_app.h:297

-mingfx::GraphicsApp::UpdateSimulation
virtual void UpdateSimulation(double dt)
Called once per frame.
Definition: graphics_app.h:306

-mingfx::GraphicsApp::~GraphicsApp
virtual ~GraphicsApp()
The destructor will shutdown the graphics system and window.

-mingfx::GraphicsApp::OnSpecialKeyDown
virtual void OnSpecialKeyDown(int key, int scancode, int modifiers)
The values for key, scancode, and modifiers are documented here: http://www.glfw.org/docs/latest/grou...
Definition: graphics_app.h:247

-mingfx::GraphicsApp::window
virtual GLFWwindow * window()
Access to the underlying GLFWwindow object.

-mingfx::GraphicsApp::GraphicsApp
GraphicsApp(int width, int height, const std::string &caption)
Constructs a new app but does not yet run it.

-mingfx::GraphicsApp::aspect_ratio
virtual float aspect_ratio()
Returns width/height for the current shape of the window.

-mingfx::GraphicsApp::OnMiddleMouseDrag
virtual void OnMiddleMouseDrag(const Point2 &pos, const Vector2 &delta)
If the mouse button is held down and the mouse has moved in the past frame then this function will be...
Definition: graphics_app.h:203

-mingfx::GraphicsApp::framebuffer_width
virtual int framebuffer_width()
Returns the current width of the framebuffer in pixels.

-mingfx::GraphicsApp::window_height
virtual int window_height()
Returns the current height of the client area of the window in pixels.

-mingfx::GraphicsApp::OnRightMouseUp
virtual void OnRightMouseUp(const Point2 &pos)
If the mouse button was released since the last frame, then this function will be called to notify yo...
Definition: graphics_app.h:216

-mingfx::GraphicsApp::OnWindowResize
virtual void OnWindowResize(int new_width, int new_height)
Override this to respond when the graphics window and/or framebuffer are resized, either by the user ...
Definition: graphics_app.h:261

-mingfx::GraphicsApp::screen
virtual nanogui::Screen * screen()
Access to the underlying NanoGUI Screen object.

-mingfx::GraphicsApp::InitNanoGUI
virtual void InitNanoGUI()
Called at the beginning of the Run() method.
Definition: graphics_app.h:284

-mingfx::GraphicsApp::OnLeftMouseDown
virtual void OnLeftMouseDown(const Point2 &pos)
If the mouse button was pressed down since the last frame, then this function will be called to notif...
Definition: graphics_app.h:174

-mingfx::GraphicsApp::framebuffer_height
virtual int framebuffer_height()
Returns the current height of the framebuffer in pixels.

-mingfx::Point2
A 2D Point with floating point coordinates, used for storing 2D texture coordinates,...
Definition: point2.h:28

-mingfx::Vector2
A 2D Vector with floating point coordinates, used for storing 2D translations, mouse movements,...
Definition: vector2.h:28

-mingfx
Namespace for the MinGfx Toolkit.
Definition: aabb.h:21

-point2.h

-vector2.h

-