vtkPythonProgrammableFilter.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 vtkPythonProgrammableFilter_h
#define vtkPythonProgrammableFilter_h

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

class vtkPythonProgrammableFilterImplementation;

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


  vtkSetStringMacro(Script);
  vtkGetStringMacro(Script);


  vtkSetStringMacro(InformationScript);
  vtkGetStringMacro(InformationScript);


  vtkSetStringMacro(UpdateExtentScript);
  vtkGetStringMacro(UpdateExtentScript);


  vtkSetStringMacro(CheckNeedsUpdateScript);
  vtkGetStringMacro(CheckNeedsUpdateScript);


  void SetParameterInternal(const char* name, const char* value);
  void SetParameter(const char* name, const char* value);
  void SetParameter(const char* name, int value);
  void SetParameter(const char* name, double value);
  void SetParameter(const char* name, double value1, double value2);
  void SetParameter(const char* name, double value1, double value2, double value3);


  void AddParameter(const char* name, const char* value);
  void ClearParameter(const char* name);

  void ClearParameters();

  static void ExecuteScript(void*);


  vtkSetMacro(OutputDataSetType, int);
  vtkGetMacro(OutputDataSetType, int);


  vtkSetStringMacro(PythonPath);
  vtkGetStringMacro(PythonPath);

  void SetNumberOfInputPorts(int numberOfInputPorts) override
  {
    this->Superclass::SetNumberOfInputPorts(numberOfInputPorts);
  }

  bool GetNeedsUpdate();

  vtkSetMacro(NeedsUpdate, bool);

protected:
  vtkPythonProgrammableFilter();
  ~vtkPythonProgrammableFilter() override;

  void Exec(const char*, const char*);

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

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

  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int ProcessRequest(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;

  char* Script;
  char* InformationScript;
  char* UpdateExtentScript;
  char* CheckNeedsUpdateScript;
  char* PythonPath;
  int OutputDataSetType;
  bool NeedsUpdate;

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

  vtkInformation* Request;

  vtkPythonProgrammableFilterImplementation* const Implementation;
};

#endif