atkinspagelayoutnode.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-02-13
 * Description : Layouting photos on a page
 *
 * Copyright (C) 2007-2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2006-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_ATKINS_PAGE_LAYOUT_NODE_H
#define DIGIKAM_ATKINS_PAGE_LAYOUT_NODE_H
 
// Qt includes
 
#include <QRectF>
#include <QMap>
 
namespace DigikamGenericPrintCreatorPlugin
{
 
class AtkinsPageLayoutNode
{
public:
 
    enum Type
    {
        TerminalNode,
        HorizontalDivision, 
        VerticalDivision    
    };
 
public:
 
    AtkinsPageLayoutNode(double aspectRatio,
                         double relativeArea,
                         int index);
    AtkinsPageLayoutNode(AtkinsPageLayoutNode* const subtree,
                         AtkinsPageLayoutNode* const terminalChild,
                         bool horizontal,
                         int index);
    AtkinsPageLayoutNode(const AtkinsPageLayoutNode&);
    ~AtkinsPageLayoutNode();
 
    AtkinsPageLayoutNode& operator=(const AtkinsPageLayoutNode&);
 
    double aspectRatio()  const;
    double relativeArea() const;
    double division()     const;
    Type   type()         const;
    int    index()        const;
 
    AtkinsPageLayoutNode* leftChild()  const;
    AtkinsPageLayoutNode* rightChild() const;
 
    void takeAndSetChild(AtkinsPageLayoutNode* const oldChild,
                         AtkinsPageLayoutNode* const newChild);
 
    AtkinsPageLayoutNode* nodeForIndex(int index);
 
    AtkinsPageLayoutNode* parentOf(AtkinsPageLayoutNode* const child);
 
    void computeRelativeSizes();
 
    void computeDivisions();
 
private:
 
    double                m_a;        
    double                m_e;        
    double                m_division;
 
    Type                  m_type;
 
    int                   m_index;
 
    AtkinsPageLayoutNode* m_leftChild;
    AtkinsPageLayoutNode* m_rightChild;
};
 
} // Namespace Digikam
 
#endif // DIGIKAM_ATKINS_PAGE_LAYOUT_NODE_H