boundcube.h

Go to the documentation of this file.

/* boundcube.h : Bounding cube class
 * Copyright (C) 2014  Daniel Haley
 * 
 * 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 3 of the License, 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.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef ATOMPROBE_BOUNDCUBE_H
#define ATOMPROBE_BOUNDCUBE_H

#include "atomprobe/primitives/point3D.h"

#include <vector>

namespace AtomProbe{

class IonHit;

class BoundCube
{
    float bounds[3][2];
#ifdef DEBUG
    bool valid[3][2];
#endif
public:

    BoundCube()
    {
#ifdef DEBUG
        setInvalid();
#endif
    }

    BoundCube(const std::vector<Point3D> &pts)
    {
        setBounds(pts);
    }

    BoundCube(const std::vector<IonHit> &pts)
    {
        setBounds(pts);
    }


    BoundCube(const Point3D &p1, const Point3D &p2);
    
    bool operator==(const BoundCube &other) const;
    void setBounds(float xMin,float yMin,float zMin,
            float xMax,float yMax,float zMax);


    void setBound(unsigned int bound, unsigned int minMax, float value) ;

    void setBounds(const BoundCube &b);
    void setBounds( const Point3D *ptArray, unsigned int nPoints);
    void setBounds( const Point3D &p, const Point3D &q);
    void setBounds(const std::vector<Point3D> &ptArray);
    void setBounds(const std::vector<IonHit> &ptArray);

    void setBounds(const Point3D &p, float radius);
#ifdef DEBUG
    bool isValid() const;
    bool isValid(unsigned int dim) const;

    void setInvalid();
#endif
    void setInverseLimits();


    float getBound(unsigned int bound, unsigned int minMax) const ;
    Point3D getCentroid() const;

    void getBounds(Point3D &low, Point3D &high) const ;

    //Return the lower left (min) bound 
    Point3D min() const;
    
    //Return the lower left (min) bound 
    Point3D max() const;

    float getSize(unsigned int dim) const;


    bool isFlat() const;

    bool intersects(const Point3D &pt, float sqrRad) const;

    bool intersects(const BoundCube &b) const;


        bool contains(const BoundCube &b) const;
    bool containsPt(const Point3D &pt) const;

    bool containedInSphere(const Point3D &origin, float radius) const;
    
    BoundCube makeUnion(const BoundCube &b) const;
        
    BoundCube makeIntersection(const BoundCube &b) const;

    float getMaxDistanceToBox(const Point3D &pt) const;

    float getLargestDim() const;

    float getVolume() const;

    void setLimits();

        unsigned int segmentTriple(unsigned int dim, float slice) const;

    BoundCube operator=(const BoundCube &);
    void expand(const BoundCube &b);
    void expand(const Point3D &p);

    void expand(float f);

    friend  std::ostream &operator<<(std::ostream &stream, const BoundCube& b);

    friend class K3DTreeExact;
    friend class K3DTreeApprox;
};
}
#endif