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

   Library: iMSTK

   Copyright (c) Kitware, Inc. & Center for Modeling, Simulation,
   & Imaging in Medicine, Rensselaer Polytechnic Institute.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0.txt

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

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

#pragma once

#include "imstkScreenCaptureUtility.h"

#include <vtkRenderWindow.h>
#include <vtkWindowToImageFilter.h>
#include <vtkPNGWriter.h>
#include <vtkNew.h>

#include <string>

namespace imstk
{
///
/// \class VTKScreenCaptureUtility
///
/// \brief Utility class to manage screen capture through VTK
///
class VTKScreenCaptureUtility : public ScreenCaptureUtility
{
public:
    ///
    /// \brief Constructor
    ///
    explicit VTKScreenCaptureUtility(vtkRenderWindow* const rw, const std::string prefix = "Screenshot-");

    ///
    /// \brief Destructor
    ///
    ~VTKScreenCaptureUtility() = default;

    ///
    /// \brief Saves the screenshot as a png file
    ///
    virtual void saveScreenShot();

    ///
    /// \brief Get screen shot number
    ///
    unsigned int getScreenShotNumber() const;

    ///
    /// \brief Set screen shot prefix
    ///
    void setScreenShotPrefix(const std::string newPrefix);

    ///
    /// \brief Reset screen shot number to zero
    ///
    void resetScreenShotNumber();

protected:
    vtkNew<vtkWindowToImageFilter> m_windowToImageFilter;
    vtkNew<vtkPNGWriter> m_pngWriter;           //> using vtk's png writer to save the screenshots
    vtkRenderWindow*     m_renderWindow;        //> render window whose screen shot will be taken
};
} // imstk
