src/InitializationPlugin/InitializationPlugin_Plugin.cpp

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