VTK  9.2.6
vtkGenericAttributeCollection.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkGenericAttributeCollection.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=========================================================================*/
25
26#ifndef vtkGenericAttributeCollection_h
27#define vtkGenericAttributeCollection_h
28
29#include "vtkCommonDataModelModule.h" // For export macro
30#include "vtkObject.h"
31
32class vtkGenericAttributeInternalVector;
33class vtkIntInternalVector;
35
36class VTKCOMMONDATAMODEL_EXPORT vtkGenericAttributeCollection : public vtkObject
37{
38public:
43
45
49 void PrintSelf(ostream& os, vtkIndent indent) override;
51
58
65
72
79
85 unsigned long GetActualMemorySize();
86
91 int IsEmpty();
92
100
107 int FindAttribute(const char* name);
108
116
124
134
141 void RemoveAttribute(int i);
142
147 void Reset();
148
156
164
170
171 // *** ALL THE FOLLOWING METHODS SHOULD BE REMOVED WHEN when the
172 // new pipeline update mechanism is checked in.
173 // *** BEGIN
174
176
181 vtkGetMacro(ActiveAttribute, int);
183
185
191 vtkGetMacro(ActiveComponent, int);
193
203 void SetActiveAttribute(int attribute, int component = 0);
204
206
213
220
226 int HasAttribute(int size, int* attributes, int attribute) VTK_SIZEHINT(attributes, size);
227
229
239 void SetAttributesToInterpolate(int size, int* attributes) VTK_SIZEHINT(attributes, size);
242
243protected:
248
253
257 vtkGenericAttributeInternalVector* AttributeInternalVector;
261 vtkIntInternalVector* AttributeIndices;
262
267
268 int NumberOfComponents; // cache
271 unsigned long ActualMemorySize; // cache
272 vtkTimeStamp ComputeTime; // cache time stamp
273
279
280private:
282 void operator=(const vtkGenericAttributeCollection&) = delete;
283};
284#endif
void ShallowCopy(vtkGenericAttributeCollection *other)
Copy, via reference counting, the other attribute array.
void RemoveAttribute(int i)
Remove the attribute at ‘i’.
static vtkGenericAttributeCollection * New()
Create an empty collection.
void SetAttributesToInterpolateToAll()
Set the attributes to interpolate.
vtkGenericAttributeCollection()
Default constructor: empty collection.
int GetNumberOfPointCenteredComponents()
Return the number of components.
vtkGenericAttributeInternalVector * AttributeInternalVector
STL vector for storing attributes.
int GetNumberOfComponents()
Return the number of components.
void InsertNextAttribute(vtkGenericAttribute *a)
Add the attribute ‘a’ to the end of the collection.
int * GetAttributesToInterpolate()
Indices of attributes to interpolate.
int IsEmpty()
Indicate whether the collection contains any attributes.
void SetAttributesToInterpolate(int size, int *attributes)
Set the attributes to interpolate.
void DeepCopy(vtkGenericAttributeCollection *other)
Copy, without reference counting, the other attribute array.
int FindAttribute(const char *name)
Return the index of the attribute named ‘name’.
vtkGenericAttribute * GetAttribute(int i)
Return a pointer to the ith instance of vtkGenericAttribute.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard type definition and print methods for a VTK class.
void SetActiveAttribute(int attribute, int component=0)
Set the scalar attribute to be processed.
virtual int GetNumberOfAttributesToInterpolate()
Number of attributes to interpolate.
void ComputeNumbers()
Compute number of components, max number of components and actual memory size.
vtkMTimeType GetMTime() override
vtkAttributeCollection is a composite object and needs to check each member of its collection for mod...
unsigned long GetActualMemorySize()
Actual size of the data in kibibytes (1024 bytes); only valid after the pipeline has updated.
int GetNumberOfAttributes()
Return the number of attributes (e.g., instances of vtkGenericAttribute) in the collection.
int GetAttributeIndex(int i)
Return the index of the first component of attribute ‘i’ in an array of format attrib0comp0 attrib0co...
void Reset()
Remove all attributes.
int HasAttribute(int size, int *attributes, int attribute)
Does the array ‘attributes’ of size ‘size’ have ‘attribute’?
int GetMaxNumberOfComponents()
Maximum number of components encountered among all attributes.
vtkIntInternalVector * AttributeIndices
STL vector for storing index of point centered attributes.
void InsertAttribute(int i, vtkGenericAttribute *a)
Replace the attribute at index ‘i’ by ‘a’.
abstract class defined API for attribute data
a simple class to control print indentation
Definition vtkIndent.h:40
record modification and/or execution time
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)