vtkContextArea.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 vtkContextArea_h
#define vtkContextArea_h

#include "vtkAbstractContextItem.h"

#include "vtkAxis.h"             // For enums
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkNew.h"              // For vtkNew
#include "vtkRect.h"             // For vtkRect/vtkVector/vtkTuple
#include "vtkWrappingHints.h"    // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkContextClip;
class vtkContextTransform;
class vtkPlotGrid;

class VTKCHARTSCORE_EXPORT VTK_MARSHALAUTO vtkContextArea : public vtkAbstractContextItem
{
public:
  typedef vtkTuple<int, 4> Margins;
  vtkTypeMacro(vtkContextArea, vtkAbstractContextItem);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkContextArea* New();

  vtkAxis* GetAxis(vtkAxis::Location location);

  vtkAbstractContextItem* GetDrawAreaItem();

  bool Paint(vtkContext2D* painter) override;


  vtkGetMacro(Geometry, vtkRecti);
  vtkSetMacro(Geometry, vtkRecti);


  vtkGetMacro(DrawAreaBounds, vtkRectd);
  vtkSetMacro(DrawAreaBounds, vtkRectd);

  enum DrawAreaResizeBehaviorType
  {
    DARB_Expand,
    DARB_FixedAspect,
    DARB_FixedRect,
    DARB_FixedMargins
  };


  vtkGetMacro(DrawAreaResizeBehavior, DrawAreaResizeBehaviorType);
  vtkSetMacro(DrawAreaResizeBehavior, DrawAreaResizeBehaviorType);


  vtkGetMacro(FixedAspect, float)
  virtual void SetFixedAspect(float aspect);


  vtkGetMacro(FixedRect, vtkRecti);
  virtual void SetFixedRect(vtkRecti rect);
  virtual void SetFixedRect(int x, int y, int width, int height);


  virtual const Margins& GetFixedMargins() { return this->FixedMargins; }
  virtual void GetFixedMarginsArray(int margins[4]);
  virtual const int* GetFixedMarginsArray();
  virtual void SetFixedMargins(Margins margins);
  virtual void SetFixedMargins(int margins[4]);
  virtual void SetFixedMargins(int left, int right, int bottom, int top);


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


  virtual void SetShowGrid(bool show);
  virtual bool GetShowGrid();
  virtual void ShowGridOn() { this->SetShowGrid(true); }
  virtual void ShowGridOff() { this->SetShowGrid(false); }

protected:
  vtkContextArea();
  ~vtkContextArea() override;

  void LayoutAxes(vtkContext2D* painter);
  virtual void SetAxisRange(vtkRectd const& data);
  virtual void ComputeViewTransform();

  vtkRecti ComputeDrawAreaGeometry(vtkContext2D* painter);


  vtkRecti ComputeExpandedDrawAreaGeometry(vtkContext2D* painter);
  vtkRecti ComputeFixedAspectDrawAreaGeometry(vtkContext2D* painter);
  vtkRecti ComputeFixedRectDrawAreaGeometry(vtkContext2D* painter);
  vtkRecti ComputeFixedMarginsDrawAreaGeometry(vtkContext2D* painter);

  void UpdateDrawArea();

  vtkTuple<vtkAxis*, 4> Axes;

  vtkNew<vtkPlotGrid> Grid;

  vtkNew<vtkContextClip> Clip;

  vtkNew<vtkContextTransform> Transform;

  vtkRecti Geometry;

  vtkRectd DrawAreaBounds;

  vtkRecti DrawAreaGeometry;

  DrawAreaResizeBehaviorType DrawAreaResizeBehavior;

  float FixedAspect;

  vtkRecti FixedRect;

  Margins FixedMargins;

  bool FillViewport;

  virtual void InitializeDrawArea();

  // Smart pointers for axis lifetime management. See this->Axes.
  vtkNew<vtkAxis> TopAxis;
  vtkNew<vtkAxis> BottomAxis;
  vtkNew<vtkAxis> LeftAxis;
  vtkNew<vtkAxis> RightAxis;

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

VTK_ABI_NAMESPACE_END
#endif // vtkContextArea_h