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

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

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
/**
 * @class   vtkSquarifyLayoutStrategy
 * @brief   uses the squarify tree map layout algorithm
 *
 *
 * vtkSquarifyLayoutStrategy partitions the space for child vertices into regions
 * that use all available space and are as close to squares as possible.
 * The algorithm also takes into account the relative vertex size.
 *
 * @par Thanks:
 * The squarified tree map algorithm comes from:
 * Bruls, D.M., C. Huizing, J.J. van Wijk. Squarified Treemaps.
 * In: W. de Leeuw, R. van Liere (eds.), Data Visualization 2000,
 * Proceedings of the joint Eurographics and IEEE TCVG Symposium on Visualization,
 * 2000, Springer, Vienna, p. 33-42.
*/

#ifndef vtkSquarifyLayoutStrategy_h
#define vtkSquarifyLayoutStrategy_h

#include "vtkInfovisLayoutModule.h" // For export macro
#include "vtkTreeMapLayoutStrategy.h"

class vtkIdList;

class VTKINFOVISLAYOUT_EXPORT vtkSquarifyLayoutStrategy : public vtkTreeMapLayoutStrategy
{
public:
  static vtkSquarifyLayoutStrategy *New();
  vtkTypeMacro(vtkSquarifyLayoutStrategy,vtkTreeMapLayoutStrategy);
  void PrintSelf(ostream& os, vtkIndent indent);

  /**
   * Perform the layout of a tree and place the results as 4-tuples in
   * coordsArray (Xmin, Xmax, Ymin, Ymax).
   */
  void Layout(
      vtkTree* inputTree,
      vtkDataArray* coordsArray,
      vtkDataArray* sizeArray);

protected:
  vtkSquarifyLayoutStrategy();
  ~vtkSquarifyLayoutStrategy();

private:

  void LayoutChildren(
    vtkTree *tree,
    vtkDataArray *coordsArray,
    vtkDataArray *sizeArray,
    vtkIdType nchildren,
    vtkIdType parent,
    vtkIdType begin,
    float minX, float maxX,
    float minY, float maxY);

  vtkSquarifyLayoutStrategy(const vtkSquarifyLayoutStrategy&) VTK_DELETE_FUNCTION;
  void operator=(const vtkSquarifyLayoutStrategy&) VTK_DELETE_FUNCTION;
};

#endif

