vtkPVComparativeView.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkRemotingViewsModule.h" //needed for exports

class vtkCollection;
class vtkImageData;
class vtkSMComparativeAnimationCueProxy;
class vtkSMProxy;
class vtkSMViewProxy;

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

  void Initialize(unsigned int){};

  void StillRender();

  void InteractiveRender();

  void Initialize(vtkSMViewProxy* rootView);

  void Build(int dx, int dy);


  void SetOverlayAllComparisons(bool);
  vtkGetMacro(OverlayAllComparisons, bool);


  vtkGetVector2Macro(Dimensions, int);

  void AddRepresentation(vtkSMProxy*);

  void RemoveRepresentation(vtkSMProxy*);

  void Update();

  void GetViews(vtkCollection* collection);


  vtkGetObjectMacro(RootView, vtkSMViewProxy);


  void SetViewSize(int x, int y)
  {
    this->ViewSize[0] = x;
    this->ViewSize[1] = y;
    this->UpdateViewLayout();
  }


  void SetViewPosition(int x, int y)
  {
    this->ViewPosition[0] = x;
    this->ViewPosition[1] = y;
    this->UpdateViewLayout();
  }


  void SetTileScale(int x, int y);
  void SetTileViewport(double x0, double y0, double x1, double y1);

  void SetPPI(int) {}


  vtkSetVector2Macro(Spacing, int);
  vtkGetVector2Macro(Spacing, int);


  void AddCue(vtkSMComparativeAnimationCueProxy*);
  void RemoveCue(vtkSMComparativeAnimationCueProxy*);


  vtkGetMacro(ViewTime, double);
  void SetViewTime(double time)
  {
    if (this->ViewTime != time)
    {
      this->ViewTime = time;
      this->Modified();
      this->MarkOutdated();
    }
  }

  void MarkOutdated() { this->Outdated = true; }

  void PrepareForScreenshot() {}
  void CleanupAfterScreenshot() {}
  vtkImageData* CaptureWindow(int magX, int magY);

protected:
  vtkPVComparativeView();
  ~vtkPVComparativeView() override;

  void UpdateViewLayout();

  int Dimensions[2];
  int ViewSize[2];
  int ViewPosition[2];
  int Spacing[2];
  double ViewTime;
  bool OverlayAllComparisons;
  bool Outdated;

  void SetRootView(vtkSMViewProxy*);
  vtkSMViewProxy* RootView;

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

  class vtkInternal;
  vtkInternal* Internal;
  vtkCommand* MarkOutdatedObserver;
};

#endif