dox / Common
vtkDataArraySelection.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkDataArraySelection.h,v $
00005 
00006   Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
00007   All rights reserved.
00008   See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
00009 
00010      This software is distributed WITHOUT ANY WARRANTY; without even
00011      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
00012      PURPOSE.  See the above copyright notice for more information.
00013 
00014 =========================================================================*/
00036 #ifndef __vtkDataArraySelection_h
00037 #define __vtkDataArraySelection_h
00038 
00039 #include "vtkObject.h"
00040 
00041 class vtkDataArraySelectionArrayNamesType;
00042 class vtkDataArraySelectionArraySettingsType;
00043 
00044 class VTK_COMMON_EXPORT vtkDataArraySelection : public vtkObject
00045 {
00046 public:
00047   vtkTypeRevisionMacro(vtkDataArraySelection,vtkObject);
00048   void PrintSelf(ostream& os, vtkIndent indent);
00049   static vtkDataArraySelection* New();
00050   
00053   void EnableArray(const char* name);
00054   
00057   void DisableArray(const char* name);
00058   
00061   int ArrayIsEnabled(const char* name);
00062   
00064   int ArrayExists(const char* name);
00065 
00067   void EnableAllArrays();
00068   
00070   void DisableAllArrays();
00071   
00073   int GetNumberOfArrays();
00074   
00076   const char* GetArrayName(int index);
00077   
00079   int GetArraySetting(int index);
00080   
00082   void RemoveAllArrays();
00083   
00084   //BTX
00089   int AddArray(const char* name);
00090 
00092 
00100   void SetArrays(const char* const* names, int numArrays);
00101   void SetArraysWithDefault(const char* const* names, int numArrays,
00102                             int defaultStatus);
00103   //ETX
00105   
00107   void CopySelections(vtkDataArraySelection* selections);
00108 protected:
00109   vtkDataArraySelection();
00110   ~vtkDataArraySelection();
00111   
00112   // The list of array names.
00113   vtkDataArraySelectionArrayNamesType* ArrayNames;
00114   
00115   // The list of array settings.
00116   vtkDataArraySelectionArraySettingsType* ArraySettings;
00117   
00118 private:
00119   vtkDataArraySelection(const vtkDataArraySelection&);  // Not implemented.
00120   void operator=(const vtkDataArraySelection&);  // Not implemented.
00121 };
00122 
00123 #endif