vtkArrayCalculator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkArrayCalculator.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.

=========================================================================*/
#ifndef vtkArrayCalculator_h
#define vtkArrayCalculator_h

#include "vtkDataObject.h" // For attribute types
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkPassInputTypeAlgorithm.h"

class vtkDataSet;
class vtkFunctionParser;

#ifndef VTK_LEGACY_REMOVE
#define VTK_ATTRIBUTE_MODE_DEFAULT 0
#define VTK_ATTRIBUTE_MODE_USE_POINT_DATA 1
#define VTK_ATTRIBUTE_MODE_USE_CELL_DATA 2
#define VTK_ATTRIBUTE_MODE_USE_VERTEX_DATA 3
#define VTK_ATTRIBUTE_MODE_USE_EDGE_DATA 4
#endif

class VTKFILTERSCORE_EXPORT vtkArrayCalculator : public vtkPassInputTypeAlgorithm
{
public:
  vtkTypeMacro(vtkArrayCalculator,vtkPassInputTypeAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkArrayCalculator *New();


  virtual void SetFunction(const char* function);
  vtkGetStringMacro(Function);


  void AddScalarArrayName(const char* arrayName, int component = 0);
  void AddVectorArrayName(const char* arrayName, int component0 = 0,
                          int component1 = 1, int component2 = 2);


  void AddScalarVariable(const char* variableName, const char* arrayName,
                         int component = 0);
  void AddVectorVariable(const char* variableName, const char* arrayName,
                         int component0 = 0, int component1 = 1,
                         int component2 = 2);


  void AddCoordinateScalarVariable(const char* variableName,
                                   int component = 0);
  void AddCoordinateVectorVariable(const char* variableName,
                                   int component0 = 0, int component1 = 1,
                                   int component2 = 2);


  void SetResultArrayName(const char* name);
  vtkGetStringMacro(ResultArrayName);


  vtkGetMacro(ResultArrayType,int);
  vtkSetMacro(ResultArrayType,int);


  vtkGetMacro(CoordinateResults, vtkTypeBool);
  vtkSetMacro(CoordinateResults, vtkTypeBool);
  vtkBooleanMacro(CoordinateResults, vtkTypeBool);


  vtkGetMacro(ResultNormals, bool);
  vtkSetMacro(ResultNormals, bool);
  vtkBooleanMacro(ResultNormals, bool);


  vtkGetMacro(ResultTCoords, bool);
  vtkSetMacro(ResultTCoords, bool);
  vtkBooleanMacro(ResultTCoords, bool);


#ifndef VTK_LEGACY_REMOVE
  VTK_LEGACY(void SetAttributeMode(int newMode);)
  VTK_LEGACY(int GetAttributeMode();)
  VTK_LEGACY(void SetAttributeModeToDefault())
    {this->SetAttributeType(DEFAULT_ATTRIBUTE_TYPE);};
  VTK_LEGACY(void SetAttributeModeToUsePointData())
    {this->SetAttributeType(vtkDataObject::POINT);};
  VTK_LEGACY(void SetAttributeModeToUseCellData())
    {this->SetAttributeType(vtkDataObject::CELL);};
  VTK_LEGACY(void SetAttributeModeToUseVertexData())
    {this->SetAttributeType(vtkDataObject::VERTEX);};
  VTK_LEGACY(void SetAttributeModeToUseEdgeData())
    {this->SetAttributeType(vtkDataObject::EDGE);};
  VTK_LEGACY(const char *GetAttributeModeAsString());
#endif


  const char *GetAttributeTypeAsString();

  static const int DEFAULT_ATTRIBUTE_TYPE = -1;

  vtkSetMacro(AttributeType, int);
  vtkGetMacro(AttributeType, int);
  void SetAttributeTypeToDefault()
  {this->SetAttributeType(DEFAULT_ATTRIBUTE_TYPE);}
  void SetAttributeTypeToPointData()
  {this->SetAttributeType(vtkDataObject::POINT);}
  void SetAttributeTypeToCellData()
  {this->SetAttributeType(vtkDataObject::CELL);}
  void SetAttributeTypeToEdgeData()
  {this->SetAttributeType(vtkDataObject::EDGE);}
  void SetAttributeTypeToVertexData()
  {this->SetAttributeType(vtkDataObject::VERTEX);}
  void SetAttributeTypeToRowData()
  {this->SetAttributeType(vtkDataObject::ROW);}

  void RemoveAllVariables();

  virtual void RemoveScalarVariables();

  virtual void RemoveVectorVariables();

  virtual void RemoveCoordinateScalarVariables();

  virtual void RemoveCoordinateVectorVariables();


  char** GetScalarArrayNames() { return this->ScalarArrayNames; }
  char* GetScalarArrayName(int i);
  char** GetVectorArrayNames() { return this->VectorArrayNames; }
  char* GetVectorArrayName(int i);
  char** GetScalarVariableNames() { return this->ScalarVariableNames; }
  char* GetScalarVariableName(int i);
  char** GetVectorVariableNames() { return this->VectorVariableNames; }
  char* GetVectorVariableName(int i);
  int* GetSelectedScalarComponents() { return this->SelectedScalarComponents; }
  int GetSelectedScalarComponent(int i);
  int** GetSelectedVectorComponents() { return this->SelectedVectorComponents;}
  int* GetSelectedVectorComponents(int i);
  vtkGetMacro(NumberOfScalarArrays, int);
  vtkGetMacro(NumberOfVectorArrays, int);


  vtkSetMacro(ReplaceInvalidValues,vtkTypeBool);
  vtkGetMacro(ReplaceInvalidValues,vtkTypeBool);
  vtkBooleanMacro(ReplaceInvalidValues,vtkTypeBool);
  vtkSetMacro(ReplacementValue,double);
  vtkGetMacro(ReplacementValue,double);

  vtkDataSet* GetDataSetOutput();

protected:
  vtkArrayCalculator();
  ~vtkArrayCalculator() override;

  int FillInputPortInformation(int, vtkInformation*) override;

  int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override;

  char  * Function;
  char  * ResultArrayName;
  char ** ScalarArrayNames;
  char ** VectorArrayNames;
  char ** ScalarVariableNames;
  char ** VectorVariableNames;
  int     NumberOfScalarArrays;
  int     NumberOfVectorArrays;
  int     AttributeType;
  int   * SelectedScalarComponents;
  int  ** SelectedVectorComponents;
  vtkFunctionParser* FunctionParser;

  vtkTypeBool     ReplaceInvalidValues;
  double  ReplacementValue;

  vtkTypeBool     CoordinateResults;
  bool    ResultNormals;
  bool    ResultTCoords;
  char ** CoordinateScalarVariableNames;
  char ** CoordinateVectorVariableNames;
  int   * SelectedCoordinateScalarComponents;
  int  ** SelectedCoordinateVectorComponents;
  int     NumberOfCoordinateScalarArrays;
  int     NumberOfCoordinateVectorArrays;

  int     ResultArrayType;
private:
  vtkArrayCalculator(const vtkArrayCalculator&) = delete;
  void operator=(const vtkArrayCalculator&) = delete;
};

#endif