VTK  9.0.1
vtkContext3D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkContext3D.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 
27 #ifndef vtkContext3D_h
28 #define vtkContext3D_h
29 
30 #include "vtkObject.h"
31 #include "vtkRenderingContext2DModule.h" // For export macro
32 #include "vtkSmartPointer.h" // For SP ivars.
33 #include "vtkVector.h" // For the vector coordinates.
34 
35 class vtkContextDevice3D;
36 class vtkPen;
37 class vtkBrush;
38 class vtkTransform;
39 
40 class VTKRENDERINGCONTEXT2D_EXPORT vtkContext3D : public vtkObject
41 {
42 public:
43  vtkTypeMacro(vtkContext3D, vtkObject);
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
49  static vtkContext3D* New();
50 
56  bool Begin(vtkContextDevice3D* device);
57 
62 
68  bool End();
69 
73  void DrawLine(const vtkVector3f& start, const vtkVector3f& end);
74 
78  void DrawPoly(const float* points, int n);
79 
83  void DrawPoint(const vtkVector3f& point);
84 
88  void DrawPoints(const float* points, int n);
89 
95  void DrawPoints(const float* points, int n, unsigned char* colors, int nc_comps);
96 
100  void DrawTriangleMesh(const float* mesh, int n, const unsigned char* colors, int nc);
101 
107  void ApplyPen(vtkPen* pen);
108 
114  void ApplyBrush(vtkBrush* brush);
115 
121  void SetTransform(vtkTransform* transform);
122 
127 
134  void AppendTransform(vtkTransform* transform);
135 
137 
141  void PushMatrix();
142  void PopMatrix();
144 
146 
153  void EnableClippingPlane(int i, double* planeEquation);
154  void DisableClippingPlane(int i);
156 
157 protected:
159  ~vtkContext3D() override;
160 
161  vtkSmartPointer<vtkContextDevice3D> Device; // The underlying device
163 
164 private:
165  vtkContext3D(const vtkContext3D&) = delete;
166  void operator=(const vtkContext3D&) = delete;
167 };
168 
169 #endif // VTKCONTEXT3D_H
provides a brush that fills shapes drawn by vtkContext2D.
Definition: vtkBrush.h:38
Class for drawing 3D primitives to a graphical context.
Definition: vtkContext3D.h:41
~vtkContext3D() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool Begin(vtkContextDevice3D *device)
Begin painting on a vtkContextDevice3D, no painting can occur before this call has been made.
void DrawLine(const vtkVector3f &start, const vtkVector3f &end)
Draw a line between the specified points.
void DrawPoly(const float *points, int n)
Draw a poly line between the specified points.
vtkContextDevice3D * GetDevice()
Get access to the underlying 3D context.
vtkTransform * GetTransform()
Compute the current transform applied to the context.
void EnableClippingPlane(int i, double *planeEquation)
Enable/Disable the specified clipping plane.
vtkSmartPointer< vtkTransform > Transform
Definition: vtkContext3D.h:162
void SetTransform(vtkTransform *transform)
Set the transform for the context, the underlying device will use the matrix of the transform.
void DisableClippingPlane(int i)
void AppendTransform(vtkTransform *transform)
Append the transform for the context, the underlying device will use the matrix of the transform.
void DrawPoints(const float *points, int n)
Draw a sequence of points at the specified locations.
void PopMatrix()
vtkSmartPointer< vtkContextDevice3D > Device
Definition: vtkContext3D.h:161
void PushMatrix()
Push/pop the transformation matrix for the painter (sets the underlying matrix for the device when av...
void DrawTriangleMesh(const float *mesh, int n, const unsigned char *colors, int nc)
Draw triangles to generate the specified mesh.
void DrawPoints(const float *points, int n, unsigned char *colors, int nc_comps)
Draw a sequence of points at the specified locations.
bool End()
Ends painting on the device, you would not usually need to call this as it should be called by the de...
void ApplyPen(vtkPen *pen)
Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related pr...
static vtkContext3D * New()
Creates a 3D context object.
void ApplyBrush(vtkBrush *brush)
Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related ...
void DrawPoint(const vtkVector3f &point)
Draw a point at the point in 3D space.
Abstract class for drawing 3D primitives.
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:54
provides a pen that draws the outlines of shapes drawn by vtkContext2D.
Definition: vtkPen.h:37
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:55
@ point
Definition: vtkX3D.h:242
@ points
Definition: vtkX3D.h:452