albaLogicWithManagers.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaLogicWithManagers
 Authors: Silvano Imboden, Paolo Quadrani
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef __albaLogicWithManagers_H__
#define __albaLogicWithManagers_H__
 
 
//----------------------------------------------------------------------------
// includes :
#include "albaGUIPanel.h"
#include "albaDecl.h"
#include "albaEvent.h"
#include "albaVMEManager.h"
#include "albaGUIMDIFrame.h"
#include "albaSideBar.h"
#include "albaAbsLogicManager.h"
 
 
//----------------------------------------------------------------------------
// forward reference
class albaViewManager;
class albaOpManager;
class albaGUIMaterialChooser;
class albaVME;
class albaVMELandmark;
class albaVMELandmarkCloud;
class albaInteractionManager;
class albaPrintManager;
class albaDeviceButtonsPadMouse;
class albaGUISettingsDialog;
class albaGUIAboutDialog;
class albaGUISplashScreen;
class albaGUISettings;
class albaUser;
class albaWizardManager;
class albaWizard;
class albaGUITimeBar;
class albaWXLog;
class albaVTKLog;
class albaGUIApplicationSettings;
class albaGUISettingsTimeBar;
class albaHelpManager;
class albaSnapshotManager;
class mmaApplicationLayout;
class albaProsthesesDBManager;
 
typedef int(*eventfilterFunc)(wxEvent& event);
 
//----------------------------------------------------------------------------
// albaLogicWithManagers :
//----------------------------------------------------------------------------
class ALBA_EXPORT albaLogicWithManagers : public albaObserver, public albaAbsLogicManager
{
public:
 
   albaLogicWithManagers(albaGUIMDIFrame *mdiFrame = NULL);
   virtual     ~albaLogicWithManagers();
 
   virtual void OnEvent(albaEventBase *alba_event);
 
   virtual void Plug(albaView* view, bool visibleInMenu = true);
 
 
   virtual void Plug(albaOp *op, wxString menuPath = "", bool canUndo = true, albaGUISettings *setting = NULL);
 
   virtual void Configure();
 
   void CreateToolBarsAndPanels();
 
   virtual void Init(int argc, char **argv);
 
   void PlugVMEManager(bool b) { m_UseVMEManager = b; };
 
   void PlugViewManager(bool b) { m_UseViewManager = b; };
 
   void PlugOpManager(bool b) { m_UseOpManager = b; };
 
   void PlugInteractionManger(bool b) { m_UseInteractionManager = b; }
 
   void PlugWizardManager(bool b) { m_UseWizardManager = b; };
 
   void PlugSnapshotManager(bool b) { m_UseSnapshotManager = b; };
 
   /* Initialize Prosthesis DB Manager*/
   void PlugProsthesisDBManager(albaString passPhrase = "");
 
   virtual void Plug(albaWizard *wizard, wxString menuPath = "");
 
   virtual void Show();
 
   void FillMenus();
 
   albaUser *GetUser() { return m_User; };
 
   void SetApplicationStamp(albaString &app_stamp);
 
   virtual void HandleException();
 
   int AppEventFilter(wxEvent& event);
 
 
   void ALBAExpertModeOn() { (*GetALBAExpertMode()) = true; };
   void ALBAExpertModeOff() { (*GetALBAExpertMode()) = false; };
   void SetALBAExpertMode(int value) { (*GetALBAExpertMode()) = value; };
 
   void SetFileExtension(albaString &extension) { m_Extension = extension; };
 
   virtual albaGUIMDIFrame *GetTopWin() { return m_Win; };
 
   void PlugToolbar(bool plug) { m_PlugToolbar = plug; };
   void PlugSidebar(bool plug) { m_PlugControlPanel = plug; };
   void PlugTimebar(bool plug) { m_PlugTimebar = plug; };
   void PlugLogbar(bool plug) { m_PlugLogPanel = plug; };
 
   
   virtual void ShowSplashScreen(wxBitmap &splashImage, wxString message ="", int pos=2, wxColour color = *wxBLACK);
 
   static void ShowWebSite(wxString url);
   
   bool IsOperationRunning() { return m_RunningOperation; }
 
   // VME
   virtual const char* GetMsfFileExtension() { return m_Extension.GetCStr(); }
      
   /* Return the Operation Manager */
   virtual albaOpManager * GetOpManager() const { return m_OpManager; }
 
   virtual albaViewManager *GetViewManager() { return m_ViewManager; }
 
   virtual void PrintImage(albaVMEImage *img);
 
   eventfilterFunc GetEventFilterFunc() const { return m_EventFilterFunc; }
 
   void SetEventFilterFunc(eventfilterFunc val) { m_EventFilterFunc = val;}
 
   mmaApplicationLayout* GetLayout() { return m_AppLayout; };
 
   // Inherited via albaAbsLogicManager
   virtual albaProsthesesDBManager * GetProsthesesDBManager();
 
   void PlugStandardOperations();
 
   void PlugStandardViews();
 
   albaString GetAboutImage() const { return m_AboutImage; }
 
   void SetAboutImage(albaString aboutImage) { m_AboutImage = aboutImage; }
 
   virtual bool IsVMEExpanded(albaVME *vme);
 
   virtual void CollapseVME(albaVME *vme);
 
   virtual void ExpandVME(albaVME *vme);
   
   
   virtual const char* GetAppBuildNum();
   virtual void SetAppBuildNum(char* buildNum);
   virtual const char* GetAlbaBuildNum();
   virtual void SetAlbaBuildNum(char* buildNum);
   const char *GetCitationPaper() { return m_CitationPaper.GetCStr(); }
   void SetCitationPaper(char *link) { m_CitationPaper = link; }
 
   void RegisterForKeyEvents(albaObserver *listener) override;
 
 
   void UnRegisterForKeyEvents(albaObserver *listener) override;
 
protected:
   //---------------------------------------------------------
   // Description:
   // Method to update the time bounds when 
   // the tree representation change by adding or deleting a vme.
   virtual void UpdateTimeBounds();
 
   // Description:
   // Set the time to update the time bar.
   virtual void TimeSet(double t);
   //---------------------------------------------------------
 
   virtual void CreateMenu();
   virtual void CreateStorage(albaEvent *e);
 
   virtual void CreateAndPlugToolbar();
 
   virtual void CreateToolbar();
 
   virtual void CreateControlPanel();
   virtual void CreateTimeBar();
   virtual void CreateLogPanel();
   void CreateNullLog();
 
 
   void EnableItem(int item, bool enable);
 
   void StoreLayout();
 
   virtual void RestoreLayout();
 
   // EVENT HANDLERS
 
   virtual void OnFileNew();
   virtual void OnFileOpen(const char *file_to_open = NULL);
   virtual void OnFileHistory(int menuId);
   virtual void OnFileSave();
   virtual void OnFileSaveAs(bool legacy = false);
 
   virtual void OnQuit();
 
   virtual void ImportExternalFile(albaString &filename);
 
   virtual void VmeSelect(albaVME *vme);
   virtual void VmeSelected(albaVME *vme);
 
   void SelectLandmark(albaVMELandmark *lm, bool select);
 
   virtual void VmeDoubleClicked(albaEvent &e);
   virtual void VmeShow(albaVME *vme, bool visibility);
 
   void ShowLandmarkCloud(albaVMELandmarkCloud * lmc, bool visibility);
 
   void ShowInSideBar(albaVME * vme, bool visibility);
 
   /* Called from VmeShow to show landmarks*/
   void ShowLandmark(albaVMELandmark * lm, bool visibility);
 
   virtual void VmeModified(albaVME *vme);
 
   virtual void VmeAdd(albaVME *vme);
   virtual void VmeAdded(albaVME *vme);
   virtual void VmeRemove(albaVME *vme);
   virtual void VmeRemoving(albaVME *vme);
   virtual void VmeRemoved();
 
   virtual void VmeVisualModeChanged(albaVME * vme);
      
   virtual void VmeChooseMaterial(albaVME *vme, bool updateProperty);
 
   //Update Vme Visual Properties
   virtual void VmeUpdateProperties(albaVME *vme, bool updatePropertyFromTag);
 
   virtual void OpRunStarting();
   virtual void OpRunTerminated(int runOk);
   virtual void OpShowGui(bool push_gui, albaGUIPanel *panel);
   virtual void OpHideGui(bool view_closed);
 
   virtual void TreeContextualMenu(albaEvent &e);
 
   virtual void ViewContextualMenu(bool vme_menu);
 
   virtual void ViewCreate(int viewId);
   virtual void ViewCreated(albaView *v);
   virtual void ViewSelect();
 
   virtual void CameraUpdate();
 
   virtual void CameraReset();
 
   virtual void EnableCameraUpdateSkip();
 
   virtual void DisableCameraUpdateSkip();
 
   void UpdateMeasureUnit();
 
   virtual void EnableMenuAndToolbar();
 
   virtual void UpdateFrameTitle();
 
   //-------------------
 
 
   virtual void ConfigureWizardManager();
 
   virtual void WizardRunStarting();
 
   virtual void WizardRunTerminated();
 
   virtual void CreateWizardToolbar();
 
 
 
   albaAbsSideBar          *m_SideBar;
   albaVMEManager          *m_VMEManager;
   albaViewManager         *m_ViewManager;
   albaOpManager           *m_OpManager;
   albaInteractionManager  *m_InteractionManager;
   albaHelpManager             *m_HelpManager;
   albaSnapshotManager      *m_SnapshotManager;
   albaVMELandmark             *m_SelectedLandmark;
   albaProsthesesDBManager *m_ProsthesisDBManager;
 
 
   albaGUIMaterialChooser  *m_MaterialChooser;
   albaPrintManager     *m_PrintSupport;
 
   albaDeviceButtonsPadMouse            *m_Mouse;
 
   mmaApplicationLayout *m_AppLayout;
 
   wxMenu *m_ImportMenu;
   wxMenu *m_ExportMenu;
   wxMenu *m_RecentFileMenu;
   wxMenu *m_OpMenu;
   wxMenu *m_ViewMenu;
 
   bool m_UseVMEManager;
   bool m_UseViewManager;
   bool m_UseOpManager;
   bool m_UseInteractionManager;
   bool m_UseHelpManager;
   bool m_UseSnapshotManager;
 
   eventfilterFunc m_EventFilterFunc;
 
   albaGUISettingsDialog   *m_SettingsDialog;
   albaGUIAboutDialog         *m_AboutDialog;
 
   albaString m_AlbaBuildNum;
   albaString m_AppBuildNum;
   albaString m_CitationPaper;
   albaString m_Extension;
 
   albaUser *m_User; 
 
   albaWizardManager *m_WizardManager;
   bool m_UseWizardManager;
   bool m_WizardRunning;
   bool m_RunningOperation;
   wxGauge *m_WizardGauge;
   wxStaticText* m_WizardLabel;
   bool m_CancelledBeforeOpStarting;
   wxMenu *m_WizardMenu;
   albaGUISplashScreen* m_SplashScreen;
 
   long                    m_ChildFrameStyle;
   albaGUIMDIFrame      *m_Win;
   wxToolBar         *m_ToolBar;
   wxMenuBar         *m_MenuBar;
   wxString             m_LastSelectedPanel;
   albaGUITimeBar       *m_TimePanel;
   wxString             m_AppTitle;
   albaString           m_AboutImage;
 
   bool                    m_LogToFile;
   albaWXLog          *m_Logger;
   albaVTKLog         *m_VtkLog;
 
   int            m_SkipCameraUpdate;
   
   albaGUIApplicationSettings *m_ApplicationSettings;
   albaGUISettingsTimeBar  *m_TimeBarSettings;
 
   std::vector<albaObserver *> m_KeyEventListeners; 
 
   bool m_Quitting;    
   bool m_PlugMenu;    
   bool m_PlugToolbar; 
   bool m_PlugControlPanel; 
   long m_SidebarStyle;
   bool m_PlugTimebar; 
   bool m_PlugLogPanel;  
   bool m_ShowStorageSettings; 
   bool m_ShowInteractionSettings; 
   bool m_FatalExptionOccurred;
   bool m_OpeningMSF;
private:
   
};
#endif