VTK  9.1.0
vtkPlaneSource.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPlaneSource.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=========================================================================*/
157#ifndef vtkPlaneSource_h
158#define vtkPlaneSource_h
159
160#include "vtkFiltersSourcesModule.h" // For export macro
161#include "vtkPolyDataAlgorithm.h"
162
163class VTKFILTERSSOURCES_EXPORT vtkPlaneSource : public vtkPolyDataAlgorithm
164{
165public:
166 void PrintSelf(ostream& os, vtkIndent indent) override;
168
174
176
179 vtkSetMacro(XResolution, int);
180 vtkGetMacro(XResolution, int);
182
184
187 vtkSetMacro(YResolution, int);
188 vtkGetMacro(YResolution, int);
190
192
195 void SetResolution(const int xR, const int yR);
196 void GetResolution(int& xR, int& yR)
197 {
198 xR = this->XResolution;
199 yR = this->YResolution;
200 }
202
204
207 vtkSetVector3Macro(Origin, double);
208 vtkGetVectorMacro(Origin, double, 3);
210
212
215 void SetPoint1(double x, double y, double z);
216 void SetPoint1(double pnt[3]);
217 vtkGetVectorMacro(Point1, double, 3);
219
221
224 void SetPoint2(double x, double y, double z);
225 void SetPoint2(double pnt[3]);
226 vtkGetVectorMacro(Point2, double, 3);
228
230
235 void GetAxis1(double a1[3]);
236 void GetAxis2(double a2[3]);
238
240
245 void SetCenter(double x, double y, double z);
246 void SetCenter(double center[3]);
247 vtkGetVectorMacro(Center, double, 3);
249
251
256 void SetNormal(double nx, double ny, double nz);
257 void SetNormal(double n[3]);
258 vtkGetVectorMacro(Normal, double, 3);
260
266 void Push(double distance);
267
273 void Rotate(double angle, double rotationAxis[3]);
274
276
281 vtkSetMacro(OutputPointsPrecision, int);
282 vtkGetMacro(OutputPointsPrecision, int);
284
285protected:
287 ~vtkPlaneSource() override = default;
288
290
293 double Origin[3];
294 double Point1[3];
295 double Point2[3];
296 double Normal[3];
297 double Center[3];
299
300 int UpdatePlane(double v1[3], double v2[3]);
301
302private:
303 vtkPlaneSource(const vtkPlaneSource&) = delete;
304 void operator=(const vtkPlaneSource&) = delete;
305};
306
307#endif
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
create an array of quadrilaterals located in a plane
void SetNormal(double nx, double ny, double nz)
Set/Get the plane normal.
void SetPoint1(double pnt[3])
Specify a point defining the first axis of the plane.
void GetResolution(int &xR, int &yR)
Set the number of x-y subdivisions in the plane.
void Rotate(double angle, double rotationAxis[3])
Rotate plane at center around a given axis If the absolute value of the angle is inferior to the defi...
void Push(double distance)
Translate the plane in the direction of the normal by the distance specified.
void SetPoint2(double pnt[3])
Specify a point defining the second axis of the plane.
~vtkPlaneSource() override=default
void SetCenter(double x, double y, double z)
Set/Get the center of the plane.
void GetAxis1(double a1[3])
Convenience methods to retrieve the axes of the plane; that is axis a1 is the vector (Point1-Origin),...
int UpdatePlane(double v1[3], double v2[3])
static vtkPlaneSource * New()
Construct plane perpendicular to z-axis, resolution 1x1, width and height 1.0, and centered at the or...
void SetNormal(double n[3])
Set/Get the plane normal.
void SetCenter(double center[3])
Set/Get the center of the plane.
void SetPoint1(double x, double y, double z)
Specify a point defining the first axis of the plane.
void SetPoint2(double x, double y, double z)
Specify a point defining the second axis of the plane.
void GetAxis2(double a2[3])
Convenience methods to retrieve the axes of the plane; that is axis a1 is the vector (Point1-Origin),...
void SetResolution(const int xR, const int yR)
Set the number of x-y subdivisions in the plane.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
Superclass for algorithms that produce only polydata as output.