GeomAPI_Pln.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef GeomAPI_Pln_H_
#define GeomAPI_Pln_H_
 
#include <memory>
#include <GeomAPI_Interface.h>
 
class GeomAPI_Ax3;
class GeomAPI_Pnt;
class GeomAPI_Dir;
class GeomAPI_Lin;
class gp_Pln;
 
class GeomAPI_Pln : public GeomAPI_Interface
{
 public:
  GEOMAPI_EXPORT
  GeomAPI_Pln(const std::shared_ptr<GeomAPI_Ax3>& theAxes);
 
  GEOMAPI_EXPORT
  GeomAPI_Pln(const std::shared_ptr<GeomAPI_Pnt>& thePoint,
              const std::shared_ptr<GeomAPI_Dir>& theNormal);
 
  GEOMAPI_EXPORT
  GeomAPI_Pln(const double theA, const double theB, const double theC, const double theD);
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Pnt> location() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Dir> direction() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Dir> xDirection() const;
 
  GEOMAPI_EXPORT
  void coefficients(double& theA, double& theB, double& theC, double& theD);
 
  GEOMAPI_EXPORT
  bool isCoincident(const std::shared_ptr<GeomAPI_Pln> thePlane, const double theTolerance = 1.e-7);
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Pnt> intersect(const std::shared_ptr<GeomAPI_Lin>& theLine) const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Pnt> project(const std::shared_ptr<GeomAPI_Pnt>& thePoint) const;
 
  GEOMAPI_EXPORT
  double distance(const std::shared_ptr<GeomAPI_Pln> thePlane) const;
 
  GEOMAPI_EXPORT
  double distance(const std::shared_ptr<GeomAPI_Pnt> thePoint) const;
 
  GEOMAPI_EXPORT
  void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theDist);
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Lin> intersect(const std::shared_ptr<GeomAPI_Pln> thePlane) const;
};
 
typedef std::shared_ptr<GeomAPI_Pln> GeomPlanePtr;
 
#endif