vtkViewLayout.h

Go to the documentation of this file.

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

#include "vtkCommand.h" // for vtkCommand
#include "vtkNew.h"     // for vtkNew
#include "vtkObject.h"
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkVector.h"              // for vtkVector2i
#include <memory>                   // for std::unique_ptr

class vtkPVView;
class vtkRenderWindow;
class vtkViewLayoutProp;
class vtkViewport;
class vtkPVComparativeView;

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

  void ShowOnTileDisplay();


  void RemoveAllViews();
  void AddView(vtkPVView*, const double* viewport);
  void AddView(vtkPVComparativeView*, const double* viewport);

  bool SaveAsPNG(int rank, const char* fname);


  vtkSetVector3Macro(SeparatorColor, double);
  vtkGetVector3Macro(SeparatorColor, double);


  vtkSetClampMacro(SeparatorWidth, int, 0, VTK_INT_MAX);
  vtkGetMacro(SeparatorWidth, int);

  enum
  {
    RequestUpdateLayoutEvent = vtkCommand::UserEvent + 1,

    RequestUpdateDisplayEvent,
  };

protected:
  vtkViewLayout();
  ~vtkViewLayout() override;


  vtkSetVector2Macro(TileDimensions, int);
  vtkGetVector2Macro(TileDimensions, int);


  vtkSetVector2Macro(TileMullions, int);
  vtkGetVector2Macro(TileMullions, int);

  void UpdateLayout(vtkObject*, unsigned long, void*);
  void UpdateLayoutForTileDisplay(vtkRenderWindow*);
  void UpdateLayoutForCAVE(vtkRenderWindow*);

  void UpdateDisplay(vtkObject*, unsigned long, void*);

  void Paint(vtkViewport*);

  bool NeedsActiveStereo() const;

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

  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
  vtkNew<vtkViewLayoutProp> Prop;

  bool InTileDisplay;
  int TileDimensions[2];
  int TileMullions[2];
  bool InCave;
  bool DisplayResults;
  int SeparatorWidth;
  double SeparatorColor[3];

  friend class vtkViewLayoutProp;
};

#endif