VTK  9.1.0
vtkPlanes.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPlanes.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 =========================================================================*/
39 #ifndef vtkPlanes_h
40 #define vtkPlanes_h
41 
42 #include "vtkCommonDataModelModule.h" // For export macro
43 #include "vtkImplicitFunction.h"
44 
45 class vtkPlane;
46 class vtkPoints;
47 class vtkDataArray;
48 
49 class VTKCOMMONDATAMODEL_EXPORT vtkPlanes : public vtkImplicitFunction
50 {
51 public:
53 
56  static vtkPlanes* New();
58  void PrintSelf(ostream& os, vtkIndent indent) override;
60 
62 
67  double EvaluateFunction(double x[3]) override;
69 
73  void EvaluateGradient(double x[3], double n[3]) override;
74 
76 
79  virtual void SetPoints(vtkPoints*);
80  vtkGetObjectMacro(Points, vtkPoints);
82 
84 
88  void SetNormals(vtkDataArray* normals);
89  vtkGetObjectMacro(Normals, vtkDataArray);
91 
96  void SetFrustumPlanes(double planes[24]);
97 
99 
104  void SetBounds(const double bounds[6]);
105  void SetBounds(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax);
107 
112 
120 
126  void GetPlane(int i, vtkPlane* plane);
127 
128 protected:
130  ~vtkPlanes() override;
131 
135 
136 private:
137  double Planes[24];
138  double Bounds[6];
139 
140 private:
141  vtkPlanes(const vtkPlanes&) = delete;
142  void operator=(const vtkPlanes&) = delete;
143 };
144 
145 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
abstract interface for implicit functions
virtual double EvaluateFunction(double x[3])=0
Evaluate function at position x-y-z and return value.
a simple class to control print indentation
Definition: vtkIndent.h:34
perform various plane computations
Definition: vtkPlane.h:34
implicit function for convex set of planes
Definition: vtkPlanes.h:50
void SetBounds(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
An alternative method to specify six planes defined by a bounding box.
void GetPlane(int i, vtkPlane *plane)
If i is within the allowable range, mutates the given plane's Normal and Origin to match the vtkPlane...
void SetFrustumPlanes(double planes[24])
An alternative method to specify six planes defined by the camera view frustrum.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instantiation, type information, and printing.
virtual void SetPoints(vtkPoints *)
Specify a list of points defining points through which the planes pass.
~vtkPlanes() override
vtkPoints * Points
Definition: vtkPlanes.h:132
void SetBounds(const double bounds[6])
An alternative method to specify six planes defined by a bounding box.
int GetNumberOfPlanes()
Return the number of planes in the set of planes.
static vtkPlanes * New()
Standard methods for instantiation, type information, and printing.
double EvaluateFunction(double x[3]) override
Evaluate plane equations.
vtkPlane * GetPlane(int i)
Create and return a pointer to a vtkPlane object at the ith position.
vtkPlane * Plane
Definition: vtkPlanes.h:134
void EvaluateGradient(double x[3], double n[3]) override
Evaluate planes gradient.
void SetNormals(vtkDataArray *normals)
Specify a list of normal vectors for the planes.
vtkDataArray * Normals
Definition: vtkPlanes.h:133
represent and manipulate 3D points
Definition: vtkPoints.h:34