vtkRect.h

Go to the documentation of this file.

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

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

#include "vtkVector.h"

#include "vtkMath.h" // for Min, Max

template<typename T>
class vtkRect : public vtkVector<T, 4>
{
public:
  vtkRect()
  {
  }

  vtkRect(const T& x, const T& y, const T& width, const T& height)
  {
    this->Data[0] = x;
    this->Data[1] = y;
    this->Data[2] = width;
    this->Data[3] = height;
  }

  explicit vtkRect(const T* init) : vtkVector<T, 4>(init) { }


  void Set(const T& x, const T& y, const T& width, const T& height)
  {
    this->Data[0] = x;
    this->Data[1] = y;
    this->Data[2] = width;
    this->Data[3] = height;
  }

  void SetX(const T& x) { this->Data[0] = x; }

  const T& GetX() const { return this->Data[0]; }

  void SetY(const T& y) { this->Data[1] = y; }

  const T& GetY() const { return this->Data[1]; }

  void SetWidth(const T& width) { this->Data[2] = width; }

  const T& GetWidth() const { return this->Data[2]; }

  void SetHeight(const T& height) { this->Data[3] = height; }

  const T& GetHeight() const { return this->Data[3]; }

  const T& GetLeft() const { return this->Data[0]; }

  T GetRight() const { return this->Data[0] + this->Data[2]; }

  T GetTop() const { return this->Data[1] + this->Data[3]; }

  const T& GetBottom() const { return this->Data[1]; }


  vtkVector2<T> GetBottomLeft() const
  {
    return vtkVector2<T>(this->GetLeft(), this->GetBottom());
  }


  vtkVector<T, 2> GetTopLeft() const
  {
    return vtkVector2<T>(this->GetLeft(), this->GetTop());
  }


  vtkVector<T, 2> GetBottomRight() const
  {
    return vtkVector2<T>(this->GetRight(), this->GetBottom());
  }


  vtkVector<T, 2> GetTopRight() const
  {
    return vtkVector2<T>(this->GetRight(), this->GetTop());
  }


  void AddPoint(const T point[2])
  {
    // This code is written like this to ensure that adding a point gives
    // exactly the same result as AddRect(vtkRect(x,y,0,0)
    if (point[0] < this->GetX())
      {
      T dx = this->GetX() - point[0];
      this->SetX(point[0]);
      this->SetWidth(dx + this->GetWidth());
      }
    else if (point[0] > this->GetX())
      {
      // this->GetX() is already correct
      T dx = point[0] - this->GetX();
      this->SetWidth(vtkMath::Max(dx, this->GetWidth()));
      }

    if (point[1] < this->GetY())
      {
      T dy = this->GetY() - point[1];
      this->SetY(point[1]);
      this->SetHeight(dy + this->GetHeight());
      }
    else if (point[1] > this->GetY())
      {
      // this->GetY() is already correct
      T dy = point[1] - this->GetY();
      this->SetHeight(vtkMath::Max(dy, this->GetHeight()));
      }
  }


  void AddPoint(T x, T y)
  {
    T point[2] = {x, y};
    this->AddPoint(point);
  }


  void AddRect(const vtkRect<T> & rect)
  {
    if (rect.GetX() < this->GetX())
      {
      T dx = this->GetX() - rect.GetX();
      this->SetX(rect.GetX());
      this->SetWidth(vtkMath::Max(dx + this->GetWidth(), rect.GetWidth()));
      }
    else if (rect.GetX() > this->GetX())
      {
      T dx = rect.GetX() - this->GetX();
      // this->GetX() is already correct
      this->SetWidth(vtkMath::Max(dx + rect.GetWidth(), this->GetWidth()));
      }
    else
      {
      // this->GetX() is already correct
      this->SetWidth(vtkMath::Max(rect.GetWidth(), this->GetWidth()));
      }

    if (rect.GetY() < this->GetY())
      {
      T dy = this->GetY() - rect.GetY();
      this->SetY(rect.GetY());
      this->SetHeight(vtkMath::Max(dy + this->GetHeight(), rect.GetHeight()));
      }
    else if (rect.GetY() > this->GetY())
      {
      T dy = rect.GetY() - this->GetY();
      // this->GetY() is already correct
      this->SetHeight(vtkMath::Max(dy + rect.GetHeight(), this->GetHeight()));
      }
    else
      {
      // this->GetY() is already correct
      this->SetHeight(vtkMath::Max(rect.GetHeight(), this->GetHeight()));
      }
  }


  bool IntersectsWith(const vtkRect<T> & rect)
  {
    bool intersects = true;

    if (rect.GetX() < this->GetX())
      {
      T dx = this->GetX() - rect.GetX();
      intersects &= (dx < rect.GetWidth());
      }
    else if (rect.GetX() > this->GetX())
      {
      T dx = rect.GetX() - this->GetX();
      intersects &= (dx < this->GetWidth());
      }

    if (rect.GetY() < this->GetY())
      {
      T dy = this->GetY() - rect.GetY();
      intersects &= (dy < rect.GetHeight());
      }
    else if (rect.GetY() > this->GetY())
      {
      T dy = rect.GetY() - this->GetY();
      intersects &= (dy < this->GetHeight());
      }

    return intersects;
  }
};

class vtkRecti : public vtkRect<int>
{
public:
  vtkRecti() {}
  vtkRecti(int x, int y, int width, int height)
    : vtkRect<int>(x, y, width, height) {}
  explicit vtkRecti(const int *init) : vtkRect<int>(init) {}
};

class vtkRectf : public vtkRect<float>
{
public:
  vtkRectf() {}
  vtkRectf(float x, float y, float width, float height)
    : vtkRect<float>(x, y, width, height) {}
  explicit vtkRectf(const float *init) : vtkRect<float>(init) {}
};

class vtkRectd : public vtkRect<double>
{
public:
  vtkRectd() {}
  vtkRectd(double x, double y, double width, double height)
    : vtkRect<double>(x, y, width, height) {}
  explicit vtkRectd(const double *init) : vtkRect<double>(init) {}
};

#endif // vtkRect_h
// VTK-HeaderTest-Exclude: vtkRect.h