VTK  9.2.5
vtkBox.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBox.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 =========================================================================*/
133 #ifndef vtkBox_h
134 #define vtkBox_h
135 
136 #include "vtkCommonDataModelModule.h" // For export macro
137 #include "vtkImplicitFunction.h"
138 class vtkBoundingBox;
139 
140 class VTKCOMMONDATAMODEL_EXPORT vtkBox : public vtkImplicitFunction
141 {
142 public:
143  vtkTypeMacro(vtkBox, vtkImplicitFunction);
144  void PrintSelf(ostream& os, vtkIndent indent) override;
145 
149  static vtkBox* New();
150 
155  double EvaluateFunction(double x[3]) override;
156 
160  void EvaluateGradient(double x[3], double n[3]) override;
161 
163 
166  void SetXMin(double p[3]);
167  void SetXMin(double x, double y, double z);
168  void GetXMin(double p[3]);
169  void GetXMin(double& x, double& y, double& z);
171 
172  void SetXMax(double p[3]);
173  void SetXMax(double x, double y, double z);
174  void GetXMax(double p[3]);
175  void GetXMax(double& x, double& y, double& z);
176 
177  void SetBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
178  void SetBounds(const double bounds[6]);
179  void GetBounds(
180  double& xMin, double& xMax, double& yMin, double& yMax, double& zMin, double& zMax);
181  void GetBounds(double bounds[6]);
182  double* GetBounds() VTK_SIZEHINT(6);
183 
190  void AddBounds(const double bounds[6]);
191 
201  static char IntersectBox(const double bounds[6], const double origin[3], const double dir[3],
202  double coord[3], double& t, const double tolerance = 0.0);
203 
216  static int IntersectWithLine(const double bounds[6], const double p1[3], const double p2[3],
217  double& t1, double& t2, double x1[3], double x2[3], int& plane1, int& plane2);
218 
228  static bool IntersectWithInfiniteLine(const double bounds[6], const double p1[3],
229  const double p2[3], double& t1, double& t2, double x1[3], double x2[3], int& plane1,
230  int& plane2);
231 
239  static vtkTypeBool IntersectWithPlane(double bounds[6], double origin[3], double normal[3]);
240 
252  static vtkTypeBool IntersectWithPlane(
253  double bounds[6], double origin[3], double normal[3], double xout[18]);
254 
262  static vtkTypeBool IsBoxInFrustum(double planes[24], double bounds[6]);
263 
264 protected:
266  ~vtkBox() override;
267 
269  double Bounds[6]; // supports the GetBounds() method
270 
271 private:
272  vtkBox(const vtkBox&) = delete;
273  void operator=(const vtkBox&) = delete;
274 };
275 
276 inline void vtkBox::SetXMin(double p[3])
277 {
278  this->SetXMin(p[0], p[1], p[2]);
279 }
280 
281 inline void vtkBox::SetXMax(double p[3])
282 {
283  this->SetXMax(p[0], p[1], p[2]);
284 }
285 
286 #endif
Fast, simple class for representing and operating on 3D bounds.
implicit function for a bounding box
Definition: vtkBox.h:141
void EvaluateGradient(double x[3], double n[3]) override
Evaluate the gradient of the box.
void SetBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetBounds(const double bounds[6])
void SetXMax(double x, double y, double z)
void GetXMax(double &x, double &y, double &z)
static vtkBox * New()
Construct box with center at (0,0,0) and each side of length 1.0.
void GetXMax(double p[3])
void SetXMin(double x, double y, double z)
Set / get the bounding box using various methods.
double * GetBounds()
void GetXMin(double &x, double &y, double &z)
Set / get the bounding box using various methods.
void GetXMin(double p[3])
Set / get the bounding box using various methods.
double EvaluateFunction(double x[3]) override
Evaluate function at position x-y-z and return value.
void SetXMax(double p[3])
Definition: vtkBox.h:281
void GetBounds(double bounds[6])
void GetBounds(double &xMin, double &xMax, double &yMin, double &yMax, double &zMin, double &zMax)
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:119
@ dir
Definition: vtkX3D.h:330
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)