BuildAPI_Interpolation.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 BuildAPI_Interpolation_H_
#define BuildAPI_Interpolation_H_
 
#include "BuildAPI.h"
 
#include <BuildPlugin_Interpolation.h>
 
#include <ModelHighAPI_Double.h>
#include <ModelHighAPI_Integer.h>
#include <ModelHighAPI_Interface.h>
#include <ModelHighAPI_Macro.h>
#include <ModelHighAPI_Selection.h>
 
class ModelHighAPI_Selection;
 
class BuildAPI_Interpolation : public ModelHighAPI_Interface
{
public:
  BUILDAPI_EXPORT
    explicit BuildAPI_Interpolation(const FeaturePtr& theFeature);
 
  BUILDAPI_EXPORT
    explicit BuildAPI_Interpolation(const FeaturePtr& theFeature,
                                    const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                    const ModelHighAPI_Selection& theStartTangent,
                                    const ModelHighAPI_Selection& theEndTangent,
                                    const bool theIsClosed, const bool theIsToReorder);
 
  BUILDAPI_EXPORT
    explicit BuildAPI_Interpolation(const FeaturePtr& theFeature,
                                    const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                    const bool theIsClosed, const bool theIsToReorder);
 
  BUILDAPI_EXPORT
    explicit BuildAPI_Interpolation(const FeaturePtr& theFeature,
                                    const std::string & theXTexpression,
                                    const std::string & theYTexpression,
                                    const std::string & theZTexpression,
                                    const ModelHighAPI_Double& theMinT,
                                    const ModelHighAPI_Double& theMaxT,
                                    const ModelHighAPI_Integer& theNbStep);
 
  BUILDAPI_EXPORT
  virtual ~BuildAPI_Interpolation();
 
  INTERFACE_13(BuildPlugin_Interpolation::ID(),
              baseObjects, BuildPlugin_Interpolation::BASE_OBJECTS_ID(),
              ModelAPI_AttributeSelectionList, ,
              closed, BuildPlugin_Interpolation::CLOSED_ID(),
              ModelAPI_AttributeBoolean, ,
              reorder, BuildPlugin_Interpolation::REORDER_ID(),
              ModelAPI_AttributeBoolean, ,
              useTangents, BuildPlugin_Interpolation::USE_TANGENTS_ID(),
              ModelAPI_AttributeString, ,
              startTangent, BuildPlugin_Interpolation::TANGENT_START_ID(),
              ModelAPI_AttributeSelection, ,
              endTangent, BuildPlugin_Interpolation::TANGENT_END_ID(),
              ModelAPI_AttributeSelection, ,
              xt, BuildPlugin_Interpolation::XT_ID(),
              ModelAPI_AttributeString, ,
              yt, BuildPlugin_Interpolation::YT_ID(),
              ModelAPI_AttributeString, ,
              zt, BuildPlugin_Interpolation::ZT_ID(),
              ModelAPI_AttributeString, ,
              mint, BuildPlugin_Interpolation::MINT_ID(),
              ModelAPI_AttributeDouble, ,
              maxt, BuildPlugin_Interpolation::MAXT_ID(),
              ModelAPI_AttributeDouble, ,
              numstep, BuildPlugin_Interpolation::NUMSTEP_ID(),
              ModelAPI_AttributeInteger, ,
              creationmethod, BuildPlugin_Interpolation::CREATION_METHOD_ID(),
              ModelAPI_AttributeString, )
 
  
  BUILDAPI_EXPORT
  void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
 
  BUILDAPI_EXPORT void setClosed(const bool theIsClosed);
 
  BUILDAPI_EXPORT void setReorder(const bool theIsToReorder);
 
  BUILDAPI_EXPORT void setUseTangents(const bool theIsToUseTangents);
 
  BUILDAPI_EXPORT void setTangents(const ModelHighAPI_Selection& theStartTangent,
                                   const ModelHighAPI_Selection& theEndTangent);
 
  BUILDAPI_EXPORT
  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 
private:
  void execIfBaseNotEmpty();
};
 
typedef std::shared_ptr<BuildAPI_Interpolation> InterpolationPtr;
 
BUILDAPI_EXPORT
InterpolationPtr addInterpolation(const std::shared_ptr<ModelAPI_Document>& thePart,
                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                  const bool theIsClosed = false,
                                  const bool theIsToReorder = false);
 
BUILDAPI_EXPORT
InterpolationPtr addInterpolation(const std::shared_ptr<ModelAPI_Document>& thePart,
                                  const std::list<ModelHighAPI_Selection>& theBaseObjects,
                                  const ModelHighAPI_Selection& theStartTangent,
                                  const ModelHighAPI_Selection& theEndTangent,
                                  const bool theIsClosed = false,
                                  const bool theIsToReorder = false);
 
BUILDAPI_EXPORT
InterpolationPtr addInterpolation(const std::shared_ptr<ModelAPI_Document>& thePart,
                                  const std::string & theXTexpression,
                                  const std::string & theYTexpression,
                                  const std::string & theZTexpression,
                                  const ModelHighAPI_Double& theMinT,
                                  const ModelHighAPI_Double& theMaxT,
                                  const ModelHighAPI_Integer& theNbStep);
 
#endif // BuildAPI_Interpolation_H_