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