qgsbox3d.h

Go to the documentation of this file.

/***************************************************************************
                             qgsbox3d.h
                             ----------
    begin                : April 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson 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 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSBOX3D_H
#define QGSBOX3D_H
 
#include "qgis_core.h"
#include "qgsrectangle.h"
 
class QgsPoint;
 
class CORE_EXPORT QgsBox3d
{
  public:
 
    QgsBox3d( double xmin = 0, double ymin = 0, double zmin = 0, double xmax = 0, double ymax = 0, double zmax = 0 ) SIP_HOLDGIL;
 
    QgsBox3d( const QgsPoint &p1, const QgsPoint &p2 ) SIP_HOLDGIL;
 
    QgsBox3d( const QgsRectangle &rect ) SIP_HOLDGIL;
 
    void setXMinimum( double x ) SIP_HOLDGIL;
 
    void setXMaximum( double x ) SIP_HOLDGIL;
 
    double xMinimum() const SIP_HOLDGIL { return mBounds2d.xMinimum(); }
 
    double xMaximum() const SIP_HOLDGIL { return mBounds2d.xMaximum(); }
 
    void setYMinimum( double y ) SIP_HOLDGIL;
 
    void setYMaximum( double y ) SIP_HOLDGIL;
 
    double yMinimum() const SIP_HOLDGIL { return mBounds2d.yMinimum(); }
 
    double yMaximum() const SIP_HOLDGIL { return mBounds2d.yMaximum(); }
 
    void setZMinimum( double z ) SIP_HOLDGIL;
 
    void setZMaximum( double z ) SIP_HOLDGIL;
 
    double zMinimum() const SIP_HOLDGIL { return mZmin; }
 
    double zMaximum() const SIP_HOLDGIL { return mZmax; }
 
    void normalize();
 
    double width() const SIP_HOLDGIL { return mBounds2d.width(); }
 
    double height() const SIP_HOLDGIL { return mBounds2d.height(); }
 
    double depth() const SIP_HOLDGIL { return mZmax - mZmin; }
 
    double volume() const SIP_HOLDGIL { return mBounds2d.area() * ( mZmax - mZmin ); }
 
    QgsBox3d intersect( const QgsBox3d &other ) const;
 
    bool is2d() const SIP_HOLDGIL;
 
    bool intersects( const QgsBox3d &other ) const;
 
    bool contains( const QgsBox3d &other ) const;
 
    bool contains( const QgsPoint &point ) const;
 
    QgsRectangle toRectangle() const { return mBounds2d; }
 
    bool operator==( const QgsBox3d &other ) const;
 
  private:
 
    QgsRectangle mBounds2d;
    double mZmin = 0.0;
    double mZmax = 0.0;
 
};
 
#endif // QGSBOX3D_H