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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
/**
* @class vtkArrayWeights
* @brief Stores a collection of weighting factors.
*
*
* vtkArrayWeights provides storage for a collection of weights to be
* used when merging / interpolating N-way arrays. Convenience
* constructors are provided for working with one, two, three, and four
* weighting factors. For arbitrary collections of weights, use
* SetCount() and operator[] to assign values.
*
* vtkArrayWeights is most commonly used with the vtkInterpolate()
* function to compute weighted sums of vtkArray objects.
*
* @sa
* vtkArray, vtkArraySlices
*
* @par Thanks:
* Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National
* Laboratories.
*/
#ifndef vtkArrayWeights_h
#define vtkArrayWeights_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkSystemIncludes.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkArrayWeightsStorage; // pimpl
class VTKCOMMONCORE_EXPORT vtkArrayWeights
{
public:
/**
* Create an empty collection of weights
*/
vtkArrayWeights();
/**
* Copy the weights from another object.
*/
vtkArrayWeights(const vtkArrayWeights& other);
/**
* Create a collection containing one weight.
*/
vtkArrayWeights(double i);
/**
* Create a collection containing two weights.
*/
vtkArrayWeights(double i, double j);
/**
* Create a collection containing three weights.
*/
vtkArrayWeights(double i, double j, double k);
/**
* Create a collection containing four weights.
*/
vtkArrayWeights(double i, double j, double k, double l);
/**
* Destructor.
*/
~vtkArrayWeights();
/**
* Returns the number of weights stored in this container.
*/
vtkIdType GetCount() const;
/**
* Sets the number of weights stored in this container. Note that each
* weight will be reset to 0.0 after calling SetCount(), use operator[]
* to assign the desired value for each weight.
*/
void SetCount(vtkIdType count);
/**
* Accesses the i-th weight in the collection.
*/
double& operator[](vtkIdType);
/**
* Accesses the i-th weight in the collection.
*/
const double& operator[](vtkIdType) const;
/**
* Assignment operator.
*/
vtkArrayWeights& operator=(const vtkArrayWeights& other);
protected:
vtkArrayWeightsStorage* Storage;
};
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkArrayWeights.h
|
