Salome HOME
Adjust TestImportXAOMem test case to check names of ImportXAOMem feature and result
[modules/shaper.git] / src / ModelAPI / ModelAPI_ResultConstruction.h
index b132572b8d063e77a81bbaad2f037b06c8dbc697..75593bdeac3b1d5dde129e10ee406584c6e051a2 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModelAPI_ResultConstruction.h
-// Created:     07 Jul 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2023  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_ResultConstruction_H_
 #define ModelAPI_ResultConstruction_H_
@@ -40,6 +53,13 @@ class ModelAPI_ResultConstruction : public ModelAPI_Result
     return RESULT_CONSTRUCTION_COLOR;
   }
 
+  /// default color for a result construction
+  inline static const std::string& RESULT_COLOR_NAME()
+  {
+    static const std::string COLOR_NAME("result_construction_color");
+    return COLOR_NAME;
+  }
+
   /// default deflection for a result construction
   inline static const std::string DEFAULT_DEFLECTION()
   {
@@ -49,13 +69,20 @@ class ModelAPI_ResultConstruction : public ModelAPI_Result
   /// Sets the result
   virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape) = 0;
 
+  /// Updates the shape taking the current value from the data structure, returns true
+  /// if update has been correctly done
+  virtual bool updateShape() = 0;
+
   /// Sets the flag that it must be displayed in history (default is true)
   virtual void setIsInHistory(const bool isInHistory) = 0;
 
   /// if the construction result may be used as faces, this method returns not zero number of faces
-  virtual int facesNum() = 0;
+  /// \param theUpdateNaming is false of keeping the naming structure untouched (on load)
+  virtual int facesNum(const bool theUpdateNaming = true) = 0;
   /// if the construction result may be used as faces, this method returns face by zero based index
   virtual std::shared_ptr<GeomAPI_Face> face(const int theIndex) = 0;
+  /// Change the order of faces
+  virtual void setFacesOrder(const std::list<std::shared_ptr<GeomAPI_Face> >& theFaces) = 0;
 
   /// By default object is not infinite.
   virtual bool isInfinite() = 0;