albaGUIDynamicVP.h

Go to the documentation of this file.

/*========================================================================= 
  Program: Multimod Application Framework RELOADED 
  Module: $RCSfile: albaGUIDynamicVP.h,v $ 
  Language: C++ 
  Date: $Date: 2012-04-06 08:28:41 $ 
  Version: $Revision: 1.1.2.5 $ 
  Authors: Josef Kohout (Josef.Kohout *AT* beds.ac.uk)
  ========================================================================== 
  Copyright (c) 2008 University of Bedfordshire (www.beds.ac.uk)
  See the COPYINGS file for license details 
  =========================================================================  
*/
 
#ifndef __albaGUIDynamicVP_H__
#define __albaGUIDynamicVP_H__
 
//----------------------------------------------------------------------------
// Include:
//----------------------------------------------------------------------------
#include "albaDefines.h"
#include "albaEvent.h"
#include "albaObserver.h"
#include "albaGUIPanel.h"
 
//----------------------------------------------------------------------------
// forward references :
//----------------------------------------------------------------------------
class albaPipe;
class albaSceneNode;
 
class albaView;
class albaGUI;
class albaGUIScrolledPanel;
class wxStaticLine;
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
class ALBA_EXPORT albaGUIDynamicVP: public albaGUIPanel, public albaObserver
{
public:  
  enum PLAYER_WIDGET_ID
  {
    ID_NAME = MINID, //must be MINID otherwise validators do not work
    ID_CREATE_VP,
    ID_CLOSE_VP,
  };
 
  enum GUI_STYLE
  {
    GS_DEFAULT        = 0,
    GS_READONLY_NAME  = 1,
    GS_NO_NAME        = 2,
    GS_NO_CREATE_VP   = 4,
    GS_NO_CLOSE_VP    = 8,    
  };
 
  //structure to store information about visual pipe
  typedef struct SUPPORTED_VP_ENTRY
  {
    const char* szClassName;            
    const char* szUserFriendlyName;     
  } SUPPORTED_VP_ENTRY;
 
protected:
#pragma region Register of Pipes
  class albaPipeRegister
  {
  protected:    
    typedef struct VIEW_ITEM
    {
      albaView* m_View;
      std::vector< albaPipe* > m_Pipes;      
    } VIEW_ITEM;
      
    static std::vector< VIEW_ITEM > m_RegViews; 
  public:
    static int RegisterPipe(albaPipe* pipe, albaView* view);
 
    static int UnregisterPipe(albaPipe* pipe, albaView* view = NULL);
  protected:
    static int FindView(albaView* view);
  };
#pragma endregion Register of Pipes
 
protected:  
  long m_GuiStyle;                
  wxWindowID  m_NotifyId;         
  albaObserver* m_Listener;        
 
  const SUPPORTED_VP_ENTRY* m_VPipes; 
 
  int m_VPipeIndex;             
  albaPipe* m_VPipe;             
  albaSceneNode* m_SceneNode;    
  albaString m_Name;             
 
#pragma region GUI
  wxComboBox* m_ComboVP;
 
  wxPanel* m_GUI_This;
  albaGUIScrolledPanel* m_GUI_VP;  
#pragma endregion GUI
 
  bool m_BGUIThisShown;      
 
protected:
  DECLARE_EVENT_TABLE();
 
public:
  albaGUIDynamicVP(wxWindow* parent, wxWindowID id, 
    long GUIstyle =  GS_DEFAULT, 
    const wxPoint& pos = wxDefaultPosition, 
    const wxSize& size = wxDefaultSize, long style = wxTAB_TRAVERSAL);
  virtual ~albaGUIDynamicVP();    
 
  inline albaObserver* GetListener(){
    return m_Listener;
  };
 
  inline void SetListener(albaObserver *Listener){
    m_Listener = Listener;
  };
 
  inline const char* GetName() {
    return m_Name;
  }
 
  void SetName(const char* szNewName);    
 
  inline const SUPPORTED_VP_ENTRY* GetVPipesList() {
    return m_VPipes;
  }
 
  void SetVPipesList(const SUPPORTED_VP_ENTRY* pList);
 
  inline int GetVPipeIndex() {
    return m_VPipeIndex;
  }
 
  void SetVPipeIndex(int nNewIndex);  
 
  inline long GetGUIStyle() {
    return m_GuiStyle;
  }
 
  void SetGUIStyle(long newtyle);
 
  inline albaSceneNode* GetSceneNode() {
    return m_SceneNode;
  }
 
  void SetSceneNode(albaSceneNode* node);  
 
  inline albaPipe* GetCurrentVisualPipe() {
    return m_VPipe;
  }
 
  /*virtual*/ void OnEvent(albaEventBase *e);
 
protected:  
  virtual void CreateVisualPipe(const char* classname);
 
  virtual void DestroyVisualPipe();
 
  virtual void OnCreateVP();  
 
  virtual void OnCloseVP();  
 
  virtual void NotifyListener(long nData);
 
  virtual wxSizer* CreateGUI(long style);
 
  void OnDeferedDelete(wxEvent& event);
};
#endif