FeaturesAPI_Scale.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_SCALE_H_
#define FEATURESAPI_SCALE_H_
 
#include "FeaturesAPI.h"
 
#include <FeaturesPlugin_Scale.h>
 
#include <ModelHighAPI_Double.h>
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
 
class ModelHighAPI_Dumper;
class ModelHighAPI_Selection;
 
class FeaturesAPI_Scale: public ModelHighAPI_Interface
{
public:
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Scale(const std::shared_ptr<ModelAPI_Feature>& theFeature);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Scale(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                             const std::list<ModelHighAPI_Selection>& theMainObjects,
                             const ModelHighAPI_Selection& theCenterPoint,
                             const ModelHighAPI_Double& theScaleFactor);
 
  FEATURESAPI_EXPORT
  explicit FeaturesAPI_Scale(const std::shared_ptr<ModelAPI_Feature>& theFeature,
                             const std::list<ModelHighAPI_Selection>& theMainObjects,
                             const ModelHighAPI_Selection& theCenterPoint,
                             const ModelHighAPI_Double& theScaleFactorX,
                             const ModelHighAPI_Double& theScaleFactorY,
                             const ModelHighAPI_Double& theScaleFactorZ);
 
  FEATURESAPI_EXPORT
  virtual ~FeaturesAPI_Scale();
 
  INTERFACE_7(FeaturesPlugin_Scale::ID(),
              creationMethod, FeaturesPlugin_Scale::CREATION_METHOD(),
              ModelAPI_AttributeString, ,
              mainObjects, FeaturesPlugin_Scale::OBJECTS_LIST_ID(),
              ModelAPI_AttributeSelectionList, ,
              centerPoint, FeaturesPlugin_Scale::CENTER_POINT_ID(),
              ModelAPI_AttributeSelection, ,
              scaleFactor, FeaturesPlugin_Scale::SCALE_FACTOR_ID(),
              ModelAPI_AttributeDouble, ,
              scaleFactorX, FeaturesPlugin_Scale::SCALE_FACTOR_X_ID(),
              ModelAPI_AttributeDouble, ,
              scaleFactorY, FeaturesPlugin_Scale::SCALE_FACTOR_Y_ID(),
              ModelAPI_AttributeDouble, ,
              scaleFactorZ, FeaturesPlugin_Scale::SCALE_FACTOR_Z_ID(),
              ModelAPI_AttributeDouble, )
 
  
  FEATURESAPI_EXPORT
  void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
 
  FEATURESAPI_EXPORT
  void setCenterPoint(const ModelHighAPI_Selection& theCenterPoint);
 
  FEATURESAPI_EXPORT
  void setScaleFactor(const ModelHighAPI_Double& theScaleFactor);
 
  FEATURESAPI_EXPORT
  void setDimensions(const ModelHighAPI_Double& theScaleFactorX,
                     const ModelHighAPI_Double& theScaleFactorY,
                     const ModelHighAPI_Double& theScaleFactorZ);
 
  FEATURESAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
};
 
typedef std::shared_ptr<FeaturesAPI_Scale> ScalePtr;
 
FEATURESAPI_EXPORT
ScalePtr addScale(const std::shared_ptr<ModelAPI_Document>& thePart,
                  const std::list<ModelHighAPI_Selection>& theMainObjects,
                  const ModelHighAPI_Selection& theCenterPoint,
                  const ModelHighAPI_Double& theScaleFactorX,
                  const ModelHighAPI_Double& theScaleFactorY = ModelHighAPI_Double(0.0),
                  const ModelHighAPI_Double& theScaleFactorZ = ModelHighAPI_Double(0.0),
                  const bool keepSubResults = false);
 
#endif // FEATURESAPI_SCALE_H_