VTK  9.1.0
vtkImplicitBoolean.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImplicitBoolean.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 =========================================================================*/
134 #ifndef vtkImplicitBoolean_h
135 #define vtkImplicitBoolean_h
136 
137 #include "vtkCommonDataModelModule.h" // For export macro
138 #include "vtkImplicitFunction.h"
139 
141 
142 class VTKCOMMONDATAMODEL_EXPORT vtkImplicitBoolean : public vtkImplicitFunction
143 {
144 public:
146  void PrintSelf(ostream& os, vtkIndent indent) override;
147 
149  {
150  VTK_UNION = 0,
153  VTK_UNION_OF_MAGNITUDES
154  };
155 
160 
162 
166  double EvaluateFunction(double x[3]) override;
168 
172  void EvaluateGradient(double x[3], double g[3]) override;
173 
177  vtkMTimeType GetMTime() override;
178 
183 
188 
192  vtkImplicitFunctionCollection* GetFunction() { return this->FunctionList; }
193 
195 
198  vtkSetClampMacro(OperationType, int, VTK_UNION, VTK_UNION_OF_MAGNITUDES);
199  vtkGetMacro(OperationType, int);
200  void SetOperationTypeToUnion() { this->SetOperationType(VTK_UNION); }
201  void SetOperationTypeToIntersection() { this->SetOperationType(VTK_INTERSECTION); }
202  void SetOperationTypeToDifference() { this->SetOperationType(VTK_DIFFERENCE); }
203  void SetOperationTypeToUnionOfMagnitudes() { this->SetOperationType(VTK_UNION_OF_MAGNITUDES); }
204  const char* GetOperationTypeAsString();
206 
207 protected:
210 
212 
214 
215 private:
216  vtkImplicitBoolean(const vtkImplicitBoolean&) = delete;
217  void operator=(const vtkImplicitBoolean&) = delete;
218 };
219 
224 {
225  if (this->OperationType == VTK_UNION)
226  {
227  return "Union";
228  }
229  else if (this->OperationType == VTK_INTERSECTION)
230  {
231  return "Intersection";
232  }
233  else if (this->OperationType == VTK_DIFFERENCE)
234  {
235  return "Difference";
236  }
237  else
238  {
239  return "UnionOfMagnitudes";
240  }
241 }
242 
243 #endif
vtkImplicitBoolean::vtkImplicitBoolean
vtkImplicitBoolean()
vtkImplicitBoolean::SetOperationTypeToIntersection
void SetOperationTypeToIntersection()
Specify the type of boolean operation.
Definition: vtkImplicitBoolean.h:201
vtkImplicitBoolean::~vtkImplicitBoolean
~vtkImplicitBoolean() override
vtkImplicitBoolean::EvaluateFunction
double EvaluateFunction(double x[3]) override
Evaluate boolean combinations of implicit function using current operator.
vtkImplicitFunction::EvaluateFunction
virtual double EvaluateFunction(double x[3])=0
Evaluate function at position x-y-z and return value.
vtkImplicitBoolean::SetOperationTypeToDifference
void SetOperationTypeToDifference()
Specify the type of boolean operation.
Definition: vtkImplicitBoolean.h:202
vtkImplicitFunction
abstract interface for implicit functions
Definition: vtkImplicitFunction.h:80
vtkImplicitBoolean
implicit function consisting of boolean combinations of implicit functions
Definition: vtkImplicitBoolean.h:143
vtkImplicitBoolean::VTK_INTERSECTION
@ VTK_INTERSECTION
Definition: vtkImplicitBoolean.h:151
vtkImplicitBoolean::GetOperationTypeAsString
const char * GetOperationTypeAsString()
Return the boolean operation type as a descriptive character string.
Definition: vtkImplicitBoolean.h:223
vtkImplicitBoolean::OperationType
int OperationType
Definition: vtkImplicitBoolean.h:213
vtkImplicitBoolean::SetOperationTypeToUnionOfMagnitudes
void SetOperationTypeToUnionOfMagnitudes()
Specify the type of boolean operation.
Definition: vtkImplicitBoolean.h:203
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkImplicitBoolean::AddFunction
void AddFunction(vtkImplicitFunction *in)
Add another implicit function to the list of functions.
vtkImplicitBoolean::FunctionList
vtkImplicitFunctionCollection * FunctionList
Definition: vtkImplicitBoolean.h:211
vtkImplicitBoolean::OperationType
OperationType
Definition: vtkImplicitBoolean.h:149
vtkImplicitBoolean::GetFunction
vtkImplicitFunctionCollection * GetFunction()
Return the collection of implicit functions.
Definition: vtkImplicitBoolean.h:192
vtkImplicitBoolean::GetMTime
vtkMTimeType GetMTime() override
Override modified time retrieval because of object dependencies.
vtkImplicitBoolean::RemoveFunction
void RemoveFunction(vtkImplicitFunction *in)
Remove a function from the list of implicit functions to boolean.
vtkImplicitBoolean::New
static vtkImplicitBoolean * New()
Default boolean method is union.
vtkImplicitFunction.h
vtkImplicitBoolean::VTK_DIFFERENCE
@ VTK_DIFFERENCE
Definition: vtkImplicitBoolean.h:152
vtkImplicitBoolean::EvaluateGradient
void EvaluateGradient(double x[3], double g[3]) override
Evaluate gradient of boolean combination.
vtkImplicitBoolean::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImplicitBoolean::VTK_UNION
@ VTK_UNION
Definition: vtkImplicitBoolean.h:150
vtkImplicitBoolean::SetOperationTypeToUnion
void SetOperationTypeToUnion()
Specify the type of boolean operation.
Definition: vtkImplicitBoolean.h:200
vtkImplicitFunctionCollection
maintain a list of implicit functions
Definition: vtkImplicitFunctionCollection.h:34
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287