src/view.cpp

   1 #include "view.h"
   2 #include "bufferbuilder.h"
   3 #include "screen.h"
   4 #include "gl_core44.h"
   5
   6 using namespace IPDF;
   7 using namespace std;
   8
   9 /**
  10  * Constructs a view
  11  * Allocates memory for ObjectRenderers
  12  * @param document - The document to associate the View with
  13  * @param bounds - Initial bounds of the View
  14  * @param colour - Colour to use for rendering this view. TODO: Make sure this actually works, or just remove it
  15  */
  16 View::View(Document & document, Screen & screen, const Rect & bounds, const Colour & colour)
  17         : m_use_gpu_transform(USE_GPU_TRANSFORM), m_use_gpu_rendering(USE_GPU_RENDERING), m_bounds_dirty(true), m_buffer_dirty(true),
  18                 m_render_dirty(true), m_document(document), m_screen(screen), m_cached_display(), m_bounds(bounds), m_colour(colour), m_bounds_ubo(),
  19                 m_objbounds_vbo(), m_object_renderers(NUMBER_OF_OBJECT_TYPES), m_cpu_rendering_pixels(NULL)
  20 {
  21         Debug("View Created - Bounds => {%s}", m_bounds.Str().c_str());
  22
  23         screen.SetView(this); // oh dear...
  24
  25         // Create ObjectRenderers - new's match delete's in View::~View
  26         //TODO: Don't forget to put new renderers here or things will be segfaultastic
  27         m_object_renderers[RECT_FILLED] = new RectFilledRenderer();
  28         m_object_renderers[RECT_OUTLINE] = new RectOutlineRenderer();
  29         m_object_renderers[CIRCLE_FILLED] = new CircleFilledRenderer();
  30         m_object_renderers[BEZIER] = new BezierRenderer();
  31
  32         // To add rendering for a new type of object;
  33         // 1. Add enum to ObjectType in ipdf.h
  34         // 2. Implement class inheriting from ObjectRenderer using that type in objectrenderer.h and objectrenderer.cpp
  35         // 3. Add it here
  36         // 4. Profit
  37
  38
  39 #ifndef QUADTREE_DISABLED
  40         m_quadtree_max_depth = 2;
  41         m_current_quadtree_node = document.GetQuadTree().root_id;
  42 #endif
  43 }
  44
  45 /**
  46  * Destroy a view
  47  * Frees memory used by ObjectRenderers
  48  */
  49 View::~View()
  50 {
  51         for (unsigned i = 0; i < m_object_renderers.size(); ++i)
  52         {
  53                 delete m_object_renderers[i]; // delete's match new's in constructor
  54         }
  55         m_object_renderers.clear();
  56         delete [] m_cpu_rendering_pixels;
  57 }
  58
  59 /**
  60  * Translate the view
  61  * @param x, y - Amount to translate
  62  */
  63 void View::Translate(Real x, Real y)
  64 {
  65         x *= m_bounds.w;
  66         y *= m_bounds.h;
  67         m_bounds.x += x;
  68         m_bounds.y += y;
  69         Debug("View Bounds => %s", m_bounds.Str().c_str());
  70         if (!m_use_gpu_transform)
  71                 m_buffer_dirty = true;
  72         m_bounds_dirty = true;
  73 }
  74
  75 /**
  76  * Scale the View at a point
  77  * @param x, y - Coordinates to scale at (eg: Mouse cursor position)
  78  * @param scale_amount - Amount to scale by
  79  */
  80 void View::ScaleAroundPoint(Real x, Real y, Real scale_amount)
  81 {
  82         // x and y are coordinates in the window
  83         // Convert to local coords.
  84         x *= m_bounds.w;
  85         y *= m_bounds.h;
  86         x += m_bounds.x;
  87         y += m_bounds.y;
  88
  89         Real top = y - m_bounds.y;
  90         Real left = x - m_bounds.x;
  91
  92         top *= scale_amount;
  93         left *= scale_amount;
  94
  95         m_bounds.x = x - left;
  96         m_bounds.y = y - top;
  97         m_bounds.w *= scale_amount;
  98         m_bounds.h *= scale_amount;
  99         //Debug("Scale at {%s, %s} by %s View Bounds => %s", x.Str().c_str(), y.Str().c_str(), scale_amount.Str().c_str(), m_bounds.Str().c_str());
 100         if (!m_use_gpu_transform)
 101                 m_buffer_dirty = true;
 102         m_bounds_dirty = true;
 103 }
 104
 105 /**
 106  * Transform a point in the document to a point relative to the top left corner of the view
 107  * This is the CPU coordinate transform code; used only if the CPU is doing coordinate transforms
 108  * @param inp - Input Rect {x,y,w,h} in the document
 109  * @returns output Rect {x,y,w,h} in the View
 110  */
 111 Rect View::TransformToViewCoords(const Rect& inp) const
 112 {
 113         Rect out;
 114         out.x = (inp.x - m_bounds.x) / m_bounds.w;
 115         out.y = (inp.y - m_bounds.y) / m_bounds.h;
 116         out.w = inp.w / m_bounds.w;
 117         out.h = inp.h / m_bounds.h;
 118         return out;
 119 }
 120
 121 /**
 122  * Render the view
 123  * Updates FrameBuffer if the document, object bounds, or view bounds have changed, then Blits it
 124  * Otherwise just Blits the cached FrameBuffer
 125  * @param width - Width of View to render
 126  * @param height - Height of View to render
 127  */
 128 void View::Render(int width, int height)
 129 {
 130         glPushDebugGroup(GL_DEBUG_SOURCE_APPLICATION,42,-1, "Beginning View::Render()");
 131         // View dimensions have changed (ie: Window was resized)
 132         int prev_width = m_cached_display.GetWidth();
 133         int prev_height = m_cached_display.GetHeight();
 134         if (width != prev_width || height != prev_height)
 135         {
 136                 m_cached_display.Create(width, height);
 137                 m_bounds_dirty = true;
 138         }
 139
 140         // View bounds have not changed; blit the FrameBuffer as it is
 141         if (!m_bounds_dirty)
 142         {
 143                 m_cached_display.UnBind();
 144                 m_cached_display.Blit();
 145                 glPopDebugGroup();
 146                 return;
 147         }
 148         m_cached_display.Bind(); //NOTE: This is redundant; Clear already calls Bind
 149         m_cached_display.Clear();
 150
 151 #ifndef QUADTREE_DISABLED
 152         if (m_bounds_dirty)
 153         {
 154                 if (ContainedInQuadChild(m_bounds, QTC_TOP_LEFT) && m_document.GetQuadTree().nodes[m_current_quadtree_node].top_left != QUADTREE_EMPTY)
 155                 {
 156                         m_bounds = TransformToQuadChild(m_bounds, QTC_TOP_LEFT);
 157                         m_current_quadtree_node = m_document.GetQuadTree().nodes[m_current_quadtree_node].top_left;
 158                 }
 159                 if ((m_bounds.w > 1 || m_bounds.h > 1) && m_document.GetQuadTree().nodes[m_current_quadtree_node].parent != QUADTREE_EMPTY)
 160                 {
 161                         m_bounds = TransformFromQuadChild(m_bounds, m_document.GetQuadTree().nodes[m_current_quadtree_node].child_type);
 162                         m_current_quadtree_node = m_document.GetQuadTree().nodes[m_current_quadtree_node].parent;
 163                 }
 164         }
 165         m_screen.DebugFontPrintF("Current View QuadTree Node: %d\n", m_current_quadtree_node);
 166 #endif
 167
 168         if (!m_use_gpu_rendering)
 169         {
 170                 // Dynamically resize CPU rendering target pixels if needed
 171                 if (m_cpu_rendering_pixels == NULL || width*height > prev_width*prev_height)
 172                 {
 173                         delete [] m_cpu_rendering_pixels;
 174                         m_cpu_rendering_pixels = new uint8_t[width*height*4];
 175                         if (m_cpu_rendering_pixels == NULL)
 176                                 Fatal("Could not allocate %d*%d*4 = %d bytes for cpu rendered pixels", width, height, width*height*4);
 177                 }
 178                 // Clear CPU rendering pixels
 179                 for (int i = 0; i < width*height*4; ++i)
 180                         m_cpu_rendering_pixels[i] = 255;
 181         }
 182 #ifdef QUADTREE_DISABLED
 183         RenderRange(width, height, 0, m_document.ObjectCount());
 184 #else
 185         RenderQuadtreeNode(width, height, m_current_quadtree_node, m_quadtree_max_depth);
 186 #endif
 187         if (!m_use_gpu_rendering)
 188         {
 189                 m_screen.RenderPixels(0,0,width, height, m_cpu_rendering_pixels); //TODO: Make this work :(
 190                 // Debug for great victory (do something similar for GPU and compare?)
 191                 ObjectRenderer::SaveBMP({m_cpu_rendering_pixels, width, height}, "cpu_rendering_last_frame.bmp");
 192         }
 193         m_cached_display.UnBind(); // resets render target to the screen
 194         m_cached_display.Blit(); // blit FrameBuffer to screen
 195         m_buffer_dirty = false;
 196         glPopDebugGroup();
 197 }
 198
 199 #ifndef QUADTREE_DISABLED
 200 void View::RenderQuadtreeNode(int width, int height, QuadTreeIndex node, int remaining_depth)
 201 {
 202         Rect old_bounds = m_bounds;
 203         if (node == QUADTREE_EMPTY) return;
 204         if (!remaining_depth) return;
 205         //Debug("Rendering QT node %d, (objs: %d -- %d)\n", node, m_document.GetQuadTree().nodes[node].object_begin, m_document.GetQuadTree().nodes[node].object_end);
 206         m_bounds_dirty = true;
 207         RenderRange(width, height, m_document.GetQuadTree().nodes[node].object_begin, m_document.GetQuadTree().nodes[node].object_end);
 208
 209         m_bounds = TransformToQuadChild(old_bounds, QTC_TOP_LEFT);
 210         m_bounds_dirty = true;
 211         RenderQuadtreeNode(width, height, m_document.GetQuadTree().nodes[node].top_left, remaining_depth-1);
 212         m_bounds = TransformToQuadChild(old_bounds, QTC_TOP_RIGHT);
 213         m_bounds_dirty = true;
 214         RenderQuadtreeNode(width, height, m_document.GetQuadTree().nodes[node].top_right, remaining_depth-1);
 215         m_bounds = TransformToQuadChild(old_bounds, QTC_BOTTOM_LEFT);
 216         m_bounds_dirty = true;
 217         RenderQuadtreeNode(width, height, m_document.GetQuadTree().nodes[node].bottom_left, remaining_depth-1);
 218         m_bounds = TransformToQuadChild(old_bounds, QTC_BOTTOM_RIGHT);
 219         m_bounds_dirty = true;
 220         RenderQuadtreeNode(width, height, m_document.GetQuadTree().nodes[node].bottom_right, remaining_depth-1);
 221         m_bounds = old_bounds;
 222         m_bounds_dirty = true;
 223 }
 224 #endif
 225
 226 void View::RenderRange(int width, int height, unsigned first_obj, unsigned last_obj)
 227 {
 228         glPushDebugGroup(GL_DEBUG_SOURCE_APPLICATION, 43, -1, "View::RenderRange()");
 229         if (m_render_dirty) // document has changed
 230                 PrepareRender();
 231
 232         if (m_buffer_dirty || m_bounds_dirty) // object bounds have changed
 233                 UpdateObjBoundsVBO(first_obj, last_obj);
 234
 235         if (m_use_gpu_transform)
 236         {
 237                 GLfloat glbounds[] = {static_cast<GLfloat>(Float(m_bounds.x)), static_cast<GLfloat>(Float(m_bounds.y)), static_cast<GLfloat>(Float(m_bounds.w)), static_cast<GLfloat>(Float(m_bounds.h)),
 238                                         0.0, 0.0, static_cast<GLfloat>(width), static_cast<GLfloat>(height)};
 239                 m_bounds_ubo.Upload(sizeof(float)*8, glbounds);
 240         }
 241         else
 242         {
 243                 GLfloat glbounds[] = {0.0f, 0.0f, 1.0f, 1.0f,
 244                                         0.0f, 0.0f, float(width), float(height)};
 245                 m_bounds_ubo.Upload(sizeof(float)*8, glbounds);
 246         }
 247         m_bounds_dirty = false;
 248
 249
 250         // Render using GPU
 251         if (m_use_gpu_rendering)
 252         {
 253                 if (m_colour.a < 1.0f)
 254                 {
 255                         glEnable(GL_BLEND);
 256                         glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 257                 }
 258                 m_objbounds_vbo.Bind();
 259                 m_bounds_ubo.Bind();
 260                 glEnableVertexAttribArray(0);
 261                 glVertexAttribPointer(0, 2, GL_FLOAT, GL_FALSE, 0, 0);
 262
 263                 for (unsigned i = 0; i < m_object_renderers.size(); ++i)
 264                 {
 265                         m_object_renderers[i]->RenderUsingGPU(first_obj, last_obj);
 266                 }
 267
 268                 glDisableVertexAttribArray(0);
 269                 if (m_colour.a < 1.0f)
 270                 {
 271                         glDisable(GL_BLEND);
 272                 }
 273         }
 274         else // Rasterise on CPU then blit texture to GPU
 275         {
 276
 277                 for (unsigned i = 0; i < m_object_renderers.size(); ++i)
 278                 {
 279                         m_object_renderers[i]->RenderUsingCPU(m_document.m_objects, *this, {m_cpu_rendering_pixels, width, height}, first_obj, last_obj);
 280                 }
 281         }
 282         glPopDebugGroup();
 283 }
 284
 285 void View::UpdateObjBoundsVBO(unsigned first_obj, unsigned last_obj)
 286 {
 287         //m_objbounds_vbo.Invalidate();
 288         m_objbounds_vbo.SetType(GraphicsBuffer::BufferTypeVertex);
 289         m_objbounds_vbo.SetName("Object Bounds VBO");
 290         if (m_use_gpu_transform)
 291         {
 292                 m_objbounds_vbo.SetUsage(GraphicsBuffer::BufferUsageStaticDraw);
 293         }
 294         else
 295         {
 296                 m_objbounds_vbo.SetUsage(GraphicsBuffer::BufferUsageDynamicDraw);
 297         }
 298         m_objbounds_vbo.Resize(m_document.ObjectCount()*sizeof(GPUObjBounds));
 299
 300         BufferBuilder<GPUObjBounds> obj_bounds_builder(m_objbounds_vbo.MapRange(first_obj*sizeof(GPUObjBounds), (last_obj-first_obj)*sizeof(GPUObjBounds), false, true, false), m_objbounds_vbo.GetSize());
 301
 302         for (unsigned id = first_obj; id < last_obj; ++id)
 303         {
 304                 Rect obj_bounds;
 305                 if (m_use_gpu_transform)
 306                 {
 307                         obj_bounds = m_document.m_objects.bounds[id];
 308                 }
 309                 else
 310                 {
 311                         obj_bounds = TransformToViewCoords(m_document.m_objects.bounds[id]);
 312                 }
 313                 GPUObjBounds gpu_bounds = {
 314                         (float)Float(obj_bounds.x),
 315                         (float)Float(obj_bounds.y),
 316                         (float)Float(obj_bounds.x + obj_bounds.w),
 317                         (float)Float(obj_bounds.y + obj_bounds.h)
 318                 };
 319                 obj_bounds_builder.Add(gpu_bounds);
 320
 321         }
 322         m_objbounds_vbo.UnMap();
 323 }
 324 /**
 325  * Prepare the document for rendering
 326  * Will be called on View::Render if m_render_dirty is set
 327  * (Called at least once, on the first Render)
 328  */
 329 void View::PrepareRender()
 330 {
 331         Debug("Recreate buffers with %u objects", m_document.ObjectCount());
 332         // Prepare bounds vbo
 333         m_bounds_ubo.Invalidate();
 334         m_bounds_ubo.SetType(GraphicsBuffer::BufferTypeUniform);
 335         m_bounds_ubo.SetUsage(GraphicsBuffer::BufferUsageStreamDraw);
 336         m_bounds_ubo.SetName("m_bounds_ubo: Screen bounds.");
 337
 338         // Instead of having each ObjectRenderer go through the whole document
 339         //  we initialise them, go through the document once adding to the appropriate Renderers
 340         //  and then finalise them
 341         // This will totally be efficient if we have like, a lot of distinct ObjectTypes. Which could totally happen. You never know.
 342
 343         // Prepare the buffers
 344         for (unsigned i = 0; i < m_object_renderers.size(); ++i)
 345         {
 346                 m_object_renderers[i]->PrepareBuffers(m_document.ObjectCount());
 347         }
 348
 349         // Add objects from Document to buffers
 350         for (unsigned id = 0; id < m_document.ObjectCount(); ++id)
 351         {
 352                 ObjectType type = m_document.m_objects.types[id];
 353                 m_object_renderers.at(type)->AddObjectToBuffers(id); // Use at() in case the document is corrupt TODO: Better error handling?
 354                 // (Also, Wow I just actually used std::vector::at())
 355                 // (Also, I just managed to make it throw an exception because I'm a moron)
 356                 //Debug("Object of type %d", type);
 357         }
 358
 359         // Finish the buffers
 360         for (unsigned i = 0; i < m_object_renderers.size(); ++i)
 361         {
 362                 m_object_renderers[i]->FinaliseBuffers();
 363         }
 364         dynamic_cast<BezierRenderer*>(m_object_renderers[BEZIER])->PrepareBezierGPUBuffer(m_document.m_objects);
 365         m_render_dirty = false;
 366 }