vtkDisplayConfiguration.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkRemotingCoreModule.h" // for exports
#include "vtkTuple.h"              // for vtkTuple
#include <memory>                  // for std::unique_ptr
#include <string>                  // for std::string

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

  vtkGetMacro(ShowBorders, bool);

  vtkGetMacro(FullScreen, bool);

  vtkGetMacro(EyeSeparation, double);

  vtkGetMacro(UseOffAxisProjection, bool);

  int GetNumberOfDisplays() const;


  const char* GetName(int index) const;


  const char* GetEnvironment(int index) const;


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


  vtkTuple<double, 3> GetLowerLeft(int index) const;
  vtkTuple<double, 3> GetLowerRight(int index) const;
  vtkTuple<double, 3> GetUpperRight(int index) const;


  bool GetHasCorners(int index) const;


  bool GetCoverable(int index) const;


  bool GetShow2DOverlays(int index) const;


  int GetViewerId(int index) const;


  int GetStereoType(int index) const;


  int GetNumberOfViewers() const;


  int GetId(int viewerIndex) const;


  double GetEyeSeparation(int viewerIndex) const;

  bool LoadPVX(const char* fname);


  static int ParseStereoType(const std::string& value);


  static const char* GetStereoTypeAsString(int stereoType);

protected:
  vtkDisplayConfiguration();
  ~vtkDisplayConfiguration() override;

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

  bool ShowBorders = false;
  bool Coverable = false;
  bool FullScreen = false;
  double EyeSeparation = 0.0;
  bool UseOffAxisProjection = true;

  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
};

#endif