VTK  9.0.20210304
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 =========================================================================*/
48 #ifndef vtkPlaneSource_h
49 #define vtkPlaneSource_h
50 
51 #include "vtkFiltersSourcesModule.h" // For export macro
52 #include "vtkPolyDataAlgorithm.h"
53 
54 class VTKFILTERSSOURCES_EXPORT vtkPlaneSource : public vtkPolyDataAlgorithm
55 {
56 public:
57  void PrintSelf(ostream& os, vtkIndent indent) override;
59 
64  static vtkPlaneSource* New();
65 
67 
70  vtkSetMacro(XResolution, int);
71  vtkGetMacro(XResolution, int);
73 
75 
78  vtkSetMacro(YResolution, int);
79  vtkGetMacro(YResolution, int);
81 
83 
86  void SetResolution(const int xR, const int yR);
87  void GetResolution(int& xR, int& yR)
88  {
89  xR = this->XResolution;
90  yR = this->YResolution;
91  }
93 
95 
98  vtkSetVector3Macro(Origin, double);
99  vtkGetVectorMacro(Origin, double, 3);
101 
103 
106  void SetPoint1(double x, double y, double z);
107  void SetPoint1(double pnt[3]);
108  vtkGetVectorMacro(Point1, double, 3);
110 
112 
115  void SetPoint2(double x, double y, double z);
116  void SetPoint2(double pnt[3]);
117  vtkGetVectorMacro(Point2, double, 3);
119 
121 
126  void GetAxis1(double a1[3]);
127  void GetAxis2(double a2[3]);
129 
131 
136  void SetCenter(double x, double y, double z);
137  void SetCenter(double center[3]);
138  vtkGetVectorMacro(Center, double, 3);
140 
142 
147  void SetNormal(double nx, double ny, double nz);
148  void SetNormal(double n[3]);
149  vtkGetVectorMacro(Normal, double, 3);
151 
157  void Push(double distance);
158 
160 
165  vtkSetMacro(OutputPointsPrecision, int);
166  vtkGetMacro(OutputPointsPrecision, int);
168 
169 protected:
171  ~vtkPlaneSource() override = default;
172 
174 
177  double Origin[3];
178  double Point1[3];
179  double Point2[3];
180  double Normal[3];
181  double Center[3];
183 
184  int UpdatePlane(double v1[3], double v2[3]);
185 
186 private:
187  vtkPlaneSource(const vtkPlaneSource&) = delete;
188  void operator=(const vtkPlaneSource&) = delete;
189 };
190 
191 #endif
vtkPlaneSource::SetPoint1
void SetPoint1(double x, double y, double z)
Specify a point defining the first axis of the plane.
vtkPlaneSource::YResolution
int YResolution
Definition: vtkPlaneSource.h:176
vtkPlaneSource::SetNormal
void SetNormal(double n[3])
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:36
vtkPlaneSource::SetResolution
void SetResolution(const int xR, const int yR)
Set the number of x-y subdivisions in the plane.
vtkPlaneSource
create an array of quadrilaterals located in a plane
Definition: vtkPlaneSource.h:55
vtkX3D::Normal
@ Normal
Definition: vtkX3D.h:51
vtkPlaneSource::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPlaneSource::SetNormal
void SetNormal(double nx, double ny, double nz)
Set/Get the plane normal.
vtkPlaneSource::Push
void Push(double distance)
Translate the plane in the direction of the normal by the distance specified.
vtkX3D::center
@ center
Definition: vtkX3D.h:236
vtkPlaneSource::GetResolution
void GetResolution(int &xR, int &yR)
Definition: vtkPlaneSource.h:87
vtkPlaneSource::SetPoint1
void SetPoint1(double pnt[3])
vtkPolyDataAlgorithm.h
vtkPlaneSource::SetPoint2
void SetPoint2(double x, double y, double z)
Specify a point defining the second axis of the plane.
vtkPlaneSource::~vtkPlaneSource
~vtkPlaneSource() override=default
vtkPlaneSource::vtkPlaneSource
vtkPlaneSource()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkPlaneSource::SetCenter
void SetCenter(double x, double y, double z)
Set/Get the center of the plane.
vtkPlaneSource::SetCenter
void SetCenter(double center[3])
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkPlaneSource::GetAxis1
void GetAxis1(double a1[3])
Convenience methods to retrieve the axes of the plane; that is axis a1 is the vector (Point1-Origin),...
vtkPlaneSource::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkPlaneSource::UpdatePlane
int UpdatePlane(double v1[3], double v2[3])
vtkPlaneSource::GetAxis2
void GetAxis2(double a2[3])
vtkPlaneSource::New
static vtkPlaneSource * New()
Construct plane perpendicular to z-axis, resolution 1x1, width and height 1.0, and centered at the or...
vtkPlaneSource::XResolution
int XResolution
Definition: vtkPlaneSource.h:175
vtkPlaneSource::SetPoint2
void SetPoint2(double pnt[3])
vtkPlaneSource::OutputPointsPrecision
int OutputPointsPrecision
Definition: vtkPlaneSource.h:182
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:42