VTK  9.1.0
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=========================================================================*/
31#ifndef vtkBox_h
32#define vtkBox_h
33
34#include "vtkCommonDataModelModule.h" // For export macro
35#include "vtkImplicitFunction.h"
36class vtkBoundingBox;
37
38class VTKCOMMONDATAMODEL_EXPORT vtkBox : public vtkImplicitFunction
39{
40public:
42 void PrintSelf(ostream& os, vtkIndent indent) override;
43
47 static vtkBox* New();
48
53 double EvaluateFunction(double x[3]) override;
54
58 void EvaluateGradient(double x[3], double n[3]) override;
59
61
64 void SetXMin(double p[3]);
65 void SetXMin(double x, double y, double z);
66 void GetXMin(double p[3]);
67 void GetXMin(double& x, double& y, double& z);
69
70 void SetXMax(double p[3]);
71 void SetXMax(double x, double y, double z);
72 void GetXMax(double p[3]);
73 void GetXMax(double& x, double& y, double& z);
74
75 void SetBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
76 void SetBounds(const double bounds[6]);
78 double& xMin, double& xMax, double& yMin, double& yMax, double& zMin, double& zMax);
79 void GetBounds(double bounds[6]);
80 double* GetBounds() VTK_SIZEHINT(6);
81
88 void AddBounds(const double bounds[6]);
89
99 static char IntersectBox(const double bounds[6], const double origin[3], const double dir[3],
100 double coord[3], double& t, const double tolerance = 0.0);
101
114 static int IntersectWithLine(const double bounds[6], const double p1[3], const double p2[3],
115 double& t1, double& t2, double x1[3], double x2[3], int& plane1, int& plane2);
116
126 static bool IntersectWithInfiniteLine(const double bounds[6], const double p1[3],
127 const double p2[3], double& t1, double& t2, double x1[3], double x2[3], int& plane1,
128 int& plane2);
129
137 static vtkTypeBool IntersectWithPlane(double bounds[6], double origin[3], double normal[3]);
138
150 static vtkTypeBool IntersectWithPlane(
151 double bounds[6], double origin[3], double normal[3], double xout[18]);
152
160 static vtkTypeBool IsBoxInFrustum(double planes[24], double bounds[6]);
161
162protected:
164 ~vtkBox() override;
165
167 double Bounds[6]; // supports the GetBounds() method
168
169private:
170 vtkBox(const vtkBox&) = delete;
171 void operator=(const vtkBox&) = delete;
172};
173
174inline void vtkBox::SetXMin(double p[3])
175{
176 this->SetXMin(p[0], p[1], p[2]);
177}
178
179inline void vtkBox::SetXMax(double p[3])
180{
181 this->SetXMax(p[0], p[1], p[2]);
182}
183
184#endif
Fast, simple class for representing and operating on 3D bounds.
implicit function for a bounding box
Definition: vtkBox.h:39
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)
double * GetBounds()
void GetXMax(double p[3])
void SetXMin(double x, double y, double z)
Set / get the bounding box using various methods.
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:179
void GetBounds(double bounds[6])
static vtkBox * New()
Construct box with center at (0,0,0) and each side of length 1.0.
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:34
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)