RmApplication.h

//=============================================================================
//=============================================================================
//=============================================================================

#ifndef _RM_CORE_APPLICATION_H_
#define _RM_CORE_APPLICATION_H_

#include <Core/RmTypes.h>
#include <Core/RmEffect.h>

class RmUndoOp;
class IRmVariableManager;
class IRmRegistryManager;
class IRmPlugIn;
class IRmEditorPlugIn;
class IRmImporterPlugIn;
class IRmExporterPlugIn;
class IRmGeneratorPlugIn;
class IRmXMLManager;
class IRmApplication;



//=============================================================================
//=============================================================================
RM_API IRmApplication* getRmApp();

//=============================================================================
//=============================================================================
struct RM_API RmWindowData
{

   //==========================================================================
   //==========================================================================
   RmWindowData() {};

   HWND           hWnd;                                        
   RmWindowType   windowType;                                  
   RM_TCHAR       strWindowName[RM_MAXIMUM_WINDOW_TITLE_SIZE]; 
   bool           bAddToWindowListMenu;                        

   int            cmdID;                                       
   int            nDockWindowID;                               
   HICON          hIcon;                                       
   bool           bDeleteIcon;                                 


}; // End of RmWindowdata

typedef RmLinkedList<RmWindowData*>           RmWindowDataList;
typedef RmWindowDataList::iterator            RmWindowDataListIterator;
typedef RmWindowDataList::const_iterator      RmWindowDataListConstIterator;

//=============================================================================
//=============================================================================
class RM_API IRmApplication
{
public :


   //==========================================================================
   //==========================================================================
   IRmApplication();

   //==========================================================================
   //==========================================================================
   virtual ~IRmApplication();

   //==========================================================================
   //==========================================================================
   virtual HINSTANCE  GetInstance() const = 0;

   //==========================================================================
   //==========================================================================
   virtual void OutputText( const RM_TCHAR *strText, ...) = 0;

   //==========================================================================
   //==========================================================================
   virtual void ClearOutputWindow() = 0;

   //..........................................................................
   //..........................................................................
   //  application 
   //..........................................................................
   //..........................................................................

   //==========================================================================
   //==========================================================================
   virtual void SetStatusText( const RM_TCHAR *strText ) = 0;

   //==========================================================================
   //==========================================================================
   virtual HWND GetMainWindow() = 0;

   //==========================================================================
   //==========================================================================
   virtual HWND GetMDIClientWindow() = 0;

   //==========================================================================
   //==========================================================================
   virtual void UpdateTitle() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void UpdateWindows() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual HMENU GetMainMenu() = 0;
                           
   //==========================================================================
   //==========================================================================
   virtual HICON GetIcon(  RmIconID   nRmIconID,
                           RmIconSize nRmIconSize = RM_ICON_SIZE_SMALL ) = 0;

   //==========================================================================
   //==========================================================================
   virtual HICON CreateIcon(  RmIconID    nRmIconID,
                              RmIconSize  nRmIconSize = RM_ICON_SIZE_SMALL,
                              bool        bTransparent = false,
                              COLORREF    rgbBackground = RGB( 255, 255, 255 ) ) = 0;

   //==========================================================================
   //==========================================================================
   virtual RmIconID GetRmIconID( RmNode *pRmNode ) = 0;
   
   //==========================================================================
   //          call failed
   //==========================================================================
   virtual HWND CreateMDIChildFrame() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void RegisterWindow( HWND         hWnd,
                                RmWindowType windowType,
                                bool         bAddToWindowListMenu,
                                HICON        hIcon = NULL,
                                bool         bDeleteIcon = false,
                                int          nDockWindowID = 0 ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void RegisterWindow( const RmWindowData *pWindowData ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void UnregisterWindow ( HWND hWin ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void OnWindowNameChanged( HWND hWnd ) = 0;

   //..........................................................................
   //..........................................................................
   //                         Docking window-related methods
   //..........................................................................
   //..........................................................................

   //==========================================================================
   //==========================================================================
   virtual int GetAvailableDockingWindowID() = 0;

   //==========================================================================
   //==========================================================================
   virtual HWND FindDockingWindow( int nID ) = 0;

   //==========================================================================
   //==========================================================================
   virtual HWND CreateDockingWindow( int                 nWindowID, 
                                     const RM_TCHAR     *strWindowTitle,
                                     RmDockingPaneLayout initialDockSite = RM_WINDOWDOCK_FLOAT,
                                     const RECT         *pRect = NULL ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void SetDockingWindowTitle( int nWindowID, const RM_TCHAR *strWindowTitle ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void SetDockingWindowIcon( int nWindowID, HICON hIcon ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void ShowDockWindow( int ID, bool bShow ) = 0;
   
   //..........................................................................
   //..........................................................................
   //..........................................................................
   //..........................................................................
     
   //==========================================================================
   //==========================================================================
   virtual void BroadcastMessage(   int               nMessageID,
                                    int               nMessageData,
                                    int               nMessageParameter = 0,
                                    const RmPlugInID* pRmPlugInID       = NULL ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void BroadcastMessage( RmPlugInType      nPluginType,
                                  int               nMessageID,
                                  int               nMessageData,
                                  int               nMessageParameter = 0,
                                  const RmPlugInID* pRmPlugInID       = NULL ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmEffectWorkspace* GetWorkspace() = 0;

   //==========================================================================
   //==========================================================================
   virtual const RM_TCHAR* GetWorkspacePath() = 0;

   //==========================================================================
   //==========================================================================
   virtual void GetInitialWorkspacePath( RM_TCHAR *pStrPath, int nSize ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void GetDefaultWorkspacePath( RM_TCHAR *pStrPath, int nSize ) = 0;

   //==========================================================================
   //==========================================================================
   virtual RmNode* CreateNode( const RM_TCHAR* pStrNodeTypeChain, const RM_TCHAR* pStrXMLVersion = NULL ) = 0;

   //==========================================================================
   //==========================================================================
   virtual HWND EditNode( RmNode *pNode, IRmEditorPlugIn *pPreferedEditorPlugIn = NULL ) = 0;

   //==========================================================================
   //==========================================================================
   virtual int GetNodeSortCompareIndex( RmNode* pRmNodeA, RmNode* pRmNodeB ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual int GetNodeTypeSortCompareIndex( const RM_TCHAR *pStrNodeType ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmLinkedList< IRmPlugIn* > GetGenericPlugInList( RmNode *pNode ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmLinkedList< IRmEditorPlugIn* > GetNodeEditorPlugInList( RmNode *pNode ) = 0;

   //==========================================================================
   //==========================================================================
   virtual RmLinkedList< IRmImporterPlugIn* > GetImporterPlugInList( RmNode *pNode ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmLinkedList< IRmExporterPlugIn* > GetExporterPlugInList( RmNode *pNode ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmLinkedList< IRmGeneratorPlugIn* > GetGeneratorPlugInList( RmNode *pNode ) = 0;

   //==========================================================================
   //==========================================================================
   virtual IRmPlugIn* GetPlugIn( const RmPlugInID* pRmPlugInID ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void OnChangedActiveEffect() = 0;

   //==========================================================================
   //==========================================================================
   virtual RmNodeID GetNextAvailableNodeID() = 0;

   //==========================================================================
   //==========================================================================
   virtual RmNode* GetNodeFromID( const RmNodeID& nodeID ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void RegisterNode( RmNode *pNode, bool bRecursive = false ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void UnregisterNode( RmNode *pNode, bool bRecursive = false ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void SuspendNodeRegistration() = 0;

   //==========================================================================
   //==========================================================================
   virtual void  ResumeRegisterNode() = 0;

   //==========================================================================
   //==========================================================================
   virtual void RefreshNodeID( RmNode *pNode, bool bRecursive = false ) = 0;

   //==========================================================================
   //==========================================================================
   virtual bool IsLoading() = 0;

   //==========================================================================
   //==========================================================================
   virtual void SetIsLoading( bool bIsLoading ) = 0;

   //==========================================================================
   //==========================================================================
   virtual bool IsSaving() = 0;

   //==========================================================================
   //==========================================================================
   virtual void SetIsSaving( bool bIsSaving ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void BuildReferenceChangeUpdateList( RmNode* pRmNode, RmLinkedList< RmNodeID* >* pRmNodeIDList ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void SendReferenceChangeUpdateList( RmLinkedList< RmNodeID* >* pRmNodeIDList ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void SendReferenceChangeUpdateDifferenceList( RmLinkedList< RmNodeID* >* pRmNodeIDList1,
                                                         RmLinkedList< RmNodeID* >* pRmNodeIDList2 ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void ReCalculateRelativePaths( const RM_TCHAR* strNewAppPath,
                                          RmNode*         pRmNode,
                                          bool            bAlwaysConvert ) = 0;

   //==========================================================================
   //==========================================================================
   virtual bool ImportXML( RmEffectWorkspace *pRmEffectWorkspace,
                           const RM_TCHAR    *strFileName,
                           const RM_TCHAR    *pStrRmXMLVersion,
                           bool               bQuietTempLoad = false ) = 0;

   
   //==========================================================================
   //==========================================================================
   virtual void SetDebugMode( bool bDebugMode ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual bool GetDebugMode() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmEffectWorkspace* GetDefaultWorkspaceCopy() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual bool CreateNewWorkspace() = 0;

   //==========================================================================
   //==========================================================================
   virtual bool IsSaveNeeded() const = 0;

   //==========================================================================
   //==========================================================================
   virtual void SetSaveNeeded( bool bSaveNeeded ) = 0;

   //..........................................................................
   //..........................................................................
   //..........................................................................
   //..........................................................................

   //==========================================================================
   //==========================================================================
   virtual IRmVariableManager* GetPredefinedVariableManager() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual const IRmVariableManager* GetPredefinedVariableManager() const = 0;

   //==========================================================================
   //==========================================================================
   virtual IRmVariableManager* GetPrelinkedVariableManager() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual const IRmVariableManager* GetPrelinkedVariableManager() const = 0;
   
   //==========================================================================
   //==========================================================================
   virtual IRmRegistryManager* GetRegistryManager() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual const IRmRegistryManager* GetRegistryManager() const = 0;

   //==========================================================================
   //==========================================================================
   virtual IRmXMLManager*       GetXMLManager() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual const IRmXMLManager* GetXMLManager() const = 0;

   //==========================================================================
   //==========================================================================
   virtual void GetGeneralPreferenceData( RmGeneralPreferenceData* pGeneralPreferenceData ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual float GetTimeCycle() = 0;

   //==========================================================================
   //==========================================================================
   virtual RmViewerUIMode GetViewerUIMode() = 0;
   
   //..........................................................................
   //..........................................................................
   //..........................................................................
   //..........................................................................
      

   //==========================================================================
   //==========================================================================
   virtual bool CanLoadGeometryModel( const RM_TCHAR* strFileName ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual bool LoadGeometryModel( const RM_TCHAR* strFileName, RmMeshModelContainer *pModelContainer ) = 0;

   //==========================================================================
   //==========================================================================
   virtual RmStringList GetModelFileList() = 0;
   
   //==========================================================================
   //==========================================================================
   virtual RmStringT GetSupportedGeometryFileExtensions( RmStringT &strDefaultExtension ) = 0;

   //..........................................................................
   //..........................................................................
   //..........................................................................
   //..........................................................................

   //==========================================================================
   //==========================================================================
   virtual bool CanLoadTexture(  RmTextureType   textureType,
                                 const RM_TCHAR *strFileName ) = 0;
                                 
   //==========================================================================
   //==========================================================================
   virtual bool LoadTexture( const RM_TCHAR   *strFileName, 
                             RmTexture        *pTexture, 
                             RmPixelFormatType format = RM_PIXELFORMAT_UNKNOWN ) = 0;
                             
   //==========================================================================
   //==========================================================================
   virtual RmStringList GetTextureFileList( RmTextureType textureType ) = 0;
                                           
   //==========================================================================
   //==========================================================================
    virtual RmStringT GetSupportedTextureFileExtensions( RmTextureType textureType, RmStringT &strDefaultExtension ) = 0;

   //..........................................................................
   //..........................................................................
   //..........................................................................
   //..........................................................................

   //==========================================================================
   //==========================================================================
   virtual void StartUndoMaking( RmUndoOp *pUndoOp ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void StartUndoMaking( const RM_TCHAR *strOpName ) = 0;

   //==========================================================================
   //==========================================================================
   virtual void EndUndoMaking() = 0;

   //==========================================================================
   //==========================================================================
   virtual void AddUndo( RmUndoOp* pUndoOp ) = 0;

   //==========================================================================
   //==========================================================================
   virtual bool CanUndo() const = 0;

   //==========================================================================
   //==========================================================================
   virtual bool CanRedo() const = 0;

   //==========================================================================
   //==========================================================================
   virtual void Undo() = 0;

   //==========================================================================
   //==========================================================================
   virtual void Redo() = 0;

   //==========================================================================
   //==========================================================================
   virtual bool IsMakingUndo() const = 0;

   //==========================================================================
   //==========================================================================
   virtual HACCEL GetAccelerator() const = 0;      

   //==========================================================================
   //==========================================================================
   virtual void CompileEffect( RmEffect *pEffect ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void CompileShader( RmShader *pRmShader ) = 0;
   
   //==========================================================================
   //==========================================================================
   virtual void BeginMessageBlock() = 0;

   //==========================================================================
   //==========================================================================
   virtual void EndMessageBlock() = 0;

   //==========================================================================
   //==========================================================================
   virtual bool GetIsInMessageBlock() = 0;
   
protected :

   //==========================================================================
   //==========================================================================
   void InitDebugHelper();

   //==========================================================================
   //==========================================================================
   void UninitializeDebugHelper();

}; //  End of IRmApplication interface declaration


//=============================================================================
// Error logging and debug output 
// 
// To use: Use #define(d) functions like this:
//       RmErrorLog( "My debug problem" );
// which will output the line number and all the goodies into the debug output 
// Do not use these methods directly
//=============================================================================
void  RM_API RmSetErrorLogFileName( RM_TCHAR *strFileName );
void  RM_API RmErrorLogExact      ( const RM_TCHAR* strString, ...);
bool  RM_API RmSetupErrorLog      ( RM_TCHAR* strFileName, const int nLineNumber, bool bFatal, bool bShort ); // Always returns FALSE
void  RM_API RmSpawnErrorLog();
void  RM_API RmSpawnErrorLogIfNeeded();
void  RM_API RmErrorLogRecordStart();
void  RM_API RmErrorLogRecordStop();

#define RmErrorLog      if ( RmSetupErrorLog(_T(__FILE__), __LINE__, TRUE, FALSE))  ; else RmErrorLogExact
#define RmErrorLogInfo  if ( RmSetupErrorLog(_T(__FILE__), __LINE__, FALSE, FALSE)) ; else RmErrorLogExact
#define RmErrorLogShort if ( RmSetupErrorLog(_T(__FILE__), __LINE__, FALSE, TRUE))  ; else RmErrorLogExact

#ifdef _UNICODE
   #define RmPrintf wprintf
#else
   #define RmPrintf printf
#endif

#endif // __RmApp_h__

---