vtkRenderView.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkRenderView.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.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkRenderView_h
#define vtkRenderView_h

#include "vtkRenderViewBase.h"
#include "vtkSmartPointer.h"       // For SP ivars
#include "vtkViewsInfovisModule.h" // For export macro

class vtkAbstractTransform;
class vtkActor2D;
class vtkAlgorithmOutput;
class vtkArrayCalculator;
class vtkBalloonRepresentation;
class vtkDynamic2DLabelMapper;
class vtkHardwareSelector;
class vtkHoverWidget;
class vtkInteractorObserver;
class vtkLabelPlacementMapper;
class vtkPolyDataMapper2D;
class vtkSelection;
class vtkTextProperty;
class vtkTexture;
class vtkTexturedActor2D;
class vtkTransformCoordinateSystems;

class VTKVIEWSINFOVIS_EXPORT vtkRenderView : public vtkRenderViewBase
{
public:
  static vtkRenderView* New();
  vtkTypeMacro(vtkRenderView, vtkRenderViewBase);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetInteractor(vtkRenderWindowInteractor* interactor) override;

  virtual void SetInteractorStyle(vtkInteractorObserver* style);

  virtual vtkInteractorObserver* GetInteractorStyle();

  void SetRenderWindow(vtkRenderWindow* win) override;

  enum
  {
    INTERACTION_MODE_2D,
    INTERACTION_MODE_3D,
    INTERACTION_MODE_UNKNOWN
  };

  void SetInteractionMode(int mode);
  vtkGetMacro(InteractionMode, int);

  virtual void SetInteractionModeTo2D() { this->SetInteractionMode(INTERACTION_MODE_2D); }
  virtual void SetInteractionModeTo3D() { this->SetInteractionMode(INTERACTION_MODE_3D); }

  void Render() override;

  void ApplyViewTheme(vtkViewTheme* theme) override;


  virtual void SetTransform(vtkAbstractTransform* transform);
  vtkGetObjectMacro(Transform, vtkAbstractTransform);


  virtual void SetDisplayHoverText(bool b);
  vtkGetMacro(DisplayHoverText, bool);
  vtkBooleanMacro(DisplayHoverText, bool);

  enum
  {
    SURFACE = 0,
    FRUSTUM = 1
  };


  vtkSetClampMacro(SelectionMode, int, 0, 1);
  vtkGetMacro(SelectionMode, int);
  void SetSelectionModeToSurface() { this->SetSelectionMode(SURFACE); }
  void SetSelectionModeToFrustum() { this->SetSelectionMode(FRUSTUM); }

  virtual void AddLabels(vtkAlgorithmOutput* conn);

  virtual void RemoveLabels(vtkAlgorithmOutput* conn);


  virtual void SetIconTexture(vtkTexture* texture);
  vtkGetObjectMacro(IconTexture, vtkTexture);


  vtkSetVector2Macro(IconSize, int);
  vtkGetVector2Macro(IconSize, int);


  vtkSetVector2Macro(DisplaySize, int);
  int* GetDisplaySize();
  void GetDisplaySize(int& dsx, int& dsy);

  enum
  {
    NO_OVERLAP,
    ALL
  };


  virtual void SetLabelPlacementMode(int mode);
  virtual int GetLabelPlacementMode();
  virtual void SetLabelPlacementModeToNoOverlap() { this->SetLabelPlacementMode(NO_OVERLAP); }
  virtual void SetLabelPlacementModeToAll() { this->SetLabelPlacementMode(ALL); }

  enum
  {
    FREETYPE,
    QT
  };


  virtual void SetLabelRenderMode(int mode);
  virtual int GetLabelRenderMode();
  virtual void SetLabelRenderModeToFreetype() { this->SetLabelRenderMode(FREETYPE); }
  virtual void SetLabelRenderModeToQt() { this->SetLabelRenderMode(QT); }


  void SetRenderOnMouseMove(bool b);
  vtkGetMacro(RenderOnMouseMove, bool);
  vtkBooleanMacro(RenderOnMouseMove, bool);

protected:
  vtkRenderView();
  ~vtkRenderView() override;

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

  virtual void GenerateSelection(void* callData, vtkSelection* selection);

  void PrepareForRendering() override;

  virtual void UpdateHoverText();

  virtual void UpdateHoverWidgetState();

  void UpdatePickRender();

  int SelectionMode;
  int LabelRenderMode;
  bool DisplayHoverText;
  bool Interacting;
  bool InHoverTextRender;
  bool InPickRender;
  bool PickRenderNeedsUpdate;

  vtkAbstractTransform* Transform;
  vtkTexture* IconTexture;
  int IconSize[2];
  int DisplaySize[2];

  int InteractionMode;
  bool RenderOnMouseMove;

  vtkSmartPointer<vtkRenderer> LabelRenderer;
  vtkSmartPointer<vtkBalloonRepresentation> Balloon;
  vtkSmartPointer<vtkLabelPlacementMapper> LabelPlacementMapper;
  vtkSmartPointer<vtkTexturedActor2D> LabelActor;
  vtkSmartPointer<vtkHoverWidget> HoverWidget;
  vtkSmartPointer<vtkHardwareSelector> Selector;

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

#endif