VTK  9.0.2
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 
31 class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
32 {
33 public:
37  static vtkPlane* New();
38 
39  vtkTypeMacro(vtkPlane, vtkImplicitFunction);
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
47  void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
48  double EvaluateFunction(double x[3]) override;
50 
54  void EvaluateGradient(double x[3], double g[3]) override;
55 
57 
60  vtkSetVector3Macro(Normal, double);
61  vtkGetVectorMacro(Normal, double, 3);
63 
65 
69  vtkSetVector3Macro(Origin, double);
70  vtkGetVectorMacro(Origin, double, 3);
72 
78  void Push(double distance);
79 
81 
86  static void ProjectPoint(
87  const double x[3], const double origin[3], const double normal[3], double xproj[3]);
88  void ProjectPoint(const double x[3], double xproj[3]);
90 
92 
96  static void ProjectVector(
97  const double v[3], const double origin[3], const double normal[3], double vproj[3]);
98  void ProjectVector(const double v[3], double vproj[3]);
100 
102 
108  const double x[3], const double origin[3], const double normal[3], double xproj[3]);
109  void GeneralizedProjectPoint(const double x[3], double xproj[3]);
111 
115  static double Evaluate(double normal[3], double origin[3], double x[3]);
116 
118 
122  static double DistanceToPlane(double x[3], double n[3], double p0[3]);
123  double DistanceToPlane(double x[3]);
125 
127 
135  static int IntersectWithLine(
136  const double p1[3], const double p2[3], double n[3], double p0[3], double& t, double x[3]);
137  int IntersectWithLine(const double p1[3], const double p2[3], double& t, double x[3]);
139 
141 
151  static int IntersectWithFinitePlane(double n[3], double o[3], double pOrigin[3], double px[3],
152  double py[3], double x0[3], double x1[3]);
154  double pOrigin[3], double px[3], double py[3], double x0[3], double x1[3]);
156 
157 protected:
159  ~vtkPlane() override {}
160 
161  double Normal[3];
162  double Origin[3];
163 
164 private:
165  vtkPlane(const vtkPlane&) = delete;
166  void operator=(const vtkPlane&) = delete;
167 };
168 
169 // Generally the normal should be normalized
170 inline double vtkPlane::Evaluate(double normal[3], double origin[3], double x[3])
171 {
172  return normal[0] * (x[0] - origin[0]) + normal[1] * (x[1] - origin[1]) +
173  normal[2] * (x[2] - origin[2]);
174 }
175 
176 // Assumes normal is normalized
177 inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
178 {
179 #define vtkPlaneAbs(x) ((x) < 0 ? -(x) : (x))
180  return (vtkPlaneAbs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
181 }
182 
183 #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:32
double DistanceToPlane(double x[3])
void GeneralizedProjectPoint(const double x[3], double xproj[3])
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])
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])
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])
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 double Evaluate(double normal[3], double origin[3], double x[3])
Quick evaluation of plane equation n(x-origin)=0.
Definition: vtkPlane.h:170
~vtkPlane() override
Definition: vtkPlane.h:159
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:177
double EvaluateFunction(double x[3]) override
Evaluate function at position x-y-z and return value.
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])
void EvaluateFunction(vtkDataArray *input, vtkDataArray *output) override
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.
@ Normal
Definition: vtkX3D.h:51
#define vtkPlaneAbs(x)