VTK  9.3.20240412
vtkPlane.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
125 #ifndef vtkPlane_h
126 #define vtkPlane_h
127 
128 #include "vtkCommonDataModelModule.h" // For export macro
129 #include "vtkImplicitFunction.h"
130 
131 VTK_ABI_NAMESPACE_BEGIN
132 class vtkPoints; // forward declaration
133 
134 class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
135 {
136 public:
140  static vtkPlane* New();
141 
143  void PrintSelf(ostream& os, vtkIndent indent) override;
144 
146 
150  void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
151  double EvaluateFunction(double x[3]) override;
153 
157  void EvaluateGradient(double x[3], double g[3]) override;
158 
160 
163  vtkSetVector3Macro(Normal, double);
164  vtkGetVectorMacro(Normal, double, 3);
166 
168 
172  vtkSetVector3Macro(Origin, double);
173  vtkGetVectorMacro(Origin, double, 3);
175 
181  void Push(double distance);
182 
184 
189  static void ProjectPoint(
190  const double x[3], const double origin[3], const double normal[3], double xproj[3]);
191  void ProjectPoint(const double x[3], double xproj[3]);
193 
195 
199  static void ProjectVector(
200  const double v[3], const double origin[3], const double normal[3], double vproj[3]);
201  void ProjectVector(const double v[3], double vproj[3]);
203 
205 
211  const double x[3], const double origin[3], const double normal[3], double xproj[3]);
212  void GeneralizedProjectPoint(const double x[3], double xproj[3]);
214 
218  static double Evaluate(double normal[3], double origin[3], double x[3]);
219 
221 
225  static double DistanceToPlane(double x[3], double n[3], double p0[3]);
226  double DistanceToPlane(double x[3]);
228 
230 
238  static int IntersectWithLine(
239  const double p1[3], const double p2[3], double n[3], double p0[3], double& t, double x[3]);
240  int IntersectWithLine(const double p1[3], const double p2[3], double& t, double x[3]);
242 
244 
254  static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3],
255  double py[3], double x0[3], double x1[3]);
257  double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]);
259 
261 
268  static bool ComputeBestFittingPlane(vtkPoints* pts, double* origin, double* normal);
270 
271 protected:
273  ~vtkPlane() override = default;
274 
275  double Normal[3];
276  double Origin[3];
277 
278 private:
279  vtkPlane(const vtkPlane&) = delete;
280  void operator=(const vtkPlane&) = delete;
281 };
282 
283 // Generally the normal should be normalized
284 inline double vtkPlane::Evaluate(double normal[3], double origin[3], double x[3])
285 {
286  return normal[0] * (x[0] - origin[0]) + normal[1] * (x[1] - origin[1]) +
287  normal[2] * (x[2] - origin[2]);
288 }
289 
290 // Assumes normal is normalized
291 inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
292 {
293 #define vtkPlaneAbs(x) ((x) < 0 ? -(x) : (x))
294  return (vtkPlaneAbs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
295 }
296 
297 VTK_ABI_NAMESPACE_END
298 #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
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:284
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:291
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:139
@ Normal
Definition: vtkX3D.h:45
#define vtkPlaneAbs(x)