1 /*=========================================================================
4 Module: $RCSfile: bbtkWxBlackBox.cxx,v $
6 Date: $Date: 2008/04/22 14:30:25 $
7 Version: $Revision: 1.14 $
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::Pointer box)
52 : mBox(box), mShown(false)
54 bbtkDebugMessage("wx",9,"WxBlackBoxWindow::WxBlackBoxWindow("<<
55 mBox.lock()->bbGetFullName()<<")"<<std::endl);
56 mBox.lock()->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() "
69 Wx::DecNbWindowsAlive();
72 mBox.lock()->bbSetWindow(0);
77 bbtkDebugMessage("wx",5," -> Number of windows alive = "
78 <<Wx::GetNbWindowsAlive()<<std::endl);
80 //=========================================================================
83 //=========================================================================
84 void WxBlackBoxWindow::bbShow()
86 if (bbIsShown()) return;
87 bbtkDebugMessage("wx",9,"WxBlackBoxWindow::bbShow()"<<std::endl);
88 Wx::IncNbWindowsShown();
90 bbtkDebugMessage("wx",5," -> Number of windows shown = "
91 <<Wx::GetNbWindowsShown()<<std::endl);
93 //=========================================================================
95 //=========================================================================
96 void WxBlackBoxWindow::bbHide()
98 if (!bbIsShown()) return;
99 bbtkDebugMessage("wx",9,"WxBlackBoxWindow::bbHide()"<<std::endl);
100 Wx::DecNbWindowsShown();
102 bbtkDebugMessage("wx",5," -> Number of windows shown = "
103 <<Wx::GetNbWindowsShown()<<std::endl);
105 //=========================================================================
109 //=========================================================================
111 //=========================================================================
113 //=========================================================================
114 WxBlackBoxDialog::WxBlackBoxDialog(WxBlackBox::Pointer box,
119 WxBlackBoxWindow(box),
133 bbtkDebugMessage("wx",9,"WxBlackBoxDialog::WxBlackBoxDialog("<<
134 bbGetBlackBox()->bbGetFullName()<<","<<parent<<","
135 <<title<<",size)"<<std::endl);
136 // Insert the widget into the window
137 wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
138 wxWindow* widget = bbGetBlackBox()->bbGetOutputWidget();
139 widget->Reparent(this);
140 sizer->Add( widget, 1, wxALL|wxEXPAND, 2);
141 //SetAutoLayout(true);
145 //=========================================================================
147 //=========================================================================
148 void WxBlackBoxDialog::bbShow()
150 bbtkDebugMessage("wx",5,"WxBlackBoxDialog::bbShow() ["
151 <<bbGetBlackBox()->bbGetFullName()<<"]"<<std::endl);
152 WxBlackBoxWindow::bbShow();
153 SetReturnCode( wxDialog::ShowModal() );
155 //=========================================================================
157 //=========================================================================
158 void WxBlackBoxDialog::bbHide()
160 bbtkDebugMessage("wx",9,"WxBlackBoxDialog::bbHide()"<<std::endl);
161 WxBlackBoxWindow::bbHide();
164 //=========================================================================
166 //=========================================================================
167 WxBlackBoxDialog::~WxBlackBoxDialog()
170 //=========================================================================
176 //=========================================================================
178 //=========================================================================
180 //=========================================================================
181 WxBlackBoxFrame::WxBlackBoxFrame(WxBlackBox::Pointer box,
185 : WxBlackBoxWindow(box),
199 bbtkDebugMessage("wx",9,"WxBlackBoxFrame::WxBlackBoxFrame("<<
200 bbGetBlackBox()->bbGetFullName()<<","<<parent<<","
201 <<title<<",size)"<<std::endl);
202 // Insert the widget into the window
203 wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
204 wxWindow* widget = bbGetBlackBox()->bbGetOutputWidget();
205 wxFrame* frame = (wxFrame*)this;
206 widget->Reparent(frame);
207 sizer->Add( widget, 1, wxALL|wxGROW, 2);
208 // frame->SetAutoLayout(true);
209 frame->SetSizer(sizer);
213 //=========================================================================
215 //=========================================================================
216 WxBlackBoxFrame::~WxBlackBoxFrame()
219 //=========================================================================
221 //=========================================================================
222 void WxBlackBoxFrame::bbShow()
224 bbtkDebugMessage("wx",5,"WxBlackBoxFrame::bbShow("
225 <<bbGetBlackBox()->bbGetFullName()<<")"<<std::endl);
226 WxBlackBoxWindow::bbShow();
228 // This Update is ** MANDATORY **
229 // to synchronize wxvtkRenderWindowInteractor objects
230 // (force wx objects creation **NOW**)
232 if (bbGetBlackBox()) bbGetBlackBox()->bbUserOnShow();
233 // wxFrame::SetFocus();
235 //=========================================================================
237 //=========================================================================
238 void WxBlackBoxFrame::bbHide()
240 bbtkDebugMessage("wx",9,"WxBlackBoxFrame::bbHide()"<<std::endl);
241 WxBlackBoxWindow::bbHide();
243 if (bbGetBlackBox()) bbGetBlackBox()->bbUserOnHide();
245 //=========================================================================
250 //=========================================================================
251 // WxBlackBoxWidgetEventHandler
252 //=========================================================================
254 //=========================================================================
255 WxBlackBoxWidgetEventHandler::
256 WxBlackBoxWidgetEventHandler( WxBlackBox::Pointer box,
262 bbtkDebugMessage("wx",9,"WxBlackBoxWidgetEventHandler::WxBlackBoxWidgetEventHandler("<<mBox.lock()->bbGetFullName()<<")"<<std::endl);
264 mBox.lock()->bbSetWidgetEventHandler(this);
266 Connect ( mWindow->GetId(),
268 (wxObjectEventFunction)
269 (void (wxEvtHandler::*)(wxWindowDestroyEvent& c))
270 &WxBlackBoxWidgetEventHandler::OnWindowDestroy );
272 mWindow->PushEventHandler(this);
275 //=========================================================================
277 //=========================================================================
278 WxBlackBoxWidgetEventHandler::~WxBlackBoxWidgetEventHandler()
280 if (mBox.expired()) return;
281 bbtkDebugMessage("wx",9,
282 "WxBlackBoxWidgetEventHandler::~WxBlackBoxWidgetEventHandler() ["
283 <<mBox.lock()->bbGetFullName()<<"]"<<std::endl);
284 mBox.lock()->bbSetWidgetEventHandler(0);
286 //=========================================================================
288 //=========================================================================
289 void WxBlackBoxWidgetEventHandler::OnWindowDestroy(wxWindowDestroyEvent&)
291 if (mBox.expired()) return;
292 bbtkDebugMessage("wx",9,"WxBlackBoxWidgetEventHandler::OnWindowDestroy() ["
293 <<mBox.lock()->bbGetFullName()<<"]"<<std::endl);
294 mBox.lock()->bbSetOutputWidget(0);
295 mBox.lock()->bbSetModifiedStatus();
297 //=========================================================================
305 //=========================================================================
307 //=========================================================================
309 //=========================================================================
310 //=========================================================================
311 //=========================================================================
312 //=========================================================================
313 BBTK_BLACK_BOX_IMPLEMENTATION(WxBlackBox,AtomicBlackBox);
314 //=========================================================================
316 //=========================================================================
317 void WxBlackBox::bbUserConstructor()
319 bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserConstructor()"<<std::endl);
322 //=========================================================================
324 //=========================================================================
325 void WxBlackBox::bbUserCopyConstructor()
327 bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserCopyConstructor()"
331 //=========================================================================
334 //=========================================================================
335 void WxBlackBox::bbUserDestructor()
337 bbtkDebugMessage("wx",9,"==> WxBlackBox::bbUserDestructor() ["<<bbGetFullName()<<"]"<<std::endl);
339 delete bbGetWindow();
342 bbtkDebugMessage("wx",9,"<== WxBlackBox::bbUserDestructor() ["<<bbGetFullName()<<"]"<<std::endl);
344 //=========================================================================
348 //=========================================================================
349 WxBlackBox::Widget* WxBlackBox::bbGetWidget()
351 if (bbGetOutputWidget() && bbGetOutputWidget()->IsDead())
353 bbtkDebugMessage("wx",9,"WxBlackBox::bbGetWidget() ["<<
354 bbGetFullName()<<"] : Widget is dead : deleting it"
356 delete bbGetOutputWidget();
357 bbSetOutputWidget(0);
359 return bbGetOutputWidget();
361 //=========================================================================
365 //=========================================================================
367 * \brief Initialize the attributes of the class
370 void WxBlackBox::bbInitAttributes()
374 // bbSetInputWinParent(0);
375 bbSetInputWinTitle(bbGetName());
376 bbSetInputWinWidth(800);
377 bbSetInputWinHeight(800);
378 bbSetInputWinDialog(false);
379 bbSetOutputWidget(0);
381 bbSetWidgetEventHandler(0);
383 //=========================================================================
385 //=========================================================================
386 /// Main processing method of the box.
387 void WxBlackBox::bbExecute(bool force)
389 bbtkDebugMessageInc("Process",1,
390 "=> WxBlackBox::bbExecute() ["
391 <<bbGetFullName()<<"]"<<std::endl);
393 // If the output 'Widget' is connected then
394 // we must execute the parent box
395 BlackBox::OutputConnectorMapType::const_iterator i
396 = bbGetOutputConnectorMap().find("Widget");
398 if ( i->second->GetConnectionVector().size() != 0 )
400 bbtkDebugMessage("Process",2,
401 "-> Output 'Widget' connected : transfering execution to parent"
404 i->second->GetConnectionVector().front() //.lock()
405 ->GetBlackBoxTo()->bbExecute(force);
408 // else call 'standard' BlackBox execution method
411 BlackBox::bbExecute(force);
415 bbtkDebugMessageDec("Process",1,
416 "<= WxBlackBox::bbExecute() ["
417 <<bbGetFullName()<<"]"<<std::endl);
419 //=========================================================================
422 //=========================================================================
423 /// Main processing method of the box.
424 IOStatus WxBlackBox::bbBackwardUpdate( Connection::Pointer caller )
426 bbtkDebugMessageInc("Process",1,
427 "=> WxBlackBox::bbBackwardUpdate("
428 <<(caller?caller->GetFullName():"0")<<") ["
429 <<bbGetFullName()<<"]"<<std::endl);
430 // If the caller is not the connection to the output widget
431 // and the output 'Widget' is connected then
432 // we must execute the parent box
434 // (this is the role of the flag UpdateTransferedToParent=
436 ((caller!=0)&&(caller->GetBlackBoxFromOutput()!="Widget"))
439 BlackBox::OutputConnectorMapType::const_iterator i
440 = bbGetOutputConnectorMap().find("Widget") ;
441 if ( i->second->GetConnectionVector().size() != 0 )
444 bbtkDebugMessage("Process",2,
445 "-> Output 'Widget' connected : transfering update order to parent"
447 if ( bbGetUpdateTransferedToParent() )
449 bbSetUpdateTransferedToParent(false);
450 bbtkDebugMessage("Process",2,
451 " ... already transfered : abort"
456 bbSetUpdateTransferedToParent(true);
457 i->second->GetConnectionVector().front() //.lock()
458 ->GetBlackBoxTo()->bbExecute(false);
462 // call 'standard' BlackBox execution method
463 if (!bbGetUpdateTransferedToParent())
465 AtomicBlackBox::bbBackwardUpdate(caller);
468 bbtkDebugMessageDec("Process",1,
469 "<= WxBlackBox::bbBackwardUpdate() ["
470 <<bbGetFullName()<<"]"<<std::endl);
474 //=========================================================================
475 void WxBlackBox::bbProcess()
477 if (bbGetOutputWidget()==0) this->bbUserCreateWidget();
478 this->bbUserProcess();
481 //=========================================================================
483 //==================================================================
484 /// Specific methods for window creation during pipeline execution
485 /// Shows the window associated to the box
486 /// (called after bbProcess during bbExecute)
487 void WxBlackBox::bbShowWindow()
489 bbtkDebugMessageInc("Process",1,"=> WxBlackBox::bbShowWindow() ["
490 <<bbGetFullName()<<"]"<<std::endl);
492 // If Event Handler for the widget does not exist or is obsolete : create it
493 if (bbGetOutputWidget()!=0)
495 if (bbGetWidgetEventHandler()==0)
497 bbtkDebugMessage("Process",3,
498 "-> No widget event handler : creating one"
500 new WxBlackBoxWidgetEventHandler(GetThisPointer<WxBlackBox>(),
501 bbGetOutputWidget());
503 else if ( ! bbGetWidgetEventHandler()->IsHandlerOf
504 ( bbGetOutputWidget() ) )
506 bbtkDebugMessage("Process",3,
507 "-> Obsolete widget event handler : re-creating one"
509 delete bbGetWidgetEventHandler();
510 new WxBlackBoxWidgetEventHandler(GetThisPointer<WxBlackBox>(),
511 bbGetOutputWidget());
513 // Sets the name of the wxWindow to the input WinTitle
514 bbGetOutputWidget()->SetName(bbtk::std2wx(bbGetInputWinTitle()));
517 // If the output 'Widget' is connected then it's gonna
518 // be captured by its parent window : nothing to do
519 if ( (*bbGetOutputConnectorMap().find("Widget")).second
520 ->GetConnectionVector().size() != 0 )
523 bbtkDebugMessage("Process",2,
524 "-> Output 'Widget' connected : nothing to do"
526 bbtkDebugDecTab("Process",1);
532 // If the window already exists : no need creating it
533 if (bbGetWindow()!=0)
535 bbtkDebugMessage("Process",2,
536 "-> Window already exists"
538 show = bbGetWindow();
540 // Else if the widget exists : create window
541 else if (bbGetOutputWidget()!=0)
543 bbtkDebugMessage("Process",2,
544 "-> Widget exists : creating the window"
548 // Input WinDialog set to true : creating a Dialog
549 if (bbGetInputWinDialog())
551 bbtkDebugMessage("Process",2,
552 " Input WinDialog set to true : creating a Dialog"
554 show = (Window*) new WxBlackBoxDialog( GetThisPointer<WxBlackBox>(),
556 std2wx( bbGetInputWinTitle() + " - bbtk (c) CREATIS LRMN"),
557 wxSize( bbGetInputWinWidth() , bbGetInputWinHeight() ) );
559 // Input WinDialog set to false : creating a Frame
562 bbtkDebugMessage("Process",2,
563 " Input WinDialog set to false : creating a Frame"
565 show = (Window*) new WxBlackBoxFrame( GetThisPointer<WxBlackBox>(),
567 std2wx( bbGetInputWinTitle() + " - bbtk (c) CREATIS LRMN"),
568 wxSize( bbGetInputWinWidth() , bbGetInputWinHeight() ) );
572 // No window nor widget : error
575 bbtkError("WxBlackBox::bbShowWindow() ["
577 <<"] : No widget. Did you set the box output 'Widget' in the processing method of the box ?");
582 if (true) //!show->IsShown())
588 bbtkDebugMessage("Process",2,"-> Already shown : nothing to do"<<std::endl);
592 bbtkDebugMessage("Process",1,"<= WxBlackBox::bbShowWindow() ["
593 <<bbGetFullName()<<"]"<<std::endl);
594 bbtkDebugDecTab("Process",1);
596 //==================================================================
601 //==================================================================
602 void WxBlackBox::bbHideWindow()
604 bbtkDebugMessageInc("Process",1,"=> WxBlackBox::bbHideWindow() ["
605 <<bbGetFullName()<<"]"<<std::endl);
607 if (bbGetWindow()!=0) bbGetWindow()->bbHide();
609 bbtkDebugMessageDec("Process",1,"<= WxBlackBox::bbHideWindow() ["
610 <<bbGetFullName()<<"]"<<std::endl);
612 //==================================================================
615 //==================================================================
616 WxBlackBox::Window* WxBlackBox::bbGetContainingWindow()
618 if (bbGetWindow()!=0) return bbGetWindow();
619 BlackBox::OutputConnectorMapType::const_iterator i
620 = bbGetOutputConnectorMap().find("Widget");
621 if ( i->second->GetConnectionVector().size() != 0 )
623 return boost::static_pointer_cast<WxBlackBox>
624 (i->second->GetConnectionVector().front() //.lock()
625 ->GetBlackBoxTo())->bbGetContainingWindow();
629 //==================================================================
632 //==================================================================
633 wxWindow* WxBlackBox::bbGetWxParent() { return Wx::GetTopWindow(); }
634 //==================================================================
637 //==================================================================
638 bool WxBlackBox::bbIsShown()
640 if (bbGetContainingWindow()!=0)
641 return bbGetContainingWindow()->bbIsShown();
644 //==================================================================