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 -------------------------------------------------------------------------*/
71 #ifndef vtkPassArrays_h
72 #define vtkPassArrays_h
73 
74 #include "vtkDataObjectAlgorithm.h"
75 #include "vtkFiltersGeneralModule.h" // For export macro
76 
77 class VTKFILTERSGENERAL_EXPORT vtkPassArrays : public vtkDataObjectAlgorithm
78 {
79 public:
80  static vtkPassArrays* New();
82  void PrintSelf(ostream& os, vtkIndent indent) override;
83 
90  virtual void AddArray(int fieldType, const char* name);
91 
92  virtual void AddPointDataArray(const char* name);
93  virtual void AddCellDataArray(const char* name);
94  virtual void AddFieldDataArray(const char* name);
95 
96  virtual void RemoveArray(int fieldType, const char* name);
97 
98  virtual void RemovePointDataArray(const char* name);
99  virtual void RemoveCellDataArray(const char* name);
100  virtual void RemoveFieldDataArray(const char* name);
101 
103 
106  virtual void ClearArrays();
107  virtual void ClearPointDataArrays();
108  virtual void ClearCellDataArrays();
109  virtual void ClearFieldDataArrays();
111 
113 
117  vtkSetMacro(RemoveArrays, bool);
118  vtkGetMacro(RemoveArrays, bool);
119  vtkBooleanMacro(RemoveArrays, bool);
121 
123 
128  vtkSetMacro(UseFieldTypes, bool);
129  vtkGetMacro(UseFieldTypes, bool);
130  vtkBooleanMacro(UseFieldTypes, bool);
132 
140  virtual void AddFieldType(int fieldType);
141 
145  virtual void ClearFieldTypes();
146 
151  vtkInformationVector** inputVector,
152  vtkInformationVector* outputVector) override;
153 
154 protected:
155  vtkPassArrays();
156  ~vtkPassArrays() override;
157 
162  int FillInputPortInformation(int port, vtkInformation* info) override;
163 
167  int RequestDataObject(vtkInformation* request,
168  vtkInformationVector** inputVector,
169  vtkInformationVector* outputVector) override;
170 
171  int RequestData(
174  vtkInformationVector*) override;
175 
178 
179  class Internals;
180  Internals* Implementation;
181 
182 private:
183  vtkPassArrays(const vtkPassArrays&) = delete;
184  void operator=(const vtkPassArrays&) = delete;
185 };
186 
187 #endif
188 
vtkDataObjectAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkDataObjectAlgorithm
Superclass for algorithms that produce only data object as output.
Definition: vtkDataObjectAlgorithm.h:43
vtkDataObjectAlgorithm::ProcessRequest
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
see vtkAlgorithm for details
vtkX3D::port
Definition: vtkX3D.h:447
vtkPassArrays::Implementation
Internals * Implementation
Definition: vtkPassArrays.h:179
vtkPassArrays::UseFieldTypes
bool UseFieldTypes
Definition: vtkPassArrays.h:177
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkPassArrays
Passes a subset of arrays to the output.
Definition: vtkPassArrays.h:77
vtkX3D::name
Definition: vtkX3D.h:219
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:70
vtkX3D::info
Definition: vtkX3D.h:376
vtkDataObjectAlgorithm::New
static vtkDataObjectAlgorithm * New()
vtkDataObjectAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Definition: vtkDataObjectAlgorithm.h:122
vtkDataObjectAlgorithm.h
vtkDataObjectAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkDataObjectAlgorithm::RequestDataObject
virtual int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkDataObjectAlgorithm.h:104
vtkPassArrays::RemoveArrays
bool RemoveArrays
Definition: vtkPassArrays.h:176
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69