src/SketchPlugin/SketchPlugin_SketchEntity.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SketchPlugin_SketchEntity_H_
  21 #define SketchPlugin_SketchEntity_H_
  22
  23 #include "SketchPlugin.h"
  24 #include "SketchPlugin_Feature.h"
  25
  26 #include <ModelAPI_CompositeFeature.h>
  27 #include <ModelAPI_Session.h>
  28 #include <GeomAPI_Shape.h>
  29 #include <GeomAPI_AISObject.h>
  30 #include <ModelAPI_Document.h>
  31 #include <ModelAPI_AttributeSelection.h>
  32 #include <ModelAPI_AttributeBoolean.h>
  33 #include <ModelAPI_AttributeIntArray.h>
  34 #include <GeomAPI_ICustomPrs.h>
  35
  36 #include <Config_PropManager.h>
  37
  38 /**\class SketchPlugin_SketchEntity
  39  * \ingroup Plugins
  40  * \brief Sketch Entity for creation of the new feature in PartSet.
  41  * This is an abstract class to give
  42  * an interface to create the entity features such as line, circle, arc and point.
  43  */
  44 class SketchPlugin_SketchEntity : public SketchPlugin_Feature, public GeomAPI_ICustomPrs
  45 {
  46  public:
  47   /// Reference to the construction type of the feature
  48   inline static const std::string& AUXILIARY_ID()
  49   {
  50     static const std::string MY_AUXILIARY_ID("Auxiliary");
  51     return MY_AUXILIARY_ID;
  52   }
  53
  54   /// Reference to the external edge or vertex as a AttributeSelection
  55   inline static const std::string& EXTERNAL_ID()
  56   {
  57     static const std::string MY_EXTERNAL_ID("External");
  58     return MY_EXTERNAL_ID;
  59   }
  60
  61   /// Reference to the copy type of the feature
  62   inline static const std::string& COPY_ID()
  63   {
  64     static const std::string MY_COPY_ID("Copy");
  65     return MY_COPY_ID;
  66   }
  67
  68   /// Width of the auxiliary line
  69   inline static const double SKETCH_LINE_WIDTH_AUXILIARY()
  70   {
  71     return 2;
  72   }
  73
  74   /// Width of the line
  75   inline static const double SKETCH_LINE_WIDTH()
  76   {
  77     return 3;
  78   }
  79
  80   /// Style of the auxiliary line
  81   inline static const int SKETCH_LINE_STYLE_AUXILIARY()
  82   {
  83     return  3;
  84   }
  85
  86   /// Style of the line
  87   inline static const int SKETCH_LINE_STYLE()
  88   {
  89     return  0;
  90   }
  91
  92   /// Request for initialization of data model of the feature: adding all attributes
  93   virtual void initAttributes();
  94
  95   /// Returns true of the feature is created basing on the external shape of not-this-sketch object
  96   virtual bool isExternal() const
  97   {
  98     AttributeSelectionPtr aAttr = data()->selection(EXTERNAL_ID());
  99     if (aAttr)
 100       return aAttr->context().get() != NULL && !aAttr->isInvalid();
 101     return false;
 102   }
 103
 104   /// Returns true of the feature is a copy of other feature
 105   virtual bool isCopy() const
 106   {
 107     AttributeBooleanPtr anAttr = data()->boolean(COPY_ID());
 108     if(anAttr.get()) {
 109       return anAttr->value();
 110     }
 111     return false;
 112   }
 113
 114 // LCOV_EXCL_START
 115   /// Customize presentation of the feature
 116   virtual bool customisePresentation(ResultPtr theResult, AISObjectPtr thePrs,
 117                                      std::shared_ptr<GeomAPI_ICustomPrs> theDefaultPrs)
 118   {
 119     /// Store previous color values of the presentation to check it after setting specific entity
 120     /// color. Default color is set into presentation to have not modified isCustomized state
 121     /// after default customize prs is completed.
 122     std::vector<int> aPrevColor;
 123     aPrevColor.resize(3);
 124     thePrs->getColor(aPrevColor[0], aPrevColor[1], aPrevColor[2]);
 125     if (theResult.get()) {
 126       std::string aSection, aName, aDefault;
 127       theResult->colorConfigInfo(aSection, aName, aDefault);
 128       std::vector<int> aColor;
 129       aColor = Config_PropManager::color(aSection, aName);
 130       thePrs->setColor(aColor[0], aColor[1], aColor[2]);
 131     }
 132
 133     bool isCustomized = theDefaultPrs.get() != NULL &&
 134                         theDefaultPrs->customisePresentation(theResult, thePrs, theDefaultPrs);
 135     int aShapeType = thePrs->getShapeType();
 136     // a compound is processed like the edge because the
 137     // arc feature uses the compound for presentable AIS
 138     if (aShapeType != 6/*an edge*/ && aShapeType != 7/*a vertex*/ && aShapeType != 0/*compound*/)
 139       return false;
 140
 141     // set color from preferences
 142     std::vector<int> aColor;
 143     std::shared_ptr<ModelAPI_AttributeBoolean> anAuxiliaryAttr =
 144                                     data()->boolean(SketchPlugin_SketchEntity::AUXILIARY_ID());
 145     bool isConstruction = anAuxiliaryAttr.get() != NULL && anAuxiliaryAttr->value();
 146     if (isConstruction) {
 147       aColor = Config_PropManager::color("Visualization", "sketch_auxiliary_color");
 148     }
 149     else if (isExternal()) {
 150       aColor = Config_PropManager::color("Visualization", "sketch_external_color");
 151     }
 152     else {
 153       aColor = Config_PropManager::color("Visualization", "sketch_entity_color");
 154     }
 155     if (!aColor.empty()) {
 156       if (theResult.get() && ModelAPI_Session::get()->isOperation()) {
 157         AttributeIntArrayPtr aColorAttr = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
 158         aColorAttr->setSize(3);
 159         // Set the color attribute in order do not use default colors in the perasentation object
 160         for (int i = 0; i < 3; i++)
 161           aColorAttr->setValue(i, aColor[i]);
 162       }
 163       thePrs->setColor(aColor[0], aColor[1], aColor[2]);
 164       for (int i = 0; i < 3 && !isCustomized; i++)
 165         isCustomized = aColor[i] != aPrevColor[i];
 166     }
 167
 168     if (aShapeType == 6 || aShapeType == 0) { // if this is an edge or a compound
 169       if (isConstruction) {
 170         isCustomized = thePrs->setWidth(SKETCH_LINE_WIDTH_AUXILIARY()) || isCustomized;
 171         isCustomized = thePrs->setLineStyle(SKETCH_LINE_STYLE_AUXILIARY()) || isCustomized;
 172       }
 173       else {
 174         isCustomized = thePrs->setWidth(SKETCH_LINE_WIDTH()) || isCustomized;
 175         isCustomized = thePrs->setLineStyle(SKETCH_LINE_STYLE()) || isCustomized;
 176       }
 177     }
 178     else if (aShapeType == 7) { // otherwise this is a vertex
 179       // The width value do not have effect on the point presentation.
 180       // It is defined in order to extend selection area of the object.
 181       thePrs->setWidth(17);
 182     //  thePrs->setPointMarker(1, 1.); // Set point as a '+' symbol
 183     }
 184     if(isCopy()) {
 185       double aWidth = thePrs->width();
 186       isCustomized = thePrs->setWidth(aWidth / 2.5) || isCustomized;
 187     }
 188
 189     if (!theResult.get()) {
 190       double aDeflection = Config_PropManager::real("Visualization", "construction_deflection");
 191       thePrs->setDeflection(aDeflection);
 192     }
 193     return isCustomized;
 194   }
 195 // LCOV_EXCL_STOP
 196
 197 protected:
 198   /// initializes mySketch
 199   SketchPlugin_SketchEntity();
 200
 201   /// \brief Initializes attributes of derived class.
 202   virtual void initDerivedClassAttributes(){};
 203
 204 };
 205
 206 #endif