VTK  9.2.6
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=========================================================================*/
28#ifndef vtkPlane_h
29#define vtkPlane_h
30
31#include "vtkCommonDataModelModule.h" // For export macro
32#include "vtkImplicitFunction.h"
33
34class vtkPoints; // forward declaration
35
36class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
37{
38public:
42 static vtkPlane* New();
43
45 void PrintSelf(ostream& os, vtkIndent indent) override;
46
48
52 void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
53 double EvaluateFunction(double x[3]) override;
55
59 void EvaluateGradient(double x[3], double g[3]) override;
60
62
65 vtkSetVector3Macro(Normal, double);
66 vtkGetVectorMacro(Normal, double, 3);
68
70
74 vtkSetVector3Macro(Origin, double);
75 vtkGetVectorMacro(Origin, double, 3);
77
83 void Push(double distance);
84
86
91 static void ProjectPoint(
92 const double x[3], const double origin[3], const double normal[3], double xproj[3]);
93 void ProjectPoint(const double x[3], double xproj[3]);
95
97
101 static void ProjectVector(
102 const double v[3], const double origin[3], const double normal[3], double vproj[3]);
103 void ProjectVector(const double v[3], double vproj[3]);
105
107
113 const double x[3], const double origin[3], const double normal[3], double xproj[3]);
114 void GeneralizedProjectPoint(const double x[3], double xproj[3]);
116
120 static double Evaluate(double normal[3], double origin[3], double x[3]);
121
123
127 static double DistanceToPlane(double x[3], double n[3], double p0[3]);
128 double DistanceToPlane(double x[3]);
130
132
141 const double p1[3], const double p2[3], double n[3], double p0[3], double& t, double x[3]);
142 int IntersectWithLine(const double p1[3], const double p2[3], double& t, double x[3]);
144
146
156 static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3],
157 double py[3], double x0[3], double x1[3]);
159 double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]);
161
163
170 static bool ComputeBestFittingPlane(vtkPoints* pts, double* origin, double* normal);
172
173protected:
175 ~vtkPlane() override = default;
176
177 double Normal[3];
178 double Origin[3];
179
180private:
181 vtkPlane(const vtkPlane&) = delete;
182 void operator=(const vtkPlane&) = delete;
183};
184
185// Generally the normal should be normalized
186inline double vtkPlane::Evaluate(double normal[3], double origin[3], double x[3])
187{
188 return normal[0] * (x[0] - origin[0]) + normal[1] * (x[1] - origin[1]) +
189 normal[2] * (x[2] - origin[2]);
190}
191
192// Assumes normal is normalized
193inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
194{
195#define vtkPlaneAbs(x) ((x) < 0 ? -(x) : (x))
196 return (vtkPlaneAbs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
197}
198
199#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:56
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:40
perform various plane computations
Definition: vtkPlane.h:37
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:186
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:193
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:40
#define vtkPlaneAbs(x)