VTK
vtkOpenGLContextDevice2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOpenGLContextDevice2D.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
30 #ifndef vtkOpenGLContextDevice2D_h
31 #define vtkOpenGLContextDevice2D_h
32 
33 #include "vtkRenderingContextOpenGLModule.h" // For export macro
34 #include "vtkContextDevice2D.h"
35 
36 #include <list> // for std::list
37 
38 class vtkWindow;
39 class vtkViewport;
40 class vtkRenderer;
41 class vtkTextRenderer;
44 
45 class VTKRENDERINGCONTEXTOPENGL_EXPORT vtkOpenGLContextDevice2D : public vtkContextDevice2D
46 {
47 public:
49  void PrintSelf(ostream &os, vtkIndent indent) override;
50 
54  static vtkOpenGLContextDevice2D *New();
55 
62  void DrawPoly(float *f, int n, unsigned char *colors = 0,
63  int nc_comps = 0) override;
64 
71  void DrawLines(float *f, int n, unsigned char *colors = 0,
72  int nc_comps = 0) override;
73 
79  void DrawPoints(float *points, int n, unsigned char* colors = 0,
80  int nc_comps = 0) override;
81 
88  void DrawPointSprites(vtkImageData *sprite, float *points, int n,
89  unsigned char* colors = 0, int nc_comps = 0) override;
90 
102  void DrawMarkers(int shape, bool highlight, float *points, int n,
103  unsigned char *colors = 0, int nc_comps = 0) override;
104 
106 
111  vtkSetMacro(MaximumMarkerCacheSize, int)
112  vtkGetMacro(MaximumMarkerCacheSize, int)
114 
118  void DrawQuad(float *points, int n) override;
119 
123  void DrawQuadStrip(float *points, int n) override;
124 
128  void DrawPolygon(float *, int) override;
129 
141  void DrawEllipseWedge(float x, float y, float outRx, float outRy,
142  float inRx, float inRy, float startAngle,
143  float stopAngle) override;
144 
151  void DrawEllipticArc(float x, float y, float rX, float rY,
152  float startAngle, float stopAngle) override;
153 
154 
158  void DrawString(float *point, const vtkStdString &string) override;
159 
168  void ComputeStringBounds(const vtkStdString &string,
169  float bounds[4]) override;
170 
174  void DrawString(float *point, const vtkUnicodeString &string) override;
175 
184  void ComputeStringBounds(const vtkUnicodeString &string,
185  float bounds[4]) override;
186 
192  void ComputeJustifiedStringBounds(const char* string, float bounds[4]) override;
193 
198  void DrawMathTextString(float point[2], const vtkStdString &string) override;
199 
204  void DrawImage(float p[2], float scale, vtkImageData *image) override;
205 
211  void DrawImage(const vtkRectf& pos, vtkImageData *image) override;
212 
219  void DrawPolyData(float p[2], float scale, vtkPolyData* polyData,
220  vtkUnsignedCharArray* colors, int scalarMode) override;
221 
225  void SetColor4(unsigned char color[4]) override;
226 
230  virtual void SetColor(unsigned char color[3]);
231 
235  void SetTexture(vtkImageData* image, int properties = 0) override;
236 
240  void SetPointSize(float size) override;
241 
245  void SetLineWidth(float width) override;
246 
250  void SetLineType(int type) override;
251 
255  void MultiplyMatrix(vtkMatrix3x3 *m) override;
256 
260  void SetMatrix(vtkMatrix3x3 *m) override;
261 
265  void GetMatrix(vtkMatrix3x3 *m) override;
266 
270  void PushMatrix() override;
271 
275  void PopMatrix() override;
276 
281  void SetClipping(int *x) override;
282 
286  void EnableClipping(bool enable) override;
287 
291  void Begin(vtkViewport* viewport) override;
292 
296  void End() override;
297 
305  void BufferIdModeBegin(vtkAbstractContextBufferId *bufferId) override;
306 
314  void BufferIdModeEnd() override;
315 
321  bool SetStringRendererToFreeType();
322 
327  bool SetStringRendererToQt();
328 
332  bool HasGLSL();
333 
335 
338  vtkGetObjectMacro(RenderWindow, vtkOpenGLRenderWindow);
340 
346  virtual void ReleaseGraphicsResources(vtkWindow *window);
347 
348 protected:
350  ~vtkOpenGLContextDevice2D() override;
351 
359  int GetNumberOfArcIterations(float rX,
360  float rY,
361  float startAngle,
362  float stopAngle);
363 
367  int Geometry[2];
368 
373 
377  bool InRender;
378 
380 
383  class Private;
384  Private *Storage;
386 
390  virtual bool LoadExtensions(vtkOpenGLExtensionManager *m);
391 
396 
397 private:
399  void operator=(const vtkOpenGLContextDevice2D &) = delete;
400 
407  vtkImageData *GetMarker(int shape, int size, bool highlight);
408 
409  class vtkMarkerCacheObject
410  {
411  public:
412  vtkTypeUInt64 Key;
413  vtkImageData *Value;
414  bool operator==(vtkTypeUInt64 key)
415  {
416  return this->Key == key;
417  }
418  };
419 
420  std::list<vtkMarkerCacheObject> MarkerCache;
421  int MaximumMarkerCacheSize;
422 
427  vtkImageData * GenerateMarker(int shape, int size, bool highlight);
428 
429  void ComputeStringBoundsInternal(const vtkUnicodeString &string,
430  float bounds[4]);
431 
432 
433 };
434 
435 #endif //vtkOpenGLContextDevice2D_h
OpenGL rendering window.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:40
virtual void SetMatrix(vtkMatrix3x3 *m)=0
Set the model view matrix for the display.
virtual void DrawPointSprites(vtkImageData *sprite, float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw a series of point sprites, images centred at the points supplied.
virtual void SetClipping(int *x)=0
Supply a float array of length 4 with x1, y1, width, height specifying clipping region for the device...
virtual void BufferIdModeEnd()
Finalize BufferId creation Mode.
virtual void ComputeJustifiedStringBounds(const char *string, float bounds[4])=0
Compute the bounds of the supplied string while taking into account the justification of the currentl...
virtual void DrawPoly(float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw a poly line using the points - fastest code path due to memory layout of the coordinates...
abstract specification for Viewports
Definition: vtkViewport.h:47
virtual void DrawPolygon(float *p, int n)
Draw a polygon using the specified number of points.
vtkRenderer * Renderer
We need to store a pointer to the renderer for the text rendering.
Class for drawing 2D primitives using OpenGL 1.1+.
virtual void BufferIdModeBegin(vtkAbstractContextBufferId *bufferId)
Start BufferId creation Mode.
abstract specification for renderers
Definition: vtkRenderer.h:63
static vtkContextDevice2D * New()
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
virtual void DrawPolyData(float p[2], float scale, vtkPolyData *polyData, vtkUnsignedCharArray *colors, int scalarMode)
Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1...
virtual void Begin(vtkViewport *)
Begin drawing, pass in the viewport to set up the view.
virtual void SetColor4(unsigned char color[4])=0
Set the color for the device using unsigned char of length 4, RGBA.
bool InRender
Is the device currently rendering? Prevent multiple End() calls.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
virtual void EnableClipping(bool enable)=0
Enable or disable the clipping of the scene.
virtual void SetLineWidth(float width)=0
Set the line width.
virtual void DrawPoints(float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw a series of points - fastest code path due to memory layout of the coordinates.
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void DrawMarkers(int shape, bool highlight, float *points, int n, unsigned char *colors=nullptr, int nc_comps=0)
Draw a series of markers centered at the points supplied.
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
virtual void DrawQuadStrip(float *, int)
Draw a quad using the specified number of points.
Abstract class for drawing 2D primitives.
virtual void PopMatrix()=0
Pop the current matrix off of the stack.
virtual void DrawLines(float *f, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... ...
virtual void SetTexture(vtkImageData *image, int properties)=0
Set the texture for the device, it is used to fill the polygons.
virtual void DrawMathTextString(float *point, const vtkStdString &string)=0
Draw text using MathText markup for mathematical equations.
vtkOpenGLRenderWindow * RenderWindow
The OpenGL render window being used by the device.
Interface class for querying and using OpenGL extensions.
virtual void SetPointSize(float size)=0
Set the point size for glyphs/sprites.
dynamic, self-adjusting array of unsigned char
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
virtual void DrawQuad(float *, int)
Draw a quad using the specified number of points.
2D array of ids, used for picking.
virtual void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle)=0
Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle ...
virtual void MultiplyMatrix(vtkMatrix3x3 *m)=0
Multiply the current model view matrix by the supplied one.
virtual void DrawString(float *point, const vtkStdString &string)=0
Draw some text to the screen.
virtual void End()
End drawing, clean up the view.
virtual void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle)=0
Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx...
Interface for generating images and path data from string data, using multiple backends.
virtual void GetMatrix(vtkMatrix3x3 *m)=0
Set the model view matrix for the display.
virtual void ComputeStringBounds(const vtkStdString &string, float bounds[4])=0
Compute the bounds of the supplied string.
VTKCOMMONCORE_EXPORT bool operator==(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)
virtual void PushMatrix()=0
Push the current matrix onto the stack.
virtual void DrawImage(float p[2], float scale, vtkImageData *image)=0
Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1...
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:36
virtual void SetLineType(int type)=0
Set the line type type (using anonymous enum in vtkPen).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
String class that stores Unicode text.