VTK  9.2.5
vtkSplitField.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSplitField.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 =========================================================================*/
49 #ifndef vtkSplitField_h
50 #define vtkSplitField_h
51 
52 #include "vtkDataSetAlgorithm.h"
53 #include "vtkFiltersGeneralModule.h" // For export macro
54 
55 #include "vtkDataSetAttributes.h" // Needed for NUM_ATTRIBUTES
56 
57 class vtkFieldData;
58 
59 class VTKFILTERSGENERAL_EXPORT vtkSplitField : public vtkDataSetAlgorithm
60 {
61 public:
63  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
68  static vtkSplitField* New();
69 
74  void SetInputField(int attributeType, int fieldLoc);
75 
80  void SetInputField(const char* name, int fieldLoc);
81 
86  void SetInputField(const char* name, const char* fieldLoc);
87 
91  void Split(int component, const char* arrayName);
92 
94  {
95  DATA_OBJECT = 0,
96  POINT_DATA = 1,
97  CELL_DATA = 2
98  };
99 
100  struct Component
101  {
102  int Index;
103  char* FieldName;
104  Component* Next; // linked list
105  void SetName(const char* name)
106  {
107  delete[] this->FieldName;
108  this->FieldName = nullptr;
109  if (name)
110  {
111  size_t len = strlen(name) + 1;
112  this->FieldName = new char[len];
113 #ifdef _MSC_VER
114  strncpy_s(this->FieldName, len, name, len - 1);
115 #else
116  strncpy(this->FieldName, name, len);
117 #endif
118  }
119  }
120  Component() { FieldName = nullptr; }
121  ~Component() { delete[] FieldName; }
122  };
123 
124 protected:
126  {
128  ATTRIBUTE
129  };
130 
132  ~vtkSplitField() override;
133 
135 
136  char* FieldName;
140 
141  static char FieldLocationNames[3][12];
142  static char AttributeNames[vtkDataSetAttributes::NUM_ATTRIBUTES][10];
143 
145 
146  // Components are stored as a linked list.
149 
150  // Methods to browse/modify the linked list.
151  Component* GetNextComponent(Component* op) { return op->Next; }
152  Component* GetFirst() { return this->Head; }
156 
157  void PrintComponent(Component* op, ostream& os, vtkIndent indent);
158  void PrintAllComponents(ostream& os, vtkIndent indent);
159 
160 private:
161  vtkSplitField(const vtkSplitField&) = delete;
162  void operator=(const vtkSplitField&) = delete;
163 };
164 
165 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
Superclass for algorithms that produce output of the same type as input.
represent and manipulate fields of data
Definition: vtkFieldData.h:172
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Split a field into single component fields.
Definition: vtkSplitField.h:60
void DeleteAllComponents()
void SetInputField(int attributeType, int fieldLoc)
Use the given attribute in the field data given by fieldLoc as input.
void SetInputField(const char *name, const char *fieldLoc)
Helper method used by other language bindings.
Component * FindComponent(int index)
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
void Split(int component, const char *arrayName)
Create a new array with the given component.
void PrintComponent(Component *op, ostream &os, vtkIndent indent)
static vtkSplitField * New()
Create a new vtkSplitField.
void PrintAllComponents(ostream &os, vtkIndent indent)
Component * Head
void SetInputField(const char *name, int fieldLoc)
Use the array with given name in the field data given by fieldLoc as input.
Component * GetNextComponent(Component *op)
Component * Tail
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void AddComponent(Component *op)
~vtkSplitField() override
vtkDataArray * SplitArray(vtkDataArray *da, int component)
Component * GetFirst()
@ component
Definition: vtkX3D.h:181
@ name
Definition: vtkX3D.h:225
@ index
Definition: vtkX3D.h:252
void SetName(const char *name)