plane.h

/******************************************************************************
 *   Copyright (C) 2007-2024 by the GIMLi development team                    *
 *   Carsten Rücker carsten@resistivity.net                                   *
 *                                                                            *
 *   Licensed under the Apache License, Version 2.0 (the "License");          *
 *   you may not use this file except in compliance with the License.         *
 *   You may obtain a copy of the License at                                  *
 *                                                                            *
 *       http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                            *
 *   Unless required by applicable law or agreed to in writing, software      *
 *   distributed under the License is distributed on an "AS IS" BASIS,        *
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *   See the License for the specific language governing permissions and      *
 *   limitations under the License.                                           *
 *                                                                            *
 ******************************************************************************/
 
#ifndef _GIMLI_PLANE__H
#define _GIMLI_PLANE__H
 
#include "gimli.h"
#include "pos.h"
 
namespace GIMLI{


class DLLEXPORT Plane{
public:
    Plane();

    Plane(const RVector3 & norm, double d);

    Plane(const RVector3 & norm, const RVector3 & x0);

    Plane(const RVector3 & p0, const RVector3 & p1, const RVector3 & p2);

    Plane(double a, double b, double c, double d);

    Plane(const Plane & plane);

    ~Plane();

    Plane & operator = (const Plane & plane);

    inline bool operator == (const Plane & plane){ 
        return this->compare(plane);
    }

    inline bool operator != (const Plane & plane){ 
        return !(*this== plane);
    }

    bool compare(const Plane & p, double tol=TOLERANCE, bool bothDirs=false);
    

    bool touch (const RVector3 & pos, double tol = TOLERANCE);

    Line intersect(const Plane & plane, double tol = TOLERANCE);

    RVector3 intersect(const Line & line, double tol = TOLERANCE, bool inside = false);

    inline const RVector3 & norm() const { return norm_; }

    inline const RVector3 x0() const { return norm_ * d_; }

    inline double distance(const RVector3 & pos) const { return norm_.dot(pos) - d_ ; }

    inline double d() const { return d_; }

    bool checkValidity(double tol = TOLERANCE);

    inline bool valid() const { return valid_; }
 
protected:

    void copy_(const Plane & plane);
 
    RVector3 norm_;
    double d_;
    bool valid_;
};
 
std::ostream & operator << (std::ostream & str, const Plane & p);
 
} //namespace GIMLI
 
#endif //  _GIMLI_PLANE__H