ConstructionPlugin_Plane.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 ConstructionPlugin_Plane_H
#define ConstructionPlugin_Plane_H
 
#include "ConstructionPlugin.h"
 
#include <ModelAPI_Feature.h>
#include <ModelAPI_Result.h>
#include <GeomAPI_ICustomPrs.h>
#include <GeomAPI_Shape.h>
 
class ConstructionPlugin_Plane: public ModelAPI_Feature, public GeomAPI_ICustomPrs
{
public:
  CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind()
  {
    static std::string MY_KIND = ConstructionPlugin_Plane::ID();
    return MY_KIND;
  }
 
  inline static const std::string& DEFAULT_COLOR()
  {
    static const std::string CONSTRUCTION_PLANE_COLOR("150,150,180");
    return CONSTRUCTION_PLANE_COLOR;
  }
 
  inline static const std::string& COLOR_NAME()
  {
    static const std::string PLANE_COLOR_NAME("construction_plane_color");
    return PLANE_COLOR_NAME;
  }
 
  inline static const std::string& ID()
  {
    static const std::string CONSTRUCTION_PLANE_KIND("Plane");
    return CONSTRUCTION_PLANE_KIND;
  }
 
  inline static const std::string& CREATION_METHOD()
  {
    static const std::string MY_CREATION_METHOD_ID("creation_method");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_GENERAL_EQUATION()
  {
    static const std::string MY_CREATION_METHOD_ID("by_general_equation");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_THREE_POINTS()
  {
    static const std::string MY_CREATION_METHOD_ID("by_three_points");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_LINE_AND_POINT()
  {
    static const std::string MY_CREATION_METHOD_ID("by_line_and_point");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_OTHER_PLANE()
  {
    static const std::string MY_CREATION_METHOD_ID("by_other_plane");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_OTHER_PLANE_OPTION()
  {
    static const std::string MY_CREATION_METHOD_ID("by_other_plane_option");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_DISTANCE_FROM_OTHER()
  {
    static const std::string MY_CREATION_METHOD_ID("by_distance_from_other");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_COINCIDENT_TO_POINT()
  {
    static const std::string MY_CREATION_METHOD_ID("by_coincident_to_point");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_ROTATION()
  {
    static const std::string MY_CREATION_METHOD_ID("by_rotation");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& CREATION_METHOD_BY_TWO_PARALLEL_PLANES()
  {
    static const std::string MY_CREATION_METHOD_ID("by_two_parallel_planes");
    return MY_CREATION_METHOD_ID;
  }
 
  inline static const std::string& POINT1()
  {
    static const std::string ATTR_ID("point1");
    return ATTR_ID;
  }
 
  inline static const std::string& POINT2()
  {
    static const std::string ATTR_ID("point2");
    return ATTR_ID;
  }
 
  inline static const std::string& POINT3()
  {
    static const std::string ATTR_ID("point3");
    return ATTR_ID;
  }
 
  inline static const std::string& LINE()
  {
    static const std::string ATTR_ID("line");
    return ATTR_ID;
  }
 
  inline static const std::string& POINT()
  {
    static const std::string ATTR_ID("point");
    return ATTR_ID;
  }
 
  inline static const std::string& PERPENDICULAR()
  {
    static const std::string ATTR_ID("perpendicular");
    return ATTR_ID;
  }
 
  inline static const std::string& PLANE()
  {
    static const std::string ATTR_ID("plane");
    return ATTR_ID;
  }
 
  inline static const std::string& DISTANCE()
  {
    static const std::string ATTR_ID("distance");
    return ATTR_ID;
  }
 
  inline static const std::string& REVERSE()
  {
    static const std::string ATTR_ID("reverse");
    return ATTR_ID;
  }
 
  inline static const std::string& COINCIDENT_POINT()
  {
    static const std::string ATTR_ID("coincident_point");
    return ATTR_ID;
  }
 
  inline static const std::string& AXIS()
  {
    static const std::string ATTR_ID("axis");
    return ATTR_ID;
  }
 
  inline static const std::string& ANGLE()
  {
    static const std::string ATTR_ID("angle");
    return ATTR_ID;
  }
 
  inline static const std::string& PLANE1()
  {
    static const std::string ATTR_ID("plane1");
    return ATTR_ID;
  }
 
  inline static const std::string& PLANE2()
  {
    static const std::string ATTR_ID("plane2");
    return ATTR_ID;
  }
 
  inline static const std::string& NB_COPIES()
  {
    static const std::string ATTR_ID("nb_copies");
    return ATTR_ID;
  }
 
  inline static const std::string& A()
  {
    static const std::string ATTR_ID("A");
    return ATTR_ID;
  }
  inline static const std::string& B()
  {
    static const std::string ATTR_ID("B");
    return ATTR_ID;
  }
  inline static const std::string& C()
  {
    static const std::string ATTR_ID("C");
    return ATTR_ID;
  }
  inline static const std::string& D()
  {
    static const std::string ATTR_ID("D");
    return ATTR_ID;
  }
 
  CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
 
  CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
 
  ConstructionPlugin_Plane();
 
  virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs);
 
protected:
  std::shared_ptr<GeomAPI_Shape> createByGeneralEquation();
  std::shared_ptr<GeomAPI_Shape> createByThreePoints();
  std::shared_ptr<GeomAPI_Shape> createByLineAndPoint();
  std::shared_ptr<GeomAPI_Shape> createByCoincidentPoint();
  void createByRotation(ListOfShape& theShapes);
  std::shared_ptr<GeomAPI_Shape> createByTwoParallelPlanes();
  void createByDistanceFromOther(ListOfShape& theShapes);
};
 
#endif