VTK  9.1.0
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=========================================================================*/
134#ifndef vtkPlane_h
135#define vtkPlane_h
136
137#include "vtkCommonDataModelModule.h" // For export macro
138#include "vtkImplicitFunction.h"
139
140class vtkPoints; // forward declaration
141
142class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
143{
144public:
148 static vtkPlane* New();
149
151 void PrintSelf(ostream& os, vtkIndent indent) override;
152
154
158 void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
159 double EvaluateFunction(double x[3]) override;
161
165 void EvaluateGradient(double x[3], double g[3]) override;
166
168
171 vtkSetVector3Macro(Normal, double);
172 vtkGetVectorMacro(Normal, double, 3);
174
176
180 vtkSetVector3Macro(Origin, double);
181 vtkGetVectorMacro(Origin, double, 3);
183
189 void Push(double distance);
190
192
197 static void ProjectPoint(
198 const double x[3], const double origin[3], const double normal[3], double xproj[3]);
199 void ProjectPoint(const double x[3], double xproj[3]);
201
203
207 static void ProjectVector(
208 const double v[3], const double origin[3], const double normal[3], double vproj[3]);
209 void ProjectVector(const double v[3], double vproj[3]);
211
213
219 const double x[3], const double origin[3], const double normal[3], double xproj[3]);
220 void GeneralizedProjectPoint(const double x[3], double xproj[3]);
222
226 static double Evaluate(double normal[3], double origin[3], double x[3]);
227
229
233 static double DistanceToPlane(double x[3], double n[3], double p0[3]);
234 double DistanceToPlane(double x[3]);
236
238
247 const double p1[3], const double p2[3], double n[3], double p0[3], double& t, double x[3]);
248 int IntersectWithLine(const double p1[3], const double p2[3], double& t, double x[3]);
250
252
262 static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3],
263 double py[3], double x0[3], double x1[3]);
265 double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]);
267
269
276 static bool ComputeBestFittingPlane(vtkPoints* pts, double* origin, double* normal);
278
279protected:
281 ~vtkPlane() override = default;
282
283 double Normal[3];
284 double Origin[3];
285
286private:
287 vtkPlane(const vtkPlane&) = delete;
288 void operator=(const vtkPlane&) = delete;
289};
290
291// Generally the normal should be normalized
292inline double vtkPlane::Evaluate(double normal[3], double origin[3], double x[3])
293{
294 return normal[0] * (x[0] - origin[0]) + normal[1] * (x[1] - origin[1]) +
295 normal[2] * (x[2] - origin[2]);
296}
297
298// Assumes normal is normalized
299inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
300{
301#define vtkPlaneAbs(x) ((x) < 0 ? -(x) : (x))
302 return (vtkPlaneAbs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
303}
304
305#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
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:113
perform various plane computations
Definition: vtkPlane.h:143
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 vtkPlane * New()
Construct plane passing through origin and normal to z-axis.
static double Evaluate(double normal[3], double origin[3], double x[3])
Quick evaluation of plane equation n(x-origin)=0.
Definition: vtkPlane.h:292
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:299
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 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:143
#define vtkPlaneAbs(x)