FeaturesAPI_Offset.h

// Copyright (C) 2017-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 FeaturesAPI_Offset_H_
#define FeaturesAPI_Offset_H_
 
#include "FeaturesAPI.h"
 
#include <FeaturesPlugin_Offset.h>
 
#include <ModelHighAPI_Double.h>
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Selection;
 
class FeaturesAPI_Offset: public ModelHighAPI_Interface
{
public:
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Offset(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Offset(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                              const ModelHighAPI_Selection& theBaseObject,
                              const ModelHighAPI_Double& theOffset,
                              const bool isPipeJoint);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Offset(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                              const ModelHighAPI_Selection& theBaseObject,
                              const ModelHighAPI_Double& theOffset,
                              const std::list<ModelHighAPI_Selection>& theFaces);
 
  FEATURESAPI_EXPORT
  virtual ~FeaturesAPI_Offset();
 
  INTERFACE_5(FeaturesPlugin_Offset::ID(),
 
              creationMethod, FeaturesPlugin_Offset::CREATION_METHOD_ID(),
              ModelAPI_AttributeString, ,
 
              baseObject, FeaturesPlugin_Offset::BASE_SHAPE_ID(),
              ModelAPI_AttributeSelection, ,
 
              offsetValue, FeaturesPlugin_Offset::OFFSET_VALUE_ID(),
              ModelAPI_AttributeDouble, ,
 
              isPipeJoint, FeaturesPlugin_Offset::PIPE_JOINT_ID(),
              ModelAPI_AttributeBoolean, ,
 
              faces, FeaturesPlugin_Offset::FACES_ID(),
              ModelAPI_AttributeSelectionList, )
 
  
  FEATURESAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<FeaturesAPI_Offset> OffsetPtr;
 
FEATURESAPI_EXPORT
OffsetPtr addOffset(const std::shared_ptr<ModelAPI_Document>& thePart,
                    const ModelHighAPI_Selection& theBaseObject,
                    const ModelHighAPI_Double& theOffset,
                    const bool isPipeJoint = true);
 
FEATURESAPI_EXPORT
OffsetPtr addOffsetPartial(const std::shared_ptr<ModelAPI_Document>& thePart,
                           const ModelHighAPI_Selection& theBaseObject,
                           const ModelHighAPI_Double& theOffset,
                           const std::list<ModelHighAPI_Selection>& theFaces);
 
#endif // FeaturesAPI_Offset_H_