Cinder

include/cinder/app/AppBasic.h

Go to the documentation of this file.

/*
 Copyright (c) 2010, The Barbarian Group
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and
    the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
    the following disclaimer in the documentation and/or other materials provided with the distribution.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once

#include "cinder/app/App.h"
#include "cinder/Display.h"

#if defined( CINDER_MAC )
    #include <OpenGL/CGLTypes.h>
    #ifdef __OBJC__
        @class AppImplCocoaBasic;
    #else
        class AppImplCocoaBasic;
    #endif
#endif


namespace cinder { namespace app {

class AppBasic : public App {
 public:
    class Settings : public App::Settings {
     public:
        Settings();

        void    setShouldQuit ( bool aShouldQuit = true );
        void    setFullScreenSize( int aFullScreenSizeX, int aFullScreenSizeY );
        void    setFullScreen( bool aFullScreen = true );
        void    setResizable( bool aResizable = true );

        int     getFullScreenWidth() const { return mFullScreenSizeX; }
        int     getFullScreenHeight() const { return mFullScreenSizeY; }

        Display*    getDisplay() const { return mDisplay; }
        void        setDisplay( shared_ptr<Display> aDisplay );
     private:
        int         mFullScreenSizeX, mFullScreenSizeY;
        Display     *mDisplay;
    };

 public:
    AppBasic();
    virtual ~AppBasic();

    virtual void            prepareSettings( Settings *settings ) {}

    virtual int     getWindowWidth() const;
    void            setWindowWidth( int windowWidth );
    virtual int     getWindowHeight() const;
    void            setWindowHeight( int windowHeight );
    void            setWindowSize( int windowWidth, int windowHeight );

    virtual float       getFrameRate() const;
    virtual void        setFrameRate( float frameRate );
    virtual bool        isFullScreen() const;
    virtual void        setFullScreen( bool fullScreen );

    Vec2i               getMousePos() const;
    void                hideCursor();
    void                showCursor();

    const Settings&     getSettings() const { return mSettings; }
    const Display&      getDisplay();

    virtual void        quit();

    virtual std::string         getAppPath();

#if defined( CINDER_MAC )
    void                privateSetImpl__( AppImplCocoaBasic *aImpl );
#elif defined( CINDER_MSW )
    virtual bool        getsWindowsPaintEvents() { return true; }
#endif
    
    static AppBasic*    get()   { return sInstance; }

    // These are called by application instantation macros and are only used in the launch process
    static void     prepareLaunch() { App::prepareLaunch(); }
    static void     executeLaunch( AppBasic *app, class Renderer *renderer, const char *title, int argc, char * const argv[] ) { sInstance = app; App::executeLaunch( app, renderer, title, argc, argv ); }
    static void     cleanupLaunch() { App::cleanupLaunch(); }
    
    virtual void    launch( const char *title, int argc, char * const argv[] );

    virtual void    privateResize__( int width, int height );

 private:
 
    static AppBasic*    sInstance;

#if defined( CINDER_MAC )
    AppImplCocoaBasic       *mImpl;
#elif defined( CINDER_MSW )
    class AppImplMswBasic   *mImpl;
    friend class AppImplMswBasic;
#endif

    Settings        mSettings;
};

} } // namespace cinder::app

// App-instantiation macros

#if defined( CINDER_MAC )
    #define CINDER_APP_BASIC( APP, RENDERER )                               \
    int main( int argc, char * const argv[] ) {                             \
        cinder::app::AppBasic::prepareLaunch();                             \
        cinder::app::AppBasic *app = new APP;                               \
        cinder::app::Renderer *ren = new RENDERER;                          \
        cinder::app::AppBasic::executeLaunch( app, ren, #APP, argc, argv ); \
        cinder::app::AppBasic::cleanupLaunch();                             \
        return 0;                                                           \
    }
#elif defined( CINDER_MSW )
    #define CINDER_APP_BASIC( APP, RENDERER )                                                       \
    int WINAPI WinMain(HINSTANCE hInstance,HINSTANCE hPrevInstance,LPSTR lpCmdLine,int nCmdShow) {  \
        cinder::app::AppBasic::prepareLaunch();                                                     \
        cinder::app::AppBasic *app = new APP;                                                       \
        cinder::app::Renderer *ren = new RENDERER;                                                  \
        cinder::app::AppBasic::executeLaunch( app, ren, #APP, -1, 0 );                              \
        cinder::app::AppBasic::cleanupLaunch();                                                     \
        return 0;                                                                                   \
    }
#endif