plugin.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

//**************************************************************************/



namespace mudbox {















struct MBDLL_DECL Plugin

{

    typedef void initializer( void );




    Plugin( void ) {};

    


    Plugin( const QString &sName, const QString &sDescription, const QString &sAuthor, const QString &sURL, const QString &sCompileTime, initializer *fFunc = 0 );

    


    static void SetVersion( const QString& sName, const QString &sVersion );



    QString m_sName;                

    QString m_sDescription;         

    QString m_sAuthor;              

    QString m_sURL;                 

    QString m_sCompileTime;         

    QString m_sPluginFolder;        

    initializer *m_pInitializer;    

    QString m_sVersion;             

};

    





class MBDLL_DECL WindowPlugin : public QObject

{

public:


    virtual void Start() = 0;

    


    virtual void Stop() = 0;

    


    virtual bool IsEnabled() = 0;

    


    virtual QWidget* CreateWidget(QWidget *parent, QString name) = 0;

    


    virtual QWidget* Widget() = 0;

    


    virtual QString Name();

    


    virtual QString Title();

    


    virtual bool AddToWindowMenu();

    

protected:

    QString m_name;

    QString m_title;

    bool    m_addToWindowMenu;

};

    





class MBDLL_DECL WebBrowserPlugin : public WindowPlugin

{

public:

    WebBrowserPlugin(const QString name, const QString title);

    


    typedef enum

    {

        eNavNone = 0,

        eNavMudLife,

        eNavTutorials,

        eNavMeshUpload,

        eNavStampUpload,

        eNavStencilUpload,

    } NavigationPoints;

    


    typedef enum

    {

        eFileTypeStamps,

        eFileTypeStencils,

        eFileTypeMeshes,

    } FileType; 

    


    virtual void Navigate(const NavigationPoints nav) = 0;

    


    virtual void Upload(const QStringList &files, const FileType fileType) = 0;

    


    virtual void GetFileList(const FileType fileType, QFileInfoList &fileList, QString filter = "") = 0;

};



}; // end of namespace mudbox