VTK  9.0.3
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 "vtkContextDevice2D.h"
34 #include "vtkRenderingContextOpenGL2Module.h" // For export macro
35 
36 #include <list> // for std::list
37 #include <vector> // STL Header
38 
39 class vtkMatrix4x4;
40 class vtkOpenGLExtensionManager;
41 class vtkOpenGLHelper;
43 class vtkPath;
44 class vtkRenderer;
45 class vtkShaderProgram;
46 class vtkStringToImage;
47 class vtkTransform;
48 class vtkViewport;
49 class vtkWindow;
50 
51 class VTKRENDERINGCONTEXTOPENGL2_EXPORT vtkOpenGLContextDevice2D : public vtkContextDevice2D
52 {
53 public:
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
61 
67  void DrawPoly(float* f, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
68 
75  void DrawLines(float* f, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
76 
82  void DrawPoints(float* points, int n, unsigned char* colors = nullptr, int nc_comps = 0) override;
83 
90  void DrawPointSprites(vtkImageData* sprite, float* points, int n, unsigned char* colors = nullptr,
91  int nc_comps = 0) override;
92 
104  void DrawMarkers(int shape, bool highlight, float* points, int n, unsigned char* colors = nullptr,
105  int nc_comps = 0) override;
106 
108 
113  vtkSetMacro(MaximumMarkerCacheSize, int);
114  vtkGetMacro(MaximumMarkerCacheSize, int);
116 
120  void DrawQuad(float* points, int n) override;
121 
125  void DrawQuadStrip(float* points, int n) override;
126 
130  void DrawPolygon(float*, int) override;
132  float* points, int numPoints, unsigned char* colors = nullptr, int nc_comps = 0) override;
133 
145  void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
146  float startAngle, float stopAngle) override;
147 
155  float x, float y, float rX, float rY, float startAngle, float stopAngle) override;
156 
160  void DrawString(float* point, const vtkStdString& string) override;
161 
170  void ComputeStringBounds(const vtkStdString& string, float bounds[4]) override;
171 
175  void DrawString(float* point, const vtkUnicodeString& string) override;
176 
185  void ComputeStringBounds(const vtkUnicodeString& string, 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 
217  void DrawPolyData(float p[2], float scale, vtkPolyData* polyData, vtkUnsignedCharArray* colors,
218  int scalarMode) override;
219 
223  void SetColor4(unsigned char color[4]) override;
224 
228  virtual void SetColor(unsigned char color[3]);
229 
233  void SetTexture(vtkImageData* image, int properties = 0) override;
234 
238  void SetPointSize(float size) override;
239 
243  void SetLineWidth(float width) override;
244 
248  void SetLineType(int type) override;
249 
253  void MultiplyMatrix(vtkMatrix3x3* m) override;
254 
258  void SetMatrix(vtkMatrix3x3* m) override;
259 
263  void GetMatrix(vtkMatrix3x3* m) override;
264 
268  void PushMatrix() override;
269 
273  void PopMatrix() override;
274 
275  /*
276  * Supply an int array of length 4 with x1, y1, width, height specifying
277  * clipping region for the device in pixels.
278  */
279  void SetClipping(int* x) override;
280 
284  void EnableClipping(bool enable) override;
285 
289  void Begin(vtkViewport* viewport) override;
290 
294  void End() override;
295 
304 
312  void BufferIdModeEnd() override;
313 
320 
326 
330  bool HasGLSL();
331 
333 
336  vtkGetObjectMacro(RenderWindow, vtkOpenGLRenderWindow);
338 
344  virtual void ReleaseGraphicsResources(vtkWindow* window);
345 
347 
353 
354 protected:
357 
365  int GetNumberOfArcIterations(float rX, float rY, float startAngle, float stopAngle);
366 
371 
375  bool InRender;
376 
378 
381  class Private;
383 
384  class CellArrayHelper;
387 
392 
393  vtkOpenGLHelper* LinesCBO; // vertex + color
397  vtkOpenGLHelper* VCBO; // vertex + color
399  vtkOpenGLHelper* VBO; // vertex
401  vtkOpenGLHelper* VTBO; // vertex + tcoord
403  vtkOpenGLHelper* SCBO; // sprite + color
405  vtkOpenGLHelper* SBO; // sprite
407 
409  void BuildVBO(
410  vtkOpenGLHelper* cbo, float* v, int nv, unsigned char* coolors, int nc, float* tcoords);
412  std::vector<float>& tverts, unsigned char* colors = nullptr, int numComp = 0);
413  // used for stipples
414  unsigned short LinePattern;
415 
417 
422  int shape, bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
424  bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
426  bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
428  bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
430  bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
432  bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
434 
436 
439  void DrawImageGL2PS(float p[2], vtkImageData* image);
440  void DrawImageGL2PS(float p[2], float scale, vtkImageData* image);
443 
445 
448  void DrawCircleGL2PS(float x, float y, float rX, float rY);
449  void DrawWedgeGL2PS(float x, float y, float outRx, float outRy, float inRx, float inRy);
451 
455  void AddEllipseToPath(vtkPath* path, float x, float y, float rx, float ry, bool reverse);
456 
460  void TransformPath(vtkPath* path) const;
461 
465  void TransformPoint(float& x, float& y) const;
466 
470  void TransformSize(float& dx, float& dy) const;
471 
472 private:
474  void operator=(const vtkOpenGLContextDevice2D&) = delete;
475 
482  vtkImageData* GetMarker(int shape, int size, bool highlight);
483 
484  class vtkMarkerCacheObject
485  {
486  public:
487  vtkTypeUInt64 Key;
488  vtkImageData* Value;
489  bool operator==(vtkTypeUInt64 key) { return this->Key == key; }
490  };
491 
492  void ComputeStringBoundsInternal(const vtkUnicodeString& string, float bounds[4]);
493 
494  vtkTransform* ProjectionMatrix;
495  vtkTransform* ModelMatrix;
496 
497  std::list<vtkMarkerCacheObject> MarkerCache;
498  int MaximumMarkerCacheSize;
499 
504  vtkImageData* GenerateMarker(int shape, int size, bool highlight);
505 };
506 
507 #endif // vtkOpenGLContextDevice2D_h
2D array of ids, used for picking.
Abstract class for drawing 2D primitives.
topologically and geometrically regular array of data
Definition: vtkImageData.h:42
a simple class to control print indentation
Definition: vtkIndent.h:34
represent and manipulate 3x3 transformation matrices
Definition: vtkMatrix3x3.h:34
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:36
Class for drawing 2D primitives using OpenGL 1.1+.
void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle) override
Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx,...
void DrawCircleMarkersGL2PS(bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
~vtkOpenGLContextDevice2D() override
void PopMatrix() override
Pop the current matrix off of the stack.
bool HasGLSL()
Check whether the current context device has support for GLSL.
void SetLineType(int type) override
Set the line type type (using anonymous enum in vtkPen).
void DrawPoly(float *f, int n, unsigned char *colors=nullptr, int nc_comps=0) override
Draw a poly line using the points - fastest code path due to memory layout of the coordinates.
void PushMatrix() override
Push the current matrix onto the stack.
int GetNumberOfArcIterations(float rX, float rY, float startAngle, float stopAngle)
Factorized code called by DrawEllipseWedge() and DrawEllipticArc() to figure out the number of iterat...
void CoreDrawTriangles(std::vector< float > &tverts, unsigned char *colors=nullptr, int numComp=0)
void BufferIdModeBegin(vtkAbstractContextBufferId *bufferId) override
Start BufferId creation Mode.
void SetMatrices(vtkShaderProgram *prog)
void DrawImageGL2PS(const vtkRectf &rect, vtkImageData *image)
void DrawImage(const vtkRectf &pos, vtkImageData *image) override
Draw the supplied image at the given position.
void SetLineWidth(float width) override
Set the line width for glyphs/sprites.
void SetPointSize(float size) override
Set the point size for glyphs/sprites.
virtual void SetColor(unsigned char color[3])
Set the color for the device using unsigned char of length 3, RGB.
void EnableClipping(bool enable) override
Disable clipping of the display.
static vtkOpenGLContextDevice2D * New()
Creates a 2D Painter object.
void DrawCrossMarkersGL2PS(bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
void DrawLines(float *f, int n, unsigned char *colors=nullptr, int nc_comps=0) override
Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2...
void DrawPointSprites(vtkImageData *sprite, float *points, int n, unsigned char *colors=nullptr, int nc_comps=0) override
Draw a series of point sprites, images centred at the points supplied.
void GetMatrix(vtkMatrix3x3 *m) override
Set the model view matrix for the display.
void SetTexture(vtkImageData *image, int properties=0) override
Set the texture for the device, it is used to fill the polygons.
void DrawString(float *point, const vtkUnicodeString &string) override
Draw some text to the screen.
void DrawColoredPolygon(float *points, int numPoints, unsigned char *colors=nullptr, int nc_comps=0) override
Draw a polygon using the specified number of points.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMatrix4x4 * GetProjectionMatrix()
Get the projection matrix this is needed.
void End() override
End drawing, clean up the view.
vtkRenderer * Renderer
We need to store a pointer to the renderer for the text rendering.
void DrawMathTextString(float point[2], const vtkStdString &string) override
Draw text using MathText markup for mathematical equations.
void DrawImageGL2PS(float p[2], float scale, vtkImageData *image)
vtkOpenGLRenderWindow * RenderWindow
The OpenGL render window being used by the device.
void DrawEllipticArc(float x, float y, float rX, float rY, float startAngle, float stopAngle) override
Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle ...
void DrawPolygon(float *, int) override
Draw a polygon using the specified number of points.
void ComputeStringBounds(const vtkUnicodeString &string, float bounds[4]) override
Compute the bounds of the supplied string.
void BuildVBO(vtkOpenGLHelper *cbo, float *v, int nv, unsigned char *coolors, int nc, float *tcoords)
void TransformSize(float &dx, float &dy) const
Transform the width and height from pixels to data units.
void DrawCircleGL2PS(float x, float y, float rX, float rY)
Inject smooth primitives into the GL2PS stream.
void DrawPoints(float *points, int n, unsigned char *colors=nullptr, int nc_comps=0) override
Draw a series of points - fastest code path due to memory layout of the coordinates.
void ComputeStringBounds(const vtkStdString &string, float bounds[4]) override
Compute the bounds of the supplied string.
virtual void ReleaseGraphicsResources(vtkWindow *window)
Release any graphics resources that are being consumed by this device.
void SetMatrix(vtkMatrix3x3 *m) override
Set the model view matrix for the display.
void DrawSquareMarkersGL2PS(bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
void DrawQuadStrip(float *points, int n) override
Draws a rectangle.
void DrawImage(float p[2], float scale, vtkImageData *image) override
Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1....
void DrawString(float *point, const vtkStdString &string) override
Draw some text to the screen!
void TransformPath(vtkPath *path) const
Transform the path using the current modelview matrix.
bool SetStringRendererToQt()
Force the use of the Qt based string render strategy.
vtkMatrix4x4 * GetModelMatrix()
void BufferIdModeEnd() override
Finalize BufferId creation Mode.
void SetClipping(int *x) override
Supply an int array of length 4 with x1, y1, width, height specifying clipping region for the device ...
void DrawMarkers(int shape, bool highlight, float *points, int n, unsigned char *colors=nullptr, int nc_comps=0) override
Draw a series of markers centered at the points supplied.
void DrawWedgeGL2PS(float x, float y, float outRx, float outRy, float inRx, float inRy)
void SetColor4(unsigned char color[4]) override
Set the color for the device using unsigned char of length 4, RGBA.
bool SetStringRendererToFreeType()
Force the use of the freetype based render strategy.
void Begin(vtkViewport *viewport) override
Begin drawing, pass in the viewport to set up the view.
void DrawImageGL2PS(float p[2], vtkImageData *image)
Embed an RGBA image in the GL2PS output at the supplied point.
void ComputeJustifiedStringBounds(const char *string, float bounds[4]) override
Compute the bounds of the supplied string while taking into account the justification of the currentl...
void DrawPolyData(float p[2], float scale, vtkPolyData *polyData, vtkUnsignedCharArray *colors, int scalarMode) override
Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1....
void AddEllipseToPath(vtkPath *path, float x, float y, float rx, float ry, bool reverse)
Add an ellipse to a vtkPath.
void DrawPlusMarkersGL2PS(bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
void TransformPoint(float &x, float &y) const
Transform the 2D point using the current modelview matrix.
void DrawDiamondMarkersGL2PS(bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
void DrawMarkersGL2PS(int shape, bool highlight, float *points, int n, unsigned char *colors, int nc_comps)
Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.
void DrawQuad(float *points, int n) override
Draws a rectangle.
bool InRender
Is the device currently rendering? Prevent multiple End() calls.
void MultiplyMatrix(vtkMatrix3x3 *m) override
Multiply the current model view matrix by the supplied one.
OpenGL rendering window.
concrete dataset representing a path defined by Bezier curves.
Definition: vtkPath.h:33
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
abstract specification for renderers
Definition: vtkRenderer.h:68
The ShaderProgram uses one or more Shader objects.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:35
base class for classes that render supplied text to an image.
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:55
String class that stores Unicode text.
dynamic, self-adjusting array of unsigned char
abstract specification for Viewports
Definition: vtkViewport.h:45
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
@ point
Definition: vtkX3D.h:242
@ key
Definition: vtkX3D.h:263
@ points
Definition: vtkX3D.h:452
@ startAngle
Definition: vtkX3D.h:492
@ scale
Definition: vtkX3D.h:235
@ type
Definition: vtkX3D.h:522
@ color
Definition: vtkX3D.h:227
@ image
Definition: vtkX3D.h:380
@ size
Definition: vtkX3D.h:259
VTKCOMMONCORE_EXPORT bool operator==(const vtkUnicodeString &lhs, const vtkUnicodeString &rhs)