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=========================================================================*/
25#ifndef vtkPlane_h
26#define vtkPlane_h
27
28#include "vtkCommonDataModelModule.h" // For export macro
29#include "vtkImplicitFunction.h"
30
31class vtkPoints; // forward declaration
32
33class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
34{
35public:
39 static vtkPlane* New();
40
42 void PrintSelf(ostream& os, vtkIndent indent) override;
43
45
49 void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
50 double EvaluateFunction(double x[3]) override;
52
56 void EvaluateGradient(double x[3], double g[3]) override;
57
59
62 vtkSetVector3Macro(Normal, double);
63 vtkGetVectorMacro(Normal, double, 3);
65
67
71 vtkSetVector3Macro(Origin, double);
72 vtkGetVectorMacro(Origin, double, 3);
74
80 void Push(double distance);
81
83
88 static void ProjectPoint(
89 const double x[3], const double origin[3], const double normal[3], double xproj[3]);
90 void ProjectPoint(const double x[3], double xproj[3]);
92
94
98 static void ProjectVector(
99 const double v[3], const double origin[3], const double normal[3], double vproj[3]);
100 void ProjectVector(const double v[3], double vproj[3]);
102
104
110 const double x[3], const double origin[3], const double normal[3], double xproj[3]);
111 void GeneralizedProjectPoint(const double x[3], double xproj[3]);
113
117 static double Evaluate(double normal[3], double origin[3], double x[3]);
118
120
124 static double DistanceToPlane(double x[3], double n[3], double p0[3]);
125 double DistanceToPlane(double x[3]);
127
129
138 const double p1[3], const double p2[3], double n[3], double p0[3], double& t, double x[3]);
139 int IntersectWithLine(const double p1[3], const double p2[3], double& t, double x[3]);
141
143
153 static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3],
154 double py[3], double x0[3], double x1[3]);
156 double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]);
158
160
167 static bool ComputeBestFittingPlane(vtkPoints* pts, double* origin, double* normal);
169
170protected:
172 ~vtkPlane() override = default;
173
174 double Normal[3];
175 double Origin[3];
176
177private:
178 vtkPlane(const vtkPlane&) = delete;
179 void operator=(const vtkPlane&) = delete;
180};
181
182// Generally the normal should be normalized
183inline double vtkPlane::Evaluate(double normal[3], double origin[3], double x[3])
184{
185 return normal[0] * (x[0] - origin[0]) + normal[1] * (x[1] - origin[1]) +
186 normal[2] * (x[2] - origin[2]);
187}
188
189// Assumes normal is normalized
190inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
191{
192#define vtkPlaneAbs(x) ((x) < 0 ? -(x) : (x))
193 return (vtkPlaneAbs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
194}
195
196#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
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:34
perform various plane computations
Definition: vtkPlane.h:34
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:183
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:190
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:34
@ Normal
Definition: vtkX3D.h:51
#define vtkPlaneAbs(x)