vtkWindow.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkWindow.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkWindow_h
#define vtkWindow_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"

class vtkUnsignedCharArray;

class VTKCOMMONCORE_EXPORT vtkWindow : public vtkObject
{
public:
  vtkTypeMacro(vtkWindow,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetDisplayId(void *) = 0;
  virtual void SetWindowId(void *)  = 0;
  virtual void SetParentId(void *)  = 0;
  virtual void *GetGenericDisplayId() = 0;
  virtual void *GetGenericWindowId()  = 0;
  virtual void *GetGenericParentId()  = 0;
  virtual void *GetGenericContext()   = 0;
  virtual void *GetGenericDrawable()  = 0;
  virtual void SetWindowInfo(const char *) = 0;
  virtual void SetParentInfo(const char *) = 0;


  virtual int *GetPosition() VTK_SIZEHINT(2);
  virtual void SetPosition(int,int);
  virtual void SetPosition(int a[2]);


  virtual int *GetSize() VTK_SIZEHINT(2);
  virtual void SetSize(int,int);
  virtual void SetSize(int a[2]);

  int *GetActualSize() VTK_SIZEHINT(2);

  virtual int     *GetScreenSize() VTK_SIZEHINT(2) = 0;


  vtkSetMacro(Mapped,vtkTypeBool);
  vtkGetMacro(Mapped,vtkTypeBool);
  vtkBooleanMacro(Mapped,vtkTypeBool);


  vtkSetMacro(Erase,vtkTypeBool);
  vtkGetMacro(Erase,vtkTypeBool);
  vtkBooleanMacro(Erase,vtkTypeBool);


  vtkSetMacro(DoubleBuffer,vtkTypeBool);
  vtkGetMacro(DoubleBuffer,vtkTypeBool);
  vtkBooleanMacro(DoubleBuffer,vtkTypeBool);


  vtkGetStringMacro(WindowName);
  vtkSetStringMacro(WindowName);

  virtual void Render() = 0;


  virtual unsigned char *GetPixelData(int x, int y, int x2, int y2,
                                      int front, int right=0) = 0;
  virtual int GetPixelData(int x, int y, int x2, int y2, int front,
                           vtkUnsignedCharArray *data, int right=0) = 0;


  vtkGetMacro(DPI,int);
  vtkSetClampMacro(DPI,int,1,VTK_INT_MAX);

  virtual bool DetectDPI() { return false; }


  vtkSetMacro(OffScreenRendering,vtkTypeBool);
  vtkGetMacro(OffScreenRendering,vtkTypeBool);
  vtkBooleanMacro(OffScreenRendering,vtkTypeBool);

  virtual void MakeCurrent() {}


  vtkSetVector2Macro(TileScale,int);
  vtkGetVector2Macro(TileScale,int);
  void SetTileScale(int s) {this->SetTileScale(s,s);}
  vtkSetVector4Macro(TileViewport,double);
  vtkGetVector4Macro(TileViewport,double);

protected:
  vtkTypeBool OffScreenRendering;
  vtkWindow();
  ~vtkWindow() override;

  char *WindowName;
  int Size[2];
  int Position[2];
  vtkTypeBool Mapped;
  vtkTypeBool Erase;
  vtkTypeBool DoubleBuffer;
  int DPI;

  double TileViewport[4];
  int    TileSize[2];
  int    TileScale[2];

private:
  vtkWindow(const vtkWindow&) = delete;
  void operator=(const vtkWindow&) = delete;
};

#endif