tui/SHAPER/FeaturesAPI__Extrusion_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_Extrusion_H_

#define FeaturesAPI_Extrusion_H_


#include "FeaturesAPI.h"


#include <FeaturesPlugin_Extrusion.h>


#include <ModelHighAPI_Interface.h>

#include <ModelHighAPI_Macro.h>


class ModelHighAPI_Double;

class ModelHighAPI_Reference;

class ModelHighAPI_Selection;


class FeaturesAPI_Extrusion: public ModelHighAPI_Interface

{

public:

  FEATURESAPI_EXPORT

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


  FEATURESAPI_EXPORT

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

                                 const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                 const ModelHighAPI_Double& theSize);


  FEATURESAPI_EXPORT

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

                                 const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                 const ModelHighAPI_Selection& theDirection,

                                 const ModelHighAPI_Double& theSize);

  FEATURESAPI_EXPORT

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

                                 const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                 const ModelHighAPI_Double& theToSize,

                                 const ModelHighAPI_Double& theFromSize);


  FEATURESAPI_EXPORT

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

                                 const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                 const ModelHighAPI_Selection& theDirection,

                                 const ModelHighAPI_Double& theToSize,

                                 const ModelHighAPI_Double& theFromSize,

                                 const std::string& theSelectionType = std::string());


  FEATURESAPI_EXPORT

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

                                 const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                 const ModelHighAPI_Selection& theToObject,

                                 const ModelHighAPI_Double& theToOffset,

                                 const ModelHighAPI_Selection& theFromObject,

                                 const ModelHighAPI_Double& theFromOffset);


  FEATURESAPI_EXPORT

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

                                 const std::list<ModelHighAPI_Selection>& theBaseObjects,

                                 const ModelHighAPI_Selection& theDirection,

                                 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_Extrusion();


  INTERFACE_10(FeaturesPlugin_Extrusion::ID(),

               sketch, FeaturesPlugin_Extrusion::SKETCH_ID(),

               ModelAPI_AttributeReference, ,

               baseObjects, FeaturesPlugin_Extrusion::BASE_OBJECTS_ID(),

               ModelAPI_AttributeSelectionList, ,

               direction, FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID(),

               ModelAPI_AttributeSelection, ,

               creationMethod, FeaturesPlugin_Extrusion::CREATION_METHOD(),

               ModelAPI_AttributeString, ,

               toSize, FeaturesPlugin_Extrusion::TO_SIZE_ID(),

               ModelAPI_AttributeDouble, ,

               fromSize, FeaturesPlugin_Extrusion::FROM_SIZE_ID(),

               ModelAPI_AttributeDouble, ,

               toObject, FeaturesPlugin_Extrusion::TO_OBJECT_ID(),

               ModelAPI_AttributeSelection, ,

               toOffset, FeaturesPlugin_Extrusion::TO_OFFSET_ID(),

               ModelAPI_AttributeDouble, ,

               fromObject, FeaturesPlugin_Extrusion::FROM_OBJECT_ID(),

               ModelAPI_AttributeSelection, ,

               fromOffset, FeaturesPlugin_Extrusion::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 setDirection(const ModelHighAPI_Selection& theDirection);


  FEATURESAPI_EXPORT

  void setSizes(const ModelHighAPI_Double& theToSize,

                const ModelHighAPI_Double& theFromSize);


  FEATURESAPI_EXPORT

  void setSize(const ModelHighAPI_Double& theSize);


  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_Extrusion> ExtrusionPtr;


FEATURESAPI_EXPORT

ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,

                          const std::list<ModelHighAPI_Selection>& theBaseObjects,

                          const ModelHighAPI_Double& theSize);


FEATURESAPI_EXPORT

ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,

                          const std::list<ModelHighAPI_Selection>& theBaseObjects,

                          const ModelHighAPI_Selection& theDirection,

                          const ModelHighAPI_Double& theSize);


FEATURESAPI_EXPORT

ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,

                          const std::list<ModelHighAPI_Selection>& theBaseObjects,

                          const ModelHighAPI_Double& theToSize,

                          const ModelHighAPI_Double& theFromSize);


FEATURESAPI_EXPORT

ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,

                          const std::list<ModelHighAPI_Selection>& theBaseObjects,

                          const ModelHighAPI_Selection& theDirection,

                          const ModelHighAPI_Double& theToSize,

                          const ModelHighAPI_Double& theFromSize,

                          const std::string& theSelectionType = std::string());


FEATURESAPI_EXPORT

ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,

                          const std::list<ModelHighAPI_Selection>& theBaseObjects,

                          const ModelHighAPI_Selection& theToObject,

                          const ModelHighAPI_Double& theToOffset,

                          const ModelHighAPI_Selection& theFromObject,

                          const ModelHighAPI_Double& theFromOffset);


FEATURESAPI_EXPORT

ExtrusionPtr addExtrusion(const std::shared_ptr<ModelAPI_Document>& thePart,

                          const std::list<ModelHighAPI_Selection>& theBaseObjects,

                          const ModelHighAPI_Selection& theDirection,

                          const ModelHighAPI_Selection& theToObject,

                          const ModelHighAPI_Double& theToOffset,

                          const ModelHighAPI_Selection& theFromObject,

                          const ModelHighAPI_Double& theFromOffset,

                          const std::string& theSelectionType = std::string());


#endif // FeaturesAPI_Extrusion_H_

FeaturesAPI_Extrusion
Interface for Extrusion feature.
Definition: FeaturesAPI_Extrusion.h:38

FeaturesAPI_Extrusion::setSizes
void setSizes(const ModelHighAPI_Double &theToSize, const ModelHighAPI_Double &theFromSize)
Modify CreationMethod, to_size, from_size attributes of the feature.
Definition: FeaturesAPI_Extrusion.cpp:170

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

FeaturesAPI_Extrusion::~FeaturesAPI_Extrusion
virtual ~FeaturesAPI_Extrusion()
Destructor.
Definition: FeaturesAPI_Extrusion.cpp:127

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

FeaturesAPI_Extrusion::direction
virtual std::shared_ptr< ModelAPI_AttributeSelection > direction() const
Direction.
Definition: FeaturesAPI_Extrusion.h:116

FeaturesAPI_Extrusion::toSize
virtual std::shared_ptr< ModelAPI_AttributeDouble > toSize() const
To size.
Definition: FeaturesAPI_Extrusion.h:116

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

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

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

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

FeaturesAPI_Extrusion::setDirection
void setDirection(const ModelHighAPI_Selection &theDirection)
Modify direction_object attribute of the feature.
Definition: FeaturesAPI_Extrusion.cpp:162

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

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

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

FeaturesAPI_Extrusion::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_Extrusion.cpp:187

FeaturesAPI_Extrusion::setSize
void setSize(const ModelHighAPI_Double &theSize)
Modify creation_method, to_size, from_size attributes of the feature.
Definition: FeaturesAPI_Extrusion.cpp:181

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

FeaturesAPI_Extrusion::fromSize
virtual std::shared_ptr< ModelAPI_AttributeDouble > fromSize() const
From size.
Definition: FeaturesAPI_Extrusion.h:116

FeaturesAPI_Extrusion::FeaturesAPI_Extrusion
FeaturesAPI_Extrusion(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_Extrusion.cpp:28

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_Extrusion::CREATION_METHOD
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_Extrusion.h:50

FeaturesPlugin_Extrusion::FROM_SIZE_ID
static const std::string & FROM_SIZE_ID()
Attribute name of extrusion from size.
Definition: FeaturesPlugin_Extrusion.h:92

FeaturesPlugin_Extrusion::TO_OFFSET_ID
static const std::string & TO_OFFSET_ID()
Attribute name of extrusion offset.
Definition: FeaturesPlugin_Extrusion.h:106

FeaturesPlugin_Extrusion::DIRECTION_OBJECT_ID
static const std::string & DIRECTION_OBJECT_ID()
Attribute name of an object to which the extrusion grows.
Definition: FeaturesPlugin_Extrusion.h:78

FeaturesPlugin_Extrusion::FROM_OBJECT_ID
static const std::string & FROM_OBJECT_ID()
Attribute name of an object from which the extrusion grows.
Definition: FeaturesPlugin_Extrusion.h:113

FeaturesPlugin_Extrusion::FROM_OFFSET_ID
static const std::string & FROM_OFFSET_ID()
Attribute name of extrusion offset.
Definition: FeaturesPlugin_Extrusion.h:120

FeaturesPlugin_Extrusion::ID
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_Extrusion.h:43

FeaturesPlugin_Extrusion::TO_SIZE_ID
static const std::string & TO_SIZE_ID()
Attribute name of extrusion to size.
Definition: FeaturesPlugin_Extrusion.h:85

FeaturesPlugin_Extrusion::TO_OBJECT_ID
static const std::string & TO_OBJECT_ID()
Attribute name of an object to which the extrusion grows.
Definition: FeaturesPlugin_Extrusion.h:99

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_Document
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:53

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

addExtrusion
ExtrusionPtr addExtrusion(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Double &theSize)
Create Extrusion feature.
Definition: FeaturesAPI_Extrusion.cpp:265