Salome HOME
Merge with Dev_1.5.0
[modules/shaper.git] / src / ModelAPI / ModelAPI_ResultPart.h
index 2f6feb5e5bae06a44166cd607656b943661ee65d..1d66dba1885b03b0d1e751aa403a26abd721de7d 100644 (file)
@@ -1,11 +1,14 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_ResultPart.h
 // Created:     07 Jul 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef ModelAPI_ResultPart_HeaderFile
-#define ModelAPI_ResultPart_HeaderFile
+#ifndef ModelAPI_ResultPart_H_
+#define ModelAPI_ResultPart_H_
 
 #include "ModelAPI_Result.h"
+#include <GeomAPI_Trsf.h>
 
 #include <string>
 
  */
 class ModelAPI_ResultPart : public ModelAPI_Result
 {
-public:
+ public:
   /// Returns the group identifier of this result
-  virtual std::string groupName()
-    { return group(); }
+  MODELAPI_EXPORT virtual std::string groupName();
 
   /// Returns the group identifier of this result
-  static std::string group()
-    {static std::string MY_GROUP = "Parts"; return MY_GROUP;}
+  inline static std::string group()
+  {
+    static std::string MY_GROUP = "Parts";
+    return MY_GROUP;
+  }
 
   /// part document reference attribute
   inline static const std::string& DOC_REF()
@@ -34,11 +39,51 @@ public:
     return MY_DOC_REF;
   }
 
+  /// default color for a result body
+  inline static const std::string& DEFAULT_COLOR()
+  {
+    static const std::string RESULT_BODY_COLOR("96,157,255");
+    return RESULT_BODY_COLOR;
+  }
+
+  // Part result can not be cencealed, even by the movement features
+  MODELAPI_EXPORT virtual bool isConcealed();
+
   /// Returns the part-document of this result
-  virtual boost::shared_ptr<ModelAPI_Document> partDoc() = 0;
+  virtual std::shared_ptr<ModelAPI_Document> partDoc() = 0;
+
+  /// Returns the original part result: for transfomration features results this is 
+  /// the original Part feature result
+  virtual std::shared_ptr<ModelAPI_ResultPart> original() = 0;
+
+  /// Sets this document as current and if it is not loaded yet, loads it
+  virtual void activate() = 0;
+
+  /// Returns true if document is activated (loaded into the memory)
+  virtual bool isActivated() = 0;
+
+  /// Returns the name of the shape inside of the part
+  virtual std::string nameInPart(const std::shared_ptr<GeomAPI_Shape>& theShape,
+    int& theIndex) = 0;
+  /// Updates the selection inside of the part by the selection index
+  virtual bool updateInPart(const int theIndex) = 0;
+
+  /// Applies the additional transformation of the part
+  virtual void setTrsf(std::shared_ptr<ModelAPI_Result> theThis, 
+    const std::shared_ptr<GeomAPI_Trsf>& theTransformation) = 0;
+
+  /// Returns the shape by the name in the part
+  virtual std::shared_ptr<GeomAPI_Shape> shapeInPart(
+    const std::string& theName, const std::string& theType, int& theIndex) = 0;
+
+  /// Returns the shape selected in the selection index
+  virtual std::shared_ptr<GeomAPI_Shape> selectionValue(const int theIndex) = 0;
+
+  /// Updates the shape-result of the part (called on Part feature execution)
+  virtual void updateShape() = 0;
 };
 
 //! Pointer on feature object
-typedef boost::shared_ptr<ModelAPI_ResultPart> ResultPartPtr;
+typedef std::shared_ptr<ModelAPI_ResultPart> ResultPartPtr;
 
 #endif