ModelAPI_ResultBody.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 ModelAPI_ResultBody_H_
#define ModelAPI_ResultBody_H_
 
#include "ModelAPI_Result.h"
#include <GeomAPI_Shape.h>
#include <GeomAPI_DataMapOfShapeShape.h>
#include <string>
#include <map>
#include <vector>
 
class ModelAPI_BodyBuilder;
class GeomAlgoAPI_MakeShape;
 
class ModelAPI_ResultBody : public ModelAPI_Result
{
public:
  enum ConnectedTopologyFlag {
    ConnectionNotComputed, 
    IsConnected,           
    IsNotConnected         
  };
 
protected:
  ConnectedTopologyFlag myConnect;
 
  ModelAPI_BodyBuilder* myBuilder; 
 
public:
  MODELAPI_EXPORT virtual ~ModelAPI_ResultBody();
 
  inline static const std::string& IMAGE_ID()
  {
    static const std::string MY_IMAGE_ID("Image");
    return MY_IMAGE_ID;
  }
 
  MODELAPI_EXPORT virtual std::string groupName();
 
  inline static std::string group()
  {
    static std::string MY_GROUP = "Bodies";
    return MY_GROUP;
  }
 
  inline static const std::string& DEFAULT_COLOR()
  {
    static const std::string RESULT_BODY_COLOR("200,200,230");
    return RESULT_BODY_COLOR;
  }
 
  inline static const std::string DEFAULT_DEFLECTION()
  {
    return "0.0001";
  }
 
  MODELAPI_EXPORT virtual int numberOfSubs(bool forTree = false) const = 0;
 
  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_ResultBody> subResult(
    const int theIndex, bool forTree = false) const = 0;
 
  MODELAPI_EXPORT virtual bool isSub(ObjectPtr theResult, int& theIndex) const = 0;
 
  MODELAPI_EXPORT virtual void store(const GeomShapePtr& theShape,
                                     const bool theIsStoreSameShapes = true);
 
  MODELAPI_EXPORT virtual void storeGenerated(const GeomShapePtr& theFromShape,
                                              const GeomShapePtr& theToShape);
 
  MODELAPI_EXPORT virtual void storeGenerated(
    const std::list<GeomShapePtr>& theFromShapes, const GeomShapePtr& theToShape,
    const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape);
 
  MODELAPI_EXPORT virtual void storeModified(const GeomShapePtr& theOldShape,
                                             const GeomShapePtr& theNewShape,
                                             const bool theIsCleanStored = true);
 
  MODELAPI_EXPORT virtual void storeModified(
    const std::list<GeomShapePtr>& theOldShapes, const GeomShapePtr& theNewShape,
    const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape);
 
  MODELAPI_EXPORT virtual GeomShapePtr shape();
 
  MODELAPI_EXPORT virtual bool generated(const GeomShapePtr& theNewShape,
    const std::string& theName, const bool theCheckIsInResult = true) = 0;
 
  MODELAPI_EXPORT virtual void generated(const GeomShapePtr& theOldShape,
                                         const GeomShapePtr& theNewShape,
                                         const std::string& theName = "");
 
  MODELAPI_EXPORT virtual void modified(const GeomShapePtr& theOldShape,
                                        const GeomShapePtr& theNewShape,
                                        const std::string& theName = "");
 
  MODELAPI_EXPORT
  virtual void loadDeletedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
                                 const GeomShapePtr& theOldShape,
                                 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
                                 const GeomShapePtr& theShapesToExclude = GeomShapePtr());
 
  MODELAPI_EXPORT
  virtual void loadModifiedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
                                  const GeomShapePtr& theOldShape,
                                  const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
                                  const std::string& theName = "") = 0;
 
  MODELAPI_EXPORT
  virtual void loadGeneratedShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape>& theAlgo,
                                   const GeomShapePtr& theOldShape,
                                   const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
                                   const std::string& theName = "",
                                   const bool theSaveOldIfNotInTree = false) = 0;
 
  MODELAPI_EXPORT virtual void loadFirstLevel(GeomShapePtr theShape,
                                              const std::string& theName) = 0;
 
  MODELAPI_EXPORT virtual bool isConnectedTopology() = 0;
 
  MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
 
  MODELAPI_EXPORT virtual void updateSubs(const GeomShapePtr& theThisShape,
    const bool theShapeChanged = true) = 0;
 
  MODELAPI_EXPORT virtual void updateSubs(
    const GeomShapePtr& theThisShape, const std::list<GeomShapePtr>& theOlds,
    const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape, const bool isGenerated) = 0;
 
  MODELAPI_EXPORT virtual void cleanCash() = 0;
 
  MODELAPI_EXPORT virtual std::wstring addShapeName
                              (std::shared_ptr<GeomAPI_Shape> theShape,
                               const std::wstring&            theName) = 0;
 
  MODELAPI_EXPORT virtual void addShapeColor
                              (const std::wstring& theName,
                               std::vector<int>&   theColor) = 0;
 
  MODELAPI_EXPORT virtual void setSubShapeColor(const std::shared_ptr<ModelAPI_Result> theResult,
    const std::shared_ptr<GeomAPI_Shape> theShape,
    const std::vector<int>& theColor) = 0;
 
  MODELAPI_EXPORT virtual void getSubShapeColor(const std::shared_ptr<ModelAPI_Result> theResult,
    const std::shared_ptr<GeomAPI_Shape> theShape,
    std::vector<int>& theColor) = 0;
 
  MODELAPI_EXPORT virtual void getColoredSubShapes(const std::shared_ptr<ModelAPI_Result> theResult,
    std::map<std::shared_ptr<GeomAPI_Shape>, std::vector<int>>& theColoredShapes) = 0;
 
  MODELAPI_EXPORT virtual void removeSubShapeColors(const std::shared_ptr<ModelAPI_Result> theResult) = 0;
 
  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection> selection() = 0;
 
  MODELAPI_EXPORT virtual void setShapeName
                          (std::map< std::wstring, std::shared_ptr<GeomAPI_Shape> > &theShapeName,
                           std::map< std::wstring, std::vector<int>> & theColorsShape) = 0;
 
  MODELAPI_EXPORT virtual void clearShapeNameAndColor() = 0;
 
  MODELAPI_EXPORT virtual std::wstring findShapeName(std::shared_ptr<GeomAPI_Shape> theShape) = 0;
 
  MODELAPI_EXPORT virtual const std::vector<int>& findShapeColor(
    const std::wstring& theShapeName) = 0;
 
  MODELAPI_EXPORT virtual void setSubShapeColorIfAny(const std::shared_ptr<ModelAPI_Result> theResult,
                                                     const std::shared_ptr<GeomAPI_Shape> theShape) = 0;
 
 
protected:
  MODELAPI_EXPORT ModelAPI_ResultBody();
 
};
 
typedef std::shared_ptr<ModelAPI_ResultBody> ResultBodyPtr;
 
#endif