tui/SHAPER/FeaturesAPI__RevolutionBoolean_8h_source.html

// 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_RevolutionBoolean_H_

#define FeaturesAPI_RevolutionBoolean_H_


#include "FeaturesAPI.h"


#include <FeaturesPlugin_CompositeBoolean.h>

#include <FeaturesPlugin_RevolutionCut.h>

#include <FeaturesPlugin_RevolutionFuse.h>


#include <ModelHighAPI_Interface.h>

#include <ModelHighAPI_Macro.h>


class ModelHighAPI_Double;

class ModelHighAPI_Dumper;

class ModelHighAPI_Reference;

class ModelHighAPI_Selection;


class FeaturesAPI_RevolutionBoolean: public ModelHighAPI_Interface

{

public:

  FEATURESAPI_EXPORT

  virtual ~FeaturesAPI_RevolutionBoolean();


  INTERFACE_11("",

               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, ,

               booleanObjects, FeaturesPlugin_CompositeBoolean::OBJECTS_ID(),

               ModelAPI_AttributeSelectionList, )


  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

  void setBooleanObjects(const std::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  virtual void dump(ModelHighAPI_Dumper& theDumper) const;


protected:

  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionBoolean(const std::shared_ptr<ModelAPI_Feature>& theFeature);


private:

  void execIfBaseNotEmpty();

};


class FeaturesAPI_RevolutionCut: public FeaturesAPI_RevolutionBoolean

{

public:


  static std::string ID() { return FeaturesPlugin_RevolutionCut::ID(); }

  virtual std::string getID() { return ID(); }


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionCut(const std::shared_ptr<ModelAPI_Feature>& theFeature);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionCut(const std::shared_ptr<ModelAPI_Feature>& theFeature,

                                     const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                     const ModelHighAPI_Selection& theAxis,

                                     const std::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionCut(const std::shared_ptr<ModelAPI_Feature>& theFeature,

                                     const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                     const ModelHighAPI_Selection& theAxis,

                                     const ModelHighAPI_Double& theAngle,

                                     const std::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionCut(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::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionCut(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::list<ModelHighAPI_Selection>& theBooleanObjects);

};


typedef std::shared_ptr<FeaturesAPI_RevolutionCut> RevolutionCutPtr;


FEATURESAPI_EXPORT

RevolutionCutPtr addRevolutionCut(const std::shared_ptr<ModelAPI_Document>& thePart,

                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                  const ModelHighAPI_Selection& theAxis,

                                  const std::list<ModelHighAPI_Selection>& theBooleanObjects);


FEATURESAPI_EXPORT

RevolutionCutPtr addRevolutionCut(const std::shared_ptr<ModelAPI_Document>& thePart,

                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                  const ModelHighAPI_Selection& theAxis,

                                  const ModelHighAPI_Double& theAngle,

                                  const std::list<ModelHighAPI_Selection>& theBooleanObjects);


FEATURESAPI_EXPORT

RevolutionCutPtr addRevolutionCut(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::list<ModelHighAPI_Selection>& theBooleanObjects);


FEATURESAPI_EXPORT

RevolutionCutPtr addRevolutionCut(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::list<ModelHighAPI_Selection>& theBooleanObjects);


class FeaturesAPI_RevolutionFuse: public FeaturesAPI_RevolutionBoolean

{

public:


  static std::string ID() { return FeaturesPlugin_RevolutionFuse::ID(); }

  virtual std::string getID() { return ID(); }


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,

                                      const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                      const ModelHighAPI_Selection& theAxis,

                                      const std::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,

                                      const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                      const ModelHighAPI_Selection& theAxis,

                                      const ModelHighAPI_Double& theAngle,

                                      const std::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionFuse(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::list<ModelHighAPI_Selection>& theBooleanObjects);


  FEATURESAPI_EXPORT

  explicit FeaturesAPI_RevolutionFuse(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::list<ModelHighAPI_Selection>& theBooleanObjects);

};


typedef std::shared_ptr<FeaturesAPI_RevolutionFuse> RevolutionFusePtr;


FEATURESAPI_EXPORT

RevolutionFusePtr addRevolutionFuse(const std::shared_ptr<ModelAPI_Document>& thePart,

                                    const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                    const ModelHighAPI_Selection& theAxis,

                                    const std::list<ModelHighAPI_Selection>& theBooleanObjects);


FEATURESAPI_EXPORT

RevolutionFusePtr addRevolutionFuse(const std::shared_ptr<ModelAPI_Document>& thePart,

                                    const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                    const ModelHighAPI_Selection& theAxis,

                                    const ModelHighAPI_Double& theAngle,

                                    const std::list<ModelHighAPI_Selection>& theBooleanObjects);


FEATURESAPI_EXPORT

RevolutionFusePtr addRevolutionFuse(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::list<ModelHighAPI_Selection>& theBooleanObjects);


FEATURESAPI_EXPORT

RevolutionFusePtr addRevolutionFuse(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::list<ModelHighAPI_Selection>& theBooleanObjects);


#endif // FeaturesAPI_RevolutionBoolean_H_

FeaturesAPI_RevolutionBoolean
Interface for RevolutionBoolean feature.
Definition: FeaturesAPI_RevolutionBoolean.h:41

FeaturesAPI_RevolutionBoolean::setAngles
void setAngles(const ModelHighAPI_Double &theToAngle, const ModelHighAPI_Double &theFromAngle)
Modify CreationMethod, to_angle, from_angle attributes of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:78

FeaturesAPI_RevolutionBoolean::fromObject
virtual std::shared_ptr< ModelAPI_AttributeSelection > fromObject() const
From object.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::booleanObjects
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > booleanObjects() const
Boolean objects.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::toAngle
virtual std::shared_ptr< ModelAPI_AttributeDouble > toAngle() const
To angle.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::sketch
virtual std::shared_ptr< ModelAPI_AttributeReference > sketch() const
Sketch launcher.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::setAngle
void setAngle(const ModelHighAPI_Double &theAngle)
Modify creation_method, to_angle, from_angle attributes of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:89

FeaturesAPI_RevolutionBoolean::setBooleanObjects
void setBooleanObjects(const std::list< ModelHighAPI_Selection > &theBooleanObjects)
Modiyfy main_objects attribute of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:110

FeaturesAPI_RevolutionBoolean::toOffset
virtual std::shared_ptr< ModelAPI_AttributeDouble > toOffset() const
To offset.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::setAxis
void setAxis(const ModelHighAPI_Selection &theAxis)
Modify axis_object attribute of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:70

FeaturesAPI_RevolutionBoolean::setNestedSketch
void setNestedSketch(const ModelHighAPI_Reference &theSketch)
Modify base attribute of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:40

FeaturesAPI_RevolutionBoolean::fromOffset
virtual std::shared_ptr< ModelAPI_AttributeDouble > fromOffset() const
From offset.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::setBase
void setBase(const std::list< ModelHighAPI_Selection > &theBaseObjects)
Modify base attribute of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:60

FeaturesAPI_RevolutionBoolean::fromAngle
virtual std::shared_ptr< ModelAPI_AttributeDouble > fromAngle() const
From angle.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::setPlanesAndOffsets
void setPlanesAndOffsets(const ModelHighAPI_Selection &theToObject, const ModelHighAPI_Double &theToOffset, const ModelHighAPI_Selection &theFromObject, const ModelHighAPI_Double &theFromOffset)
Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:95

FeaturesAPI_RevolutionBoolean::~FeaturesAPI_RevolutionBoolean
virtual ~FeaturesAPI_RevolutionBoolean()
Destructor.
Definition: FeaturesAPI_RevolutionBoolean.cpp:35

FeaturesAPI_RevolutionBoolean::creationMethod
virtual std::shared_ptr< ModelAPI_AttributeString > creationMethod() const
Creation method.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::toObject
virtual std::shared_ptr< ModelAPI_AttributeSelection > toObject() const
To object.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::dump
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:119

FeaturesAPI_RevolutionBoolean::baseObjects
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > baseObjects() const
Base objects.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionBoolean::axis
virtual std::shared_ptr< ModelAPI_AttributeSelection > axis() const
Axis.
Definition: FeaturesAPI_RevolutionBoolean.h:69

FeaturesAPI_RevolutionCut
Interface for RevolutionCut feature.
Definition: FeaturesAPI_RevolutionBoolean.h:120

FeaturesAPI_RevolutionFuse
Interface for RevolutionFuse feature.
Definition: FeaturesAPI_RevolutionBoolean.h:212

FeaturesPlugin_CompositeBoolean::OBJECTS_ID
static const std::string & OBJECTS_ID()
Attribute name of main objects.
Definition: FeaturesPlugin_CompositeBoolean.h:44

FeaturesPlugin_CompositeSketch::BASE_OBJECTS_ID
static const std::string & BASE_OBJECTS_ID()
Attribute name of base objects.
Definition: FeaturesPlugin_CompositeSketch.h:43

FeaturesPlugin_CompositeSketch::SKETCH_ID
static const std::string & SKETCH_ID()
Attribute name of sketch feature.
Definition: FeaturesPlugin_CompositeSketch.h:36

FeaturesPlugin_RevolutionCut::ID
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_RevolutionCut.h:36

FeaturesPlugin_RevolutionFuse::ID
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_RevolutionFuse.h:36

FeaturesPlugin_Revolution::FROM_ANGLE_ID
static const std::string & FROM_ANGLE_ID()
Attribute name of revolution from angle.
Definition: FeaturesPlugin_Revolution.h:87

FeaturesPlugin_Revolution::TO_ANGLE_ID
static const std::string & TO_ANGLE_ID()
Attribute name of revolution to angle.
Definition: FeaturesPlugin_Revolution.h:80

FeaturesPlugin_Revolution::TO_OFFSET_ID
static const std::string & TO_OFFSET_ID()
Attribute name of revolution offset.
Definition: FeaturesPlugin_Revolution.h:101

FeaturesPlugin_Revolution::FROM_OFFSET_ID
static const std::string & FROM_OFFSET_ID()
Attribute name of revolution offset.
Definition: FeaturesPlugin_Revolution.h:115

FeaturesPlugin_Revolution::AXIS_OBJECT_ID
static const std::string & AXIS_OBJECT_ID()
Attribute name of an revolution axis.
Definition: FeaturesPlugin_Revolution.h:73

FeaturesPlugin_Revolution::TO_OBJECT_ID
static const std::string & TO_OBJECT_ID()
Attribute name of an object to which the revolution grows.
Definition: FeaturesPlugin_Revolution.h:94

FeaturesPlugin_Revolution::CREATION_METHOD
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_Revolution.h:45

FeaturesPlugin_Revolution::FROM_OBJECT_ID
static const std::string & FROM_OBJECT_ID()
Attribute name of an object from which the revolution grows.
Definition: FeaturesPlugin_Revolution.h:108

ModelAPI_AttributeDouble
Attribute that contains real value with double precision.
Definition: ModelAPI_AttributeDouble.h:34

ModelAPI_AttributeReference
Attribute that contains reference to feature (located in the same document).
Definition: ModelAPI_AttributeReference.h:32

ModelAPI_AttributeSelectionList
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37

ModelAPI_AttributeSelection
Attribute that contains reference to the sub-shape of some result, the selected shape.
Definition: ModelAPI_AttributeSelection.h:35

ModelAPI_AttributeString
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33

ModelAPI_Feature
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:41

ModelHighAPI_Double
Class for filling ModelAPI_AttributeDouble.
Definition: ModelHighAPI_Double.h:37

ModelHighAPI_Dumper
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81

ModelHighAPI_Interface
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:46

ModelHighAPI_Reference
Class for filling ModelAPI_AttributeReference.
Definition: ModelHighAPI_Reference.h:41

ModelHighAPI_Selection
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49

addRevolutionCut
RevolutionCutPtr addRevolutionCut(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &theAxis, const std::list< ModelHighAPI_Selection > &theBooleanObjects)
Create RevolutionCut feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:268

addRevolutionFuse
RevolutionFusePtr addRevolutionFuse(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &theAxis, const std::list< ModelHighAPI_Selection > &theBooleanObjects)
Create RevolutionFuse feature.
Definition: FeaturesAPI_RevolutionBoolean.cpp:421