vtkScivisView.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 vtkScivisView_h
#define vtkScivisView_h
 
#include "vtkCommand.h" // For the event id
#include "vtkNew.h"     // For ivars
#include "vtkObject.h"
#include "vtkSmartPointer.h"      // For ivars
#include "vtkViewsScivisModule.h" // For export macro
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkInteractorObserver;
class vtkInteractorStyleRubberBand3D;
class vtkInteractorStyleTrackballCamera;
class vtkLight;
class vtkCamera;
class vtkLightKit;
class vtkLookupTableManager;
class vtkOrientationMarkerWidget;
class vtkScivisSelector;
class vtkScivisExporter;
class vtkRenderWindow;
class vtkRenderWindowInteractor;
class vtkRenderer;
class vtkScivisRepresentation;
class vtkScivisScalarBars;
 
class VTKVIEWSSCIVIS_EXPORT VTK_MARSHALAUTO vtkScivisView : public vtkObject
{
public:
  static vtkScivisView* New();
  vtkTypeMacro(vtkScivisView, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;


  void AddRepresentation(vtkScivisRepresentation* rep);
  void SetRepresentation(vtkScivisRepresentation* rep);
  void RemoveRepresentation(vtkScivisRepresentation* rep);
  void RemoveAllRepresentations();
  int GetNumberOfRepresentations();
  vtkScivisRepresentation* GetRepresentation(int index = 0);
  bool IsRepresentationPresent(vtkScivisRepresentation* rep);


  vtkRenderer* GetRenderer();
  void SetRenderer(vtkRenderer* renderer);
  vtkRenderWindow* GetRenderWindow();
  void SetRenderWindow(vtkRenderWindow* window);
  vtkRenderWindowInteractor* GetInteractor();
  void SetInteractor(vtkRenderWindowInteractor* interactor);


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


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


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

  vtkOrientationMarkerWidget* GetOrientationMarkerWidget();


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

  vtkLightKit* GetLightKit();


  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();


  void SetLookupTableManager(vtkLookupTableManager* manager);
  vtkLookupTableManager* GetLookupTableManager();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  vtkScivisScalarBars* GetScalarBars();

  vtkScivisSelector* GetSelector();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  vtkScivisExporter* GetExporter();

  vtkCamera* GetCamera();


  void ViewPositiveX();
  void ViewNegativeX();
  void ViewPositiveY();
  void ViewNegativeY();
  void ViewPositiveZ();
  void ViewNegativeZ();
  void ViewIsometric();

  void SetViewDirection(double look[3], double up[3]);
  void SetViewDirection(
    double lookX, double lookY, double lookZ, double upX, double upY, double upZ);

  enum
  {
    BoundsChangedEvent = vtkCommand::UserEvent + 1
  };

  bool GetSceneBounds(double bounds[6]);
 
  void Start();

  virtual void Render();

  virtual void ResetCamera();

  virtual void Update();
 
protected:
  vtkScivisView();
  ~vtkScivisView() override;

  virtual void PrepareForRendering();

  vtkCommand* GetObserver();

  virtual void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData);


  virtual void AddRepresentationInternal(vtkScivisRepresentation* vtkNotUsed(rep)) {}
  virtual void RemoveRepresentationInternal(vtkScivisRepresentation* vtkNotUsed(rep)) {}
 
  vtkSmartPointer<vtkRenderer> Renderer;
  vtkSmartPointer<vtkRenderWindow> RenderWindow;
 
private:
  vtkScivisView(const vtkScivisView&) = delete;
  void operator=(const vtkScivisView&) = delete;
 
  class Command;
  friend class Command;
  Command* Observer;
 
  class Internals;
  Internals* Implementation;
 
  vtkNew<vtkOrientationMarkerWidget> OrientationMarkerWidget;
  vtkNew<vtkLightKit> LightKit;
  vtkSmartPointer<vtkLookupTableManager> LookupTableManager;
  vtkNew<vtkScivisScalarBars> ScalarBars;
 
  // The scene bounds last reported, so that the event fires on a change
  // rather than on every render.
  double SceneBounds[6];
  bool HasSceneBounds;
  // The headlight that lights the scene while the light kit is off.  Owning one
  // is what keeps vtkRenderer from inventing its own -- see the constructor.
  vtkNew<vtkLight> DefaultLight;
  vtkNew<vtkScivisSelector> Selector;
  vtkNew<vtkScivisExporter> Exporter;
 
  // 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;
};
 
VTK_ABI_NAMESPACE_END
#endif