vtkAbstractContextItem.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkContextItem.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 vtkAbstractContextItem_h
#define vtkAbstractContextItem_h

#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkObject.h"

class vtkContext2D;
class vtkContextMouseEvent;
class vtkContextKeyEvent;
class vtkContextScene;
class vtkContextScenePrivate;
class vtkVector2f;

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

  virtual void Update();

  virtual bool Paint(vtkContext2D *painter);

  virtual bool PaintChildren(vtkContext2D *painter);

  virtual void ReleaseGraphicsResources();

  vtkIdType AddItem(vtkAbstractContextItem* item);

  bool RemoveItem(vtkAbstractContextItem* item);

  bool RemoveItem(vtkIdType index);

  vtkAbstractContextItem* GetItem(vtkIdType index);

  vtkIdType GetItemIndex(vtkAbstractContextItem* item);

  vtkIdType GetNumberOfItems();

  void ClearItems();

  vtkIdType Raise(vtkIdType index);

  virtual vtkIdType StackAbove(vtkIdType index,
                               vtkIdType under);

  vtkIdType Lower(vtkIdType index);

  virtual vtkIdType StackUnder(vtkIdType child,
                               vtkIdType above);

  virtual bool Hit(const vtkContextMouseEvent &mouse);

  virtual vtkAbstractContextItem* GetPickedItem(const vtkContextMouseEvent &mouse);

  virtual bool MouseEnterEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseLeaveEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonPressEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseButtonReleaseEvent(const vtkContextMouseEvent &mouse);

  virtual bool MouseDoubleClickEvent(const vtkContextMouseEvent &mouse);

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

  virtual bool KeyPressEvent(const vtkContextKeyEvent &key);

  virtual bool KeyReleaseEvent(const vtkContextKeyEvent &key);

  virtual void SetScene(vtkContextScene *scene);

  vtkContextScene* GetScene()
  {
    return this->Scene;
  }

  virtual void SetParent(vtkAbstractContextItem *parent);

  vtkAbstractContextItem* GetParent()
  {
    return this->Parent;
  }

  virtual vtkVector2f MapToParent(const vtkVector2f& point);

  virtual vtkVector2f MapFromParent(const vtkVector2f& point);

  virtual vtkVector2f MapToScene(const vtkVector2f& point);

  virtual vtkVector2f MapFromScene(const vtkVector2f& point);


  vtkGetMacro(Visible, bool);


  vtkSetMacro(Visible, bool);


  vtkGetMacro(Interactive, bool);


  vtkSetMacro(Interactive, bool);

protected:
  vtkAbstractContextItem();
  ~vtkAbstractContextItem() override;

  vtkContextScene* Scene;

  vtkAbstractContextItem* Parent;

  vtkContextScenePrivate* Children;

  bool Visible;

  bool Interactive;

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

};

#endif //vtkContextItem_h