0024023: Revamp the OCCT Handle -- automatic
[occt.git] / 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 #include <TObjDRAW.ixx>
17 #include <stdio.h>
18
19 #include <TObj_Model.hxx>
20 #include <TObj_TModel.hxx>
21 #include <TObj_Object.hxx>
22 #include <TObj_ObjectIterator.hxx>
23 #include <TObj_TNameContainer.hxx>
24
25 #include <Message_MsgFile.hxx>
26 #include <Standard_Type.hxx>
27 #include <TColStd_HArray1OfReal.hxx>
28 #include <TCollection_ExtendedString.hxx>
29
30 #include <Draw.hxx>
31
32 #include <DDocStd.hxx>
33 #include <DDocStd_DrawDocument.hxx>
34
35 #include <TDF_Tool.hxx>
36 #include <TDF_Data.hxx>
37 #include <TDataStd_Name.hxx>
38 #include <TDocStd_Document.hxx>
39
40 #include <Draw_PluginMacro.hxx>
41
42 // avoid warnings on 'extern "C"' functions returning C++ classes
43 #ifdef WNT
44 #pragma warning(4:4190)
45 #endif
46
47 //=======================================================================
48 // Section: General commands
49 //=======================================================================
50
51
52 //! simple model with redefined pure virtual method
53 class TObjDRAW_Model : public TObj_Model
54 {
55  public:
56   Standard_EXPORT TObjDRAW_Model()
57     : TObj_Model() {}
58   
59   virtual Standard_EXPORT Handle(TObj_Model) NewEmpty()
60     {
61       return new TObjDRAW_Model();
62     }
63   
64  public:
65   //! CASCADE RTTI
66   DEFINE_STANDARD_RTTI(TObjDRAW_Model, TObj_Model)
67
68 };
69 DEFINE_STANDARD_HANDLE (TObjDRAW_Model,TObj_Model)
70
71
72
73 //! simple object to check API and features of TObj_Object
74 class TObjDRAW_Object : public TObj_Object
75 {
76  protected:
77   //! enumeration for the ranks of label under Data section.
78   enum DataTag
79   {
80     DataTag_First = TObj_Object::DataTag_Last,
81     DataTag_IntVal,
82     DataTag_RealArr,
83     DataTag_Last = DataTag_First + 100 
84   };
85   
86   // enumeration for the ranks of label under Reference section.
87   enum RefTag
88   {
89     RefTag_First = TObj_Object::RefTag_Last,
90     RefTag_Other, //!< here we test only one refrence to other
91     RefTag_Last = RefTag_First + 100 
92   };
93
94   //! enumeration for the ranks of label under Children section.
95   enum ChildTag
96   {
97     ChildTag_First = TObj_Object::ChildTag_Last,
98     ChildTag_Child, //!< here we test only one child (or one branch of children)
99     ChildTag_Last = ChildTag_First + 100 
100   };
101   
102  public:
103   Standard_EXPORT TObjDRAW_Object(const TDF_Label& theLab)
104     : TObj_Object( theLab )  {}
105   
106   //! sets int value
107   Standard_EXPORT void SetInt( const Standard_Integer theVal )
108     { setInteger( theVal, DataTag_IntVal ); }
109   //! returns int value
110   Standard_EXPORT Standard_Integer GetInt() const
111     { return getInteger( DataTag_IntVal ); }
112   
113   //! sets array of real
114   Standard_EXPORT void SetRealArr( const Handle(TColStd_HArray1OfReal)& theHArr )
115     { setArray( theHArr, DataTag_RealArr ); }
116   //! returns array of real
117   Standard_EXPORT Handle(TColStd_HArray1OfReal) GetRealArr() const
118     { return getRealArray( 0, DataTag_RealArr ); }
119   
120   //! set reference to other object
121   Standard_EXPORT void SetRef( const Handle(TObj_Object)& theOther )
122     { setReference( theOther, RefTag_Other ); }
123   //! return reference
124   Standard_EXPORT Handle(TObj_Object) GetRef() const
125     { return getReference( RefTag_Other ); }
126   
127   //! add child object
128   Standard_EXPORT Handle(TObj_Object) AddChild()
129     {
130       TDF_Label aChL = getChildLabel( ChildTag_Child ).NewChild();
131       return new TObjDRAW_Object( aChL );
132     }
133   
134   protected:
135   // Persistence of TObj object
136   DECLARE_TOBJOCAF_PERSISTENCE(TObjDRAW_Object,TObj_Object)
137
138  public:
139   // Declaration of CASCADE RTTI
140  DEFINE_STANDARD_RTTI (TObjDRAW_Object, TObj_Object)
141   
142 };
143
144 // Definition of HANDLE object using Standard_DefineHandle.hxx
145 DEFINE_STANDARD_HANDLE (TObjDRAW_Object,TObj_Object)
146
147
148 IMPLEMENT_TOBJOCAF_PERSISTENCE(TObjDRAW_Object)
149
150 //=======================================================================
151 //function : newModel
152 //purpose  :
153 //=======================================================================
154 static Standard_Integer newModel (Draw_Interpretor& di, Standard_Integer argc, const char** argv)
155 {
156   if (argc < 2) {di<<"Use "<< argv[0] << "nameDoc\n";return 1;}
157
158   Handle(TDocStd_Document) D;
159   Handle(DDocStd_DrawDocument) DD;
160
161   if (!DDocStd::GetDocument(argv[1],D,Standard_False)) {
162     Handle(TObjDRAW_Model) aModel = new TObjDRAW_Model();
163     aModel->Load(0);
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   // load TObjOcaf base data model messages
466   Message_MsgFile::Load( ::getenv( "CSF_TObjResources" ), "TObj.msg" );
467   
468   //=====================================
469   // General commands
470   //=====================================
471
472   Standard_CString g = "TObj general commands";
473
474   di.Add ("TObjNew","DocName \t: Create new TObj model with document named DocName",
475                    __FILE__, newModel, g);
476
477   di.Add ("TObjSave","DocName [Path] \t: Save Model with DocName",
478                    __FILE__, saveModel, g);
479
480   di.Add ("TObjLoad","DocName Path \t: Load model DocName from file Path",
481                    __FILE__, loadModel, g);
482
483   di.Add ("TObjClose","DocName\t: Close model DocName",
484                    __FILE__, closeModel, g);
485
486   di.Add ("TObjAddObj","DocName ObjName \t: Add object to model document",
487                    __FILE__, addObj, g);
488
489   di.Add ("TObjSetVal","DocName ObjName1 intVal | -r N r1 r2 ... rN \t: Set one integer or set of real values",
490                    __FILE__, setVal, g);
491
492   di.Add ("TObjGetVal","DocName ObjName1 -i | -r \t: Returns one integer or set of real values",
493                    __FILE__, getVal, g);
494
495   di.Add ("TObjSetRef","DocName ObjName1 ObjName2 \t: Set reference from object1 to object2",
496                    __FILE__, setRef, g);
497
498   di.Add ("TObjGetRef","DocName ObjName \t: Returns list of children objects",
499                    __FILE__, getRef, g);
500   
501   di.Add ("TObjAddChild","DocName ObjName chldName \t: Add child object to indicated object",
502                    __FILE__, addChild, g);
503   
504   di.Add ("TObjGetChildren","DocName ObjName \t: Returns list of children objects",
505                    __FILE__, getChild, g);
506   
507 }
508
509
510 //==============================================================================
511 // TObjDRAW::Factory
512
513 //==============================================================================
514 void TObjDRAW::Factory(Draw_Interpretor& theDI)
515 {
516   TObjDRAW::Init(theDI);
517
518 #ifdef OCCT_DEBUG
519       theDI << "Draw Plugin : All TKTObjDRAW commands are loaded" << "\n";
520 #endif
521 }
522
523 // Declare entry point PLUGINFACTORY
524 DPLUGIN(TObjDRAW)