Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
cinder::app::AppCocoaTouch Class Reference

#include <AppCocoaTouch.h>

Inheritance diagram for cinder::app::AppCocoaTouch:
[legend]

Classes

struct  KeyboardOptions
 Optional params passed to showKeyboard();. More...
 
class  Settings
 

Public Types

enum  KeyboardType { DEFAULT, NUMERICAL, URL }
 
enum  StatusBarAnimation { NONE, FADE, SLIDE }
 
typedef enum
cinder::app::AppCocoaTouch::StatusBarAnimation 
StatusBarAnimation
 

Public Member Functions

 AppCocoaTouch ()
 
virtual ~AppCocoaTouch ()
 
virtual void prepareSettings (Settings *settings)
 
signals::signal< void()> & getSignalDidEnterBackground ()
 
void emitDidEnterBackground ()
 
signals::signal< void()> & getSignalWillEnterForeground ()
 
void emitWillEnterForeground ()
 
signals::signal< void()> & getSignalMemoryWarning ()
 
void emitMemoryWarning ()
 
EventSignalSupportedOrientationsgetSignalSupportedOrientations ()
 Returns the signal emitted when an orientation change may occur, allowing the user to specify which orientations are permitted (any connection can forbid a given orientation). The connected std::function must return an InterfaceOrientation bitmask. More...
 
uint32_t emitSupportedOrientations ()
 Emits a signal to ask the user what orientations are supported. More...
 
signals::signal< void()> & getSignalWillRotate ()
 Returns the signal emitted when the interface is about to rotate to a new orientation. At this time, the Window's bounds and orientation have already been updated. More...
 
void emitWillRotate ()
 Emits the signal to notify the user that the orientation will change. More...
 
signals::signal< void()> & getSignalDidRotate ()
 Returns the signal emitted when the interface is finished rotating to a new orientation. More...
 
void emitDidRotate ()
 Emits the signal to notify the user that the orientation did change. More...
 
signals::signal< void()> & getSignalKeyboardWillShow ()
 Returns the signal emitted when the virtual keyboard is about to animate on screen. More...
 
void emitKeyboardWillShow ()
 Emits the signal used to notify when the virtual keyboard is about to animate on screen. More...
 
signals::signal< void()> & getSignalKeyboardWillHide ()
 Returns the signal emitted when the virtual keyboard is about to animate off screen. More...
 
void emitKeyboardWillHide ()
 Emits the signal used to notify when the virtual keyboard is about to animate off screen. More...
 
WindowRef createWindow (const Window::Format &format)
 
virtual WindowRef getWindow () const override
 Returns the the currently active Window. Throws ExcInvalidWindow if called with no active window. More...
 
virtual size_t getNumWindows () const override
 Returns the number of Windows the app has open. More...
 
virtual app::WindowRef getWindowIndex (size_t index=0) const override
 Gets a Window by index, in the range [0, getNumWindows()). More...
 
InterfaceOrientation getOrientation () const
 Returns the InterfaceOrientation for the device Window. More...
 
InterfaceOrientation getWindowOrientation () const
 Returns the current InterfaceOrientation for the active Window. More...
 
void enableProximitySensor ()
 Enables the device's proximity sensor, which can return whether the device is close to the user or not. Use in conjunction with proximityIsClose() or getSignalProximitySensor() More...
 
void disableProximitySensor ()
 Disables the device's proximity sensor. More...
 
bool proximityIsClose () const
 Returns whether the device is close to the user or not. Must call enableProximitySensor() before using. More...
 
signals::signal< void(bool)> & getSignalProximitySensor ()
 Signal emitted when the device becomes close (true) or far (false). Must call enableProximitySensor() before using. More...
 
void emitSignalProximitySensor (bool isClose)
 
void enableBatteryMonitoring ()
 Enables the device's battery monitor. Use in conjunction with getBatteryLevel(), isUnplugged() and getSignalBatteryState() More...
 
void disableBatteryMonitoring ()
 Disables the device's battery monitor. More...
 
float getBatteryLevel () const
 Returns the device's battery level, in the range of [0,1];. More...
 
bool isUnplugged () const
 Returns true when the device is not plugged into power. More...
 
signals::signal< void(bool)> & getSignalBatteryState ()
 Signal emitted when the device is unplugged (true) or plugged in (false). Use in place of polling isUnplugged(). More...
 
void emitSignalBatteryState (bool isUnplugged)
 
void enablePowerManagement (bool powerManagement=true) override
 When disabled, the device will not sleep even after the idling threshold. More...
 
void showKeyboard (const KeyboardOptions &options=KeyboardOptions())
 Shows the iOS virtual keyboard with KeyboardOptions options. This method can be called with new options while the keyboard is visible. More...
 
bool isKeyboardVisible () const
 Returns whether the iOS keyboard is visible. More...
 
void hideKeyboard ()
 Hides the default iOS keyboard. More...
 
std::string getKeyboardString () const
 Returns the current text recorded since the most recent call to showKeyboard(). More...
 
void setKeyboardString (const std::string &keyboardString)
 Sets the current text string that the keyboard is manipulating, overwriting any previous content. More...
 
::UITextView * getkeyboardTextView () const
 Retuens a pointer to the native UITextView, which can be used for further customization. More...
 
void showStatusBar (StatusBarAnimation animation=StatusBarAnimation::NONE)
 Shows the system status bar. More...
 
bool isStatusBarVisible () const
 Returns whether the system status bar is visible. More...
 
void hideStatusBar (StatusBarAnimation animation=StatusBarAnimation::NONE)
 Hides the system status bar. More...
 
virtual float getFrameRate () const
 Returns the maximum frame-rate the App will attempt to maintain. More...
 
virtual void setFrameRate (float frameRate)
 Sets the maximum frame-rate the App will attempt to maintain. This will be rounded to the nearest factor of 60 FPS. More...
 
virtual bool isFullScreen () const
 Returns whether the App is in full-screen mode or not. More...
 
virtual void setFullScreen (bool aFullScreen)
 Sets whether the active App is in full-screen mode based on fullScreen. More...
 
virtual double getElapsedSeconds () const
 Returns the number seconds which have elapsed since the active App launched. More...
 
virtual fs::path getAppPath () const
 Returns the path to the application on disk. More...
 
virtual void quit ()
 Not implemented on iPhone. More...
 
virtual const SettingsgetSettings () const
 Returns a pointer to the current global AppBasic. More...
 
virtual void setup ()
 Override to perform any application setup after the Renderer has been initialized. More...
 
virtual void shutdown ()
 Override to perform any application cleanup before exiting. More...
 
virtual void update ()
 Override to perform any once-per-loop computation. More...
 
virtual void draw ()
 Override to perform any rendering once-per-loop or in response to OS-prompted requests for refreshes. More...
 
virtual void mouseDown (MouseEvent event)
 Override to receive mouse-down events. More...
 
virtual void mouseUp (MouseEvent event)
 Override to receive mouse-up events. More...
 
virtual void mouseWheel (MouseEvent event)
 Override to receive mouse-wheel events. More...
 
virtual void mouseMove (MouseEvent event)
 Override to receive mouse-move events. More...
 
virtual void mouseDrag (MouseEvent event)
 Override to receive mouse-drag events. More...
 
virtual void touchesBegan (TouchEvent event)
 Override to respond to the beginning of a multitouch sequence. More...
 
virtual void touchesMoved (TouchEvent event)
 Override to respond to movement (drags) during a multitouch sequence. More...
 
virtual void touchesEnded (TouchEvent event)
 Override to respond to the end of a multitouch sequence. More...
 
virtual void keyDown (KeyEvent event)
 Override to receive key-down events. More...
 
virtual void keyUp (KeyEvent event)
 Override to receive key-up events. More...
 
virtual void resize ()
 Override to receive window resize events. More...
 
virtual void fileDrop (FileDropEvent event)
 Override to receive file-drop events. More...
 
signals::signal< void()> & getSignalUpdate ()
 Emitted at the start of each application update cycle. More...
 
signals::signal< void()> & getSignalShutdown ()
 Emitted prior to the application shutting down. More...
 
void emitShutdown ()
 
signals::signal< void()> & getSignalWillResignActive ()
 
void emitWillResignActive ()
 
signals::signal< void()> & getSignalDidBecomeActive ()
 
void emitDidBecomeActive ()
 
const std::vector
< TouchEvent::Touch > & 
getActiveTouches () const
 
RendererRef getRenderer () const
 Returns the Renderer of the active Window. More...
 
DisplayRef getDisplay () const
 Returns the Display of the active Window. More...
 
virtual bool isPowerManagementEnabled () const
 is power management enabled, allowing screensavers and the system's power management to hide the application More...
 
int getWindowWidth () const
 Returns the width of the App's current window measured in points. More...
 
int getWindowHeight () const
 Returns the height of the App's current window measured in points. More...
 
void setWindowSize (int windowWidth, int windowHeight)
 Sets the size of the App's current window measured in points. Ignored in full-screen mode. More...
 
void setWindowSize (const Vec2i &size)
 Sets the size of the App's window measured in points. Ignored in full-screen mode. More...
 
Vec2f getWindowCenter () const
 Returns the center of the App's window measured in points. More...
 
Vec2i getWindowSize () const
 Returns the size of the App's current window measured in points. More...
 
float getWindowAspectRatio () const
 Returns the aspect ratio of the App's current window. More...
 
Area getWindowBounds () const
 Returns the bounding area of the App's current window measured in points. More...
 
float getWindowContentScale () const
 Returns the contentScale of the App's window, which is the multiplier that maps points to pixels. More...
 
Vec2i getWindowPos () const
 Returns tcoordinates of the top-left corner of the current window measured in points. More...
 
int getWindowPosX () const
 Returns the X coordinate of the top-left corner of the current window measured in points. More...
 
int getWindowPosY () const
 Returns the Y coordinate of the top-left corner of the current window contents measured in points. More...
 
void setWindowPos (int x, int y)
 Sets the coordinates of the top-left corner of the current window measured in points. More...
 
virtual void setWindowPos (const Vec2i &windowPos)
 Sets the coordinates of the top-left corner of the current window measured points. More...
 
float getAverageFps () const
 Returns the average frame-rate attained by the App as measured in frames-per-second. More...
 
double getFpsSampleInterval () const
 Returns the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps() More...
 
void setFpsSampleInterval (double sampleInterval)
 Sets the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps() More...
 
void setFullScreen (bool aFullScreen, const FullScreenOptions &options=FullScreenOptions())
 Sets whether the active App is in full-screen mode based on fullScreen. More...
 
uint32_t getElapsedFrames () const
 Returns the number of animation frames which have elapsed since application launch. More...
 
DataSourceRef loadAsset (const fs::path &relativePath)
 Returns a DataSourceRef to an application asset. Throws a AssetLoadExc on failure. More...
 
fs::path getAssetPath (const fs::path &relativePath)
 Returns a fs::path to an application asset. Returns an empty path on failure. More...
 
void addAssetDirectory (const fs::path &dirPath)
 Adds an absolute path 'dirPath' to the list of directories which are searched for assets. More...
 
fs::path getOpenFilePath (const fs::path &initialPath="", std::vector< std::string > extensions=std::vector< std::string >())
 Presents the user with a folder-open dialog and returns the selected folder path in the spcified callback. More...
 
fs::path getFolderPath (const fs::path &initialPath="")
 Presents the user with a folder-open dialog and returns the selected folder. More...
 
fs::path getSaveFilePath (const fs::path &initialPath="", std::vector< std::string > extensions=std::vector< std::string >())
 Presents the user with a file-save dialog and returns the selected file path. More...
 
std::ostream & console ()
 Returns a reference to an output console, which is an alias to std::cout on the mac, and a wrapper around OutputDebugString on MSW. More...
 
Timelinetimeline ()
 Returns a reference to the App's Timeline. More...
 
boost::asio::io_service & io_service ()
 Returns a reference to the App's boost::asio::io_service() More...
 
void dispatchAsync (const std::function< void()> &fn)
 defined( CINDER_WINRT ) More...
 
template<typename T >
std::result_of< T()>::type dispatchSync (T fn)
 
RendererRef getDefaultRenderer () const
 Returns the default Renderer which will be used when creating a new Window. Set by the app instantiation macro automatically. More...
 
Surface copyWindowSurface ()
 
Surface copyWindowSurface (const Area &area)
 
void restoreWindowContext ()
 Restores the current rendering context to be the App's window or the screen in full-screen mode. Generally this is only necessary if the app has displayed a dialog box or some other external window. More...
 
RendererRef findSharedRenderer (RendererRef searchRenderer) const
 Finds any Renderer of the same type as searchRenderer among existing windows. This is generally not necessary and used to enable context sharing between Windows. Returns NULL on failure. More...
 
virtual bool receivesEvents () const
 

Static Public Member Functions

static AppCocoaTouchget ()
 Returns a pointer to the current global AppBasic. More...
 
static Vec2i getMousePos ()
 Returns the current location of the mouse in screen coordinates measured in points. Can be called outside the normal event loop. More...
 
static DataSourceRef loadResource (const std::string &macPath, int mswID, const std::string &mswType)
 Returns a DataSourceRef to an application resource. On Mac OS X, macPath is a path relative to the bundle's resources folder. On Windows, mswID and mswType identify the resource as defined the application's .rc file(s). Throws ResourceLoadExc on failure. More...
 
static bool isPrimaryThread ()
 Return true if the calling thread is the Application's primary thread. More...
 

Protected Attributes

RendererRef mDefaultRenderer
 
bool mPowerManagement
 

Friends

void setupCocoaTouchWindow (AppCocoaTouch *app)
 

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
DEFAULT 
NUMERICAL 
URL 
Enumerator
NONE 
FADE 
SLIDE 

Constructor & Destructor Documentation

cinder::app::AppCocoaTouch::AppCocoaTouch ( )
virtual cinder::app::AppCocoaTouch::~AppCocoaTouch ( )
virtual

Member Function Documentation

virtual void cinder::app::AppCocoaTouch::prepareSettings ( Settings settings)
virtual
signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalDidEnterBackground ( )
void cinder::app::AppCocoaTouch::emitDidEnterBackground ( )
signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalWillEnterForeground ( )
void cinder::app::AppCocoaTouch::emitWillEnterForeground ( )
signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalMemoryWarning ( )
void cinder::app::AppCocoaTouch::emitMemoryWarning ( )
EventSignalSupportedOrientations& cinder::app::AppCocoaTouch::getSignalSupportedOrientations ( )

Returns the signal emitted when an orientation change may occur, allowing the user to specify which orientations are permitted (any connection can forbid a given orientation). The connected std::function must return an InterfaceOrientation bitmask.

uint32_t cinder::app::AppCocoaTouch::emitSupportedOrientations ( )

Emits a signal to ask the user what orientations are supported.

signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalWillRotate ( )

Returns the signal emitted when the interface is about to rotate to a new orientation. At this time, the Window's bounds and orientation have already been updated.

void cinder::app::AppCocoaTouch::emitWillRotate ( )

Emits the signal to notify the user that the orientation will change.

signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalDidRotate ( )

Returns the signal emitted when the interface is finished rotating to a new orientation.

void cinder::app::AppCocoaTouch::emitDidRotate ( )

Emits the signal to notify the user that the orientation did change.

signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalKeyboardWillShow ( )

Returns the signal emitted when the virtual keyboard is about to animate on screen.

void cinder::app::AppCocoaTouch::emitKeyboardWillShow ( )

Emits the signal used to notify when the virtual keyboard is about to animate on screen.

signals::signal<void()>& cinder::app::AppCocoaTouch::getSignalKeyboardWillHide ( )

Returns the signal emitted when the virtual keyboard is about to animate off screen.

void cinder::app::AppCocoaTouch::emitKeyboardWillHide ( )

Emits the signal used to notify when the virtual keyboard is about to animate off screen.

WindowRef cinder::app::AppCocoaTouch::createWindow ( const Window::Format format)
WindowRef cinder::app::AppCocoaTouch::getWindow ( ) const
overridevirtual

Returns the the currently active Window. Throws ExcInvalidWindow if called with no active window.

Implements cinder::app::App.

size_t cinder::app::AppCocoaTouch::getNumWindows ( ) const
overridevirtual

Returns the number of Windows the app has open.

Implements cinder::app::App.

WindowRef cinder::app::AppCocoaTouch::getWindowIndex ( size_t  index = 0) const
overridevirtual

Gets a Window by index, in the range [0, getNumWindows()).

Implements cinder::app::App.

InterfaceOrientation cinder::app::AppCocoaTouch::getOrientation ( ) const

Returns the InterfaceOrientation for the device Window.

InterfaceOrientation cinder::app::AppCocoaTouch::getWindowOrientation ( ) const

Returns the current InterfaceOrientation for the active Window.

void cinder::app::AppCocoaTouch::enableProximitySensor ( )

Enables the device's proximity sensor, which can return whether the device is close to the user or not. Use in conjunction with proximityIsClose() or getSignalProximitySensor()

void cinder::app::AppCocoaTouch::disableProximitySensor ( )

Disables the device's proximity sensor.

bool cinder::app::AppCocoaTouch::proximityIsClose ( ) const

Returns whether the device is close to the user or not. Must call enableProximitySensor() before using.

signals::signal<void(bool)>& cinder::app::AppCocoaTouch::getSignalProximitySensor ( )

Signal emitted when the device becomes close (true) or far (false). Must call enableProximitySensor() before using.

void cinder::app::AppCocoaTouch::emitSignalProximitySensor ( bool  isClose)
void cinder::app::AppCocoaTouch::enableBatteryMonitoring ( )

Enables the device's battery monitor. Use in conjunction with getBatteryLevel(), isUnplugged() and getSignalBatteryState()

void cinder::app::AppCocoaTouch::disableBatteryMonitoring ( )

Disables the device's battery monitor.

float cinder::app::AppCocoaTouch::getBatteryLevel ( ) const

Returns the device's battery level, in the range of [0,1];.

bool cinder::app::AppCocoaTouch::isUnplugged ( ) const

Returns true when the device is not plugged into power.

signals::signal<void(bool)>& cinder::app::AppCocoaTouch::getSignalBatteryState ( )

Signal emitted when the device is unplugged (true) or plugged in (false). Use in place of polling isUnplugged().

void cinder::app::AppCocoaTouch::emitSignalBatteryState ( bool  isUnplugged)
void cinder::app::AppCocoaTouch::enablePowerManagement ( bool  powerManagement = true)
overridevirtual

When disabled, the device will not sleep even after the idling threshold.

Reimplemented from cinder::app::App.

void cinder::app::AppCocoaTouch::showKeyboard ( const KeyboardOptions options = KeyboardOptions())

Shows the iOS virtual keyboard with KeyboardOptions options. This method can be called with new options while the keyboard is visible.

bool cinder::app::AppCocoaTouch::isKeyboardVisible ( ) const

Returns whether the iOS keyboard is visible.

void cinder::app::AppCocoaTouch::hideKeyboard ( )

Hides the default iOS keyboard.

std::string cinder::app::AppCocoaTouch::getKeyboardString ( ) const

Returns the current text recorded since the most recent call to showKeyboard().

void cinder::app::AppCocoaTouch::setKeyboardString ( const std::string keyboardString)

Sets the current text string that the keyboard is manipulating, overwriting any previous content.

UITextView * cinder::app::AppCocoaTouch::getkeyboardTextView ( ) const

Retuens a pointer to the native UITextView, which can be used for further customization.

void cinder::app::AppCocoaTouch::showStatusBar ( AppCocoaTouch::StatusBarAnimation  animation = StatusBarAnimation::NONE)

Shows the system status bar.

bool cinder::app::AppCocoaTouch::isStatusBarVisible ( ) const

Returns whether the system status bar is visible.

void cinder::app::AppCocoaTouch::hideStatusBar ( AppCocoaTouch::StatusBarAnimation  animation = StatusBarAnimation::NONE)

Hides the system status bar.

float cinder::app::AppCocoaTouch::getFrameRate ( ) const
virtual

Returns the maximum frame-rate the App will attempt to maintain.

Implements cinder::app::App.

void cinder::app::AppCocoaTouch::setFrameRate ( float  frameRate)
virtual

Sets the maximum frame-rate the App will attempt to maintain. This will be rounded to the nearest factor of 60 FPS.

Sets the maximum frame-rate the App will attempt to maintain.

Implements cinder::app::App.

bool cinder::app::AppCocoaTouch::isFullScreen ( ) const
virtual

Returns whether the App is in full-screen mode or not.

void cinder::app::AppCocoaTouch::setFullScreen ( bool  aFullScreen)
virtual

Sets whether the active App is in full-screen mode based on fullScreen.

double cinder::app::AppCocoaTouch::getElapsedSeconds ( ) const
virtual

Returns the number seconds which have elapsed since the active App launched.

fs::path cinder::app::AppCocoaTouch::getAppPath ( ) const
virtual

Returns the path to the application on disk.

Implements cinder::app::App.

void cinder::app::AppCocoaTouch::quit ( )
virtual

Not implemented on iPhone.

Implements cinder::app::App.

static AppCocoaTouch* cinder::app::AppCocoaTouch::get ( )
static

Returns a pointer to the current global AppBasic.

virtual const Settings& cinder::app::AppCocoaTouch::getSettings ( ) const
virtual

Returns a pointer to the current global AppBasic.

Implements cinder::app::App.

virtual void cinder::app::App::setup ( )
virtualinherited

Override to perform any application setup after the Renderer has been initialized.

virtual void cinder::app::App::shutdown ( )
virtualinherited

Override to perform any application cleanup before exiting.

virtual void cinder::app::App::update ( )
virtualinherited

Override to perform any once-per-loop computation.

virtual void cinder::app::App::draw ( )
virtualinherited

Override to perform any rendering once-per-loop or in response to OS-prompted requests for refreshes.

virtual void cinder::app::App::mouseDown ( MouseEvent  event)
virtualinherited

Override to receive mouse-down events.

virtual void cinder::app::App::mouseUp ( MouseEvent  event)
virtualinherited

Override to receive mouse-up events.

virtual void cinder::app::App::mouseWheel ( MouseEvent  event)
virtualinherited

Override to receive mouse-wheel events.

virtual void cinder::app::App::mouseMove ( MouseEvent  event)
virtualinherited

Override to receive mouse-move events.

virtual void cinder::app::App::mouseDrag ( MouseEvent  event)
virtualinherited

Override to receive mouse-drag events.

virtual void cinder::app::App::touchesBegan ( TouchEvent  event)
virtualinherited

Override to respond to the beginning of a multitouch sequence.

virtual void cinder::app::App::touchesMoved ( TouchEvent  event)
virtualinherited

Override to respond to movement (drags) during a multitouch sequence.

virtual void cinder::app::App::touchesEnded ( TouchEvent  event)
virtualinherited

Override to respond to the end of a multitouch sequence.

virtual void cinder::app::App::keyDown ( KeyEvent  event)
virtualinherited

Override to receive key-down events.

virtual void cinder::app::App::keyUp ( KeyEvent  event)
virtualinherited

Override to receive key-up events.

virtual void cinder::app::App::resize ( )
virtualinherited

Override to receive window resize events.

virtual void cinder::app::App::fileDrop ( FileDropEvent  event)
virtualinherited

Override to receive file-drop events.

signals::signal<void()>& cinder::app::App::getSignalUpdate ( )
inherited

Emitted at the start of each application update cycle.

signals::signal<void()>& cinder::app::App::getSignalShutdown ( )
inherited

Emitted prior to the application shutting down.

void cinder::app::App::emitShutdown ( )
inherited
signals::signal<void()>& cinder::app::App::getSignalWillResignActive ( )
inherited
void cinder::app::App::emitWillResignActive ( )
inherited
signals::signal<void()>& cinder::app::App::getSignalDidBecomeActive ( )
inherited
void cinder::app::App::emitDidBecomeActive ( )
inherited
const std::vector<TouchEvent::Touch>& cinder::app::App::getActiveTouches ( ) const
inherited
RendererRef cinder::app::App::getRenderer ( ) const
inherited

Returns the Renderer of the active Window.

DisplayRef cinder::app::App::getDisplay ( ) const
inherited

Returns the Display of the active Window.

virtual bool cinder::app::App::isPowerManagementEnabled ( ) const
virtualinherited

is power management enabled, allowing screensavers and the system's power management to hide the application

int cinder::app::App::getWindowWidth ( ) const
inherited

Returns the width of the App's current window measured in points.

int cinder::app::App::getWindowHeight ( ) const
inherited

Returns the height of the App's current window measured in points.

void cinder::app::App::setWindowSize ( int  windowWidth,
int  windowHeight 
)
inherited

Sets the size of the App's current window measured in points. Ignored in full-screen mode.

void cinder::app::App::setWindowSize ( const Vec2i size)
inherited

Sets the size of the App's window measured in points. Ignored in full-screen mode.

Vec2f cinder::app::App::getWindowCenter ( ) const
inherited

Returns the center of the App's window measured in points.

Equivalent to Vec2f( getWindowWidth() * 0.5, getWindowHeight() * 0.5 )

Vec2i cinder::app::App::getWindowSize ( ) const
inherited

Returns the size of the App's current window measured in points.

float cinder::app::App::getWindowAspectRatio ( ) const
inherited

Returns the aspect ratio of the App's current window.

Area cinder::app::App::getWindowBounds ( ) const
inherited

Returns the bounding area of the App's current window measured in points.

Equivalent to Area( 0, 0, getWindowWidth(), getWindowHeight() );

float cinder::app::App::getWindowContentScale ( ) const
inherited

Returns the contentScale of the App's window, which is the multiplier that maps points to pixels.

Vec2i cinder::app::App::getWindowPos ( ) const
inherited

Returns tcoordinates of the top-left corner of the current window measured in points.

int cinder::app::App::getWindowPosX ( ) const
inherited

Returns the X coordinate of the top-left corner of the current window measured in points.

int cinder::app::App::getWindowPosY ( ) const
inherited

Returns the Y coordinate of the top-left corner of the current window contents measured in points.

void cinder::app::App::setWindowPos ( int  x,
int  y 
)
inherited

Sets the coordinates of the top-left corner of the current window measured in points.

virtual void cinder::app::App::setWindowPos ( const Vec2i windowPos)
virtualinherited

Sets the coordinates of the top-left corner of the current window measured points.

float cinder::app::App::getAverageFps ( ) const
inherited

Returns the average frame-rate attained by the App as measured in frames-per-second.

double cinder::app::App::getFpsSampleInterval ( ) const
inherited

Returns the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps()

void cinder::app::App::setFpsSampleInterval ( double  sampleInterval)
inherited

Sets the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps()

void cinder::app::App::setFullScreen ( bool  aFullScreen,
const FullScreenOptions options = FullScreenOptions() 
)
inherited

Sets whether the active App is in full-screen mode based on fullScreen.

uint32_t cinder::app::App::getElapsedFrames ( ) const
inherited

Returns the number of animation frames which have elapsed since application launch.

Vec2i cinder::app::App::getMousePos ( )
staticinherited

Returns the current location of the mouse in screen coordinates measured in points. Can be called outside the normal event loop.

DataSourceRef cinder::app::App::loadResource ( const std::string macPath,
int  mswID,
const std::string mswType 
)
staticinherited

Returns a DataSourceRef to an application resource. On Mac OS X, macPath is a path relative to the bundle's resources folder. On Windows, mswID and mswType identify the resource as defined the application's .rc file(s). Throws ResourceLoadExc on failure.

See also
Assets & Resources in Cinder
DataSourceRef cinder::app::App::loadAsset ( const fs::path &  relativePath)
inherited

Returns a DataSourceRef to an application asset. Throws a AssetLoadExc on failure.

fs::path cinder::app::App::getAssetPath ( const fs::path &  relativePath)
inherited

Returns a fs::path to an application asset. Returns an empty path on failure.

void cinder::app::App::addAssetDirectory ( const fs::path &  dirPath)
inherited

Adds an absolute path 'dirPath' to the list of directories which are searched for assets.

fs::path cinder::app::App::getOpenFilePath ( const fs::path &  initialPath = "",
std::vector< std::string extensions = std::vector<std::string>() 
)
inherited

Presents the user with a folder-open dialog and returns the selected folder path in the spcified callback.

The dialog optionally begins at the path initialPath and can be limited to allow selection of files ending in the extensions enumerated in extensions. On WinRT, at least one extension must be specified in extensions or an exception will occur. If the active app is in snapped mode it will be unsnapped to present the dialog.

Returns
void. The selected folder path or an empty string if the user cancelled will be returned in the f callback.
fs::path cinder::app::App::getFolderPath ( const fs::path &  initialPath = "")
inherited

Presents the user with a folder-open dialog and returns the selected folder.

fs::path cinder::app::App::getSaveFilePath ( const fs::path &  initialPath = "",
std::vector< std::string extensions = std::vector<std::string>() 
)
inherited

Presents the user with a file-save dialog and returns the selected file path.

The dialog optionally begins at the path initialPath and can be limited to allow selection of files ending in the extensions enumerated in extensions. If the active app is in full-screen mode it will temporarily switch to windowed-mode to present the dialog.

Returns
the selected file path or an empty string if the user cancelled.
std::ostream & cinder::app::App::console ( )
inherited

Returns a reference to an output console, which is an alias to std::cout on the mac, and a wrapper around OutputDebugString on MSW.

Timeline& cinder::app::App::timeline ( )
inherited

Returns a reference to the App's Timeline.

bool cinder::app::App::isPrimaryThread ( )
staticinherited

Return true if the calling thread is the Application's primary thread.

boost::asio::io_service& cinder::app::App::io_service ( )
inherited

Returns a reference to the App's boost::asio::io_service()

void cinder::app::App::dispatchAsync ( const std::function< void()> &  fn)
inherited

defined( CINDER_WINRT )

Executes a std::function on the App's primary thread ahead of the next update()

template<typename T >
std::result_of<T()>::type cinder::app::App::dispatchSync ( fn)
inherited
RendererRef cinder::app::App::getDefaultRenderer ( ) const
inherited

Returns the default Renderer which will be used when creating a new Window. Set by the app instantiation macro automatically.

Surface cinder::app::App::copyWindowSurface ( )
inherited
Returns
a copy of the current window's contents as a Surface8u
Surface cinder::app::App::copyWindowSurface ( const Area area)
inherited
Returns
a copy of the Area area (measured in pixels) from the current window's contents as a Surface8u
void cinder::app::App::restoreWindowContext ( )
inherited

Restores the current rendering context to be the App's window or the screen in full-screen mode. Generally this is only necessary if the app has displayed a dialog box or some other external window.

RendererRef cinder::app::App::findSharedRenderer ( RendererRef  searchRenderer) const
inherited

Finds any Renderer of the same type as searchRenderer among existing windows. This is generally not necessary and used to enable context sharing between Windows. Returns NULL on failure.

virtual bool cinder::app::App::receivesEvents ( ) const
virtualinherited

Reimplemented in cinder::app::AppScreenSaver.

Friends And Related Function Documentation

void setupCocoaTouchWindow ( AppCocoaTouch app)
friend

Member Data Documentation

RendererRef cinder::app::App::mDefaultRenderer
protectedinherited
bool cinder::app::App::mPowerManagement
protectedinherited

The documentation for this class was generated from the following files: