vtkPlane.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPlane.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkPlane_h
#define vtkPlane_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkImplicitFunction.h"

class VTKCOMMONDATAMODEL_EXPORT vtkPlane : public vtkImplicitFunction
{
public:
  static vtkPlane *New();

  vtkTypeMacro(vtkPlane,vtkImplicitFunction);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  using vtkImplicitFunction::EvaluateFunction;
  void EvaluateFunction(vtkDataArray* input, vtkDataArray* output) override;
  double EvaluateFunction(double x[3]) override;

  void EvaluateGradient(double x[3], double g[3]) override;


  vtkSetVector3Macro(Normal,double);
  vtkGetVectorMacro(Normal,double,3);


  vtkSetVector3Macro(Origin,double);
  vtkGetVectorMacro(Origin,double,3);

  void Push(double distance);


  static void ProjectPoint(const double x[3], const double origin[3], const double normal[3],
                           double xproj[3]);
  void ProjectPoint(const double x[3], double xproj[3]);


  static void ProjectVector(const double v[3], const double origin[3], const double normal[3],
                           double vproj[3]);
  void ProjectVector(const double v[3], double vproj[3]);


  static void GeneralizedProjectPoint(const double x[3], const double origin[3],
                                      const double normal[3], double xproj[3]);
  void GeneralizedProjectPoint(const double x[3], double xproj[3]);


  static double Evaluate(double normal[3], double origin[3], double x[3]);


  static double DistanceToPlane(double x[3], double n[3], double p0[3]);
  double DistanceToPlane(double x[3]);


  static int IntersectWithLine(const double p1[3], const double p2[3], double n[3],
                               double p0[3], double& t, double x[3]);
  int IntersectWithLine(const double p1[3], const double p2[3], double& t, double 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]);
  int IntersectWithFinitePlane(double pOrigin[3], double px[3], double py[3],
                               double x0[3], double x1[3]);

protected:
  vtkPlane();
  ~vtkPlane() override {}

  double Normal[3];
  double Origin[3];

private:
  vtkPlane(const vtkPlane&) = delete;
  void operator=(const vtkPlane&) = delete;
};

// Generally the normal should be normalized
inline double vtkPlane::Evaluate(double normal[3],
                                 double origin[3], double x[3])
{
  return normal[0]*(x[0]-origin[0]) + normal[1]*(x[1]-origin[1]) +
         normal[2]*(x[2]-origin[2]);
}

// Assumes normal is normalized
inline double vtkPlane::DistanceToPlane(double x[3], double n[3], double p0[3])
{
#define vtkPlaneAbs(x) ((x)<0?-(x):(x))
  return (vtkPlaneAbs(n[0]*(x[0]-p0[0]) + n[1]*(x[1]-p0[1]) +
                      n[2]*(x[2]-p0[2])));
}

#endif