VTK  9.3.0
vtkPlanes.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
39 #ifndef vtkPlanes_h
40 #define vtkPlanes_h
41 
42 #include "vtkCommonDataModelModule.h" // For export macro
43 #include "vtkImplicitFunction.h"
44 
45 VTK_ABI_NAMESPACE_BEGIN
46 class vtkPlane;
47 class vtkPoints;
48 class vtkDataArray;
49 
50 class VTKCOMMONDATAMODEL_EXPORT vtkPlanes : public vtkImplicitFunction
51 {
52 public:
54 
57  static vtkPlanes* New();
59  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
63 
68  double EvaluateFunction(double x[3]) override;
70 
74  void EvaluateGradient(double x[3], double n[3]) override;
75 
77 
80  virtual void SetPoints(vtkPoints*);
81  vtkGetObjectMacro(Points, vtkPoints);
83 
85 
89  void SetNormals(vtkDataArray* normals);
90  vtkGetObjectMacro(Normals, vtkDataArray);
92 
97  void SetFrustumPlanes(double planes[24]);
98 
100 
105  void SetBounds(const double bounds[6]);
106  void SetBounds(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax);
108 
113 
121 
127  void GetPlane(int i, vtkPlane* plane);
128 
129 protected:
131  ~vtkPlanes() override;
132 
136 
137 private:
138  double Planes[24];
139  double Bounds[6];
140 
141  vtkPlanes(const vtkPlanes&) = delete;
142  void operator=(const vtkPlanes&) = delete;
143 };
144 
145 VTK_ABI_NAMESPACE_END
146 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
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:38
perform various plane computations
Definition: vtkPlane.h:35
implicit function for convex set of planes
Definition: vtkPlanes.h:51
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:133
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:135
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:134
represent and manipulate 3D points
Definition: vtkPoints.h:38