vtkSMImageExtractWriterProxy.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkSMImageExtractWriterProxy.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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 vtkSMImageExtractWriterProxy_h
#define vtkSMImageExtractWriterProxy_h

#include "vtkRemotingViewsModule.h" // needed for exports
#include "vtkSMExtractWriterProxy.h"
#include "vtkSMExtractsController.h" // for SummaryParametersT type

class VTKREMOTINGVIEWS_EXPORT vtkSMImageExtractWriterProxy : public vtkSMExtractWriterProxy
{
public:
  static vtkSMImageExtractWriterProxy* New();
  vtkTypeMacro(vtkSMImageExtractWriterProxy, vtkSMExtractWriterProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  bool Write(vtkSMExtractsController* extractor) override;
  bool CanExtract(vtkSMProxy* proxy) override;
  bool IsExtracting(vtkSMProxy* proxy) override;
  void SetInput(vtkSMProxy* proxy) override;
  vtkSMProxy* GetInput() override;

  enum CameraMode
  {
    Static = 0,
    PhiTheta = 1,
  };

protected:
  vtkSMImageExtractWriterProxy();
  ~vtkSMImageExtractWriterProxy() override;

  void CreateVTKObjects() override;

  using SummaryParametersT = vtkSMExtractsController::SummaryParametersT;

  bool WriteImage(vtkSMExtractsController* extractor,
    const SummaryParametersT& cameraParams = SummaryParametersT{});

  virtual bool WriteInternal(
    vtkSMExtractsController* extractor, const SummaryParametersT& params = SummaryParametersT{});

  virtual const char* GetShortName(const std::string& key) const;

private:
  vtkSMImageExtractWriterProxy(const vtkSMImageExtractWriterProxy&) = delete;
  void operator=(const vtkSMImageExtractWriterProxy&) = delete;
};

#endif