VTK  9.3.0
vtkDataSetAttributes.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
45#ifndef vtkDataSetAttributes_h
46#define vtkDataSetAttributes_h
47
48#include "vtkCommonDataModelModule.h" // For export macro
49#include "vtkDataSetAttributesFieldList.h" // for vtkDataSetAttributesFieldList
50#include "vtkFieldData.h"
51
52VTK_ABI_NAMESPACE_BEGIN
53class vtkLookupTable;
54
55class VTKCOMMONDATAMODEL_EXPORT vtkDataSetAttributes : public vtkFieldData
56{
57public:
63
65 void PrintSelf(ostream& os, vtkIndent indent) override;
66
71 void Initialize() override;
72
77 virtual void Update() {}
78
79 // -- shallow and deep copy -----------------------------------------------
80
86 void DeepCopy(vtkFieldData* pd) override;
87
92 void ShallowCopy(vtkFieldData* pd) override;
93
94 // -- attribute types -----------------------------------------------------
95
96 // Always keep NUM_ATTRIBUTES as the last entry
98 {
99 SCALARS = 0,
100 VECTORS = 1,
101 NORMALS = 2,
102 TCOORDS = 3,
103 TENSORS = 4,
104 GLOBALIDS = 5,
105 PEDIGREEIDS = 6,
106 EDGEFLAG = 7,
107 TANGENTS = 8,
108 RATIONALWEIGHTS = 9,
109 HIGHERORDERDEGREES = 10,
110 PROCESSIDS = 11,
111 NUM_ATTRIBUTES
112 };
113
115 {
118 NOLIMIT
119 };
120
121 // ----------- ghost points and ghost cells -------------------------------------------
122 // The following bit fields are consistent with VisIt ghost zones specification
123 // For details, see http://www.visitusers.org/index.php?title=Representing_ghost_data
124
126 {
127 DUPLICATECELL = 1, // the cell is present on multiple processors
128 HIGHCONNECTIVITYCELL = 2, // the cell has more neighbors than in a regular mesh
129 LOWCONNECTIVITYCELL = 4, // the cell has less neighbors than in a regular mesh
130 REFINEDCELL = 8, // other cells are present that refines it.
131 EXTERIORCELL = 16, // the cell is on the exterior of the data set
132 HIDDENCELL =
133 32 // the cell is needed to maintain connectivity, but the data values should be ignored.
134 };
135
137 {
138 DUPLICATEPOINT = 1, // the cell is present on multiple processors
139 HIDDENPOINT =
140 2 // the point is needed to maintain connectivity, but the data values should be ignored.
141 };
142
143 // A vtkDataArray with this name must be of type vtkUnsignedCharArray.
144 // Each value must be assigned according to the bit fields described in
145 // PointGhostTypes or CellGhostType
146 static const char* GhostArrayName() { return "vtkGhostType"; }
147
148 //-----------------------------------------------------------------------------------
149
151
155 int SetActiveScalars(const char* name);
158
160
164 int SetActiveVectors(const char* name);
167
169
173 int SetActiveNormals(const char* name);
176
178
182 int SetActiveTangents(const char* name);
185
187
191 int SetActiveTCoords(const char* name);
194
196
200 int SetActiveTensors(const char* name);
203
205
209 int SetActiveGlobalIds(const char* name);
212
214
218 int SetActivePedigreeIds(const char* name);
221
223
227 int SetActiveRationalWeights(const char* name);
230
232
236 int SetActiveHigherOrderDegrees(const char* name);
239
241
245 int SetActiveProcessIds(const char* name);
248
250
256 vtkDataArray* GetScalars(const char* name);
257 vtkDataArray* GetVectors(const char* name);
258 vtkDataArray* GetNormals(const char* name);
259 vtkDataArray* GetTangents(const char* name);
260 vtkDataArray* GetTCoords(const char* name);
261 vtkDataArray* GetTensors(const char* name);
262 vtkDataArray* GetGlobalIds(const char* name);
266 vtkDataArray* GetProcessIds(const char* name);
268
287 int SetActiveAttribute(const char* name, int attributeType);
288
294 int SetActiveAttribute(int index, int attributeType);
295
301 void GetAttributeIndices(int* indexArray);
302
309 int IsArrayAnAttribute(int idx);
310
333 int SetAttribute(vtkAbstractArray* aa, int attributeType);
334
341 vtkDataArray* GetAttribute(int attributeType);
342
351
353
358 void RemoveArray(int index) override;
360
362
366 static const char* GetAttributeTypeAsString(int attributeType);
367 static const char* GetLongAttributeTypeAsString(int attributeType);
369
370 // -- attribute copy properties ------------------------------------------
371
373 {
374 COPYTUPLE = 0,
375 INTERPOLATE = 1,
376 PASSDATA = 2,
377 ALLCOPY // all of the above
378 };
379
401 void SetCopyAttribute(int index, int value, int ctype = ALLCOPY);
402
407 int GetCopyAttribute(int index, int ctype);
408
410 void SetCopyScalars(vtkTypeBool i, int ctype = ALLCOPY);
411 vtkTypeBool GetCopyScalars(int ctype = ALLCOPY);
412 vtkBooleanMacro(CopyScalars, vtkTypeBool);
413
415 void SetCopyVectors(vtkTypeBool i, int ctype = ALLCOPY);
416 vtkTypeBool GetCopyVectors(int ctype = ALLCOPY);
417 vtkBooleanMacro(CopyVectors, vtkTypeBool);
418
420 void SetCopyNormals(vtkTypeBool i, int ctype = ALLCOPY);
421 vtkTypeBool GetCopyNormals(int ctype = ALLCOPY);
422 vtkBooleanMacro(CopyNormals, vtkTypeBool);
423
425 void SetCopyTangents(vtkTypeBool i, int ctype = ALLCOPY);
426 vtkTypeBool GetCopyTangents(int ctype = ALLCOPY);
427 vtkBooleanMacro(CopyTangents, vtkTypeBool);
428
430 void SetCopyTCoords(vtkTypeBool i, int ctype = ALLCOPY);
431 vtkTypeBool GetCopyTCoords(int ctype = ALLCOPY);
432 vtkBooleanMacro(CopyTCoords, vtkTypeBool);
433
435 void SetCopyTensors(vtkTypeBool i, int ctype = ALLCOPY);
436 vtkTypeBool GetCopyTensors(int ctype = ALLCOPY);
437 vtkBooleanMacro(CopyTensors, vtkTypeBool);
438
440 void SetCopyGlobalIds(vtkTypeBool i, int ctype = ALLCOPY);
441 vtkTypeBool GetCopyGlobalIds(int ctype = ALLCOPY);
442 vtkBooleanMacro(CopyGlobalIds, vtkTypeBool);
443
445 void SetCopyPedigreeIds(vtkTypeBool i, int ctype = ALLCOPY);
446 vtkTypeBool GetCopyPedigreeIds(int ctype = ALLCOPY);
447 vtkBooleanMacro(CopyPedigreeIds, vtkTypeBool);
448
450 void SetCopyRationalWeights(vtkTypeBool i, int ctype = ALLCOPY);
452 vtkBooleanMacro(CopyRationalWeights, vtkTypeBool);
453
455 void SetCopyHigherOrderDegrees(vtkTypeBool i, int ctype = ALLCOPY);
457 vtkBooleanMacro(CopyHigherOrderDegrees, vtkTypeBool);
458
460 void SetCopyProcessIds(vtkTypeBool i, int ctype = ALLCOPY);
461 vtkTypeBool GetCopyProcessIds(int ctype = ALLCOPY);
462 vtkBooleanMacro(CopyProcessIds, vtkTypeBool);
463
465 void CopyAllOn(int ctype = ALLCOPY) override;
466
468 void CopyAllOff(int ctype = ALLCOPY) override;
469
470 // -- passthrough operations ----------------------------------------------
471
481 void PassData(vtkFieldData* fd) override;
482
483 // -- copytuple operations ------------------------------------------------
484
486
498 {
499 this->CopyAllocate(pd, sze, ext, 0);
500 }
501 void CopyAllocate(vtkDataSetAttributes* pd, vtkIdType sze, vtkIdType ext, int shallowCopyArrays);
503
512
522 vtkDataSetAttributes* inDsa, const int* inExt, const int* outExt, bool setSize = true);
523
525
539 void CopyData(vtkDataSetAttributes* fromPd, vtkIdList* fromIds, vtkIdList* toIds);
540 void CopyData(vtkDataSetAttributes* fromPd, vtkIdList* fromIds, vtkIdType destStartId = 0);
542
548 void CopyData(vtkDataSetAttributes* fromPd, vtkIdType dstStart, vtkIdType n, vtkIdType srcStart);
549
551
558 vtkAbstractArray* fromData, vtkAbstractArray* toData, vtkIdType fromId, vtkIdType toId);
560 vtkAbstractArray* fromData, vtkAbstractArray* toData, vtkIdList* fromIds, vtkIdList* toIds);
561 void CopyTuples(vtkAbstractArray* fromData, vtkAbstractArray* toData, vtkIdType dstStart,
562 vtkIdType n, vtkIdType srcStart);
564
565 // -- interpolate operations ----------------------------------------------
566
568
577 {
578 this->InterpolateAllocate(pd, sze, ext, 0);
579 }
581 vtkDataSetAttributes* pd, vtkIdType sze, vtkIdType ext, int shallowCopyArrays);
583
592 vtkDataSetAttributes* fromPd, vtkIdType toId, vtkIdList* ids, double* weights);
593
604 vtkDataSetAttributes* fromPd, vtkIdType toId, vtkIdType p1, vtkIdType p2, double t);
605
619 vtkDataSetAttributes* from1, vtkDataSetAttributes* from2, vtkIdType id, double t);
620
622
623 // field list copy operations ------------------------------------------
624
630
638 vtkIdType fromId, vtkIdType toId);
640 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart);
641
649 vtkDataSetAttributes::FieldList& list, vtkIdType sze = 0, vtkIdType ext = 1000);
650
658 int idx, vtkIdType toId, vtkIdList* ids, double* weights);
659
660protected:
663
665 vtkIdType ext = 1000, int shallowCopyArrays = 0, bool createNewArrays = true);
666
670 void InitializeFields() override;
671
672 int AttributeIndices[NUM_ATTRIBUTES]; // index to attribute array in field data
673 int CopyAttributeFlags[ALLCOPY][NUM_ATTRIBUTES]; // copy flag for attribute data
674
675 friend struct ArrayList; // Friend to base class in vtkArrayListTemplate
678
679 static const int NumberOfAttributeComponents[NUM_ATTRIBUTES];
680 static const int AttributeLimits[NUM_ATTRIBUTES];
681 static const char AttributeNames[NUM_ATTRIBUTES][19];
682 static const char LongAttributeNames[NUM_ATTRIBUTES][42];
683
684private:
685 static int CheckNumberOfComponents(vtkAbstractArray* da, int attributeType);
686
687 vtkFieldData::BasicIterator ComputeRequiredArrays(vtkDataSetAttributes* pd, int ctype);
688
690 void operator=(const vtkDataSetAttributes&) = delete;
691
693};
694
695VTK_ABI_NAMESPACE_END
696#endif
Abstract superclass for all arrays.
abstract superclass for arrays of numeric data
helps manage arrays from multiple vtkDataSetAttributes.
represent and manipulate attribute data in a dataset
static const char * GetLongAttributeTypeAsString(int attributeType)
Given an integer attribute type, this static method returns a string type for the attribute (i....
vtkTypeBool GetCopyPedigreeIds(int ctype=ALLCOPY)
void PassData(vtkFieldData *fd) override
Pass entire arrays of input data through to output.
virtual void Update()
Attributes have a chance to bring themselves up to date; right now this is ignored.
vtkDataArray * GetTangents(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
int SetActiveTangents(const char *name)
Set/get the tangent data.
int SetGlobalIds(vtkDataArray *da)
Set/Get the global id data.
void InterpolateEdge(vtkDataSetAttributes *fromPd, vtkIdType toId, vtkIdType p1, vtkIdType p2, double t)
Interpolate data from the two points p1,p2 (forming an edge) and an interpolation factor,...
void CopyAllocate(vtkDataSetAttributes *pd, vtkIdType sze, vtkIdType ext, int shallowCopyArrays)
Allocates point data for point-by-point (or cell-by-cell) copy operation.
void Initialize() override
Initialize all of the object's data to nullptr Also, clear the copy flags.
int GetCopyAttribute(int index, int ctype)
Get the attribute copy flag for copy operation ctype of attribute index.
vtkFieldData::BasicIterator RequiredArrays
vtkDataArray * GetHigherOrderDegrees(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
vtkDataArray * GetScalars(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
vtkTypeBool GetCopyScalars(int ctype=ALLCOPY)
vtkDataArray * GetTCoords()
Set/Get the texture coordinate data.
static vtkDataSetAttributes * ExtendedNew()
int SetActiveAttribute(int index, int attributeType)
Make the array with the given index the active attribute.
void SetCopyAttribute(int index, int value, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
int SetActiveProcessIds(const char *name)
Set/Get the process id data.
~vtkDataSetAttributes() override
int SetHigherOrderDegrees(vtkDataArray *da)
Set/Get the rational degrees data.
int SetActiveNormals(const char *name)
Set/get the normal data.
vtkDataArray * GetTangents()
Set/get the tangent data.
vtkAbstractArray * GetPedigreeIds(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
vtkDataArray * GetRationalWeights()
Set/Get the rational weights data.
void SetCopyNormals(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void InterpolateAllocate(vtkDataSetAttributes *pd, vtkIdType sze=0, vtkIdType ext=1000)
Initialize point interpolation method.
void CopyData(vtkDataSetAttributes *fromPd, vtkIdList *fromIds, vtkIdType destStartId=0)
Copy the attribute data from one id to another.
vtkDataArray * GetProcessIds()
Set/Get the process id data.
int SetActiveHigherOrderDegrees(const char *name)
Set/Get the rational degrees data.
vtkDataArray * GetNormals()
Set/get the normal data.
int SetScalars(vtkDataArray *da)
Set/Get the scalar data.
vtkDataArray * GetNormals(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
void SetCopyTCoords(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void InterpolatePoint(vtkDataSetAttributes::FieldList &list, vtkDataSetAttributes *fromPd, int idx, vtkIdType toId, vtkIdList *ids, double *weights)
Interpolate data set attributes from other data set attributes given cell or point ids and associated...
vtkDataArray * GetRationalWeights(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
int SetActiveTCoords(const char *name)
Set/Get the texture coordinate data.
void SetCopyTangents(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
vtkTypeBool GetCopyVectors(int ctype=ALLCOPY)
vtkTypeBool GetCopyNormals(int ctype=ALLCOPY)
void CopyTuples(vtkAbstractArray *fromData, vtkAbstractArray *toData, vtkIdList *fromIds, vtkIdList *toIds)
Copy a tuple (or set of tuples) of data from one data array to another.
void InterpolatePoint(vtkDataSetAttributes *fromPd, vtkIdType toId, vtkIdList *ids, double *weights)
Interpolate data set attributes from other data set attributes given cell or point ids and associated...
void InterpolateAllocate(vtkDataSetAttributes::FieldList &list, vtkIdType sze=0, vtkIdType ext=1000)
A special form of InterpolateAllocate() to be used with FieldLists.
void SetCopyPedigreeIds(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void InitializeFields() override
Initialize all of the object's data to nullptr.
vtkDataArray * GetTensors()
Set/Get the tensor data.
int SetActiveGlobalIds(const char *name)
Set/Get the global id data.
void SetupForCopy(vtkDataSetAttributes *pd)
Create a mapping between the input attributes and this object so that methods like CopyData() and Cop...
int SetActiveScalars(const char *name)
Set/Get the scalar data.
void CopyData(vtkDataSetAttributes *fromPd, vtkIdType dstStart, vtkIdType n, vtkIdType srcStart)
Copy n consecutive attributes starting at srcStart from fromPd to this container, starting at the dst...
int SetNormals(vtkDataArray *da)
Set/get the normal data.
void InterpolateTime(vtkDataSetAttributes *from1, vtkDataSetAttributes *from2, vtkIdType id, double t)
Interpolate data from the same id (point or cell) at different points in time (parameter t).
void CopyData(vtkDataSetAttributes::FieldList &list, vtkDataSetAttributes *dsa, int idx, vtkIdType fromId, vtkIdType toId)
Special forms of CopyData() to be used with FieldLists.
void CopyAllOn(int ctype=ALLCOPY) override
Turn on/off the copying of attribute data.
void SetCopyScalars(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void CopyTuple(vtkAbstractArray *fromData, vtkAbstractArray *toData, vtkIdType fromId, vtkIdType toId)
Copy a tuple (or set of tuples) of data from one data array to another.
void InternalCopyAllocate(vtkDataSetAttributes *pd, int ctype, vtkIdType sze=0, vtkIdType ext=1000, int shallowCopyArrays=0, bool createNewArrays=true)
int IsArrayAnAttribute(int idx)
Determine whether a data array of index idx is considered a data set attribute (i....
vtkTypeBool GetCopyTangents(int ctype=ALLCOPY)
vtkDataArray * GetTCoords(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
void CopyData(vtkDataSetAttributes *fromPd, vtkIdType fromId, vtkIdType toId)
Copy the attribute data from one id to another.
int SetActivePedigreeIds(const char *name)
Set/Get the pedigree id data.
vtkAbstractArray * GetPedigreeIds()
Set/Get the pedigree id data.
vtkDataArray * GetVectors()
Set/Get the vector data.
int SetProcessIds(vtkDataArray *da)
Set/Get the process id data.
int SetActiveRationalWeights(const char *name)
Set/Get the rational weights data.
vtkAbstractArray * GetAbstractAttribute(int attributeType)
Return an attribute given the attribute type (see vtkDataSetAttributes::AttributeTypes).
void RemoveArray(int index) override
Remove an array (with the given index) from the list of arrays.
static const char * GhostArrayName()
vtkTypeBool GetCopyRationalWeights(int ctype=ALLCOPY)
vtkTypeBool GetCopyHigherOrderDegrees(int ctype=ALLCOPY)
vtkDataArray * GetAttribute(int attributeType)
Return an attribute given the attribute type (see vtkDataSetAttributes::AttributeTypes).
void CopyTuples(vtkAbstractArray *fromData, vtkAbstractArray *toData, vtkIdType dstStart, vtkIdType n, vtkIdType srcStart)
Copy a tuple (or set of tuples) of data from one data array to another.
void CopyData(vtkDataSetAttributes::FieldList &list, vtkDataSetAttributes *dsa, int idx, vtkIdType dstStart, vtkIdType n, vtkIdType srcStart)
vtkTypeBool GetCopyGlobalIds(int ctype=ALLCOPY)
vtkTypeBool GetCopyTCoords(int ctype=ALLCOPY)
static vtkDataSetAttributes * New()
Construct object with copying turned on for all data.
void CopyStructuredData(vtkDataSetAttributes *inDsa, const int *inExt, const int *outExt, bool setSize=true)
This method is used to copy data arrays in images.
void CopyAllocate(vtkDataSetAttributes::FieldList &list, vtkIdType sze=0, vtkIdType ext=1000)
A special form of CopyAllocate() to be used with FieldLists.
void CopyAllocate(vtkDataSetAttributes *pd, vtkIdType sze=0, vtkIdType ext=1000)
Allocates point data for point-by-point (or cell-by-cell) copy operation.
void DeepCopy(vtkFieldData *pd) override
Deep copy of data (i.e., create new data arrays and copy from input data).
int SetRationalWeights(vtkDataArray *da)
Set/Get the rational weights data.
void ShallowCopy(vtkFieldData *pd) override
Shallow copy of data (i.e., use reference counting).
static const char * GetAttributeTypeAsString(int attributeType)
Given an integer attribute type, this static method returns a string type for the attribute (i....
void GetAttributeIndices(int *indexArray)
Get the field data array indices corresponding to scalars, vectors, tensors, etc.
void SetCopyRationalWeights(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void SetCopyTensors(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
int SetActiveAttribute(const char *name, int attributeType)
Make the array with the given name the active attribute.
int SetTCoords(vtkDataArray *da)
Set/Get the texture coordinate data.
vtkTypeBool GetCopyProcessIds(int ctype=ALLCOPY)
void SetCopyHigherOrderDegrees(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void InterpolateAllocate(vtkDataSetAttributes *pd, vtkIdType sze, vtkIdType ext, int shallowCopyArrays)
Initialize point interpolation method.
int SetPedigreeIds(vtkAbstractArray *da)
Set/Get the pedigree id data.
vtkTypeBool GetCopyTensors(int ctype=ALLCOPY)
void CopyData(vtkDataSetAttributes *fromPd, vtkIdList *fromIds, vtkIdList *toIds)
Copy the attribute data from one id to another.
void SetCopyProcessIds(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
int SetActiveVectors(const char *name)
Set/Get the vector data.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetCopyGlobalIds(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
void CopyAllOff(int ctype=ALLCOPY) override
Turn on/off the copying of attribute data.
vtkDataArray * GetGlobalIds(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
vtkDataArray * GetScalars()
Set/Get the scalar data.
vtkDataArray * GetHigherOrderDegrees()
Set/Get the rational degrees data.
int SetTangents(vtkDataArray *da)
Set/get the tangent data.
int SetActiveTensors(const char *name)
Set/Get the tensor data.
void SetCopyVectors(vtkTypeBool i, int ctype=ALLCOPY)
Turn on/off the copying of attribute data.
vtkDataArray * GetVectors(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
int SetVectors(vtkDataArray *da)
Set/Get the vector data.
vtkDataArray * GetTensors(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
vtkDataArray * GetGlobalIds()
Set/Get the global id data.
int SetTensors(vtkDataArray *da)
Set/Get the tensor data.
int SetAttribute(vtkAbstractArray *aa, int attributeType)
Set an array to use as the given attribute type (i.e., vtkDataSetAttributes::SCALAR,...
vtkDataArray * GetProcessIds(const char *name)
If the string is nullptr or empty, calls the alternate method of the same name (that takes no paramet...
represent and manipulate fields of data
virtual void RemoveArray(const char *name)
Remove an array (with the given name) from the list of arrays.
list of point or cell ids
Definition vtkIdList.h:23
a simple class to control print indentation
Definition vtkIndent.h:29
map scalar values into colors via a lookup table
int vtkTypeBool
Definition vtkABI.h:64
int vtkIdType
Definition vtkType.h:315