vtkAbstractContextItem.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 vtkAbstractContextItem_h
#define vtkAbstractContextItem_h

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

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

class VTKRENDERINGCONTEXT2D_EXPORT VTK_MARSHALAUTO 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();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  virtual vtkIdType AddItem(vtkAbstractContextItem* item);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  bool RemoveItem(vtkAbstractContextItem* item);

  bool RemoveItem(vtkIdType index);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL)
  virtual vtkAbstractContextItem* GetItem(vtkIdType index);

  vtkIdType GetItemIndex(vtkAbstractContextItem* item);

  vtkIdType GetNumberOfItems() VTK_FUTURE_CONST;

  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; }

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  virtual void SetParent(vtkAbstractContextItem* parent);

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


  virtual bool GetVisible()
  {
    vtkDebugMacro(<< this->GetClassName() << " (" << this << "): returning Visible of "
                  << this->Visible);
    return this->Visible;
  }



  vtkSetMacro(Visible, bool);


  vtkGetMacro(Interactive, bool);


  vtkSetMacro(Interactive, bool);

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

  virtual void ReleaseGraphicsCache();

  vtkContextScene* Scene;

  vtkAbstractContextItem* Parent;

  vtkContextScenePrivate* Children;

  bool Visible;

  bool Interactive;

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

VTK_ABI_NAMESPACE_END
#endif // vtkContextItem_h