include/cinder/app/AppCocoaTouch.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/cocoa/CinderCocoaTouch.h"
#include "cinder/app/Window.h"
#include "cinder/app/TouchEvent.h"

#ifdef __OBJC__
    @class AppImplCocoaTouch;
#else
    class AppImplCocoaTouch;
#endif

namespace cinder { namespace app {

struct AppCocoaTouchState;

enum InterfaceOrientation {
    Unknown                 = 0,
    Portrait                = 1 << 0,
    PortraitUpsideDown      = 1 << 1,
    LandscapeLeft           = 1 << 2,
    LandscapeRight          = 1 << 3,
    PortraitAll             = (Portrait | PortraitUpsideDown),
    LandscapeAll            = (LandscapeLeft | LandscapeRight),
    All                     = (PortraitAll | LandscapeAll)
};

typedef signals::signal<uint32_t (), BitwiseAndEventCombiner<uint32_t> >        EventSignalSupportedOrientations;

class AppCocoaTouch : public App {
  public:
    class Settings : public App::Settings {
      public:
        Settings()
            : App::Settings(), mEnableStatusBar( false )
        {
            mPowerManagement = false;
        }

        void        enableStatusBar( bool enable = true ) { mEnableStatusBar = enable; }
        bool        isStatusBarEnabled() const { return mEnableStatusBar; }
        
      private:
        bool        mEnableStatusBar;
    };

    AppCocoaTouch();
    virtual ~AppCocoaTouch() {}

    virtual void        prepareSettings( Settings *settings ) {}

    signals::signal<void()>&    getSignalDidEnterBackground() { return mSignalDidEnterBackground; }
    void                        emitDidEnterBackground();
    signals::signal<void()>&    getSignalWillEnterForeground() { return mSignalWillEnterForeground; }
    void                        emitWillEnterForeground();
    signals::signal<void()>&    getSignalWillResignActive() { return mSignalWillResignActive; }
    void                        emitWillResignActive();
    signals::signal<void()>&    getSignalDidBecomeActive() { return mSignalDidBecomeActive; }
    void                        emitDidBecomeActive();
    signals::signal<void()>&    getSignalMemoryWarning() { return mSignalMemoryWarning; }
    void                        emitMemoryWarning();

    EventSignalSupportedOrientations&   getSignalSupportedOrientations() { return mSignalSupportedOrientations; }
    uint32_t                            emitSupportedOrientations();
    signals::signal<void()>&            getSignalWillRotate() { return mSignalWillRotate; }
    void                                emitWillRotate();
    signals::signal<void()>&            getSignalDidRotate() { return mSignalDidRotate; }
    void                                emitDidRotate();

    WindowRef       createWindow( const Window::Format &format );

    virtual WindowRef getWindow() const override;
    virtual size_t getNumWindows() const override;
    virtual app::WindowRef  getWindowIndex( size_t index = 0 ) const override;

    InterfaceOrientation    getOrientation() const;
    InterfaceOrientation    getWindowOrientation() const;

    void enableProximitySensor();
    void disableProximitySensor();
    bool proximityIsClose() const;
    signals::signal<void(bool)>&    getSignalProximitySensor() { return mSignalProximitySensor; }
    void                            emitSignalProximitySensor( bool isClose ) { mSignalProximitySensor( isClose ); }

    void    enableBatteryMonitoring();
    void    disableBatteryMonitoring();
    float   getBatteryLevel() const;
    bool    isUnplugged() const;
    signals::signal<void(bool)>&    getSignalBatteryState() { return mSignalBatteryState; }
    void                            emitSignalBatteryState( bool isUnplugged ) { mSignalBatteryState( isUnplugged ); }

    void enablePowerManagement( bool powerManagement = true ) override;

    void        showKeyboard();
    bool        isKeyboardVisible() const;
    void        hideKeyboard();
    std::string getKeyboardString() const;

    typedef enum StatusBarAnimation { NONE, FADE, SLIDE } StatusBarAnimation;
    void    showStatusBar( StatusBarAnimation animation = StatusBarAnimation::NONE );
    bool    isStatusBarVisible() const;
    void    hideStatusBar( StatusBarAnimation animation = StatusBarAnimation::NONE );
    
    virtual float       getFrameRate() const;
    virtual void        setFrameRate( float frameRate );
    virtual bool        isFullScreen() const;
    virtual void        setFullScreen( bool aFullScreen );

    virtual double      getElapsedSeconds() const;

    virtual fs::path    getAppPath() const;

    virtual void    quit();

    static AppCocoaTouch*   get() { return sInstance; }
    virtual const Settings& getSettings() const { return mSettings; }


    // These are called by application instantation macros and are only used in the launch process
    static void     prepareLaunch() { App::prepareLaunch(); }
    static void     executeLaunch( AppCocoaTouch *app, RendererRef renderer, const char *title, int argc, char * const argv[] ) { App::sInstance = 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[] ) override;

    // 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.
    void        privatePrepareSettings__();
    void        privateSetImpl__( AppImplCocoaTouch *impl ) { mImpl = impl; }

  private:
    friend void     setupCocoaTouchWindow( AppCocoaTouch *app );
    
    
    static AppCocoaTouch    *sInstance; 
    AppImplCocoaTouch       *mImpl;
    Settings                mSettings;

    signals::signal<void()>     mSignalDidEnterBackground, mSignalWillEnterForeground, mSignalWillResignActive, mSignalDidBecomeActive, mSignalMemoryWarning;

    signals::signal<void(bool)>     mSignalProximitySensor, mSignalBatteryState;

    EventSignalSupportedOrientations        mSignalSupportedOrientations;
    signals::signal<void()>                 mSignalWillRotate, mSignalDidRotate;

    bool                    mIsKeyboardVisible;
};

extern std::ostream& operator<<( std::ostream &lhs, const InterfaceOrientation &rhs );
float getOrientationDegrees( InterfaceOrientation orientation );

} } // namespace cinder::app

#define CINDER_APP_COCOA_TOUCH( APP, RENDERER )                             \
int main( int argc, char *argv[] ) {                                        \
    cinder::app::AppCocoaTouch::prepareLaunch();                            \
    cinder::app::AppCocoaTouch *app = new APP;                              \
    cinder::app::RendererRef ren( new RENDERER );                           \
    cinder::app::AppCocoaTouch::executeLaunch( app, ren, #APP, argc, argv );\
    cinder::app::AppCocoaTouch::cleanupLaunch();                            \
    return 0;                                                               \
}