vtkConvertSelection.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkConvertSelection.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
/*----------------------------------------------------------------------------
 Copyright (c) Sandia Corporation
 See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/
#ifndef vtkConvertSelection_h
#define vtkConvertSelection_h
 
#include "vtkFiltersExtractionModule.h" // For export macro
#include "vtkSelectionAlgorithm.h"
 
class vtkCompositeDataSet;
class vtkGraph;
class vtkIdTypeArray;
class vtkSelection;
class vtkSelectionNode;
class vtkStringArray;
class vtkTable;
class vtkExtractSelection;
 
class VTKFILTERSEXTRACTION_EXPORT vtkConvertSelection : public vtkSelectionAlgorithm
{
public:
  static vtkConvertSelection* New();
  vtkTypeMacro(vtkConvertSelection, vtkSelectionAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetDataObjectConnection(vtkAlgorithmOutput* in);
 
 
  vtkSetMacro(InputFieldType, int);
  vtkGetMacro(InputFieldType, int);
 
 
  vtkSetMacro(OutputType, int);
  vtkGetMacro(OutputType, int);
 
 
  virtual void SetArrayName(const char*);
  virtual const char* GetArrayName();
 
 
  virtual void SetArrayNames(vtkStringArray*);
  vtkGetObjectMacro(ArrayNames, vtkStringArray);
 
 
  void AddArrayName(const char*);
  void ClearArrayNames();
 
 
  vtkSetMacro(MatchAnyValues, bool);
  vtkGetMacro(MatchAnyValues, bool);
  vtkBooleanMacro(MatchAnyValues, bool);
 
 
  vtkSetMacro(AllowMissingArray, bool);
  vtkGetMacro(AllowMissingArray, bool);
  vtkBooleanMacro(AllowMissingArray, bool);
 
 
  virtual void SetSelectionExtractor(vtkExtractSelection*);
  vtkGetObjectMacro(SelectionExtractor, vtkExtractSelection);
 
 
  static vtkSelection* ToIndexSelection(vtkSelection* input, vtkDataObject* data);
  static vtkSelection* ToGlobalIdSelection(vtkSelection* input, vtkDataObject* data);
  static vtkSelection* ToPedigreeIdSelection(vtkSelection* input, vtkDataObject* data);
  static vtkSelection* ToValueSelection(
    vtkSelection* input, vtkDataObject* data, const char* arrayName);
  static vtkSelection* ToValueSelection(
    vtkSelection* input, vtkDataObject* data, vtkStringArray* arrayNames);
 
  static void GetSelectedItems(
    vtkSelection* input, vtkDataObject* data, int fieldType, vtkIdTypeArray* indices);
 
 
  static void GetSelectedVertices(vtkSelection* input, vtkGraph* data, vtkIdTypeArray* indices);
  static void GetSelectedEdges(vtkSelection* input, vtkGraph* data, vtkIdTypeArray* indices);
  static void GetSelectedPoints(vtkSelection* input, vtkDataSet* data, vtkIdTypeArray* indices);
  static void GetSelectedCells(vtkSelection* input, vtkDataSet* data, vtkIdTypeArray* indices);
  static void GetSelectedRows(vtkSelection* input, vtkTable* data, vtkIdTypeArray* indices);
 
  static vtkSelection* ToSelectionType(vtkSelection* input, vtkDataObject* data, int type,
    vtkStringArray* arrayNames = nullptr, int inputFieldType = -1, bool allowMissingArray = false);
 
protected:
  vtkConvertSelection();
  ~vtkConvertSelection() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  int Convert(vtkSelection* input, vtkDataObject* data, vtkSelection* output);
 
  int ConvertCompositeDataSet(vtkSelection* input, vtkCompositeDataSet* data, vtkSelection* output);
 
  int ConvertFromQueryNodeCompositeDataSet(
    vtkSelectionNode* input, vtkCompositeDataSet* data, vtkSelection* output);
 
  int ConvertToIndexSelection(vtkSelectionNode* input, vtkDataSet* data, vtkSelectionNode* output);
 
  int SelectTableFromTable(vtkTable* selTable, vtkTable* dataTable, vtkIdTypeArray* indices);
 
  int ConvertToBlockSelection(vtkSelection* input, vtkCompositeDataSet* data, vtkSelection* output);
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  int OutputType;
  int InputFieldType;
  vtkStringArray* ArrayNames;
  bool MatchAnyValues;
  bool AllowMissingArray;
  vtkExtractSelection* SelectionExtractor;
 
private:
  vtkConvertSelection(const vtkConvertSelection&) = delete;
  void operator=(const vtkConvertSelection&) = delete;
};
 
#endif