vtkSMRenderViewProxy.h

Go to the documentation of this file.

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

#include "vtkNew.h"                 // needed for vtkInteractorObserver.
#include "vtkParaViewDeprecation.h" // For PARAVIEW_DEPRECATED_IN_6_2_0
#include "vtkRemotingViewsModule.h" // needed for exports
#include "vtkSMViewProxy.h"         // for base class
#include "vtkTuple.h"               // for vtkTuple

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

class vtkCamera;
class vtkCollection;
class vtkFloatArray;
class vtkIntArray;
class vtkRenderer;
class vtkRenderWindow;
class vtkSMViewProxyInteractorHelper;

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


  bool SelectSurfaceCells(const int region[4], vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections = false,
    int modifier = /* replace */ 0, bool select_blocks = false, const char* arrayName = nullptr);
  bool SelectSurfacePoints(const int region[4], vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections = false,
    int modifier = /* replace */ 0, bool select_blocks = false, const char* arrayName = nullptr);
  bool SelectFrustumCells(const int region[4], vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections = false);
  bool SelectFrustumPoints(const int region[4], vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections = false);
  bool SelectPolygonPoints(vtkIntArray* polygon, vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections = false, int modifier = 0,
    bool selectBlocks = false);
  bool SelectPolygonCells(vtkIntArray* polygon, vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections = false, int modifier = 0,
    bool selectBlocks = false);


  bool SelectPointsByArrayValue(vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, vtkSMRepresentationProxy* source, const char* arrayName,
    vtkIdType idValue, bool multiple_selections = false, int modifier = 0,
    bool selectBlocks = false);
  bool SelectCellsByArrayValue(vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, vtkSMRepresentationProxy* source, const char* arrayName,
    vtkIdType idValue, bool multiple_selections = false, int modifier = 0,
    bool selectBlocks = false);


  bool ComputeVisibleScalarRange(const int region[4], int fieldAssociation, const char* scalarName,
    int component, double range[]);
  bool ComputeVisibleScalarRange(
    int fieldAssociation, const char* scalarName, int component, double range[]);

  vtkSMRepresentationProxy* Pick(int x, int y);

  vtkSMRepresentationProxy* PickBlock(int x, int y, unsigned int& flatIndex, int& rank);

  bool ConvertDisplayToPointOnSurface(const int display_position[2], double world_position[3],
    double world_normal[3], bool snapOnMeshPoint = false);

  virtual bool IsSelectionAvailable();

  void SynchronizeGeometryBounds();


  void ResetCamera(bool closest = false, double offsetRatio = 0.9);
  void ResetCamera(double bounds[6], bool closest = false, double offsetRatio = 0.9);
  void ResetCamera(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax,
    bool closest = false, double offsetRatio = 0.9);

  virtual void ZoomTo(vtkSMProxy* representation, bool closest = false, double offsetRatio = 0.9);


  virtual const char* IsSelectVisibleCellsAvailable();
  virtual const char* IsSelectVisiblePointsAvailable();

  void SetupInteractor(vtkRenderWindowInteractor* iren) override;

  vtkRenderWindowInteractor* GetInteractor() override;

  vtkRenderer* GetRenderer();

  void UpdateVTKObjects() override;

  enum class CameraAdjustmentType : int
  {
    Roll = 0,
    Elevation,
    Azimuth,
    Zoom
  };

  vtkCamera* GetActiveCamera();
  void AdjustActiveCamera(const CameraAdjustmentType&, const double&);
  void AdjustActiveCamera(const int&, const double&);
  void AdjustAzimuth(const double& value);
  void AdjustElevation(const double& value);
  void AdjustRoll(const double& value);
  void AdjustZoom(const double& value);
  void ApplyIsometricView();
  void ResetActiveCameraToDirection(const double& look_x, const double& look_y,
    const double& look_z, const double& up_x, const double& up_y, const double& up_z);
  void ResetActiveCameraToPositiveX();
  void ResetActiveCameraToNegativeX();
  void ResetActiveCameraToPositiveY();
  void ResetActiveCameraToNegativeY();
  void ResetActiveCameraToPositiveZ();
  void ResetActiveCameraToNegativeZ();

  void SynchronizeCameraProperties();

  virtual bool LastRenderWasInteractive();

  void Update() override;

  bool GetNeedsUpdate() override;

  bool StreamingUpdate(bool render_if_needed);

  const char* GetRepresentationType(vtkSMSourceProxy* producer, int outputPort) override;

  vtkRenderWindow* GetRenderWindow() override;

  vtkSMViewProxyInteractorHelper* GetInteractorHelper();

  vtkFloatArray* CaptureDepthBuffer();

  virtual const char* GetSelectionRepresentationProxyName() { return "SelectionRepresentation"; }

  virtual void CopySelectionRepresentationProperties(
    vtkSMProxy* vtkNotUsed(fromSelectionRep), vtkSMProxy* vtkNotUsed(toSelectionRep))
  {
  }

  void ComputeVisibleBounds(vtkSMProxy* representation, double* bounds);

  bool ClearSelectionCache(bool force = false);

  void SetEnableSynchronizableActors(bool);
  bool GetEnableSynchronizableActors();

  bool GetIsInCAVE();

  int GetNumberOfDisplays();

  double GetEyeSeparation();

  bool GetUseOffAxisProjection();

  bool GetShowBorders();

  bool GetFullScreen();

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

  bool GetShow2DOverlays(int index);

  bool GetHasCorners(int index);

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

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

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

  PARAVIEW_DEPRECATED_IN_6_2_0("SetResizingWindow has been removed. Simply remove the function.")
  vtkSetMacro(ResizingWindow, bool);

  const char* GetName(int index);

  int GetStereoType(int index);
  bool GetStereoEnabled(int index);

  int GetViewerId(int index);

  int GetNumberOfViewers();

  int GetId(int viewerIndex);

  double GetEyeSeparation(int viewerIndex);

protected:
  vtkSMRenderViewProxy();
  ~vtkSMRenderViewProxy() override;

  void RenderForImageCapture() override;

  void UpdateLOD();

  void MarkDirty(vtkSMProxy* modifiedProxy) override;

  bool SelectFrustumInternal(const int region[4], vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections, int fieldAssociation);
  bool SelectPolygonInternal(vtkIntArray* polygon, vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections, int fieldAssociation, int modifier,
    bool selectBlocks);

  vtkTypeUInt32 PreRender(bool interactive) override;
  void PostRender(bool interactive) override;

  bool FetchLastSelection(bool multiple_selections, vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, int modifier, bool selectBlocks);

  void CreateVTKObjects() override;

  bool IsInSelectionMode();

  bool IsSelectionCached;

  // Internal fields for the observer mechanism that is used to invalidate
  // the cache of selection when the current user became master
  unsigned long NewMasterObserverId;
  void NewMasterCallback(vtkObject* src, unsigned long event, void* data);
  // Update ANARI properties in the correct order
  void UpdateAnariProperties();

  bool NeedsUpdateLOD;

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

  bool SelectInternal(const vtkClientServerStream& cmd, vtkCollection* selectedRepresentations,
    vtkCollection* selectionSources, bool multiple_selections, int modifier = /* replace */ 0,
    bool selectBlocks = false);

  void UpdateStereoProperties();

  bool SelectByArrayValue(vtkCollection* selectedRepresentations, vtkCollection* selectionSources,
    vtkSMRepresentationProxy* repr, int fieldAssociation, const char* arrayName, vtkIdType idValue,
    bool multiple_selections, int modifier = 0, bool select_blocks = false);

  vtkNew<vtkSMViewProxyInteractorHelper> InteractorHelper;

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

  bool ResizingWindow = false;
};

#endif