vtkBox.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 vtkBox_h
#define vtkBox_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkImplicitFunction.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkBoundingBox;
 
class VTKCOMMONDATAMODEL_EXPORT vtkBox : public vtkImplicitFunction
{
public:
  vtkTypeMacro(vtkBox, vtkImplicitFunction);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkBox* New();

  using vtkImplicitFunction::EvaluateFunction;
  double EvaluateFunction(double x[3]) override;

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


  void SetXMin(VTK_FUTURE_CONST double p[3]);
  void SetXMin(double x, double y, double z);
  void GetXMin(double p[3]) VTK_FUTURE_CONST;
  void GetXMin(double& x, double& y, double& z) VTK_FUTURE_CONST;
 
  void SetXMax(VTK_FUTURE_CONST double p[3]);
  void SetXMax(double x, double y, double z);
  void GetXMax(double p[3]) VTK_FUTURE_CONST;
  void GetXMax(double& x, double& y, double& z) VTK_FUTURE_CONST;
 
  void SetBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
  void SetBounds(const double bounds[6]);
  void GetBounds(double& xMin, double& xMax, double& yMin, double& yMax, double& zMin,
    double& zMax) VTK_FUTURE_CONST;
  void GetBounds(double bounds[6]) VTK_FUTURE_CONST;
  double* GetBounds() VTK_SIZEHINT(6);

  void AddBounds(const double bounds[6]);

  static char IntersectBox(const double bounds[6], const double origin[3], const double dir[3],
    double coord[3], double& t, double tolerance = 0.0);

  static int IntersectWithLine(const double bounds[6], const double p1[3], const double p2[3],
    double& t1, double& t2, double x1[3], double x2[3], int& plane1, int& plane2);

  static bool IntersectWithInfiniteLine(const double bounds[6], const double p1[3],
    const double p2[3], double& t1, double& t2, double x1[3], double x2[3], int& plane1,
    int& plane2);

  static vtkTypeBool IntersectWithPlane(double bounds[6], double origin[3], double normal[3]);

  static vtkTypeBool IntersectWithPlane(
    double bounds[6], double origin[3], double normal[3], double xout[18]);

  static vtkTypeBool IsBoxInFrustum(double planes[24], double bounds[6]);
 
protected:
  vtkBox();
  ~vtkBox() override;
 
  vtkBoundingBox* BBox;
  double Bounds[6]; // supports the GetBounds() method
 
private:
  vtkBox(const vtkBox&) = delete;
  void operator=(const vtkBox&) = delete;
};
 
inline void vtkBox::SetXMin(VTK_FUTURE_CONST double p[3])
{
  this->SetXMin(p[0], p[1], p[2]);
}
 
inline void vtkBox::SetXMax(VTK_FUTURE_CONST double p[3])
{
  this->SetXMax(p[0], p[1], p[2]);
}
 
VTK_ABI_NAMESPACE_END
#endif