1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkGraphWeightFilter
* @brief Base class for filters that weight graph
* edges.
*
*
* vtkGraphWeightFilter is the abstract base class that provides an interface
* for classes that apply weights to graph edges. The weights are added
* as a vtkFloatArray named "Weights."
* The ComputeWeight function must be implemented to provide the function of two
* vertices which determines the weight of each edge.
* The CheckRequirements function can be implemented if you wish to ensure
* that the input graph has all of the properties that will be required
* by the ComputeWeight function.
*/
#ifndef vtkGraphWeightFilter_h
#define vtkGraphWeightFilter_h
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkGraphAlgorithm.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkGraph;
class VTKFILTERSGENERAL_EXPORT vtkGraphWeightFilter : public vtkGraphAlgorithm
{
public:
vtkTypeMacro(vtkGraphWeightFilter, vtkGraphAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
protected:
vtkGraphWeightFilter() = default;
~vtkGraphWeightFilter() override = default;
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
/**
* Compute the weight on the 'graph' for a particular 'edge'.
* This is a pure virtual function that must be implemented in subclasses.
*/
virtual float ComputeWeight(vtkGraph* graph, const vtkEdgeType& edge) const = 0;
/**
* Ensure that the 'graph' is has all properties that are needed to compute
* the weights. For example, in vtkGraphWeightEuclideanDistanceFilter,
* 'graph' must have Points set for each vertex, as the ComputeWeight
* function calls GetPoint.
*/
virtual bool CheckRequirements(vtkGraph* graph) const;
private:
vtkGraphWeightFilter(const vtkGraphWeightFilter&) = delete;
void operator=(const vtkGraphWeightFilter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
