vtkContextScene.h

Go to the documentation of this file.

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

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

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

#ifndef vtkContextScene_h
#define vtkContextScene_h

#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWeakPointer.h" // Needed for weak pointer to the window.
#include "vtkVector.h" // For vtkVector return type.

class vtkContext2D;
class vtkAbstractContextItem;
class vtkTransform2D;
class vtkContextMouseEvent;
class vtkContextKeyEvent;
class vtkContextScenePrivate;
class vtkContextInteractorStyle;

class vtkAnnotationLink;

class vtkRenderer;
class vtkAbstractContextBufferId;

class VTKRENDERINGCONTEXT2D_EXPORT vtkContextScene : public vtkObject
{
public:
  vtkTypeMacro(vtkContextScene, vtkObject);
  void PrintSelf(ostream &os, vtkIndent indent) override;

  static vtkContextScene * New();

  virtual bool Paint(vtkContext2D *painter);

  unsigned int AddItem(vtkAbstractContextItem* item);

  bool RemoveItem(vtkAbstractContextItem* item);

  bool RemoveItem(unsigned int index);

  vtkAbstractContextItem* GetItem(unsigned int index);

  unsigned int GetNumberOfItems();

  void ClearItems();

  virtual void SetAnnotationLink(vtkAnnotationLink *link);


  vtkGetObjectMacro(AnnotationLink, vtkAnnotationLink);


  vtkSetVector2Macro(Geometry, int);


  vtkGetVector2Macro(Geometry, int);


  vtkSetMacro(UseBufferId, bool);


  vtkGetMacro(UseBufferId, bool);

  virtual int GetViewWidth();

  virtual int GetViewHeight();

  int GetSceneWidth();

  int GetSceneHeight();


  vtkSetMacro(ScaleTiles, bool);
  vtkGetMacro(ScaleTiles, bool);
  vtkBooleanMacro(ScaleTiles, bool);

  vtkVector2i GetLogicalTileScale();


  virtual void SetRenderer(vtkRenderer *renderer);
  virtual vtkRenderer* GetRenderer();


  void SetDirty(bool isDirty);
  bool GetDirty()const;

  void ReleaseGraphicsResources();

  vtkWeakPointer<vtkContext2D> GetLastPainter();

  vtkAbstractContextBufferId *GetBufferId();

  virtual void SetTransform(vtkTransform2D *transform);

  vtkTransform2D* GetTransform();

  bool HasTransform() { return this->Transform != nullptr; }

  enum {
    SELECTION_NONE = 0,
    SELECTION_DEFAULT,
    SELECTION_ADDITION,
    SELECTION_SUBTRACTION,
    SELECTION_TOGGLE
  };

protected:
  vtkContextScene();
  ~vtkContextScene() override;

  virtual bool ProcessSelectionEvent(unsigned int rect[5]);

  virtual bool MouseMoveEvent(const vtkContextMouseEvent &event);

  virtual bool ButtonPressEvent(const vtkContextMouseEvent &event);

  virtual bool ButtonReleaseEvent(const vtkContextMouseEvent &event);

  virtual bool DoubleClickEvent(const vtkContextMouseEvent &event);

  virtual bool MouseWheelEvent(int delta, const vtkContextMouseEvent &event);

  virtual bool KeyPressEvent(const vtkContextKeyEvent& keyEvent);

  virtual bool KeyReleaseEvent(const vtkContextKeyEvent& keyEvent);

  virtual void PaintIds();

  void TestBufferIdSupport();

  vtkIdType GetPickedItem(int x, int y);

  vtkAbstractContextItem* GetPickedItem();

  void UpdateBufferId();

  vtkAnnotationLink *AnnotationLink;

  // Store the chart dimensions - width, height of scene in pixels
  int Geometry[2];

  friend class vtkContextInteractorStyle;


  class Private;
  Private *Storage;

  vtkContextScenePrivate* Children;

  vtkWeakPointer<vtkContext2D> LastPainter;

  vtkWeakPointer<vtkRenderer> Renderer;

  vtkAbstractContextBufferId *BufferId;
  bool BufferIdDirty;

  bool UseBufferId;

  bool BufferIdSupportTested;
  bool BufferIdSupported;

  bool ScaleTiles;

  vtkTransform2D* Transform;

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

  typedef bool (vtkAbstractContextItem::* MouseEvents)(const vtkContextMouseEvent&);
  bool ProcessItem(vtkAbstractContextItem* cur,
                   const vtkContextMouseEvent& event,
                   MouseEvents eventPtr);
  void EventCopy(const vtkContextMouseEvent &event);

};

#endif //vtkContextScene_h