FeaturesAPI_Placement.h

// Copyright (C) 2014-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_Placement_H_
#define FeaturesAPI_Placement_H_
 
#include "FeaturesAPI.h"
 
#include <FeaturesPlugin_Placement.h>
 
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Dumper;
class ModelHighAPI_Selection;
 
class FeaturesAPI_Placement: public ModelHighAPI_Interface
{
public:
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Placement(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  FEATURESAPI_EXPORT
  FeaturesAPI_Placement(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                        const std::list<ModelHighAPI_Selection>& theObjects,
                        const ModelHighAPI_Selection& theStartShape,
                        const ModelHighAPI_Selection& theEndShape,
                        const bool theReverseDirection = false,
                        const bool theCentering = false);
 
  FEATURESAPI_EXPORT
  virtual ~FeaturesAPI_Placement();
 
  INTERFACE_5(FeaturesPlugin_Placement::ID(),
              objects, FeaturesPlugin_Placement::OBJECTS_LIST_ID(),
              ModelAPI_AttributeSelectionList, ,
              startShape, FeaturesPlugin_Placement::START_SHAPE_ID(),
              ModelAPI_AttributeSelection, ,
              endShape, FeaturesPlugin_Placement::END_SHAPE_ID(),
              ModelAPI_AttributeSelection, ,
              reverseDirection, FeaturesPlugin_Placement::REVERSE_ID(),
              ModelAPI_AttributeBoolean, ,
              centering, FeaturesPlugin_Placement::CENTERING_ID(),
              ModelAPI_AttributeBoolean, )
 
  
  FEATURESAPI_EXPORT
  void setObjects(const std::list<ModelHighAPI_Selection>& theObjects);
 
  FEATURESAPI_EXPORT
  void setStartShape(const ModelHighAPI_Selection& theStartShape);
 
  FEATURESAPI_EXPORT
  void setEndShape(const ModelHighAPI_Selection& theEndShape);
 
  FEATURESAPI_EXPORT
  void setReverseDirection(const bool theReverseDirection);
 
  FEATURESAPI_EXPORT
  void setCentering(const bool theCentering);
 
  FEATURESAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<FeaturesAPI_Placement> PlacementPtr;
 
FEATURESAPI_EXPORT
PlacementPtr addPlacement(const std::shared_ptr<ModelAPI_Document>& thePart,
                          const std::list<ModelHighAPI_Selection>& theObjects,
                          const ModelHighAPI_Selection& theStartShape,
                          const ModelHighAPI_Selection& theEndShape,
                          const bool reverse = false,
                          const bool centering = false,
                          const bool keepSubResults = false);
 
#endif // FeaturesAPI_Placement_H_