src/TObjDRAW/TObjDRAW.cxx

   1 // Created on: 2008-06-07
   2 // Created by: Pavel TELKOV
   3 // Copyright (c) 2008-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16
  17 #include <DDocStd.hxx>
  18 #include <DDocStd_DrawDocument.hxx>
  19 #include <Draw.hxx>
  20 #include <Draw_PluginMacro.hxx>
  21 #include <Message_MsgFile.hxx>
  22 #include <Standard_Type.hxx>
  23 #include <TCollection_ExtendedString.hxx>
  24 #include <TColStd_HArray1OfReal.hxx>
  25 #include <TDataStd_Name.hxx>
  26 #include <TDF_Data.hxx>
  27 #include <TDF_Tool.hxx>
  28 #include <TDocStd_Document.hxx>
  29 #include <TObj_Application.hxx>
  30 #include <TObj_Model.hxx>
  31 #include <TObj_Object.hxx>
  32 #include <TObj_ObjectIterator.hxx>
  33 #include <TObj_TModel.hxx>
  34 #include <TObj_TNameContainer.hxx>
  35 #include <TObjDRAW.hxx>
  36
  37 #include <BinTObjDrivers.hxx>
  38 #include <XmlTObjDrivers.hxx>
  39
  40 #include <stdio.h>
  41 // avoid warnings on 'extern "C"' functions returning C++ classes
  42 #ifdef _MSC_VER
  43 #pragma warning(4:4190)
  44 #endif
  45
  46 //=======================================================================
  47 // Section: General commands
  48 //=======================================================================
  49
  50
  51 //! simple model with redefined pure virtual method
  52 class TObjDRAW_Model : public TObj_Model
  53 {
  54  public:
  55   Standard_EXPORT TObjDRAW_Model()
  56     : TObj_Model() {}
  57
  58   virtual Standard_EXPORT Handle(TObj_Model) NewEmpty() Standard_OVERRIDE
  59     {
  60       return new TObjDRAW_Model();
  61     }
  62
  63  public:
  64   //! CASCADE RTTI
  65   DEFINE_STANDARD_RTTI_INLINE(TObjDRAW_Model,TObj_Model)
  66
  67 };
  68 DEFINE_STANDARD_HANDLE (TObjDRAW_Model,TObj_Model)
  69
  70
  71
  72 //! simple object to check API and features of TObj_Object
  73 class TObjDRAW_Object : public TObj_Object
  74 {
  75  protected:
  76   //! enumeration for the ranks of label under Data section.
  77   enum DataTag
  78   {
  79     DataTag_First = TObj_Object::DataTag_Last,
  80     DataTag_IntVal,
  81     DataTag_RealArr,
  82     DataTag_Last = DataTag_First + 100
  83   };
  84
  85   // enumeration for the ranks of label under Reference section.
  86   enum RefTag
  87   {
  88     RefTag_First = TObj_Object::RefTag_Last,
  89     RefTag_Other, //!< here we test only one refrence to other
  90     RefTag_Last = RefTag_First + 100
  91   };
  92
  93   //! enumeration for the ranks of label under Children section.
  94   enum ChildTag
  95   {
  96     ChildTag_First = TObj_Object::ChildTag_Last,
  97     ChildTag_Child, //!< here we test only one child (or one branch of children)
  98     ChildTag_Last = ChildTag_First + 100
  99   };
 100
 101  public:
 102   Standard_EXPORT TObjDRAW_Object(const TDF_Label& theLab)
 103     : TObj_Object( theLab )  {}
 104
 105   //! sets int value
 106   Standard_EXPORT void SetInt( const Standard_Integer theVal )
 107     { setInteger( theVal, DataTag_IntVal ); }
 108   //! returns int value
 109   Standard_EXPORT Standard_Integer GetInt() const
 110     { return getInteger( DataTag_IntVal ); }
 111
 112   //! sets array of real
 113   Standard_EXPORT void SetRealArr( const Handle(TColStd_HArray1OfReal)& theHArr )
 114     { setArray( theHArr, DataTag_RealArr ); }
 115   //! returns array of real
 116   Standard_EXPORT Handle(TColStd_HArray1OfReal) GetRealArr() const
 117     { return getRealArray( 0, DataTag_RealArr ); }
 118
 119   //! set reference to other object
 120   Standard_EXPORT void SetRef( const Handle(TObj_Object)& theOther )
 121     { setReference( theOther, RefTag_Other ); }
 122   //! return reference
 123   Standard_EXPORT Handle(TObj_Object) GetRef() const
 124     { return getReference( RefTag_Other ); }
 125
 126   //! add child object
 127   Standard_EXPORT Handle(TObj_Object) AddChild()
 128     {
 129       TDF_Label aChL = getChildLabel( ChildTag_Child ).NewChild();
 130       return new TObjDRAW_Object( aChL );
 131     }
 132
 133   protected:
 134   // Persistence of TObj object
 135   DECLARE_TOBJOCAF_PERSISTENCE(TObjDRAW_Object,TObj_Object)
 136
 137  public:
 138   // Declaration of CASCADE RTTI
 139  DEFINE_STANDARD_RTTI_INLINE(TObjDRAW_Object,TObj_Object)
 140
 141 };
 142
 143 // Definition of HANDLE object using Standard_DefineHandle.hxx
 144 DEFINE_STANDARD_HANDLE (TObjDRAW_Object,TObj_Object)
 145
 146
 147 IMPLEMENT_TOBJOCAF_PERSISTENCE(TObjDRAW_Object)
 148
 149 //=======================================================================
 150 //function : newModel
 151 //purpose  :
 152 //=======================================================================
 153 static Standard_Integer newModel (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 154 {
 155   if (argc < 2) {di<<"Use "<< argv[0] << "nameDoc\n";return 1;}
 156
 157   Handle(TDocStd_Document) D;
 158   Handle(DDocStd_DrawDocument) DD;
 159
 160   if (!DDocStd::GetDocument(argv[1],D,Standard_False)) {
 161     Handle(TObjDRAW_Model) aModel = new TObjDRAW_Model();
 162     // initializes the new model: filename is empty
 163     aModel->Load("");
 164     D = aModel->GetDocument();
 165     DD = new DDocStd_DrawDocument(D);
 166     TDataStd_Name::Set(D->GetData()->Root(),argv[1]);
 167     Draw::Set(argv[1],DD);
 168     di << "document " << argv[1] << " created\n";
 169   }
 170   else di << argv[1] << " is already a document\n";
 171
 172   return 0;
 173 }
 174
 175 static Handle(TObj_Model) getModelByName( const char* theName )
 176 {
 177   Handle(TObj_Model) aModel;
 178   Handle(TDocStd_Document) D;
 179   if (!DDocStd::GetDocument(theName,D)) return aModel;
 180
 181   TDF_Label aLabel = D->Main();
 182   Handle(TObj_TModel) aModelAttr;
 183   if (!aLabel.IsNull() && aLabel.FindAttribute(TObj_TModel::GetID(), aModelAttr))
 184     aModel = aModelAttr->Model();
 185   return aModel;
 186 }
 187
 188 //=======================================================================
 189 //function : saveModel
 190 //purpose  :
 191 //=======================================================================
 192 static Standard_Integer saveModel (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 193 {
 194   if (argc < 2) {di<<"Use "<< argv[0] << "nameDoc [fileName]\n";return 1;}
 195
 196   Handle(TObj_Model) aModel = getModelByName(argv[1]);
 197   if ( aModel.IsNull() ) return 1;
 198   Standard_Boolean isSaved = Standard_False;
 199   if (argc > 2 )
 200     isSaved = aModel->SaveAs( argv[2] );
 201   else
 202     isSaved = aModel->Save();
 203
 204   if (!isSaved) {
 205     di << "Error: Document not saved\n";
 206     return 1;
 207   }
 208   return 0;
 209 }
 210
 211 //=======================================================================
 212 //function : loadModel
 213 //purpose  :
 214 //=======================================================================
 215 static Standard_Integer loadModel (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 216 {
 217   if (argc < 3) {di<<"Use "<< argv[0] << "nameDoc fileName\n";return 1;}
 218
 219   Standard_Boolean isLoaded = Standard_False;
 220   Handle(TObj_Model) aModel = getModelByName(argv[1]);
 221   if ( aModel.IsNull() )
 222   {
 223     // create new
 224     aModel = new TObjDRAW_Model();
 225     isLoaded = aModel->Load( argv[2] );
 226     if ( isLoaded )
 227     {
 228       Handle(TDocStd_Document) D = aModel->GetDocument();
 229       Handle(DDocStd_DrawDocument) DD = new DDocStd_DrawDocument(D);
 230
 231       TDataStd_Name::Set(D->GetData()->Root(),argv[1]);
 232       Draw::Set(argv[1],DD);
 233     }
 234   }
 235   else
 236     isLoaded = aModel->Load( argv[2] );
 237
 238
 239   if (!isLoaded) {
 240     di << "Error: Document not loaded\n";
 241     return 1;
 242   }
 243   return 0;
 244 }
 245
 246
 247 //=======================================================================
 248 //function : closeModel
 249 //purpose  :
 250 //=======================================================================
 251 static Standard_Integer closeModel (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 252 {
 253   if (argc < 2) {di<<"Use "<< argv[0] << "nameDoc\n";return 1;}
 254
 255   Handle(TObj_Model) aModel = getModelByName(argv[1]);
 256   if ( aModel.IsNull() ) return 1;
 257   aModel->Close();
 258
 259   return 0;
 260 }
 261
 262 //=======================================================================
 263 //function : addObj
 264 //purpose  :
 265 //=======================================================================
 266 static Standard_Integer addObj (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 267 {
 268   if (argc < 3) {di<<"Use "<< argv[0] << "DocName ObjName\n";return 1;}
 269   Handle(TObj_Model) aModel = getModelByName(argv[1]);
 270   if ( aModel.IsNull() ) return 1;
 271   Handle(TObjDRAW_Object) tObj =
 272     new TObjDRAW_Object( aModel->GetMainPartition()->NewLabel() );
 273   if ( tObj.IsNull() )
 274   {
 275     di << "Error: Object not created\n";
 276     return 1;
 277   }
 278   tObj->SetName( argv[2] );
 279
 280   return 0;
 281 }
 282
 283 static Handle(TObjDRAW_Object) getObjByName( const char* modelName, const char* objName )
 284 {
 285   Handle(TObjDRAW_Object) tObj;
 286   Handle(TObj_Model) aModel = getModelByName(modelName);
 287   if ( aModel.IsNull() )
 288     return tObj;
 289   Handle(TCollection_HExtendedString) aName = new TCollection_HExtendedString( objName );
 290   Handle(TObj_TNameContainer) aDict;
 291   tObj = Handle(TObjDRAW_Object)::DownCast( aModel->FindObject(aName, aDict) );
 292   return tObj;
 293 }
 294
 295 //=======================================================================
 296 //function : setVal
 297 //purpose  :
 298 //=======================================================================
 299 static Standard_Integer setVal (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 300 {
 301   if (argc < 4) {di<<"Use "<< argv[0] << "DocName ObjName1 intVal | -r N r1 r2 ... rN\n";return 1;}
 302   Handle(TObjDRAW_Object) tObj = getObjByName( argv[1], argv[2] );
 303   if ( tObj.IsNull() )
 304   {
 305     di << "Error: Object " << argv[2] << " not found\n";
 306     return 1;
 307   }
 308   if ( !strcmp(argv[3],"-r") )
 309   {
 310     int Nb = Draw::Atoi(argv[4]);
 311     Handle(TColStd_HArray1OfReal) rArr = new TColStd_HArray1OfReal(1,Nb);
 312     for ( int i = 1; i <= Nb; i++ )
 313       rArr->SetValue(i, Draw::Atof(argv[4+i]));
 314     tObj->SetRealArr( rArr );
 315   }
 316   else
 317     tObj->SetInt( Draw::Atoi(argv[3] ) );
 318
 319   return 0;
 320 }
 321
 322 //=======================================================================
 323 //function : getVal
 324 //purpose  :
 325 //=======================================================================
 326 static Standard_Integer getVal (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 327 {
 328   if (argc < 4) {di<<"Use "<< argv[0] << "DocName ObjName1 -i | -r\n";return 1;}
 329
 330   Handle(TObjDRAW_Object) tObj = getObjByName( argv[1], argv[2] );
 331   if ( tObj.IsNull() )
 332   {
 333     di << "Error: Object " << argv[2] << " not found\n";
 334     return 1;
 335   }
 336   if ( !strcmp(argv[3],"-i") )
 337     di << tObj->GetInt();
 338   else
 339   {
 340     Handle(TColStd_HArray1OfReal) rArr = tObj->GetRealArr();
 341     if ( !rArr.IsNull() )
 342       for ( int i = 1, n = rArr->Upper(); i <= n; i++ )
 343       {
 344         if ( i > 1 )
 345           di << " ";
 346         di << rArr->Value(i);
 347       }
 348   }
 349
 350   return 0;
 351 }
 352
 353 //=======================================================================
 354 //function : setRef
 355 //purpose  :
 356 //=======================================================================
 357 static Standard_Integer setRef (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 358 {
 359   if (argc < 4) {di<<"Use "<< argv[0] << "DocName ObjName1 ObjName2\n";return 1;}
 360
 361   Handle(TObjDRAW_Object) tObj1 = getObjByName( argv[1], argv[2] );
 362   Handle(TObjDRAW_Object) tObj2 = getObjByName( argv[1], argv[3] );
 363   if ( tObj1.IsNull() || tObj2.IsNull() )
 364   {
 365     di << "Error: Object " << argv[2] << " or object " << argv[3] << " not found\n";
 366     return 1;
 367   }
 368   tObj1->SetRef( tObj2 );
 369
 370   return 0;
 371 }
 372
 373 //=======================================================================
 374 //function : getRef
 375 //purpose  :
 376 //=======================================================================
 377 static Standard_Integer getRef (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 378 {
 379   if (argc < 3) {di<<"Use "<< argv[0] << "DocName ObjName\n";return 1;}
 380
 381   Handle(TObjDRAW_Object) tObj = getObjByName( argv[1], argv[2] );
 382   if ( tObj.IsNull() )
 383   {
 384     di << "Error: Object " << argv[2] << " not found\n";
 385     return 1;
 386   }
 387   Handle(TObj_Object) aRefObj = tObj->GetRef();
 388   if ( aRefObj.IsNull() )
 389     return 1;
 390   else
 391   {
 392     TCollection_AsciiString aName;
 393     aRefObj->GetName( aName );
 394     di << aName.ToCString();
 395   }
 396
 397   return 0;
 398 }
 399
 400 //=======================================================================
 401 //function : addChild
 402 //purpose  :
 403 //=======================================================================
 404 static Standard_Integer addChild (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 405 {
 406   if (argc < 4) {di<<"Use "<< argv[0] << "DocName ObjName childObj\n";return 1;}
 407
 408   Handle(TObjDRAW_Object) tObj = getObjByName( argv[1], argv[2] );
 409   if ( tObj.IsNull() )
 410   {
 411     di << "Error: Object " << argv[2] << " not found\n";
 412     return 1;
 413   }
 414   Handle(TObj_Object) chldObj = tObj->AddChild();
 415   if ( chldObj.IsNull() )
 416   {
 417     di << "Error: No child object created\n";
 418     return 1;
 419   }
 420   chldObj->SetName( new TCollection_HExtendedString( argv[3] ) );
 421
 422   return 0;
 423 }
 424
 425 //=======================================================================
 426 //function : getChild
 427 //purpose  :
 428 //=======================================================================
 429 static Standard_Integer getChild (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
 430 {
 431   if (argc < 3) {di<<"Use "<< argv[0] << "DocName ObjName\n";return 1;}
 432
 433   Handle(TObjDRAW_Object) tObj = getObjByName( argv[1], argv[2] );
 434   if ( tObj.IsNull() )
 435   {
 436     di << "Error: Object " << argv[2] << " not found\n";
 437     return 1;
 438   }
 439   Handle(TObj_ObjectIterator) anItr = tObj->GetChildren();
 440   int i = 0;
 441   for ( ; anItr->More(); anItr->Next(), i++ )
 442   {
 443     Handle(TObj_Object) anObj = anItr->Value();
 444     TCollection_AsciiString aName;
 445     anObj->GetName( aName );
 446     if ( i > 0 )
 447       di << " ";
 448     di << aName.ToCString();
 449   }
 450
 451   return 0;
 452 }
 453
 454 //=======================================================================
 455 //function : Init
 456 //purpose  :
 457 //=======================================================================
 458
 459 void TObjDRAW::Init(Draw_Interpretor& di)
 460 {
 461
 462   static Standard_Boolean initactor = Standard_False;
 463   if (initactor) return;  initactor = Standard_True;
 464
 465   //=====================================
 466   // General commands
 467   //=====================================
 468
 469   Standard_CString g = "TObj general commands";
 470
 471   di.Add ("TObjNew","DocName \t: Create new TObj model with document named DocName",
 472                    __FILE__, newModel, g);
 473
 474   di.Add ("TObjSave","DocName [Path] \t: Save Model with DocName",
 475                    __FILE__, saveModel, g);
 476
 477   di.Add ("TObjLoad","DocName Path \t: Load model DocName from file Path",
 478                    __FILE__, loadModel, g);
 479
 480   di.Add ("TObjClose","DocName\t: Close model DocName",
 481                    __FILE__, closeModel, g);
 482
 483   di.Add ("TObjAddObj","DocName ObjName \t: Add object to model document",
 484                    __FILE__, addObj, g);
 485
 486   di.Add ("TObjSetVal","DocName ObjName1 intVal | -r N r1 r2 ... rN \t: Set one integer or set of real values",
 487                    __FILE__, setVal, g);
 488
 489   di.Add ("TObjGetVal","DocName ObjName1 -i | -r \t: Returns one integer or set of real values",
 490                    __FILE__, getVal, g);
 491
 492   di.Add ("TObjSetRef","DocName ObjName1 ObjName2 \t: Set reference from object1 to object2",
 493                    __FILE__, setRef, g);
 494
 495   di.Add ("TObjGetRef","DocName ObjName \t: Returns list of children objects",
 496                    __FILE__, getRef, g);
 497
 498   di.Add ("TObjAddChild","DocName ObjName chldName \t: Add child object to indicated object",
 499                    __FILE__, addChild, g);
 500
 501   di.Add ("TObjGetChildren","DocName ObjName \t: Returns list of children objects",
 502                    __FILE__, getChild, g);
 503
 504 }
 505
 506
 507 //==============================================================================
 508 // TObjDRAW::Factory
 509
 510 //==============================================================================
 511 void TObjDRAW::Factory(Draw_Interpretor& theDI)
 512 {
 513   // Initialize TObj OCAF formats
 514   Handle(TDocStd_Application) anApp = DDocStd::GetApplication();
 515   BinTObjDrivers::DefineFormat(anApp);
 516   XmlTObjDrivers::DefineFormat(anApp);
 517
 518   // define formats for TObj specific application
 519   anApp = TObj_Application::GetInstance();
 520   BinTObjDrivers::DefineFormat(anApp);
 521   XmlTObjDrivers::DefineFormat(anApp);
 522
 523   TObjDRAW::Init(theDI);
 524
 525 #ifdef OCCT_DEBUG
 526       theDI << "Draw Plugin : All TKTObjDRAW commands are loaded\n";
 527 #endif
 528 }
 529
 530 // Declare entry point PLUGINFACTORY
 531 DPLUGIN(TObjDRAW)