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