VTK
vtkPassArrays.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPassArrays.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 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
66 #ifndef vtkPassArrays_h
67 #define vtkPassArrays_h
68 
69 #include "vtkFiltersGeneralModule.h" // For export macro
70 #include "vtkDataObjectAlgorithm.h"
71 
72 class VTKFILTERSGENERAL_EXPORT vtkPassArrays : public vtkDataObjectAlgorithm
73 {
74 public:
75  static vtkPassArrays* New();
77  void PrintSelf(ostream& os, vtkIndent indent) override;
78 
85  virtual void AddArray(int fieldType, const char* name);
86 
87  virtual void AddPointDataArray(const char* name);
88  virtual void AddCellDataArray(const char* name);
89  virtual void AddFieldDataArray(const char* name);
90 
91  virtual void RemoveArray(int fieldType, const char* name);
92 
93  virtual void RemovePointDataArray(const char* name);
94  virtual void RemoveCellDataArray(const char* name);
95  virtual void RemoveFieldDataArray(const char* name);
96 
98 
101  virtual void ClearArrays();
102  virtual void ClearPointDataArrays();
103  virtual void ClearCellDataArrays();
104  virtual void ClearFieldDataArrays();
106 
108 
112  vtkSetMacro(RemoveArrays, bool);
113  vtkGetMacro(RemoveArrays, bool);
114  vtkBooleanMacro(RemoveArrays, bool);
116 
118 
123  vtkSetMacro(UseFieldTypes, bool);
124  vtkGetMacro(UseFieldTypes, bool);
125  vtkBooleanMacro(UseFieldTypes, bool);
127 
135  virtual void AddFieldType(int fieldType);
136 
140  virtual void ClearFieldTypes();
141 
146  vtkInformationVector** inputVector,
147  vtkInformationVector* outputVector) override;
148 
149 protected:
151  ~vtkPassArrays() override;
152 
158 
163  vtkInformationVector** inputVector,
164  vtkInformationVector* outputVector) override;
165 
169  vtkInformationVector*) override;
170 
173 
174  class Internals;
175  Internals* Implementation;
176 
177 private:
178  vtkPassArrays(const vtkPassArrays&) = delete;
179  void operator=(const vtkPassArrays&) = delete;
180 };
181 
182 #endif
183 
vtkPassArrays::RemoveCellDataArray
virtual void RemoveCellDataArray(const char *name)
vtkPassArrays::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
vtkPassArrays::RemoveFieldDataArray
virtual void RemoveFieldDataArray(const char *name)
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkPassArrays::~vtkPassArrays
~vtkPassArrays() override
vtkPassArrays::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Override to limit types of supported input types to non-composite datasets.
vtkDataObjectAlgorithm
Superclass for algorithms that produce only data object as output.
Definition: vtkDataObjectAlgorithm.h:44
vtkPassArrays::AddCellDataArray
virtual void AddCellDataArray(const char *name)
vtkPassArrays::ProcessRequest
int ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is required to capture REQUEST_DATA_OBJECT requests.
vtkPassArrays::New
static vtkPassArrays * New()
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkPassArrays::Implementation
Internals * Implementation
Definition: vtkPassArrays.h:174
vtkPassArrays::RemoveArray
virtual void RemoveArray(int fieldType, const char *name)
vtkPassArrays::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPassArrays::UseFieldTypes
bool UseFieldTypes
Definition: vtkPassArrays.h:172
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPassArrays
Passes a subset of arrays to the output.
Definition: vtkPassArrays.h:73
vtkPassArrays::ClearFieldTypes
virtual void ClearFieldTypes()
Clear all field types to process.
vtkPassArrays::ClearFieldDataArrays
virtual void ClearFieldDataArrays()
vtkPassArrays::AddFieldType
virtual void AddFieldType(int fieldType)
Add a field type to process.
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkPassArrays::RequestDataObject
int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Creates the same output type as the input type.
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkPassArrays::AddArray
virtual void AddArray(int fieldType, const char *name)
Adds an array to pass through.
vtkPassArrays::ClearCellDataArrays
virtual void ClearCellDataArrays()
vtkPassArrays::AddFieldDataArray
virtual void AddFieldDataArray(const char *name)
vtkPassArrays::RemovePointDataArray
virtual void RemovePointDataArray(const char *name)
vtkDataObjectAlgorithm.h
vtkPassArrays::AddPointDataArray
virtual void AddPointDataArray(const char *name)
vtkPassArrays::ClearPointDataArrays
virtual void ClearPointDataArrays()
vtkPassArrays::RemoveArrays
bool RemoveArrays
Definition: vtkPassArrays.h:171
vtkPassArrays::vtkPassArrays
vtkPassArrays()
vtkPassArrays::ClearArrays
virtual void ClearArrays()
Clear all arrays to pass through.