VTK  9.3.20240416
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
139 #ifndef vtkPlanes_h
140 #define vtkPlanes_h
141 
142 #include "vtkCommonDataModelModule.h" // For export macro
143 #include "vtkImplicitFunction.h"
144 
145 VTK_ABI_NAMESPACE_BEGIN
146 class vtkPlane;
147 class vtkPoints;
148 class vtkDataArray;
149 
150 class VTKCOMMONDATAMODEL_EXPORT vtkPlanes : public vtkImplicitFunction
151 {
152 public:
154 
157  static vtkPlanes* New();
159  void PrintSelf(ostream& os, vtkIndent indent) override;
161 
163 
168  double EvaluateFunction(double x[3]) override;
170 
174  void EvaluateGradient(double x[3], double n[3]) override;
175 
177 
180  virtual void SetPoints(vtkPoints*);
181  vtkGetObjectMacro(Points, vtkPoints);
183 
185 
189  void SetNormals(vtkDataArray* normals);
190  vtkGetObjectMacro(Normals, vtkDataArray);
192 
197  void SetFrustumPlanes(double planes[24]);
198 
200 
205  void SetBounds(const double bounds[6]);
206  void SetBounds(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax);
208 
213 
221 
227  void GetPlane(int i, vtkPlane* plane);
228 
229 protected:
231  ~vtkPlanes() override;
232 
236 
237 private:
238  double Planes[24];
239  double Bounds[6];
240 
241  vtkPlanes(const vtkPlanes&) = delete;
242  void operator=(const vtkPlanes&) = delete;
243 };
244 
245 VTK_ABI_NAMESPACE_END
246 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:155
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:108
perform various plane computations
Definition: vtkPlane.h:135
implicit function for convex set of planes
Definition: vtkPlanes.h:151
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:233
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:235
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:234
represent and manipulate 3D points
Definition: vtkPoints.h:139