VTK
vtkImplicitSum.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImplicitSum.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 =========================================================================*/
32 #ifndef vtkImplicitSum_h
33 #define vtkImplicitSum_h
34 
35 #include "vtkCommonDataModelModule.h" // For export macro
36 #include "vtkImplicitFunction.h"
37 
38 class vtkDoubleArray;
40 
41 class VTKCOMMONDATAMODEL_EXPORT vtkImplicitSum : public vtkImplicitFunction
42 {
43 public:
44  static vtkImplicitSum *New();
45 
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
50 
54  double EvaluateFunction(double x[3]) override;
56 
61  void EvaluateGradient(double x[3], double g[3]) override;
62 
66  vtkMTimeType GetMTime() override;
67 
73 
78  void AddFunction(vtkImplicitFunction *in) { this->AddFunction(in, 1.0); }
79 
84 
89 
91 
98  vtkSetMacro(NormalizeByWeight, vtkTypeBool);
99  vtkGetMacro(NormalizeByWeight, vtkTypeBool);
100  vtkBooleanMacro(NormalizeByWeight, vtkTypeBool);
102 
103 protected:
105  ~vtkImplicitSum() override;
106 
109  double TotalWeight;
110 
113 
114 private:
115  vtkImplicitSum(const vtkImplicitSum&) = delete;
116  void operator=(const vtkImplicitSum&) = delete;
117 };
118 
119 #endif
vtkImplicitSum::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImplicitSum::FunctionList
vtkImplicitFunctionCollection * FunctionList
Definition: vtkImplicitSum.h:107
vtkX3D::weight
@ weight
Definition: vtkX3D.h:532
vtkImplicitSum::TotalWeight
double TotalWeight
Definition: vtkImplicitSum.h:109
vtkImplicitFunction::EvaluateFunction
virtual double EvaluateFunction(double x[3])=0
Evaluate function at position x-y-z and return value.
vtkImplicitSum::EvaluateGradient
void EvaluateGradient(double x[3], double g[3]) override
Evaluate gradient of the weighted sum of functions.
vtkImplicitSum::Weights
vtkDoubleArray * Weights
Definition: vtkImplicitSum.h:108
vtkImplicitSum::GetMTime
vtkMTimeType GetMTime() override
Override modified time retrieval because of object dependencies.
vtkImplicitFunction
abstract interface for implicit functions
Definition: vtkImplicitFunction.h:61
vtkImplicitSum
implicit sum of other implicit functions
Definition: vtkImplicitSum.h:42
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkImplicitSum::SetFunctionWeight
void SetFunctionWeight(vtkImplicitFunction *f, double weight)
Set the weight (coefficient) of the given function to be weight.
vtkImplicitSum::CalculateTotalWeight
void CalculateTotalWeight(void)
vtkImplicitSum::~vtkImplicitSum
~vtkImplicitSum() override
vtkImplicitSum::AddFunction
void AddFunction(vtkImplicitFunction *in, double weight)
Add another implicit function to the list of functions, along with a weighting factor.
vtkImplicitFunction.h
vtkImplicitSum::EvaluateFunction
double EvaluateFunction(double x[3]) override
Evaluate function at position x-y-z and return value.
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:42
vtkImplicitSum::AddFunction
void AddFunction(vtkImplicitFunction *in)
Add another implicit function to the list of functions, weighting it by a factor of 1.
Definition: vtkImplicitSum.h:78
vtkImplicitSum::RemoveAllFunctions
void RemoveAllFunctions()
Remove all functions from the list.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkImplicitSum::New
static vtkImplicitSum * New()
vtkImplicitFunctionCollection
maintain a list of implicit functions
Definition: vtkImplicitFunctionCollection.h:34
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkImplicitSum::vtkImplicitSum
vtkImplicitSum()
vtkImplicitSum::NormalizeByWeight
vtkTypeBool NormalizeByWeight
Definition: vtkImplicitSum.h:112