vtkPythonCalculator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPythonCalculator_h
#define vtkPythonCalculator_h

#include "vtkDataObject.h"                         // for FIELD_ASSOCIATION_POINTS
#include "vtkPVVTKExtensionsFiltersPythonModule.h" //needed for exports
#include "vtkProgrammableFilter.h"

class VTKPVVTKEXTENSIONSFILTERSPYTHON_EXPORT vtkPythonCalculator : public vtkProgrammableFilter
{
public:
  vtkTypeMacro(vtkPythonCalculator, vtkProgrammableFilter);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkPythonCalculator* New();


  vtkSetMacro(ArrayAssociation, int);
  vtkGetMacro(ArrayAssociation, int);


  vtkSetMacro(Expression, std::string);
  vtkGetMacro(Expression, std::string);


  vtkSetMacro(MultilineExpression, std::string);
  vtkGetMacro(MultilineExpression, std::string);


  vtkSetStringMacro(ArrayName);
  vtkGetStringMacro(ArrayName);


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


  vtkGetMacro(UseMultilineExpression, bool);
  vtkSetMacro(UseMultilineExpression, bool);


  void SetInputName(int index, const std::string& inputName);
  std::string GetInputName(int index);

  void ClearInputNames();

  static void ExecuteScript(void*);

protected:
  vtkPythonCalculator();
  ~vtkPythonCalculator() override;

  void Exec(const std::string&);

  int FillOutputPortInformation(int port, vtkInformation* info) override;

  // overridden to allow multiple inputs to port 0
  int FillInputPortInformation(int port, vtkInformation* info) override;

  // ovveridden to set a time range so the filter is updated when a timestep changes.
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  // overridden to allow string substitutions for the Expression
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  // Creates whatever output data set type is selected.
  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  std::string Expression;
  std::string MultilineExpression;
  bool UseMultilineExpression = false;

  char* ArrayName = nullptr;
  int ArrayAssociation = vtkDataObject::FIELD_ASSOCIATION_POINTS;
  int ResultArrayType = VTK_DOUBLE;

private:
  vtkPythonCalculator(const vtkPythonCalculator&) = delete;
  void operator=(const vtkPythonCalculator&) = delete;

  std::vector<std::string> InputsName;
};

#endif