/***************************************************************************
 *   Copyright (c) 2013 Luke Parry <l.parry@warwick.ac.uk>                 *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef _TECHDRAW_FEATUREVIEWGROUP_H_
#define _TECHDRAW_FEATUREVIEWGROUP_H_

# include <QRectF>
#include <App/DocumentObject.h>
#include <App/PropertyStandard.h>

#include <Base/BoundBox.h>
#include <Base/Matrix.h>

#include "DrawViewCollection.h"

namespace TechDraw
{

class DrawProjGroupItem;

/**
 * Class super-container for managing a collection of DrawProjGroupItem
 * Page Features
 */
class TechDrawExport DrawProjGroup : public TechDraw::DrawViewCollection
{
    PROPERTY_HEADER(TechDraw::DrawProjGroup);

public:
    /// Constructor
    DrawProjGroup();
    ~DrawProjGroup();

    App::PropertyEnumeration ProjectionType;

    /// Default horizontal spacing between adjacent views on Drawing, in mm
    App::PropertyFloat spacingX;
    /// Default vertical spacing between adjacent views on Drawing, in mm
    App::PropertyFloat spacingY;

    /// Transforms Direction and XAxisDirection vectors in child views
    App::PropertyMatrix viewOrientationMatrix;

    App::PropertyLink Anchor; /// Anchor Element to align views to

    Base::BoundBox3d getBoundingBox() const;
    double calculateAutomaticScale() const;
    virtual QRectF getRect(void) const;

    /// Check if container has a view of a specific type
    bool hasProjection(const char *viewProjType) const;

    App::DocumentObject * getProjObj(const char *viewProjType) const;

    //! Adds a projection to the group
    /*!
     * \return pointer to the new view
     */
    App::DocumentObject * addProjection(const char *viewProjType);

    //! Removes a projection from the group
    /*!
     * \return number of projections remaining
     */
    int removeProjection(const char *viewProjType);

    /// Automatically position child views
    bool distributeProjections(void);
    void resetPositions(void);
    /// Changes child views' coordinate space
    /*!
     * Used to set the Direction and XAxisDirection in child views
     */
    void setFrontViewOrientation(const Base::Matrix4D &newMat);

    short mustExecute() const;
    /** @name methods overide Feature */
    //@{
    /// recalculate the Feature
    virtual void onDocumentRestored();
    virtual App::DocumentObjectExecReturn *execute(void);
    //@}

    /// returns the type name of the ViewProvider
    virtual const char* getViewProviderName(void) const {
        return "TechDrawGui::ViewProviderProjGroup";
    }
    //return PyObject as DrawProjGroupPy
    virtual PyObject *getPyObject(void);

    /// Determines either "First Angle" or "Third Angle".
    App::Enumeration usedProjectionType(void);

    /// Allowed projection types - either Document, First Angle or Third Angle
    static const char* ProjectionTypeEnums[];

protected:
    void onChanged(const App::Property* prop);

    //! Moves anchor view to keep our bounding box centre on the origin
    void moveToCentre();

    /// Annoying helper - keep in sync with DrawProjGroupItem::TypeEnums
    /*!
     * \TODO See note regarding App::PropertyEnumeration on my wiki page http://freecadweb.org/wiki/index.php?title=User:Ian.rees
     * \return true iff 'in' is a valid name for an orthographic/isometric view
     */
    bool checkViewProjType(const char *in);

    /// Sets Direction and XAxisDirection in v
    /*!
     * Applies viewOrientationMatrix to appropriate unit vectors depending on projType
     */
    void setViewOrientation(DrawProjGroupItem *v, const char *projType) const;

    /// Populates an array of DrawProjGroupItem*s arranged for drawing
    /*!
     * Setup array of pointers to the views that we're displaying,
     * assuming front is in centre (index 4):
     * <pre>
     * [0]  [1]  [2]
     * [3]  [4]  [5]  [6]
     * [7]  [8]  [9]
     *
     * Third Angle:  FTL  T  FTRight
     *                L   F   Right   Rear
     *               FBL  B  FBRight
     *
     * First Angle:  FBRight  B  FBL
     *                Right   F   L  Rear
     *               FTRight  T  FTL
     * </pre>
     */
    void arrangeViewPointers(DrawProjGroupItem *viewPtrs[10]) const;

    /// Populates array of 10 BoundBox3d's given DrawProjGroupItem *s
    /*!
     * If documentScale is set, then returned bounding boxes are scaled as in
     * the Drawing.  Otherwise, the dimensions are as in object space.
     */
    void makeViewBbs(DrawProjGroupItem *viewPtrs[10],
                     Base::BoundBox3d bboxes[10],
                     bool documentScale = true) const;

    /// Helper for calculateAutomaticScale
    /*!
     * Returns a width and height in object-space scale, for the enabled views
     * without accounting for their actual X and Y positions or borders.
     */
    void minimumBbViews(DrawProjGroupItem *viewPtrs[10],
                       double &width, double &height) const;

    /// Returns pointer to our page, or NULL if it couldn't be located
    TechDraw::DrawPage * getPage(void) const;
};

} //namespace TechDraw

#endif // _TECHDRAW_FEATUREVIEWGROUP_H_