vtkPVCAVEConfigInformation.h

Go to the documentation of this file.

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

#include "vtkPVInformation.h" // for base class
#include "vtkTuple.h"         // for vtkTuple

#include <memory> // for std::unique_ptr

class vtkClientServerStream;

class VTKREMOTINGCORE_EXPORT vtkPVCAVEConfigInformation : public vtkPVInformation
{
public:
  static vtkPVCAVEConfigInformation* New();
  vtkTypeMacro(vtkPVCAVEConfigInformation, vtkPVInformation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void CopyFromObject(vtkObject*) override;

  void AddInformation(vtkPVInformation*) override;


  void CopyToStream(vtkClientServerStream*) override;
  void CopyFromStream(const vtkClientServerStream*) override;


  virtual bool GetIsInCAVE();


  virtual double GetEyeSeparation();

  virtual bool GetUseOffAxisProjection();


  virtual int GetNumberOfDisplays();


  virtual bool GetShowBorders();


  virtual bool GetFullScreen();


  virtual const char* GetName(int index);


  virtual bool GetShow2DOverlays(int index);


  virtual vtkTuple<int, 4> GetGeometry(int index);


  virtual bool GetHasCorners(int index);


  virtual vtkTuple<double, 3> GetLowerLeft(int index);


  virtual vtkTuple<double, 3> GetLowerRight(int index);


  virtual vtkTuple<double, 3> GetUpperRight(int index);


  virtual bool GetStereoEnabled(int index);


  virtual int GetStereoType(int index);


  int GetViewerId(int index);


  int GetNumberOfViewers();


  int GetId(int viewerIndex);


  double GetEyeSeparation(int viewerIndex);

protected:
  vtkPVCAVEConfigInformation();
  ~vtkPVCAVEConfigInformation() override;

private:
  class vtkInternals;
  std::unique_ptr<vtkInternals> Internal;

  // When adding information, we need to know the rank where the stereo
  // configs were queried. This is because stereo can now be configured
  // via pvx or cli, and while all ranks know all other ranks pvx config
  // state, only each rank knows the cli arguments it was provided.
  int GetRank();

  vtkPVCAVEConfigInformation(const vtkPVCAVEConfigInformation&) = delete;
  void operator=(const vtkPVCAVEConfigInformation&) = delete;
};

#endif