VTK  9.3.0
vtkBox.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
22#ifndef vtkBox_h
23#define vtkBox_h
24
25#include "vtkCommonDataModelModule.h" // For export macro
26#include "vtkImplicitFunction.h"
27VTK_ABI_NAMESPACE_BEGIN
28class vtkBoundingBox;
29
30class VTKCOMMONDATAMODEL_EXPORT vtkBox : public vtkImplicitFunction
31{
32public:
34 void PrintSelf(ostream& os, vtkIndent indent) override;
35
39 static vtkBox* New();
40
45 double EvaluateFunction(double x[3]) override;
46
50 void EvaluateGradient(double x[3], double n[3]) override;
51
53
56 void SetXMin(double p[3]);
57 void SetXMin(double x, double y, double z);
58 void GetXMin(double p[3]);
59 void GetXMin(double& x, double& y, double& z);
61
62 void SetXMax(double p[3]);
63 void SetXMax(double x, double y, double z);
64 void GetXMax(double p[3]);
65 void GetXMax(double& x, double& y, double& z);
66
67 void SetBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
68 void SetBounds(const double bounds[6]);
70 double& xMin, double& xMax, double& yMin, double& yMax, double& zMin, double& zMax);
71 void GetBounds(double bounds[6]);
72 double* GetBounds() VTK_SIZEHINT(6);
73
80 void AddBounds(const double bounds[6]);
81
91 static char IntersectBox(const double bounds[6], const double origin[3], const double dir[3],
92 double coord[3], double& t, double tolerance = 0.0);
93
106 static int IntersectWithLine(const double bounds[6], const double p1[3], const double p2[3],
107 double& t1, double& t2, double x1[3], double x2[3], int& plane1, int& plane2);
108
118 static bool IntersectWithInfiniteLine(const double bounds[6], const double p1[3],
119 const double p2[3], double& t1, double& t2, double x1[3], double x2[3], int& plane1,
120 int& plane2);
121
129 static vtkTypeBool IntersectWithPlane(double bounds[6], double origin[3], double normal[3]);
130
142 static vtkTypeBool IntersectWithPlane(
143 double bounds[6], double origin[3], double normal[3], double xout[18]);
144
152 static vtkTypeBool IsBoxInFrustum(double planes[24], double bounds[6]);
153
154protected:
156 ~vtkBox() override;
157
159 double Bounds[6]; // supports the GetBounds() method
160
161private:
162 vtkBox(const vtkBox&) = delete;
163 void operator=(const vtkBox&) = delete;
164};
165
166inline void vtkBox::SetXMin(double p[3])
167{
168 this->SetXMin(p[0], p[1], p[2]);
169}
170
171inline void vtkBox::SetXMax(double p[3])
172{
173 this->SetXMax(p[0], p[1], p[2]);
174}
175
176VTK_ABI_NAMESPACE_END
177#endif
Fast, simple class for representing and operating on 3D bounds.
implicit function for a bounding box
Definition vtkBox.h:31
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:171
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:29
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)