vtkPVView.h

Go to the documentation of this file.

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

#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkView.h"
#include "vtkWeakPointer.h" // for vtkWeakPointer

class vtkBoundingBox;
class vtkInformation;
class vtkInformationObjectBaseKey;
class vtkInformationRequestKey;
class vtkInformationVector;
class vtkPVDataDeliveryManager;
class vtkPVDataRepresentation;
class vtkPVSession;
class vtkRenderWindow;
class vtkViewLayout;

class VTKREMOTINGVIEWS_EXPORT vtkPVView : public vtkView
{
public:
  vtkTypeMacro(vtkPVView, vtkView);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static void SetEnableStreaming(bool);
  static bool GetEnableStreaming();


  virtual void SetPosition(int, int);
  vtkGetVector2Macro(Position, int);


  virtual void SetSize(int, int);
  vtkGetVector2Macro(Size, int);

  virtual void SetPPI(int);
  vtkGetMacro(PPI, int);

  virtual void StillRender() = 0;

  virtual void InteractiveRender() = 0;


  virtual void SetViewTime(double value);
  vtkGetMacro(ViewTime, double);

  vtkGetMacro(ViewTimeValid, bool);


  vtkSetMacro(CacheKey, double);
  vtkGetMacro(CacheKey, double);


  vtkSetMacro(UseCache, bool);
  vtkGetMacro(UseCache, bool);


  virtual void PrepareForScreenshot();
  virtual void CleanupAfterScreenshot();

  static vtkInformationObjectBaseKey* VIEW();

  static vtkInformationRequestKey* REQUEST_UPDATE();

  static vtkInformationRequestKey* REQUEST_UPDATE_LOD();

  static vtkInformationRequestKey* REQUEST_RENDER();

  void Update() override;

  bool InTileDisplayMode();

  bool InCaveDisplayMode();

  bool GetLocalProcessSupportsInteraction();

  vtkRenderWindow* GetRenderWindow() { return this->RenderWindow; }


  static void SetUseGenericOpenGLRenderWindow(bool val);
  static bool GetUseGenericOpenGLRenderWindow();


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


  virtual void SetLogName(const std::string& name) { this->LogName = name; }
  const std::string& GetLogName() const { return this->LogName; }

  virtual void ScaleRendererViewports(const double viewport[4]);

  vtkMTimeType GetUpdateTimeStamp() { return this->UpdateTimeStamp; }


  void SetDeliveryManager(vtkPVDataDeliveryManager*);
  vtkGetObjectMacro(DeliveryManager, vtkPVDataDeliveryManager);

  static void SetPiece(vtkInformation* info, vtkPVDataRepresentation* repr, vtkDataObject* data,
    unsigned long trueSize = 0, int port = 0);
  static vtkDataObject* GetPiece(vtkInformation* info, vtkPVDataRepresentation* repr, int port = 0);
  static vtkDataObject* GetDeliveredPiece(
    vtkInformation* info, vtkPVDataRepresentation* repr, int port = 0);

  static void SetPieceLOD(vtkInformation* info, vtkPVDataRepresentation* repr, vtkDataObject* data,
    unsigned long trueSize = 0, int port = 0);
  static vtkDataObject* GetPieceLOD(
    vtkInformation* info, vtkPVDataRepresentation* repr, int port = 0);
  static vtkDataObject* GetDeliveredPieceLOD(
    vtkInformation* info, vtkPVDataRepresentation* repr, int port = 0);

  virtual void Deliver(int use_lod, unsigned int size, unsigned int* representation_ids);

  virtual bool IsCached(vtkPVDataRepresentation*);

  virtual void ClearCache(vtkPVDataRepresentation*);

protected:
  vtkPVView(bool create_render_window = true);
  ~vtkPVView() override;

  vtkRenderWindow* NewRenderWindow();

  void SetRenderWindow(vtkRenderWindow*);

  void AllReduce(const vtkBoundingBox& source, vtkBoundingBox& dest);

  void AllReduce(
    vtkTypeUInt64 source, vtkTypeUInt64& dest, int operation, bool skip_data_server = false);


  void AddRepresentationInternal(vtkDataRepresentation* rep) override;
  void RemoveRepresentationInternal(vtkDataRepresentation* rep) override;


  vtkInformation* RequestInformation;
  vtkInformationVector* ReplyInformationVector;


  int CallProcessViewRequest(
    vtkInformationRequestKey* passType, vtkInformation* request, vtkInformationVector* reply);

  vtkPVSession* GetSession();

  vtkGetMacro(InCaptureScreenshot, bool);

  double ViewTime;
  double CacheKey;
  bool UseCache;

  int Size[2];
  int Position[2];
  int PPI;

  vtkTimeStamp UpdateTimeStamp;

  static vtkPVDataDeliveryManager* GetDeliveryManager(vtkInformation* info);

  void SynchronizeRepresentationTemporalPipelineStates();

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

  vtkRenderWindow* RenderWindow;
  bool ViewTimeValid;
  static bool EnableStreaming;
  vtkWeakPointer<vtkPVSession> Session;
  std::string LogName;

  static bool UseGenericOpenGLRenderWindow;

  bool InCaptureScreenshot;

  vtkPVDataDeliveryManager* DeliveryManager;
};

#endif