ConstructionAPI_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 SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_AXIS_H_
#define SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_AXIS_H_
 
#include "ConstructionAPI.h"
 
#include <ConstructionPlugin_Axis.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Double;
class ModelHighAPI_Selection;
 
class ConstructionAPI_Axis: public ModelHighAPI_Interface
{
public:
  CONSTRUCTIONAPI_EXPORT
  explicit ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Selection& theObject1,
                       const ModelHighAPI_Selection& theObject2);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Selection& theObject);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Selection& thePoint,
                       const ModelHighAPI_Double& theX,
                       const ModelHighAPI_Double& theY,
                       const ModelHighAPI_Double& theZ);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Double& theDX,
                       const ModelHighAPI_Double& theDY,
                       const ModelHighAPI_Double& theDZ);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Selection& thePlane1,
                       const ModelHighAPI_Double& theOffset1,
                       const bool theReverseOffset1,
                       const ModelHighAPI_Selection& thePlane2,
                       const ModelHighAPI_Double& theOffset2,
                       const bool theReverseOffset2);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Selection& thePlane1,
                       const ModelHighAPI_Selection& thePlane2,
                       const ModelHighAPI_Double& theOffset2,
                       const bool theReverseOffset2);
 
  CONSTRUCTIONAPI_EXPORT
  ConstructionAPI_Axis(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                       const ModelHighAPI_Selection& thePlane1,
                       const ModelHighAPI_Double& theOffset1,
                       const bool theReverseOffset1,
                       const ModelHighAPI_Selection& thePlane2);
 
  CONSTRUCTIONAPI_EXPORT
  virtual ~ConstructionAPI_Axis();
 
  INTERFACE_21(ConstructionPlugin_Axis::ID(),
               creationMethod, ConstructionPlugin_Axis::METHOD(),
               ModelAPI_AttributeString, ,
               firstPoint, ConstructionPlugin_Axis::POINT_FIRST(),
               ModelAPI_AttributeSelection, ,
               secondPoint, ConstructionPlugin_Axis::POINT_SECOND(),
               ModelAPI_AttributeSelection, ,
               cylindricalFace, ConstructionPlugin_Axis::CYLINDRICAL_FACE(),
               ModelAPI_AttributeSelection, ,
               xDirection, ConstructionPlugin_Axis::X_DIRECTION(),
               ModelAPI_AttributeDouble, ,
               yDirection, ConstructionPlugin_Axis::Y_DIRECTION(),
               ModelAPI_AttributeDouble, ,
               zDirection, ConstructionPlugin_Axis::Z_DIRECTION(),
               ModelAPI_AttributeDouble, ,
               xDimension, ConstructionPlugin_Axis::DX(),
               ModelAPI_AttributeDouble, ,
               yDimension, ConstructionPlugin_Axis::DY(),
               ModelAPI_AttributeDouble, ,
               zDimension, ConstructionPlugin_Axis::DZ(),
               ModelAPI_AttributeDouble, ,
               line, ConstructionPlugin_Axis::LINE(),
               ModelAPI_AttributeSelection, ,
               plane, ConstructionPlugin_Axis::PLANE(),
               ModelAPI_AttributeSelection, ,
               point, ConstructionPlugin_Axis::POINT(),
               ModelAPI_AttributeSelection, ,
               plane1, ConstructionPlugin_Axis::PLANE1(),
               ModelAPI_AttributeSelection, ,
               useOffset1, ConstructionPlugin_Axis::USE_OFFSET1(),
               ModelAPI_AttributeString, ,
               offset1, ConstructionPlugin_Axis::OFFSET1(),
               ModelAPI_AttributeDouble, ,
               reverseOffset1, ConstructionPlugin_Axis::REVERSE_OFFSET1(),
               ModelAPI_AttributeBoolean, ,
               plane2, ConstructionPlugin_Axis::PLANE2(),
               ModelAPI_AttributeSelection, ,
               useOffset2, ConstructionPlugin_Axis::USE_OFFSET2(),
               ModelAPI_AttributeString, ,
               offset2, ConstructionPlugin_Axis::OFFSET2(),
               ModelAPI_AttributeDouble, ,
               reverseOffset2, ConstructionPlugin_Axis::REVERSE_OFFSET2(),
               ModelAPI_AttributeBoolean, )
 
  
  CONSTRUCTIONAPI_EXPORT
  void setByPoints(const ModelHighAPI_Selection& thePoint1,
                   const ModelHighAPI_Selection& thePoint2);
 
  CONSTRUCTIONAPI_EXPORT
  void setByCylindricalFace(const ModelHighAPI_Selection& theCylindricalFace);
 
  CONSTRUCTIONAPI_EXPORT
  void setByPointAndDirection(const ModelHighAPI_Selection& thePoint,
                              const ModelHighAPI_Double& theX,
                              const ModelHighAPI_Double& theY,
                              const ModelHighAPI_Double& theZ);
 
  CONSTRUCTIONAPI_EXPORT
  void setByDimensions(const ModelHighAPI_Double& theDX,
                       const ModelHighAPI_Double& theDY,
                       const ModelHighAPI_Double& theDZ);
 
  CONSTRUCTIONAPI_EXPORT
  void setByLine(const ModelHighAPI_Selection& theCylindricalFace);
 
  CONSTRUCTIONAPI_EXPORT
  void setByPlaneAndPoint(const ModelHighAPI_Selection& thePlane,
                          const ModelHighAPI_Selection& thePoint);
 
  CONSTRUCTIONAPI_EXPORT
  void setByTwoPlanes(const ModelHighAPI_Selection& thePlane1,
                      const ModelHighAPI_Selection& thePlane2);
 
  CONSTRUCTIONAPI_EXPORT
  void setByTwoPlanes(const ModelHighAPI_Selection& thePlane1,
                      const ModelHighAPI_Double& theOffset1,
                      const bool theReverseOffset1,
                      const ModelHighAPI_Selection& thePlane2,
                      const ModelHighAPI_Double& theOffset2,
                      const bool theReverseOffset2);
 
  CONSTRUCTIONAPI_EXPORT
  void setByTwoPlanes(const ModelHighAPI_Selection& thePlane1,
                      const ModelHighAPI_Selection& thePlane2,
                      const ModelHighAPI_Double& theOffset2,
                      const bool theReverseOffset2);
 
  CONSTRUCTIONAPI_EXPORT
  void setByTwoPlanes(const ModelHighAPI_Selection& thePlane1,
                      const ModelHighAPI_Double& theOffset1,
                      const bool theReverseOffset1,
                      const ModelHighAPI_Selection& thePlane2);
 
  CONSTRUCTIONAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<ConstructionAPI_Axis> AxisPtr;
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Selection& theObject1,
                const ModelHighAPI_Selection& theObject2);
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Selection& theObject);
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Selection& thePoint,
                const ModelHighAPI_Double& theX,
                const ModelHighAPI_Double& theY,
                const ModelHighAPI_Double& theZ);
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Double& theDX,
                const ModelHighAPI_Double& theDY,
                const ModelHighAPI_Double& theDZ);
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Selection& thePlane1,
                const ModelHighAPI_Double& theOffset1,
                const bool theReverseOffset1,
                const ModelHighAPI_Selection& thePlane2,
                const ModelHighAPI_Double& theOffset2,
                const bool theReverseOffset2);
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Selection& thePlane1,
                const ModelHighAPI_Selection& thePlane2,
                const ModelHighAPI_Double& theOffset2,
                const bool theReverseOffset2);
 
CONSTRUCTIONAPI_EXPORT
AxisPtr addAxis(const std::shared_ptr<ModelAPI_Document>& thePart,
                const ModelHighAPI_Selection& thePlane1,
                const ModelHighAPI_Double& theOffset1,
                const bool theReverseOffset1,
                const ModelHighAPI_Selection& thePlane2);
 
#endif /* SRC_CONSTRUCTIONAPI_CONSTRUCTIONAPI_AXIS_H_ */