src/InitializationPlugin/InitializationPlugin_Plugin.cpp

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include <InitializationPlugin_Plugin.h>
  22
  23 #include <InitializationPlugin_EvalListener.h>
  24 #include <ModelAPI_Session.h>
  25 #include <ModelAPI_Document.h>
  26 #include <ModelAPI_AttributeBoolean.h>
  27 #include <ModelAPI_AttributeDouble.h>
  28 #include <ModelAPI_AttributeString.h>
  29 #include <ModelAPI_AttributeSelection.h>
  30 #include <ModelAPI_Events.h>
  31 #include <ModelAPI_Result.h>
  32
  33 #include <GeomDataAPI_Point.h>
  34
  35 #include <Events_Message.h>
  36 #include <Events_InfoMessage.h>
  37
  38 #include <memory>
  39
  40 // the only created instance of this plugin
  41 static InitializationPlugin_Plugin* MY_INITIALIZATIONPLUGIN_INSTANCE =
  42     new InitializationPlugin_Plugin();
  43
  44 InitializationPlugin_Plugin::InitializationPlugin_Plugin()
  45 {
  46   Events_Loop* aLoop = Events_Loop::loop();
  47   const Events_ID kDocCreatedEvent = ModelAPI_DocumentCreatedMessage::eventId();
  48   aLoop->registerListener(this, kDocCreatedEvent, NULL, true);
  49
  50   myEvalListener =
  51     std::shared_ptr<InitializationPlugin_EvalListener>(new InitializationPlugin_EvalListener());
  52 }
  53
  54 void InitializationPlugin_Plugin::processEvent(const std::shared_ptr<Events_Message>& theMessage)
  55 {
  56   const Events_ID kDocCreatedEvent = ModelAPI_DocumentCreatedMessage::eventId();
  57   if (theMessage->eventID() == kDocCreatedEvent) {
  58     std::shared_ptr<ModelAPI_DocumentCreatedMessage> aMessage = std::dynamic_pointer_cast<
  59         ModelAPI_DocumentCreatedMessage>(theMessage);
  60     DocumentPtr aDoc = aMessage->document();
  61
  62     /// Issue 431: for the current moment create planes only in the module document,
  63     /// Later if it is needed we may create special initial planes in Parts (may be different)
  64     if (aDoc != ModelAPI_Session::get()->moduleDocument())
  65       return;
  66
  67     std::list<FeaturePtr> aFeatures;
  68
  69     // the viewer update should be blocked in order to avoid the features blinking before they are
  70     // hidden
  71     std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
  72         new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
  73     Events_Loop::loop()->send(aMsg);
  74
  75     FeaturePtr aOrigin = createPoint(aDoc, "Origin", 0., 0., 0.);
  76     aFeatures.push_back(aOrigin);
  77     aFeatures.push_back(createAxis(aDoc, aOrigin, 100., 0., 0.));
  78     aFeatures.push_back(createAxis(aDoc, aOrigin, 0., 100., 0.));
  79     aFeatures.push_back(createAxis(aDoc, aOrigin, 0., 0., 100.));
  80     aFeatures.push_back(createPlane(aDoc, 1., 0., 0.));
  81     aFeatures.push_back(createPlane(aDoc, 0., -1., 0.));
  82     aFeatures.push_back(createPlane(aDoc, 0., 0., 1.));
  83     // for PartSet it is done outside of the transaction, so explicitly flush this creation
  84     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
  85
  86     // hides the created features, the precondition is that the feature's results have been
  87     // already built, so the createPlane/Points method calls the execute function for the planes
  88     std::list<FeaturePtr >::const_iterator aFIter = aFeatures.begin();
  89     for (; aFIter != aFeatures.cend(); aFIter++) {
  90       FeaturePtr aPlane = *aFIter;
  91       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aPlane->results();
  92       std::list<ResultPtr >::const_iterator aRIter = aResults.begin();
  93       for (; aRIter != aResults.cend(); aRIter++) {
  94         (*aRIter)->setDisplayed(false);
  95       }
  96     }
  97     Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
  98     // the viewer update should be unblocked in order to avoid the features blinking before they are
  99     // hidden
 100     aMsg = std::shared_ptr<Events_Message>(
 101                   new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
 102
 103     Events_Loop::loop()->send(aMsg);
 104   }
 105 }
 106
 107 FeaturePtr InitializationPlugin_Plugin::createPlane(DocumentPtr theDoc, double theX, double theY,
 108                                                     double theZ)
 109 {
 110   FeaturePtr aPlane = theDoc->addFeature("Plane");
 111   aPlane->string("creation_method")->setValue("by_general_equation");
 112   aPlane->real("A")->setValue(theX);
 113   aPlane->real("B")->setValue(theY);
 114   aPlane->real("C")->setValue(theZ);
 115   aPlane->real("D")->setValue(0.);
 116
 117   if (theX) {
 118     aPlane->data()->setName("YOZ");
 119   } else if (theY) {
 120     aPlane->data()->setName("XOZ");
 121   } else if (theZ) {
 122     aPlane->data()->setName("XOY");
 123   }
 124     // don't show automatically created feature in the features history
 125   aPlane->setInHistory(aPlane, false);
 126
 127   // the plane should be executed in order to build the feature result immediatelly
 128   // the results are to be hidden in the plugin
 129   aPlane->execute();
 130   // this flag is needed here to avoid setting it inside of the next transaction
 131   // (may cause crash on redo of the first transaction in OCAF)
 132   aPlane->data()->execState(ModelAPI_StateDone);
 133   aPlane->firstResult()->data()->execState(ModelAPI_StateDone);
 134
 135   return aPlane;
 136 }
 137
 138 FeaturePtr InitializationPlugin_Plugin::createPoint(DocumentPtr theDoc, const std::string& theName,
 139                                                     double theX, double theY, double theZ)
 140 {
 141   std::shared_ptr<ModelAPI_Feature> aPoint = theDoc->addFeature("Point");
 142   AttributePointPtr aPointAttr = std::dynamic_pointer_cast<GeomDataAPI_Point>
 143     (aPoint->data()->attribute("point3d"));
 144   aPointAttr->setValue(theX, theY, theZ);
 145   aPoint->string("creation_method")->setValue("by_xyz");
 146   aPoint->data()->setName(theName);
 147   // don't show automatically created feature in the features history
 148   aPoint->setInHistory(aPoint, false);
 149
 150   // the point should be executed in order to build the feature result immediatelly
 151   // the results are to be hidden in the plugin
 152   aPoint->execute();
 153   aPoint->data()->execState(ModelAPI_StateDone);
 154   aPoint->firstResult()->data()->execState(ModelAPI_StateDone);
 155
 156   return aPoint;
 157 }
 158
 159 FeaturePtr InitializationPlugin_Plugin::createAxis(DocumentPtr theDoc, FeaturePtr theOrigin,
 160                                                    double theX, double theY, double theZ)
 161 {
 162   std::shared_ptr<ModelAPI_Feature> aAxis = theDoc->addFeature("Axis");
 163   aAxis->string("CreationMethod")->setValue("AxisByPointAndDirection");
 164
 165   ResultPtr aResult = theOrigin->firstResult();
 166   aAxis->selection("FirstPoint")->setValue(aResult, aResult->shape());
 167
 168   aAxis->real("X_Direction")->setValue(theX);
 169   aAxis->real("Y_Direction")->setValue(theY);
 170   aAxis->real("Z_Direction")->setValue(theZ);
 171
 172   if (theX != 0) {
 173     aAxis->data()->setName("OX");
 174   } else if (theY != 0) {
 175     aAxis->data()->setName("OY");
 176   } else if (theZ != 0) {
 177     aAxis->data()->setName("OZ");
 178   }
 179    // don't show automatically created feature in the features history
 180   aAxis->setInHistory(aAxis, false);
 181   aAxis->execute();
 182   aAxis->data()->execState(ModelAPI_StateDone);
 183   aAxis->firstResult()->data()->execState(ModelAPI_StateDone);
 184
 185   return aAxis;
 186 }