interface.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 2008 Autodesk, Inc.
// All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
//
//**************************************************************************/
// DESCRIPTION:
// CREATED: October 2008
//**************************************************************************/

#ifndef __MUDBOXSDK_INTERFACE_H__
#define __MUDBOXSDK_INTERFACE_H__
#pragma once


namespace mudbox
{
    class MBDLL_DECL KeyboardEventNotifier : public Node
    {
        DECLARE_CLASS;

        enum Type
        {
            ePressed,
            eReleased
        } m_eType;
        int m_iKey;
        int m_iModifiers;
    };

    class MBDLL_DECL Interface : public Node
    {
    public:
        Interface( void );

        enum LayerUIType
        {
            ltSculptUI,     
            ltPaintUI       
        };
        enum MessageBoxType
        {
            msgInformation,
            msgWarning,
            msgQuestion,
            msgError
        };
        enum MessageBoxButton
        {
            buttonNone      = 0x00000000,
            buttonOk        = 0x00000400,
            buttonCancel    = 0x00400000,
            buttonClose     = 0x00200000,
            buttonYes       = 0x00004000,
            buttonYesToAll  = 0x00008000,
            buttonNo        = 0x00010000,
            buttonNoToAll   = 0x00020000,
            buttonAbort     = 0x00040000,
            buttonRetry     = 0x00080000,
            buttonIgnore    = 0x00100000,
            buttonHelp      = 0x01000000
        };
        enum HUDMessageType
        {
            HUDmsgPin,      
            HUDmsgFade      
        };

        enum StatusType
        {
            stNormal,       
            stWarning,      
            stError         
        };

        enum HotkeySetName
        {
            HotkeySetMudbox     = 0,
            HotkeySetMaya       = 1,
            HotkeySet3dsMax     = 2,
            HotkeySetSoftimage  = 3
        };

        enum MenuType
        {
            ddmFile,              
            ddmEdit,              
            ddmCreate,            
            ddmMesh,              
            ddmCurves,            
            ddmDisplay,           
            ddmMaps,              
            ddmRender,            
            ddmWindows,           
            ddmHelp,              
            ddmLayerContext,      
            ddmObjectListContext, 
            ddmHotbox,            
            ddmMarking            
        };

        class MBDLL_DECL MenuManipulator : public Node
        {
        public:
            enum MarkingMenuItemLocation
            {
                mmlocNorth,
                mmlocNorthwest,
                mmlocWest,
                mmlocSouthwest,
                mmlocSouth,
                mmlocSoutheast,
                mmlocEast,
                mmlocNortheast,
                mmlocOverflow
            };

            enum CheckState
            {
                csChecked,
                csUnchecked,
                csNoCheckbox
            };
        protected:
            MenuManipulator( void );
            DECLARE_CLASS;

        public:
            virtual MenuType Type( void ) const;
            virtual QMenu *Menu( void ) const;
            virtual Node *Object( void ) const;
            virtual QString MarkingMenuID( void ) const;
            virtual QAction *AddMenuItem( 
                const QString &sName,       
                void (*pCallback)( void ),  
                int iIndex = -1,            
                bool bDisabled = false      
                );
            virtual void AddClassMenuItem(
                const QString &sName,        
                const ClassDesc *pClass,     
                const QString &sCreatorText, 
                const int &index = -1,       
                bool bDisable = false,       
                int version = 0              
                );
            virtual void AddHotboxItem(
                const QString &sName,       
                const QString &sMarkingID,  
                const QImage &cIcon,        
                int iRadius = 40,           
                int bRing = 1               
                );
            virtual void AddMarkingMenuItem(
                const QString &sName,                   
                MarkingMenuItemLocation eLocation,      
                void (*pCallback)(void),                
                CheckState eCheckState = csNoCheckbox,  
                const QString &sParent = ""             
                );

            virtual void ClearMarkingMenu( const QString &sNewMarkingMenuID );
        };  

        QMenu *DropDownMenu( MenuType eType ) const;

        static QString menuFile;
        static QString menuEdit;
        static QString menuCreate;
        static QString menuCurves;
        static QString menuDisplay;
        static QString menuHelp;
        static QString menuPlugins;
        static QString menuMesh;
        static QString menuRender;
        static QString menuScripts;
        static QString menuMaps;
        static QString menuWindows;


        QWidget *MainWindow( void ) const;

        void ShowNewPaintLayerDialog( void );

        void ShowBrushRing( bool bShow );

        bool RestorePreviousBrush( void );

        void SetSelectedBrush( const QString &sBrushName );

        aptr<BrushOperation> SelectedBrush;

        void ActivateLayerSystem( 
            LayerUIType eType  
            );

        void Load( 
            QString filename, 
            Scene::LoadData& cData  
            );

        void ShowProperties( 
            Node *pNode,    
            bool bFloating  
            ) const;

        void ClearProperties();

        int MessageBox(
            MessageBoxType iType,   
            const QString &sTitle,  
            const QString &sText,   
            int iButtons = buttonNone,  
            int iDefaultButton = buttonNone 
            );

        int OneTimeMessageBox (
            MessageBoxType iType,   
            const QString &sTitle,  
            const QString &sText,   
            int buttons = 0  
            );

        void HUDMessageShow(
            const QString &sMessage, 
            HUDMessageType iType = HUDmsgFade   
            );
            
        void HUDMessageHide();
        
        void SetStatus(
            StatusType iType,   
            const QString& sMsg 
            );

        void AddClassMenuItem(
            const QString &sMenu,           
            const QString &sSubmenu,        
            const ClassDesc *pClass,        
            const QString &sCreatorText,    
            const int &index = -1,          
            const int &subindex = -1,       
            const bool addSeparator = false, 
            int version = 0                  
            );

        void AddCallbackMenuItem(
            const QString &sMenu,       
            const QString &sSubmenu,    
            const QString &sItemName,   
            void (*pCallback)(),        
            const QString &sID = "",    
            const int &index = -1,      
            const int &subindex = -1,   
            const bool addSeparator = false, 
            int version = 0                  
           );

        void AddWelcomeWindowButton(
            const QString &sItemName,   
            void (*pCallback)(),        
            const QString &icon = "",   
            const QString &styleSheet = ""   
            );

        void RemoveWelcomeWindowButton(
            const QString &sItemName   
            );

        void SelectHotkeySet(
            HotkeySetName newKeySet,        
            bool forceSetHotkey = false     
            );

        HotkeySetName CurrentHotkeySet() const; 

        void AddToCreateMeshMenu(QFileInfo fileInfo);
    
        void AddObjectListContextMenuItem(
            const ClassDesc *pObjectType,   
            const QString &sItemName,       
            void (*pCallback)(),            
            int index = -1,                 
            bool addSeparator = false,      
            int version = 0                 
           );

        void AddLayerCallbackMenuItem(
            mudbox::Interface::LayerUIType ltType,  
            const QString &sItemName,               
            void (*pCallback)(),                    
            int version = 0                         
           );

        QAction* CreateHighlightableMenuItem(
            const QString &text,        
            QObject *parent,            
            int version = 0             
            );

        void ProgressStart(
            const QString &sDescription,    
            unsigned int iMaxValue,         
            float fWeight = 1.0f,           
            int iDelayTime = 0            
            );

        void ProgressStartGroup(
            const QString &sDescription,        
            float fTotalWeight,                 
            int iDelayTime = 0
            );
        
        bool ProgressSet(
            unsigned int iValue     
            );
        
        bool ProgressAdd( void );
        
        void ProgressEnd( void );
        
        bool ProgressIsCancelRequested( void );

        void ProgressRequestCancel( void );

        QString LoadFileDialog(
            const QString &sTitle,       
            const QString &sPath,        
            const QString &sFilter,      
            QString* sSelectedFilter = 0 
            ) const;
        
        QString SaveFileDialog(
            const QString &sTitle,          
            const QString &sPath,           
            const QString &sFilter,         
            bool bAskForOverwrite = true,   
            QString* sSelectedFilter = 0    
            ) const;

        QString GetDirectoryDialog(
            const QString &sTitle,  
            const QString &sPath    
            ) const;

        QStringList LoadFilesDialog(
            const QString &sTitle,  
            const QString &sPath,   
            const QString &sFilter  
            ) const;

        void WaitCursorStart( void );
        
        void WaitCursorEnd( void );

        void RefreshUI( void ) const;

        void AddView(QString className, QString windowTitle, const bool select = false) const;


        float currentTabletPressure() const;


        mutable aptr<KeyboardEventNotifier> KeyboardEvent;

        aevent PostUIInitializationEvent;

        float LastPatchXPosition( void );
        float LastPatchYPosition( void );

        aptr<MenuManipulator> CurrentMenu;

        bool IsInStroke() const;

        bool IsInTumble() const;
        void SetInTumble( bool b );

        bool IsInDoubleClick() const;

        bool IsInCameraNavigation() const;
        void SetInCameraNavigation( bool bInCameraNavigation = false );
    };

    class MBDLL_DECL Action : public Node
    {
        DECLARE_CLASS;

        enum Hotkeys
        {
            keyAlt   = 0x00010000,  
            keyShift = 0x00020000,  
            keyCtrl  = 0x00040000,  
            keyMeta  = 0x00080000,  
            keyLMB   = 0x00000100,  
            keyMMB   = 0x00000200,  
            keyRMB   = 0x00000400,  
            keyWheel = 0x00000800,  
            keyLeft  = 0x01000012,  
            keyUp    = 0x01000013,  
            keyRight = 0x01000014,  
            keyDown  = 0x01000015   
        };

    public:
        Action( void );
        ~Action( void );

        virtual int DefaultHotkey( void ) const;
        virtual bool IsSticky( void ) const;
        virtual bool IsHidden( void ) const;

        virtual bool IsEnabled( void ) const;

        virtual void SetEnabled( bool bEnabled );

        virtual void OnActivate( 
            bool bRepeat    
            );
        virtual void OnDeactivate( void );
        virtual void OnCursorMove( 
            float fXPosition,   
            float fYPosition,   
            float fXChange,     
            float fYChange      
            );
        virtual void OnOptions( void );
    };
};

#endif