FeaturesAPI_Revolution.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 FeaturesAPI_Revolution_H_
#define FeaturesAPI_Revolution_H_
 
#include "FeaturesAPI.h"
 
#include <FeaturesPlugin_Revolution.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Double;
class ModelHighAPI_Reference;
class ModelHighAPI_Selection;
 
class FeaturesAPI_Revolution: public ModelHighAPI_Interface
{
public:
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                  const ModelHighAPI_Selection& theAxis,
                                  const ModelHighAPI_Double& theAngle);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                  const ModelHighAPI_Selection& theAxis,
                                  const ModelHighAPI_Double& theToAngle,
                                  const ModelHighAPI_Double& theFromAngle,
                                  const std::string& theSelectionType = std::string());
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Revolution(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                  const ModelHighAPI_Selection& theAxis,
                                  const ModelHighAPI_Selection& theToObject,
                                  const ModelHighAPI_Double& theToOffset,
                                  const ModelHighAPI_Selection& theFromObject,
                                  const ModelHighAPI_Double& theFromOffset,
                                  const std::string& theSelectionType = std::string());
 
  FEATURESAPI_EXPORT
  virtual ~FeaturesAPI_Revolution();
 
  INTERFACE_10(FeaturesPlugin_Revolution::ID(),
               sketch, FeaturesPlugin_Revolution::SKETCH_ID(),
               ModelAPI_AttributeReference, ,
               baseObjects, FeaturesPlugin_Revolution::BASE_OBJECTS_ID(),
               ModelAPI_AttributeSelectionList, ,
               axis, FeaturesPlugin_Revolution::AXIS_OBJECT_ID(),
               ModelAPI_AttributeSelection, ,
               creationMethod, FeaturesPlugin_Revolution::CREATION_METHOD(),
               ModelAPI_AttributeString, ,
               toAngle, FeaturesPlugin_Revolution::TO_ANGLE_ID(),
               ModelAPI_AttributeDouble, ,
               fromAngle, FeaturesPlugin_Revolution::FROM_ANGLE_ID(),
               ModelAPI_AttributeDouble, ,
               toObject, FeaturesPlugin_Revolution::TO_OBJECT_ID(),
               ModelAPI_AttributeSelection, ,
               toOffset, FeaturesPlugin_Revolution::TO_OFFSET_ID(),
               ModelAPI_AttributeDouble, ,
               fromObject, FeaturesPlugin_Revolution::FROM_OBJECT_ID(),
               ModelAPI_AttributeSelection, ,
               fromOffset, FeaturesPlugin_Revolution::FROM_OFFSET_ID(),
               ModelAPI_AttributeDouble, )
 
  
  FEATURESAPI_EXPORT
  void setNestedSketch(const ModelHighAPI_Reference& theSketch);
 
  FEATURESAPI_EXPORT
  void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
 
  FEATURESAPI_EXPORT
  void setAxis(const ModelHighAPI_Selection& theAxis);
 
  FEATURESAPI_EXPORT
  void setAngles(const ModelHighAPI_Double& theToAngle,
                 const ModelHighAPI_Double& theFromAngle);
 
  FEATURESAPI_EXPORT
  void setAngle(const ModelHighAPI_Double& theAngle);
 
  FEATURESAPI_EXPORT
  void setPlanesAndOffsets(const ModelHighAPI_Selection& theToObject,
                           const ModelHighAPI_Double& theToOffset,
                           const ModelHighAPI_Selection& theFromObject,
                           const ModelHighAPI_Double& theFromOffset);
 
  FEATURESAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 
private:
  void execIfBaseNotEmpty();
};
 
typedef std::shared_ptr<FeaturesAPI_Revolution> RevolutionPtr;
 
FEATURESAPI_EXPORT
RevolutionPtr addRevolution(const std::shared_ptr<ModelAPI_Document>& thePart,
                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
                            const ModelHighAPI_Selection& theAxis,
                            const ModelHighAPI_Double& theAngle);
 
FEATURESAPI_EXPORT
RevolutionPtr addRevolution(const std::shared_ptr<ModelAPI_Document>& thePart,
                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
                            const ModelHighAPI_Selection& theAxis,
                            const ModelHighAPI_Double& theToAngle,
                            const ModelHighAPI_Double& theFromAngle,
                            const std::string& theSelectionType = std::string());
 
FEATURESAPI_EXPORT
RevolutionPtr addRevolution(const std::shared_ptr<ModelAPI_Document>& thePart,
                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
                            const ModelHighAPI_Selection& theAxis,
                            const ModelHighAPI_Selection& theToObject,
                            const ModelHighAPI_Double& theToOffset,
                            const ModelHighAPI_Selection& theFromObject,
                            const ModelHighAPI_Double& theFromOffset,
                            const std::string& theSelectionType = std::string());
 
#endif // FeaturesAPI_Revolution_H_