VTK  9.2.6
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
39class vtkMatrix4x4;
40class vtkOpenGLExtensionManager;
41class vtkOpenGLHelper;
43class vtkPath;
44class vtkRenderer;
47class vtkTransform;
48class vtkViewport;
49class vtkWindow;
50
51class VTKRENDERINGCONTEXTOPENGL2_EXPORT vtkOpenGLContextDevice2D : public vtkContextDevice2D
52{
53public:
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
108 void DrawMarkers(int shape, bool highlight, float* points, int n, unsigned char* colors = nullptr,
109 int nc_comps = 0) override;
110
112
117 vtkSetMacro(MaximumMarkerCacheSize, int);
118 vtkGetMacro(MaximumMarkerCacheSize, int);
120
124 void DrawQuad(float* points, int n) override;
125
129 void DrawQuadStrip(float* points, int n) override;
130
134 void DrawPolygon(float*, int) override;
136 float* points, int numPoints, unsigned char* colors = nullptr, int nc_comps = 0) override;
137
149 void DrawEllipseWedge(float x, float y, float outRx, float outRy, float inRx, float inRy,
150 float startAngle, float stopAngle) override;
151
159 float x, float y, float rX, float rY, float startAngle, float stopAngle) override;
160
164 void DrawString(float* point, const vtkStdString& string) override;
165
174 void ComputeStringBounds(const vtkStdString& string, float bounds[4]) override;
175
181 void ComputeJustifiedStringBounds(const char* string, float bounds[4]) override;
182
187 void DrawMathTextString(float point[2], const vtkStdString& string) override;
188
193 void DrawImage(float p[2], float scale, vtkImageData* image) override;
194
200 void DrawImage(const vtkRectf& pos, vtkImageData* image) override;
201
206 void DrawPolyData(float p[2], float scale, vtkPolyData* polyData, vtkUnsignedCharArray* colors,
207 int scalarMode) override;
208
212 void SetColor4(unsigned char color[4]) override;
213
217 virtual void SetColor(unsigned char color[3]);
218
222 void SetTexture(vtkImageData* image, int properties = 0) override;
223
227 void SetPointSize(float size) override;
228
232 void SetLineWidth(float width) override;
233
237 void SetLineType(int type) override;
238
242 void MultiplyMatrix(vtkMatrix3x3* m) override;
243
247 void SetMatrix(vtkMatrix3x3* m) override;
248
252 void GetMatrix(vtkMatrix3x3* m) override;
253
257 void PushMatrix() override;
258
262 void PopMatrix() override;
263
264 /*
265 * Supply an int array of length 4 with x1, y1, width, height specifying
266 * clipping region for the device in pixels.
267 */
268 void SetClipping(int* x) override;
269
273 void EnableClipping(bool enable) override;
274
278 void Begin(vtkViewport* viewport) override;
279
283 void End() override;
284
293
301 void BufferIdModeEnd() override;
302
309
315
319 bool HasGLSL();
320
322
325 vtkGetObjectMacro(RenderWindow, vtkOpenGLRenderWindow);
327
333 virtual void ReleaseGraphicsResources(vtkWindow* window);
334
336
342
343protected:
346
354 int GetNumberOfArcIterations(float rX, float rY, float startAngle, float stopAngle);
355
360
365
367
370 class Private;
372
373 class CellArrayHelper;
376
381
382 vtkOpenGLHelper* LinesCBO; // vertex + color
386 vtkOpenGLHelper* VCBO; // vertex + color
390 vtkOpenGLHelper* VTBO; // vertex + tcoord
392 vtkOpenGLHelper* SCBO; // sprite + color
396
399 vtkOpenGLHelper* cbo, float* v, int nv, unsigned char* coolors, int nc, float* tcoords);
401 std::vector<float>& tverts, unsigned char* colors = nullptr, int numComp = 0);
402 // used for stipples
403 unsigned short LinePattern;
404
406
411 int shape, bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
413 bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
415 bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
417 bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
419 bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
421 bool highlight, float* points, int n, unsigned char* colors, int nc_comps);
423
425
428 void DrawImageGL2PS(float p[2], vtkImageData* image);
429 void DrawImageGL2PS(float p[2], float scale, vtkImageData* image);
430 void DrawImageGL2PS(const vtkRectf& rect, vtkImageData* image);
432
434
437 void DrawCircleGL2PS(float x, float y, float rX, float rY);
438 void DrawWedgeGL2PS(float x, float y, float outRx, float outRy, float inRx, float inRy);
440
444 void AddEllipseToPath(vtkPath* path, float x, float y, float rx, float ry, bool reverse);
445
449 void TransformPath(vtkPath* path) const;
450
454 void TransformPoint(float& x, float& y) const;
455
459 void TransformSize(float& dx, float& dy) const;
460
461private:
463 void operator=(const vtkOpenGLContextDevice2D&) = delete;
464
471 vtkImageData* GetMarker(int shape, int size, bool highlight);
472
473 class vtkMarkerCacheObject
474 {
475 public:
476 vtkTypeUInt64 Key;
477 vtkImageData* Value;
478 bool operator==(vtkTypeUInt64 key) { return this->Key == key; }
479 };
480
481 void ComputeStringBoundsInternal(const std::string& string, float bounds[4]);
482
483 vtkTransform* ProjectionMatrix;
484 vtkTransform* ModelMatrix;
485
486 std::list<vtkMarkerCacheObject> MarkerCache;
487 int MaximumMarkerCacheSize;
488
493 vtkImageData* GenerateMarker(int shape, int size, bool highlight);
494};
495
496#endif // vtkOpenGLContextDevice2D_h
2D array of ids, used for picking.
Abstract class for drawing 2D primitives.
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:34
represent and manipulate 3x3 transformation matrices
represent and manipulate 4x4 transformation matrices
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)
Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.
~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.
vtkMatrix4x4 * GetModelMatrix()
Get the projection matrix this is needed.
void SetMatrices(vtkShaderProgram *prog)
void DrawImageGL2PS(const vtkRectf &rect, vtkImageData *image)
Embed an RGBA image in the GL2PS output at the supplied point.
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.
void DrawCrossMarkersGL2PS(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 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... The lines will be c...
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.
static vtkOpenGLContextDevice2D * New()
Creates a 2D Painter object.
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.
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)
Embed an RGBA image in the GL2PS output at the supplied point.
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 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)
Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.
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 * GetProjectionMatrix()
Get the projection matrix this is needed.
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)
Inject smooth primitives into the GL2PS stream.
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)
Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.
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)
Draw the markers as paths/polydata instead of sprites for detailed GL2PS capture.
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:67
The ShaderProgram uses one or more Shader objects.
Wrapper around std::string to keep symbols short.
base class for classes that render supplied text to an image.
describes linear transformations via a 4x4 matrix
dynamic, self-adjusting array of unsigned char
abstract specification for Viewports
Definition vtkViewport.h:50
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
bool VTKCOMMONDATAMODEL_EXPORT operator==(vtkEdgeBase e1, vtkEdgeBase e2)