vtkSMSaveAnimationProxy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMSaveAnimationProxy_h
#define vtkSMSaveAnimationProxy_h

#include "vtkRemotingAnimationModule.h" //needed for exports
#include "vtkSMSaveScreenshotProxy.h"
namespace vtkSMSaveAnimationProxyNS
{
class Friendship;
}

class vtkPVXMLElement;

class VTKREMOTINGANIMATION_EXPORT vtkSMSaveAnimationProxy : public vtkSMSaveScreenshotProxy
{
public:
  static vtkSMSaveAnimationProxy* New();
  vtkTypeMacro(vtkSMSaveAnimationProxy, vtkSMSaveScreenshotProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual bool WriteAnimation(const char* filename, vtkTypeUInt32 location = vtkPVSession::CLIENT);

  void UpdateDefaultsAndVisibilities(const char* filename) override;

protected:
  vtkSMSaveAnimationProxy();
  ~vtkSMSaveAnimationProxy() override;

  virtual bool WriteAnimationInternal(
    const char* filename, vtkTypeUInt32 location = vtkPVSession::CLIENT);

  bool Prepare() override;

  bool Cleanup() override;

  virtual bool EnforceSizeRestrictions(const char* filename);

  vtkSMViewLayoutProxy* GetLayout();
  vtkSMViewProxy* GetView();
  vtkSMSaveScreenshotProxy* GetScreenshotHelper();
  vtkSMProxy* GetAnimationScene();

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

  friend class vtkSMSaveAnimationProxyNS::Friendship;

  vtkSmartPointer<vtkPVXMLElement> SceneState;
};

#endif