vtkStandardRenderView.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef vtkStandardRenderView_h
#define vtkStandardRenderView_h
 
#include "vtkNew.h" // For ivars
#include "vtkRenderViewBase.h"
#include "vtkSmartPointer.h"         // For ivars
#include "vtkViewsRenderingModule.h" // For export macro
#include "vtkWrappingHints.h"        // For VTK_MARSHALEXCLUDE
 
VTK_ABI_NAMESPACE_BEGIN
class vtkHardwareSelector;
class vtkInteractorObserver;
class vtkInteractorStyleRubberBand3D;
class vtkInteractorStyleTrackballCamera;
class vtkLight;
class vtkLightKit;
class vtkOrientationMarkerWidget;
class vtkSelection;
 
class VTKVIEWSRENDERING_EXPORT vtkStandardRenderView : public vtkRenderViewBase
{
public:
  static vtkStandardRenderView* New();
  vtkTypeMacro(vtkStandardRenderView, vtkRenderViewBase);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;


  void SetBackground(double r, double g, double b);
  double* GetBackground() VTK_SIZEHINT(3);
  void SetBackground2(double r, double g, double b);
  double* GetBackground2() VTK_SIZEHINT(3);
  void SetGradientBackground(bool val);
  bool GetGradientBackground();


  void SetWindowSize(int w, int h);
  int* GetWindowSize() VTK_SIZEHINT(2);
  void SetWindowTitle(const char* title);
  const char* GetWindowTitle();


  void SetOrientationAxesVisibility(bool val);
  bool GetOrientationAxesVisibility();


  void SetOrientationAxesInteractive(bool val);
  bool GetOrientationAxesInteractive();

  vtkOrientationMarkerWidget* GetOrientationMarkerWidget();


  void SetUseLightKit(bool val);
  bool GetUseLightKit();


  void SetKeyLightIntensity(double val);
  double GetKeyLightIntensity();
  void SetKeyToFillRatio(double val);
  double GetKeyToFillRatio();
  void SetKeyToHeadRatio(double val);
  double GetKeyToHeadRatio();
  void SetKeyToBackRatio(double val);
  double GetKeyToBackRatio();
  void SetKeyLightWarmth(double val);
  double GetKeyLightWarmth();
  void SetFillLightWarmth(double val);
  double GetFillLightWarmth();
  void SetHeadLightWarmth(double val);
  double GetHeadLightWarmth();
  void SetBackLightWarmth(double val);
  double GetBackLightWarmth();
  void SetKeyLightAngle(double elevation, double azimuth);
  double* GetKeyLightAngle() VTK_SIZEHINT(2);
  void SetFillLightAngle(double elevation, double azimuth);
  double* GetFillLightAngle() VTK_SIZEHINT(2);
  void SetBackLightAngle(double elevation, double azimuth);
  double* GetBackLightAngle() VTK_SIZEHINT(2);
  void SetMaintainLuminance(bool val);
  bool GetMaintainLuminance();

  vtkLightKit* GetLightKit();


  void AddLight(vtkLight* light);
  void RemoveLight(vtkLight* light);
  void RemoveAllLights();


  enum
  {
    INTERACTION_MODE_3D = 0,
    INTERACTION_MODE_SELECTION = 1,
    INTERACTION_MODE_CUSTOM = 2
  };
  void SetInteractionMode(int mode);
  int GetInteractionMode();
  void SetInteractionModeTo3D() { this->SetInteractionMode(INTERACTION_MODE_3D); }
  void SetInteractionModeToSelection() { this->SetInteractionMode(INTERACTION_MODE_SELECTION); }


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetInteractorStyle(vtkInteractorObserver* style);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  vtkInteractorObserver* GetInteractorStyle();


  enum
  {
    SELECTION_MODE_SURFACE = 0,
    SELECTION_MODE_FRUSTUM = 1
  };
  void SetSelectionMode(int mode);
  int GetSelectionMode();
  void SetSelectionModeToSurface() { this->SetSelectionMode(SELECTION_MODE_SURFACE); }
  void SetSelectionModeToFrustum() { this->SetSelectionMode(SELECTION_MODE_FRUSTUM); }


  void SetSelectionFieldAssociation(int assoc);
  int GetSelectionFieldAssociation();
  void SelectCells();
  void SelectPoints();

  void SelectRegion(int x0, int y0, int x1, int y1, bool extend = false);

  void ClearSelection();

  vtkSelection* GetCurrentSelection();

  void Start();

  void Render() override;
 
protected:
  vtkStandardRenderView();
  ~vtkStandardRenderView() override;
 
  void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
 
private:
  vtkStandardRenderView(const vtkStandardRenderView&) = delete;
  void operator=(const vtkStandardRenderView&) = delete;

  void GenerateSelection(const int region[4], vtkSelection* sel);
 
  vtkNew<vtkOrientationMarkerWidget> OrientationWidget;
  vtkNew<vtkLightKit> LightKit;
  vtkNew<vtkHardwareSelector> HardwareSelector;
  vtkSmartPointer<vtkSelection> CurrentSelection;
 
  // One instance of each built-in style, so switching modes preserves whatever
  // the application configured on them.
  vtkSmartPointer<vtkInteractorStyleTrackballCamera> TrackballStyle;
  vtkSmartPointer<vtkInteractorStyleRubberBand3D> RubberBandStyle;
  vtkSmartPointer<vtkInteractorObserver> CustomStyle;
  bool UseLightKitFlag;
  bool FirstRender;
  int InteractionMode;
  int SelectionMode;
  int FieldAssociation;
};
 
VTK_ABI_NAMESPACE_END
#endif