include/cinder/app/AppBasic.h

Go to the documentation of this file.

/*
 Copyright (c) 2012, The Cinder Project, All rights reserved.

 This code is intended for use with the Cinder C++ library: http://libcinder.org

 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/Cinder.h"
#include "cinder/app/App.h"
#include "cinder/Display.h"
#include "cinder/Function.h"

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

#include "cinder/app/TouchEvent.h"

namespace cinder { namespace app {

typedef signals::signal<bool (),BooleanAndEventCombiner>                EventSignalShouldQuit;

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

        void    setShouldQuit ( bool aShouldQuit = true );
        bool    isFullScreen() { return mDefaultWindowFormat.isFullScreen(); }

        bool    isResizable() const { return mDefaultWindowFormat.isResizable(); }
        void    setResizable( bool resizable = true ) { mDefaultWindowFormat.setResizable( resizable ); }
        bool    isBorderless() const { return mDefaultWindowFormat.isBorderless(); }
        void    setBorderless( bool borderless = true ) { mDefaultWindowFormat.setBorderless( borderless ); }
        bool    isAlwaysOnTop() const { return mDefaultWindowFormat.isAlwaysOnTop(); }
        void    setAlwaysOnTop( bool alwaysOnTop = true ) { mDefaultWindowFormat.setAlwaysOnTop( alwaysOnTop ); }

        DisplayRef  getDisplay() const { return mDefaultWindowFormat.getDisplay(); }
        void        setDisplay( DisplayRef display ) { mDefaultWindowFormat.setDisplay( display ); }

#if defined( CINDER_MSW )

        void    enableConsoleWindow( bool enable = true ) { mEnableMswConsole = enable; }
        bool    isConsoleWindowEnabled() const { return mEnableMswConsole; }
#endif

        void        enableQuitOnLastWindowClose( bool enable = true ) { mQuitOnLastWindowClose = enable; }
        bool        isQuitOnLastWindowCloseEnabled() const { return mQuitOnLastWindowClose; }

     private:
        bool        mQuitOnLastWindowClose;
#if defined( CINDER_MSW )
        bool        mEnableMswConsole;
#endif
    };

    // This is really just here to disambiguate app::WindowRef from the WindowRef found in QuickDraw (so that client code doesn't have to invoke cinder::app::WindowRef explicitly) 
    typedef std::shared_ptr<Window>     WindowRef;

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

    virtual void        prepareSettings( Settings *settings ) {}

    EventSignalShouldQuit&  getSignalShouldQuit() { return mSignalShouldQuit; }

    WindowRef       createWindow( const Window::Format &format = Window::Format() );
    
    virtual float       getFrameRate() const;
    virtual void        setFrameRate( float frameRate );
    virtual void        disableFrameRate();
    virtual bool        isFrameRateEnabled() const; 

    void                hideCursor();
    void                showCursor();

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


    virtual void        quit();

    const std::vector<std::string>&     getArgs() const { return mCommandLineArgs; }

    virtual fs::path    getAppPath() const;
    
    virtual app::WindowRef  getWindow() const;
    virtual size_t          getNumWindows() const;
    virtual WindowRef       getWindowIndex( size_t index ) const;
    virtual WindowRef       getForegroundWindow() const;

    // DO NOT CALL - should be private but aren't for esoteric reasons
    // Internal handlers - these are called into by AppImpl's. If you are calling one of these, you have likely strayed far off the path.
#if defined( CINDER_MAC )
    void        privateSetImpl__( AppImplCocoaBasic *aImpl );
#endif
    bool        privateShouldQuit();
    
#if 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(); }
#if defined( CINDER_MSW )
    static void     executeLaunch( AppBasic *app, RendererRef renderer, const char *title );
#elif defined( CINDER_MAC )
    static void     executeLaunch( AppBasic *app, RendererRef renderer, const char *title, int argc, char * const argv[] ) { App::sInstance = sInstance = app; App::executeLaunch( app, renderer, title, argc, argv ); }
#endif
    static void     cleanupLaunch() { App::cleanupLaunch(); }
    
    virtual void    launch( const char *title, int argc, char * const argv[] );

  protected:
    static AppBasic*    sInstance;

    EventSignalShouldQuit   mSignalShouldQuit;

#if defined( CINDER_MAC )
    AppImplCocoaBasic           *mImpl;
#elif defined( CINDER_MSW )
    class AppImplMswBasic   *mImpl;
    friend class AppImplMswBasic;
#endif
    
    std::vector<std::string>    mCommandLineArgs;

    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::RendererRef 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::RendererRef ren( new RENDERER );                                               \
        cinder::app::AppBasic::executeLaunch( app, ren, #APP );                                     \
        cinder::app::AppBasic::cleanupLaunch();                                                     \
        return 0;                                                                                   \
    }
#endif