vtkPlane.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPlane_h
#define vtkPlane_h

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

#include <cmath> // for std::abs

VTK_ABI_NAMESPACE_BEGIN
class vtkPoints; // forward declaration

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO 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;


  virtual void SetNormal(double x, double y, double z);
  virtual void SetNormal(const double normal[3]);
  vtkGetVectorMacro(Normal, double, 3);


  virtual void SetOrigin(double x, double y, double z);
  virtual void SetOrigin(const double origin[3]);
  vtkGetVectorMacro(Origin, double, 3);


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  virtual void SetOffset(double _arg);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  vtkGetMacro(Offset, double);


  virtual void SetAxisAligned(bool _arg);
  vtkGetMacro(AxisAligned, bool);

  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]);


  static bool ComputeBestFittingPlane(vtkPoints* pts, double* origin, double* normal);


  void DeepCopy(vtkPlane* plane);

protected:
  vtkPlane() = default;
  ~vtkPlane() override = default;

  // Construct plane passing through origin and normal to z-axis.
  double Normal[3] = { 0.0, 0.0, 1.0 };
  double Origin[3] = { 0.0, 0.0, 0.0 };

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

  // If AxisAligned is enabled, sets axis to the nearest canonical axis.
  void ComputeInternalNormal();
  // Shifts the origin in the direction of the normal by the offset.
  void ComputeInternalOrigin();
  // Computes InternalNormal and InternalOrigin.
  void InternalUpdates();

  double Offset = 0.0;
  bool AxisAligned = false;


  double InternalNormal[3] = { 0.0, 0.0, 1.0 };
  double InternalOrigin[3] = { 0.0, 0.0, 0.0 };
};

// 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])
{
  return (std::abs(n[0] * (x[0] - p0[0]) + n[1] * (x[1] - p0[1]) + n[2] * (x[2] - p0[2])));
}

VTK_ABI_NAMESPACE_END
#endif