VTK  9.2.20221001
vtkPlane.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPlane.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 =========================================================================*/
137 #ifndef vtkPlane_h
138 #define vtkPlane_h
139 
140 #include "vtkCommonDataModelModule.h" // For export macro
141 #include "vtkImplicitFunction.h"
142 
143 VTK_ABI_NAMESPACE_BEGIN
144 class vtkPoints; // forward declaration
145 
146 class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
147 {
148 public:
152  static vtkPlane* New();
153 
155  void PrintSelf(ostream& os, vtkIndent indent) override;
156 
158 
162  void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
163  double EvaluateFunction(double x[3]) override;
165 
169  void EvaluateGradient(double x[3], double g[3]) override;
170 
172 
175  vtkSetVector3Macro(Normal, double);
176  vtkGetVectorMacro(Normal, double, 3);
178 
180 
184  vtkSetVector3Macro(Origin, double);
185  vtkGetVectorMacro(Origin, double, 3);
187 
193  void Push(double distance);
194 
196 
201  static void ProjectPoint(
202  const double x[3], const double origin[3], const double normal[3], double xproj[3]);
203  void ProjectPoint(const double x[3], double xproj[3]);
205 
207 
211  static void ProjectVector(
212  const double v[3], const double origin[3], const double normal[3], double vproj[3]);
213  void ProjectVector(const double v[3], double vproj[3]);
215 
217 
223  const double x[3], const double origin[3], const double normal[3], double xproj[3]);
224  void GeneralizedProjectPoint(const double x[3], double xproj[3]);
226 
230  static double Evaluate(double normal[3], double origin[3], double x[3]);
231 
233 
237  static double DistanceToPlane(double x[3], double n[3], double p0[3]);
238  double DistanceToPlane(double x[3]);
240 
242 
250  static int IntersectWithLine(
251  const double p1[3], const double p2[3], double n[3], double p0[3], double& t, double x[3]);
252  int IntersectWithLine(const double p1[3], const double p2[3], double& t, double x[3]);
254 
256 
266  static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3],
267  double py[3], double x0[3], double x1[3]);
269  double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]);
271 
273 
280  static bool ComputeBestFittingPlane(vtkPoints* pts, double* origin, double* normal);
282 
283 protected:
285  ~vtkPlane() override = default;
286 
287  double Normal[3];
288  double Origin[3];
289 
290 private:
291  vtkPlane(const vtkPlane&) = delete;
292  void operator=(const vtkPlane&) = delete;
293 };
294 
295 // Generally the normal should be normalized
296 inline double vtkPlane::Evaluate(double normal[3], double origin[3], double x[3])
297 {
298  return normal[0] * (x[0] - origin[0]) + normal[1] * (x[1] - origin[1]) +
299  normal[2] * (x[2] - origin[2]);
300 }
301 
302 // Assumes normal is normalized
303 inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
304 {
305 #define vtkPlaneAbs(x) ((x) < 0 ? -(x) : (x))
306  return (vtkPlaneAbs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
307 }
308 
309 VTK_ABI_NAMESPACE_END
310 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:166
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:120
perform various plane computations
Definition: vtkPlane.h:147
double DistanceToPlane(double x[3])
Return the distance of a point x to a plane defined by n(x-p0) = 0.
void GeneralizedProjectPoint(const double x[3], double xproj[3])
Project a point x onto plane defined by origin and normal.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void ProjectVector(const double v[3], const double origin[3], const double normal[3], double vproj[3])
Project a vector v onto plane defined by origin and normal.
void ProjectPoint(const double x[3], double xproj[3])
Project a point x onto plane defined by origin and normal.
~vtkPlane() override=default
void Push(double distance)
Translate the plane in the direction of the normal by the distance specified.
int IntersectWithLine(const double p1[3], const double p2[3], double &t, double x[3])
Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0,...
void EvaluateGradient(double x[3], double g[3]) override
Evaluate function gradient at point x[3].
int IntersectWithFinitePlane(double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3])
Given two planes, one infinite and one finite, defined by the normal n and point o (infinite plane),...
static void GeneralizedProjectPoint(const double x[3], const double origin[3], const double normal[3], double xproj[3])
Project a point x onto plane defined by origin and normal.
static bool ComputeBestFittingPlane(vtkPoints *pts, double *origin, double *normal)
Given a set of points calculate the best-fitting origin and normal for the plane.
static double Evaluate(double normal[3], double origin[3], double x[3])
Quick evaluation of plane equation n(x-origin)=0.
Definition: vtkPlane.h:296
static double DistanceToPlane(double x[3], double n[3], double p0[3])
Return the distance of a point x to a plane defined by n(x-p0) = 0.
Definition: vtkPlane.h:303
double EvaluateFunction(double x[3]) override
Evaluate plane equation for point x[3].
static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3])
Given two planes, one infinite and one finite, defined by the normal n and point o (infinite plane),...
static vtkPlane * New()
Construct plane passing through origin and normal to z-axis.
static int IntersectWithLine(const double p1[3], const double p2[3], double n[3], double p0[3], double &t, double x[3])
Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0,...
void ProjectVector(const double v[3], double vproj[3])
Project a vector v onto plane defined by origin and normal.
void EvaluateFunction(vtkDataArray *input, vtkDataArray *output) override
Evaluate plane equation for point x[3].
static void ProjectPoint(const double x[3], const double origin[3], const double normal[3], double xproj[3])
Project a point x onto plane defined by origin and normal.
represent and manipulate 3D points
Definition: vtkPoints.h:150
@ Normal
Definition: vtkX3D.h:57
#define vtkPlaneAbs(x)