1 /*=========================================================================
4 Module: $RCSfile: bbtkWxBlackBox.cxx,v $
6 Date: $Date: 2008/04/08 06:59:30 $
7 Version: $Revision: 1.11 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #ifdef _USE_WXWIDGETS_
28 #include "bbtkWxBlackBox.h"
29 //#include "bbtkWxContainerBlackBox.h"
30 #include <wx/dialog.h>
32 //#include "bbtkData.h"
33 //#include "bbtkFactory.h"
44 //=========================================================================
46 //=========================================================================
50 //=========================================================================
51 WxBlackBoxWindow::WxBlackBoxWindow(WxBlackBox* box)
52 : mBox(box), mShown(false)
54 bbtkDebugMessage("Wx",9,"WxBlackBoxWindow::WxBlackBoxWindow("<<
55 mBox->bbGetFullName()<<")"<<std::endl);
56 mBox->bbSetWindow(this);
57 Wx::IncNbWindowsAlive();
58 bbtkDebugMessage("Wx",5," -> Number of windows alive = "
59 <<Wx::GetNbWindowsAlive()<<std::endl);
61 //=========================================================================
63 //=========================================================================
64 WxBlackBoxWindow::~WxBlackBoxWindow()
66 bbtkDebugMessage("Wx",9,"WxBlackBoxWindow::~WxBlackBoxWindow() ["<<
67 mBox->bbGetFullName()<<"]"<<std::endl);
70 Wx::DecNbWindowsAlive();
71 bbtkDebugMessage("Wx",5," -> Number of windows alive = "
72 <<Wx::GetNbWindowsAlive()<<std::endl);
76 //=========================================================================
79 //=========================================================================
80 void WxBlackBoxWindow::bbShow()
82 if (bbIsShown()) return;
83 bbtkDebugMessage("Wx",9,"WxBlackBoxWindow::bbShow() ["<<
84 mBox->bbGetFullName()<<"]"<<std::endl);
85 Wx::IncNbWindowsShown();
87 bbtkDebugMessage("Wx",5," -> Number of windows shown = "
88 <<Wx::GetNbWindowsShown()<<std::endl);
90 //=========================================================================
92 //=========================================================================
93 void WxBlackBoxWindow::bbHide()
95 if (!bbIsShown()) return;
96 bbtkDebugMessage("Wx",9,"WxBlackBoxWindow::bbHide() ["<<
97 mBox->bbGetFullName()<<"]"<<std::endl);
98 Wx::DecNbWindowsShown();
100 bbtkDebugMessage("Wx",5," -> Number of windows shown = "
101 <<Wx::GetNbWindowsShown()<<std::endl);
103 //=========================================================================
107 //=========================================================================
109 //=========================================================================
111 //=========================================================================
112 WxBlackBoxDialog::WxBlackBoxDialog(WxBlackBox* box,
117 WxBlackBoxWindow(box),
131 bbtkDebugMessage("Wx",9,"WxBlackBoxDialog::WxBlackBoxDialog("<<
132 bbGetBlackBox()->bbGetFullName()<<","<<parent<<","
133 <<title<<",size)"<<std::endl);
134 // Insert the widget into the window
135 wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
136 wxWindow* widget = bbGetBlackBox()->bbGetOutputWidget();
137 widget->Reparent(this);
138 sizer->Add( widget, 1, wxALL|wxEXPAND, 2);
139 //SetAutoLayout(true);
143 //=========================================================================
145 //=========================================================================
146 void WxBlackBoxDialog::bbShow()
148 bbtkDebugMessage("Wx",5,"WxBlackBoxDialog::bbShow() ["
149 <<bbGetBlackBox()->bbGetFullName()<<"]"<<std::endl);
150 WxBlackBoxWindow::bbShow();
151 SetReturnCode( wxDialog::ShowModal() );
153 //=========================================================================
155 //=========================================================================
156 void WxBlackBoxDialog::bbHide()
158 bbtkDebugMessage("Wx",9,"WxBlackBoxDialog::bbHide() ["<<
159 bbGetBlackBox()->bbGetFullName()<<"]"<<std::endl);
160 WxBlackBoxWindow::bbHide();
163 //=========================================================================
165 //=========================================================================
166 WxBlackBoxDialog::~WxBlackBoxDialog()
169 //=========================================================================
175 //=========================================================================
177 //=========================================================================
179 //=========================================================================
180 WxBlackBoxFrame::WxBlackBoxFrame(WxBlackBox* box,
184 : WxBlackBoxWindow(box),
198 bbtkDebugMessage("Wx",9,"WxBlackBoxFrame::WxBlackBoxFrame("<<
199 bbGetBlackBox()->bbGetFullName()<<","<<parent<<","
200 <<title<<",size)"<<std::endl);
201 // Insert the widget into the window
202 wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
203 wxWindow* widget = bbGetBlackBox()->bbGetOutputWidget();
204 wxFrame* frame = (wxFrame*)this;
205 widget->Reparent(frame);
206 sizer->Add( widget, 1, wxALL|wxGROW, 2);
207 // frame->SetAutoLayout(true);
208 frame->SetSizer(sizer);
212 //=========================================================================
214 //=========================================================================
215 WxBlackBoxFrame::~WxBlackBoxFrame()
218 //=========================================================================
220 //=========================================================================
221 void WxBlackBoxFrame::bbShow()
223 bbtkDebugMessage("Wx",5,"WxBlackBoxFrame::bbShow("
224 <<bbGetBlackBox()->bbGetFullName()<<")"<<std::endl);
225 WxBlackBoxWindow::bbShow();
227 // This Update is ** MANDATORY **
228 // to synchronize wxvtkRenderWindowInteractor objects
229 // (force wx objects creation **NOW**)
231 bbGetBlackBox()->bbUserOnShow();
232 // wxFrame::SetFocus();
234 //=========================================================================
236 //=========================================================================
237 void WxBlackBoxFrame::bbHide()
239 bbtkDebugMessage("Wx",9,"WxBlackBoxFrame::bbHide() ["<<
240 bbGetBlackBox()->bbGetFullName()<<"]"<<std::endl);
241 WxBlackBoxWindow::bbHide();
243 bbGetBlackBox()->bbUserOnHide();
245 //=========================================================================
249 //=========================================================================
250 // WxBlackBoxDialogWrapper
251 //=========================================================================
253 //=========================================================================
254 WxBlackBoxDialogWrapper::WxBlackBoxDialogWrapper(WxBlackBox* box,
256 : WxBlackBoxWindow(box),
259 bbtkDebugMessage("Wx",9,
260 "WxBlackBoxDialogWrapper::WxBlackBoxDialogWrapper("
261 <<bbGetBlackBox()->bbGetFullName()<<","<<wrapped
264 //=========================================================================
266 //=========================================================================
267 WxBlackBoxDialogWrapper::~WxBlackBoxDialogWrapper()
270 //=========================================================================
272 //=========================================================================
273 void WxBlackBoxDialogWrapper::bbShow()
275 bbtkDebugMessage("Wx",5,"WxBlackBoxDialogWrapper::bbShow("
276 <<bbGetBlackBox()->bbGetFullName()<<")"<<std::endl);
277 WxBlackBoxWindow::bbShow();
278 int i = mWrapped->ShowModal();
280 mWrapped->SetReturnCode( i );
282 //=========================================================================
284 //=========================================================================
285 void WxBlackBoxDialogWrapper::bbHide()
287 bbtkDebugMessage("Wx",9,"WxBlackBoxDialogWrapper::bbHide() ["<<
288 bbGetBlackBox()->bbGetFullName()<<"]"<<std::endl);
289 WxBlackBoxWindow::bbHide();
292 //=========================================================================
297 //=========================================================================
299 //=========================================================================
301 //=========================================================================
302 WxBlackBoxWidget::WxBlackBoxWidget( WxBlackBox* box)
305 bbtkDebugMessage("Wx",9,"WxBlackBoxWidget::WxBlackBoxWidget("<<box->bbGetFullName()<<")"<<std::endl);
306 mBox->bbSetWidget(this);
308 //=========================================================================
310 //=========================================================================
311 WxBlackBoxWidget::~WxBlackBoxWidget()
313 bbtkDebugMessage("Wx",9,"WxBlackBoxWidget::~WxBlackBoxWidget("<<mBox->bbGetFullName()<<")"<<std::endl);
314 mBox->bbSetWidget(0);
315 //bbtkDebugMessage("Wx",9,"EO WxBlackBoxWidget::~WxBlackBoxWidget("<<mBox->bbGetFullName()<<")"<<std::endl);
317 //=========================================================================
322 //=========================================================================
323 // WxBlackBoxWidgetEventHandler
324 //=========================================================================
326 //=========================================================================
327 WxBlackBoxWidgetEventHandler::WxBlackBoxWidgetEventHandler( WxBlackBox* box,
334 bbtkDebugMessage("Wx",9,"WxBlackBoxWidgetEventHandler::WxBlackBoxWidgetEventHandler("<<mBox->bbGetFullName()<<")"<<std::endl);
336 mBox->bbSetWidgetEventHandler(this);
338 Connect ( mWindow->GetId(),
340 (wxObjectEventFunction)
341 (void (wxEvtHandler::*)(wxWindowDestroyEvent& c))
342 &WxBlackBoxWidgetEventHandler::OnWindowDestroy );
344 mWindow->PushEventHandler(this);
347 //=========================================================================
349 //=========================================================================
350 WxBlackBoxWidgetEventHandler::~WxBlackBoxWidgetEventHandler()
352 bbtkDebugMessage("Wx",9,
353 "WxBlackBoxWidgetEventHandler::~WxBlackBoxWidgetEventHandler("
354 <<mBox->bbGetFullName()<<")"<<std::endl);
355 mBox->bbSetWidgetEventHandler(0);
357 //=========================================================================
359 //=========================================================================
360 void WxBlackBoxWidgetEventHandler::OnWindowDestroy(wxWindowDestroyEvent&)
362 bbtkDebugMessage("Wx",9,"WxBlackBoxWidgetEventHandler::OnWindowDestroy() ["
363 <<mBox->bbGetFullName()<<"]"<<std::endl);
364 mBox->bbSetOutputWidget(0);
365 mBox->bbSetModifiedStatus();
369 //=========================================================================
378 //=========================================================================
379 wxWindow* WxParentToChildData::GetWindowInWhichToInsert( const BlackBox* b)
382 bbtkDebugMessageInc("Kernel",9,"WxParentToChildData::GetWindowInWhichToInsert("<<b->bbGetFullName()<<")"<<std::endl);
384 BlackBox::InputConnectorMapType::const_iterator i = b->bbGetInputConnectorMap().find("WinParent");
385 if (i==b->bbGetInputConnectorMap().end())
387 bbtkError("WxParentToChildData::GetWindowInWhichToInsert : the box "
389 <<" does not have any 'Parent' input ?!?");
391 Connection* c = i->second->GetConnection();
394 bbtkDebugMessage("Kernel",9,
395 "-> The input 'Parent' of the box "
397 <<" is not connected."<<std::endl);
401 std::map< Connection*, wxWindow *>::const_iterator j
402 = mConnectionToWindowMap.find(c);
404 if (j==mConnectionToWindowMap.end())
406 bbtkError("WxParentToChildData::GetWindowInWhichToInsert("
408 <<") no window provided by parent ?!?");
411 bbtkDebugDecTab("Kernel",9);
414 //=========================================================================
417 //=========================================================================
419 //=========================================================================
421 //=========================================================================
422 //=========================================================================
423 //=========================================================================
424 //=========================================================================
425 BBTK_USER_BLACK_BOX_IMPLEMENTATION(WxBlackBox,AtomicBlackBox);
426 //=========================================================================
428 //=========================================================================
429 void WxBlackBox::bbUserConstructor()
431 bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserConstructor()"<<std::endl);
434 //=========================================================================
436 //=========================================================================
437 void WxBlackBox::bbUserCopyConstructor()
439 bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserCopyConstructor()"
443 //=========================================================================
446 //=========================================================================
447 void WxBlackBox::bbUserDestructor()
449 bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserDestructor()"<<std::endl);
451 delete bbGetWindow();
454 bbtkDebugMessage("Kernel",9,"EO WxBlackBox::bbUserDestructor()"<<std::endl);
456 //=========================================================================
460 //=========================================================================
461 WxBlackBox::Widget* WxBlackBox::bbGetWidget()
463 if (bbGetOutputWidget() && bbGetOutputWidget()->IsDead())
465 bbtkDebugMessage("Wx",9,"WxBlackBox::bbGetWidget() ["<<
466 bbGetFullName()<<"] : Widget is dead : deleting it"
468 delete bbGetOutputWidget();
469 bbSetOutputWidget(0);
471 return bbGetOutputWidget();
473 //=========================================================================
477 //=========================================================================
479 * \brief Initialize the attributes of the class
482 void WxBlackBox::bbInitAttributes()
486 // bbSetInputWinParent(0);
487 bbSetInputWinTitle(bbGetName());
488 bbSetInputWinWidth(800);
489 bbSetInputWinHeight(800);
490 bbSetInputWinDialog(false);
491 bbSetOutputWidget(0);
493 bbSetWidgetEventHandler(0);
495 //=========================================================================
497 //=========================================================================
498 /// Main processing method of the box.
499 void WxBlackBox::bbExecute(bool force)
501 bbtkDebugMessageInc("Process",1,
502 "=> WxBlackBox::bbExecute() ["
503 <<bbGetFullName()<<"]"<<std::endl);
505 // If the output 'Widget' is connected then
506 // we must execute the parent box
507 BlackBox::OutputConnectorMapType::const_iterator i
508 = bbGetOutputConnectorMap().find("Widget");
510 if ( i->second->GetConnectionVector().size() != 0 )
512 bbtkDebugMessage("Process",2,
513 "-> Output 'Widget' connected : transfering execution to parent"
516 i->second->GetConnectionVector().front()
517 ->GetBlackBoxTo()->bbExecute(force);
520 // else call 'standard' BlackBox execution method
523 BlackBox::bbExecute(force);
527 bbtkDebugMessageDec("Process",1,
528 "<= WxBlackBox::bbExecute() ["
529 <<bbGetFullName()<<"]"<<std::endl);
531 //=========================================================================
534 //=========================================================================
535 /// Main processing method of the box.
536 IOStatus WxBlackBox::bbBackwardUpdate( Connection* caller )
538 bbtkDebugMessageInc("Process",1,
539 "=> WxBlackBox::bbBackwardUpdate("
540 <<(caller?caller->GetFullName():"0")<<") ["
541 <<bbGetFullName()<<"]"<<std::endl);
543 if (bbGetExecuting())
545 bbtkWarning(bbGetFullName()<<" : Cyclic execution stopped");
548 bbSetExecuting(true);
550 // If the caller is not the connection to the output widget
551 // and the output 'Widget' is connected then
552 // we must execute the parent box
555 ((caller!=0)&&(caller->GetBlackBoxFromOutput()!="Widget"))
558 BlackBox::OutputConnectorMapType::const_iterator i
559 = bbGetOutputConnectorMap().find("Widget") ;
561 i->second->GetConnectionVector().size() != 0 )
563 bbtkDebugMessage("Process",2,
564 "-> Output 'Widget' connected : transfering execution to parent"
567 i->second->GetConnectionVector().front()
568 ->GetBlackBoxTo()->bbExecute(false);
572 // call 'standard' BlackBox execution method
575 bbSetExecuting(false);
576 AtomicBlackBox::bbBackwardUpdate(caller);
579 bbtkDebugMessageDec("Process",1,
580 "<= WxBlackBox::bbBackwardUpdate() ["
581 <<bbGetFullName()<<"]"<<std::endl);
583 bbSetExecuting(false);
586 //=========================================================================
587 void WxBlackBox::bbProcess()
589 if (bbGetOutputWidget()==0) this->bbUserCreateWidget();
590 this->bbUserProcess();
593 //=========================================================================
595 //==================================================================
596 /// Specific methods for window creation during pipeline execution
597 /// Shows the window associated to the box
598 /// (called after bbProcess during bbExecute)
599 void WxBlackBox::bbShowWindow()
601 bbtkDebugMessageInc("Process",1,"=> WxBlackBox::bbShowWindow() ["
602 <<bbGetFullName()<<"]"<<std::endl);
604 // If Event Handler for the widget does not exist or is obsolete : create it
605 if (bbGetOutputWidget()!=0)
607 if (bbGetWidgetEventHandler()==0)
609 bbtkDebugMessage("Process",3,
610 "-> No widget event handler : creating one"
612 new WxBlackBoxWidgetEventHandler(this,bbGetOutputWidget());
614 else if ( ! bbGetWidgetEventHandler()->IsHandlerOf
615 ( bbGetOutputWidget() ) )
617 bbtkDebugMessage("Process",3,
618 "-> Obsolete widget event handler : re-creating one"
620 delete bbGetWidgetEventHandler();
621 new WxBlackBoxWidgetEventHandler(this,bbGetOutputWidget());
623 // Sets the name of the wxWindow to the input WinTitle
624 bbGetOutputWidget()->SetName(bbtk::std2wx(bbGetInputWinTitle()));
627 // If the output 'Widget' is connected then it's gonna
628 // be captured by its parent window : nothing to do
629 if ( (*bbGetOutputConnectorMap().find("Widget")).second
630 ->GetConnectionVector().size() != 0 )
633 bbtkDebugMessage("Process",2,
634 "-> Output 'Widget' connected : nothing to do"
636 bbtkDebugDecTab("Process",1);
642 // If the window already exists : no need creating it
643 if (bbGetWindow()!=0)
645 bbtkDebugMessage("Process",2,
646 "-> Window already exists"
648 show = bbGetWindow();
650 // Else if the widget exists : create window
651 else if (bbGetOutputWidget()!=0)
653 bbtkDebugMessage("Process",2,
654 "-> Widget exists : creating the window"
658 // Input WinDialog set to true : creating a Dialog
659 if (bbGetInputWinDialog())
661 bbtkDebugMessage("Process",2,
662 " Input WinDialog set to true : creating a Dialog"
664 show = (Window*) new WxBlackBoxDialog( this,
666 std2wx( bbGetInputWinTitle() + " - bbtk (c) CREATIS LRMN"),
667 wxSize( bbGetInputWinWidth() , bbGetInputWinHeight() ) );
669 // Input WinDialog set to false : creating a Frame
672 bbtkDebugMessage("Process",2,
673 " Input WinDialog set to false : creating a Frame"
675 show = (Window*) new WxBlackBoxFrame( this,
677 std2wx( bbGetInputWinTitle() + " - bbtk (c) CREATIS LRMN"),
678 wxSize( bbGetInputWinWidth() , bbGetInputWinHeight() ) );
682 // No window nor widget : error
685 bbtkError("WxBlackBox::bbShowWindow() ["
687 <<"] : No widget. Did you set the box output 'Widget' in the processing method of the box ?");
692 if (true) //!show->IsShown())
698 bbtkDebugMessage("Process",2,"-> Already shown : nothing to do"<<std::endl);
702 bbtkDebugMessage("Process",1,"<= WxBlackBox::bbShowWindow() ["
703 <<bbGetFullName()<<"]"<<std::endl);
704 bbtkDebugDecTab("Process",1);
706 //==================================================================
711 //==================================================================
712 void WxBlackBox::bbHideWindow()
714 bbtkDebugMessageInc("Process",1,"=> WxBlackBox::bbHideWindow() ["
715 <<bbGetFullName()<<"]"<<std::endl);
717 if (bbGetWindow()!=0) bbGetWindow()->bbHide();
719 bbtkDebugMessageDec("Process",1,"<= WxBlackBox::bbHideWindow() ["
720 <<bbGetFullName()<<"]"<<std::endl);
722 //==================================================================
725 //==================================================================
726 WxBlackBox::Window* WxBlackBox::bbGetContainingWindow()
728 if (bbGetWindow()!=0) return bbGetWindow();
729 BlackBox::OutputConnectorMapType::const_iterator i
730 = bbGetOutputConnectorMap().find("Widget");
731 if ( i->second->GetConnectionVector().size() != 0 )
733 return ((WxBlackBox*)i->second->GetConnectionVector().front()
734 ->GetBlackBoxTo())->bbGetContainingWindow();
738 //==================================================================
741 //==================================================================
742 wxWindow* WxBlackBox::bbGetWxParent() { return Wx::GetTopWindow(); }
743 //==================================================================
746 //==================================================================
747 bool WxBlackBox::bbIsShown()
749 if (bbGetContainingWindow()!=0)
750 return bbGetContainingWindow()->bbIsShown();
753 //==================================================================