ConstructionPlugin_Axis.h

// Copyright (C) 2014-2026  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_Axis_H
#define ConstructionPlugin_Axis_H
 
#include "ConstructionPlugin.h"
#include <ModelAPI_Feature.h>
#include <ModelAPI_Result.h>
#include <GeomAPI_ICustomPrs.h>
 
class ConstructionPlugin_Axis : public ModelAPI_Feature, public GeomAPI_ICustomPrs
{
 public:
  CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind()
  {
    static std::string MY_KIND = ConstructionPlugin_Axis::ID();
    return MY_KIND;
  }
 
  inline static const std::string& ID()
  {
    static const std::string CONSTRUCTION_AXIS_KIND("Axis");
    return CONSTRUCTION_AXIS_KIND;
  }
 
  inline static const std::string& METHOD()
  {
    static const std::string METHOD_ATTR("CreationMethod");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_TWO_POINTS()
  {
    static const std::string METHOD_ATTR("AxisByPointsCase");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_CYLINDRICAL_FACE()
  {
    static const std::string METHOD_ATTR("AxisByCylindricalFaceCase");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_POINT_AND_DIRECTION()
  {
    static const std::string METHOD_ATTR("AxisByPointAndDirection");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_DIMENSIONS()
  {
    static const std::string METHOD_ATTR("AxisByDimensionsCase");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_LINE()
  {
    static const std::string METHOD_ATTR("by_line");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_PLANE_AND_POINT()
  {
    static const std::string METHOD_ATTR("by_plane_and_point");
    return METHOD_ATTR;
  }
 
  inline static const std::string& CREATION_METHOD_BY_TWO_PLANES()
  {
    static const std::string METHOD_ATTR("by_two_planes");
    return METHOD_ATTR;
  }
 
  inline static const std::string& POINT_FIRST()
  {
    static const std::string POINT_ATTR_FIRST("FirstPoint");
    return POINT_ATTR_FIRST;
  }
  inline static const std::string& POINT_SECOND()
  {
    static const std::string POINT_ATTR_SECOND("SecondPoint");
    return POINT_ATTR_SECOND;
  }
  inline static const std::string& CYLINDRICAL_FACE()
  {
    static const std::string CYLINDRICAL_FACE_ATTR("CylindricalFace");
    return CYLINDRICAL_FACE_ATTR;
  }
  inline static const std::string& DX()
  {
    static const std::string DX_ATTR("DX");
    return DX_ATTR;
  }
  inline static const std::string& DY()
  {
    static const std::string DY_ATTR("DY");
    return DY_ATTR;
  }
  inline static const std::string& DZ()
  {
    static const std::string DZ_ATTR("DZ");
    return DZ_ATTR;
  }
 
  inline static const std::string& X_DIRECTION()
  {
    static const std::string ATTR_X_DIRECTION("X_Direction");
    return ATTR_X_DIRECTION;
  }
 
  inline static const std::string& Y_DIRECTION()
  {
    static const std::string ATTR_Y_DIRECTION("Y_Direction");
    return ATTR_Y_DIRECTION;
  }
 
  inline static const std::string& Z_DIRECTION()
  {
    static const std::string ATTR_Z_DIRECTION("Z_Direction");
    return ATTR_Z_DIRECTION;
  }
 
  inline static const std::string& LINE()
  {
    static const std::string ATTR_ID("line");
    return ATTR_ID;
  }
 
  inline static const std::string& PLANE()
  {
    static const std::string ATTR_ID("plane");
    return ATTR_ID;
  }
 
  inline static const std::string& POINT()
  {
    static const std::string ATTR_ID("point");
    return ATTR_ID;
  }
 
  inline static const std::string& PLANE1()
  {
    static const std::string ATTR_ID("plane1");
    return ATTR_ID;
  }
 
  inline static const std::string& USE_OFFSET1()
  {
    static const std::string ATTR_ID("use_offset1");
    return ATTR_ID;
  }
 
  inline static const std::string& OFFSET1()
  {
    static const std::string ATTR_ID("offset1");
    return ATTR_ID;
  }
 
  inline static const std::string& REVERSE_OFFSET1()
  {
    static const std::string ATTR_ID("reverse_offset1");
    return ATTR_ID;
  }
 
  inline static const std::string& PLANE2()
  {
    static const std::string ATTR_ID("plane2");
    return ATTR_ID;
  }
 
  inline static const std::string& USE_OFFSET2()
  {
    static const std::string ATTR_ID("use_offset2");
    return ATTR_ID;
  }
 
  inline static const std::string& OFFSET2()
  {
    static const std::string ATTR_ID("offset2");
    return ATTR_ID;
  }
 
  inline static const std::string& REVERSE_OFFSET2()
  {
    static const std::string ATTR_ID("reverse_offset2");
    return ATTR_ID;
  }
 
  inline static const double MINIMAL_LENGTH() { return 1.e-5; }
 
  CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
 
  CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
 
  ConstructionPlugin_Axis();
 
  virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs);
 
 protected:
  void createAxisByTwoPoints();
  void createAxisByDimensions();
  void createAxisByCylindricalFace();
  void createAxisByPointAndDirection();
  void createAxisByLine();
  void createAxisByPlaneAndPoint();
  void createAxisByTwoPlanes();
};
 
 
#endif