cinder::app::AppCocoaTouch Class Reference

#include <AppCocoaTouch.h>

Inherits cinder::app::App.

List of all members.

Classes

class  Settings

Public Member Functions

 AppCocoaTouch ()
virtual ~AppCocoaTouch ()
virtual void prepareSettings (Settings *settings)
virtual void touchesBegan (TouchEvent event)
 Override to respond to the beginning of a multitouch sequence.
virtual void touchesMoved (TouchEvent event)
 Override to respond to movement (drags) during a multitouch sequence.
virtual void touchesEnded (TouchEvent event)
 Override to respond to the end of a multitouch sequence.
const std::vector
< TouchEvent::Touch > & 
getActiveTouches () const
 Returns a std::vector of all active touches.
virtual void accelerated (AccelEvent event)
 Returns a Vec3d of the acceleration direction.
CallbackId registerTouchesBegan (std::function< bool(TouchEvent)> callback)
 Registers a callback for touchesBegan events. Returns a unique identifier which can be used as a parameter to unregisterTouchesBegan().
template<typename T >
CallbackId registerTouchesBegan (T *obj, bool(T::*callback)(TouchEvent))
 Registers a callback for touchesBegan events. Returns a unique identifier which can be used as a parameter to unregisterTouchesBegan().
void unregisterTouchesBegan (CallbackId id)
 Unregisters a callback for touchesBegan events.
CallbackId registerTouchesMoved (std::function< bool(TouchEvent)> callback)
 Registers a callback for touchesMoved events. Returns a unique identifier which can be used as a parameter to unregisterTouchesMoved().
template<typename T >
CallbackId registerTouchesMoved (T *obj, bool(T::*callback)(TouchEvent))
 Registers a callback for touchesMoved events. Returns a unique identifier which can be used as a parameter to unregisterTouchesMoved().
void unregisterTouchesMoved (CallbackId id)
 Unregisters a callback for touchesMoved events.
CallbackId registerTouchesEnded (std::function< bool(TouchEvent)> callback)
 Registers a callback for touchesEnded events. Returns a unique identifier which can be used as a parameter to unregisterTouchesEnded().
template<typename T >
CallbackId registerTouchesEnded (T *obj, bool(T::*callback)(TouchEvent))
 Registers a callback for touchesEnded events. Returns a unique identifier which can be used as a parameter to unregisterTouchesEnded().
void unregisterTouchesEnded (CallbackId id)
 Unregisters a callback for touchesEnded events.
CallbackId registerAccelerated (std::function< bool(AccelEvent)> callback)
 Registers a callback for accelerated events. Returns a unique identifier which can be used as a parameter to unregisterAccelerated().
template<typename T >
CallbackId registerAccelerated (T *obj, bool(T::*callback)(AccelEvent))
 Registers a callback for touchesEnded events. Returns a unique identifier which can be used as a parameter to unregisterTouchesEnded().
void unregisterAccelerated (CallbackId id)
 Unregisters a callback for touchesEnded events.
virtual int getWindowWidth () const
 Returns the width of the App's window measured in pixels, or the screen when in full-screen mode.
virtual int getWindowHeight () const
 Returns the height of the App's window measured in pixels, or the screen when in full-screen mode.
void setWindowWidth (int windowWidth)
 Ignored on the iPhone.
void setWindowHeight (int windowHeight)
 Ignored on the iPhone.
void setWindowSize (int windowWidth, int windowHeight)
 Ignored on the iPhone.
void enableAccelerometer (float updateFrequency=30.0f, float filterFactor=0.1f)
 Enables the device's accelerometer and modifies its filtering. updateFrequency represents the frequency with which accelerated() is called, measured in Hz. filterFactor represents the amount to weight the current value relative to the previous.
void disableAccelerometer ()
 Turns off the accelerometer.
virtual float getFrameRate () const
 Returns the maximum frame-rate the App will attempt to maintain.
virtual void setFrameRate (float aFrameRate)
 Sets the maximum frame-rate the App will attempt to maintain.
virtual bool isFullScreen () const
 Returns whether the App is in full-screen mode or not.
virtual void setFullScreen (bool aFullScreen)
 Sets whether the active App is in full-screen mode based on fullScreen.
virtual double getElapsedSeconds () const
 Returns the number seconds which have elapsed since the active App launched.
virtual std::string getAppPath ()
 Returns the path to the application on disk.
virtual void quit ()
 Ceases execution of the application. Not implemented yet on iPhone.
virtual const SettingsgetSettings () const
 Returns a pointer to the current global AppBasic.
virtual void setup ()
 Override to perform any application setup after the Renderer has been initialized.
virtual void shutdown ()
 Override to perform any application cleanup before exiting.
virtual void update ()
 Override to perform any once-per-loop computation.
virtual void draw ()
 Override to perform any rendering once-per-loop or in response to OS-prompted requests for refreshes.
virtual void mouseDown (MouseEvent event)
 Override to receive mouse-down events.
virtual void mouseUp (MouseEvent event)
 Override to receive mouse-up events.
virtual void mouseWheel (MouseEvent event)
 Override to receive mouse-wheel events.
virtual void mouseMove (MouseEvent event)
 Override to receive mouse-move events.
virtual void mouseDrag (MouseEvent event)
 Override to receive mouse-drag events.
virtual void keyDown (KeyEvent event)
 Override to receive key-down events.
virtual void keyUp (KeyEvent event)
 Override to receive key-up events.
virtual void resize (ResizeEvent event)
 Override to receive window resize events.
virtual void fileDrop (FileDropEvent event)
 Override to receive file-drop events.
CallbackId registerMouseDown (std::function< bool(MouseEvent)> callback)
 Registers a callback for mouseDown events. Returns a unique identifier which can be used as a parameter to unregisterMouseDown().
template<typename T >
CallbackId registerMouseDown (T *obj, bool(T::*callback)(MouseEvent))
 Registers a callback for mouseDown events. Returns a unique identifier which can be used as a parameter to unregisterMouseDown().
void unregisterMouseDown (CallbackId id)
 Unregisters a callback for mouseDown events.
CallbackId registerMouseUp (std::function< bool(MouseEvent)> callback)
 Registers a callback for mouseUp events. Returns a unique identifier which can be used as a parameter to unregisterMouseUp().
template<typename T >
CallbackId registerMouseUp (T *obj, bool(T::*callback)(MouseEvent))
 Registers a callback for mouseUp events. Returns a unique identifier which can be used as a parameter to unregisterMouseUp().
void unregisterMouseUp (CallbackId id)
 Unregisters a callback for mouseUp events.
CallbackId registerMouseWheel (std::function< bool(MouseEvent)> callback)
 Registers a callback for mouseWheel events. Returns a unique identifier which can be used as a parameter to unregisterMouseWheel().
template<typename T >
CallbackId registerMouseWheel (T *obj, bool(T::*callback)(MouseEvent))
 Registers a callback for mouseWheel events. Returns a unique identifier which can be used as a parameter to unregisterMouseWheel().
void unregisterMouseWheel (CallbackId id)
 Unregisters a callback for mouseWheel events.
CallbackId registerMouseMove (std::function< bool(MouseEvent)> callback)
 Registers a callback for mouseMove events. Returns a unique identifier which can be used as a parameter to unregisterMouseMove().
template<typename T >
CallbackId registerMouseMove (T *obj, bool(T::*callback)(MouseEvent))
 Registers a callback for mouseMove events. Returns a unique identifier which can be used as a parameter to unregisterMouseMove().
void unregisterMouseMove (CallbackId id)
 Unregisters a callback for mouseMove events.
CallbackId registerMouseDrag (std::function< bool(MouseEvent)> callback)
 Registers a callback for mouseDrag events. Returns a unique identifier which can be used as a parameter to unregisterMouseDrag().
template<typename T >
CallbackId registerMouseDrag (T *obj, bool(T::*callback)(MouseEvent))
 Registers a callback for mouseDrag events. Returns a unique identifier which can be used as a parameter to unregisterMouseDrag().
void unregisterMouseDrag (CallbackId id)
 Unregisters a callback for mouseDrag events.
CallbackId registerKeyDown (std::function< bool(KeyEvent)> callback)
 Registers a callback for keyDown events. Returns a unique identifier which can be used as a parameter to unregisterKeyDown().
template<typename T >
CallbackId registerKeyDown (T *obj, bool(T::*callback)(KeyEvent))
 Registers a callback for keyDown events. Returns a unique identifier which can be used as a parameter to unregisterKeyDown().
void unregisterKeyDown (CallbackId id)
 Unregisters a callback for keyDown events.
CallbackId registerKeyUp (std::function< bool(KeyEvent)> callback)
 Registers a callback for keyUp events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().
template<typename T >
CallbackId registerKeyUp (T *obj, bool(T::*callback)(KeyEvent))
 Registers a callback for keyUp events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().
void unregisterKeyUp (CallbackId id)
 Unregisters a callback for keyUp events.
CallbackId registerResize (std::function< bool(ResizeEvent)> callback)
 Registers a callback for resize events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().
template<typename T >
CallbackId registerResize (T *obj, bool(T::*callback)(ResizeEvent))
 Registers a callback for resize events. Returns a unique identifier which can be used as a parameter to unregisterResize().
void unregisterResize (CallbackId id)
 Unregisters a callback for resize events.
CallbackId registerFileDrop (std::function< bool(FileDropEvent)> callback)
 Registers a callback for fileDrop events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().
template<typename T >
CallbackId registerFileDrop (T *obj, bool(T::*callback)(FileDropEvent))
 Registers a callback for fileDrop events. Returns a unique identifier which can be used as a parameter to unregisterFileDrop().
void unregisterFileDrop (CallbackId id)
 Unregisters a callback for fileDrop events.
RenderergetRenderer () const
void setWindowSize (const Vec2i &size)
 Sets the size of the App's window. Ignored in full-screen mode.
Vec2f getWindowCenter () const
 Returns the center of the App's window or the screen in full-screen mode.
Vec2i getWindowSize () const
 Returns the size of the App's window or the screen in full-screen mode.
float getWindowAspectRatio () const
 Returns the aspect ratio of the App's window or the screen in full-screen mode.
Area getWindowBounds () const
 Returns the bounding area of the App's window or the screen in full-screen mode.
float getAverageFps () const
 Returns the average frame-rate attained by the App as measured in frames-per-second.
double getFpsSampleInterval () const
 Returns the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps().
void setFpsSampleInterval (double sampleInterval)
 Sets the sampling rate in seconds for measuring the average frame-per-second as returned by getAverageFps().
uint32_t getElapsedFrames () const
 Returns the number of animation frames which have elapsed since application launch.
std::string getOpenFilePath (const std::string &initialPath="", std::vector< std::string > extensions=std::vector< std::string >())
 Presents the user with a file-open dialog and returns the selected file path.
std::string getFolderPath (const std::string &initialPath="")
 Presents the user with a folder-open dialog and returns the selected folder.
std::string getSaveFilePath (const std::string &initialPath="", std::vector< std::string > extensions=std::vector< std::string >())
 Presents the user with a file-save dialog and returns the selected file path.
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.
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.
virtual bool getsWindowsPaintEvents ()=0
virtual bool receivesEvents () const

Static Public Member Functions

static AppCocoaTouchget ()
 Returns a pointer to the current global AppBasic.
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.
static DataSourcePathRef loadResource (const std::string &macPath)
 Returns a DataSourceRef to an application resource. macPath is a path relative to the bundle's resources folder. Throws ResourceLoadExc on failure.
static DataSourceBufferRef loadResource (int mswID, const std::string &mswType)
 Returns a DataSourceRef to an application resource. mswID and mswType identify the resource as defined the application's .rc file(s).
static std::string getResourcePath (const std::string &rsrcRelativePath)
 Returns the absolute file path to a resource located at rsrcRelativePath inside the bundle's resources folder. Throws ResourceLoadExc on failure.
static std::string getResourcePath ()
 Returns the absolute file path to the bundle's resources folder.

Friends

void setupCocoaTouchWindow (AppCocoaTouch *app)

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]
virtual void cinder::app::AppCocoaTouch::touchesBegan ( TouchEvent  event  )  [virtual]

Override to respond to the beginning of a multitouch sequence.

virtual void cinder::app::AppCocoaTouch::touchesMoved ( TouchEvent  event  )  [virtual]

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

virtual void cinder::app::AppCocoaTouch::touchesEnded ( TouchEvent  event  )  [virtual]

Override to respond to the end of a multitouch sequence.

const std::vector<TouchEvent::Touch>& cinder::app::AppCocoaTouch::getActiveTouches (  )  const

Returns a std::vector of all active touches.

virtual void cinder::app::AppCocoaTouch::accelerated ( AccelEvent  event  )  [virtual]

Returns a Vec3d of the acceleration direction.

CallbackId cinder::app::AppCocoaTouch::registerTouchesBegan ( std::function< bool(TouchEvent)>  callback  ) 

Registers a callback for touchesBegan events. Returns a unique identifier which can be used as a parameter to unregisterTouchesBegan().

template<typename T >
CallbackId cinder::app::AppCocoaTouch::registerTouchesBegan ( T *  obj,
bool(T::*)(TouchEvent callback 
)

Registers a callback for touchesBegan events. Returns a unique identifier which can be used as a parameter to unregisterTouchesBegan().

void cinder::app::AppCocoaTouch::unregisterTouchesBegan ( CallbackId  id  ) 

Unregisters a callback for touchesBegan events.

CallbackId cinder::app::AppCocoaTouch::registerTouchesMoved ( std::function< bool(TouchEvent)>  callback  ) 

Registers a callback for touchesMoved events. Returns a unique identifier which can be used as a parameter to unregisterTouchesMoved().

template<typename T >
CallbackId cinder::app::AppCocoaTouch::registerTouchesMoved ( T *  obj,
bool(T::*)(TouchEvent callback 
)

Registers a callback for touchesMoved events. Returns a unique identifier which can be used as a parameter to unregisterTouchesMoved().

void cinder::app::AppCocoaTouch::unregisterTouchesMoved ( CallbackId  id  ) 

Unregisters a callback for touchesMoved events.

CallbackId cinder::app::AppCocoaTouch::registerTouchesEnded ( std::function< bool(TouchEvent)>  callback  ) 

Registers a callback for touchesEnded events. Returns a unique identifier which can be used as a parameter to unregisterTouchesEnded().

template<typename T >
CallbackId cinder::app::AppCocoaTouch::registerTouchesEnded ( T *  obj,
bool(T::*)(TouchEvent callback 
)

Registers a callback for touchesEnded events. Returns a unique identifier which can be used as a parameter to unregisterTouchesEnded().

void cinder::app::AppCocoaTouch::unregisterTouchesEnded ( CallbackId  id  ) 

Unregisters a callback for touchesEnded events.

CallbackId cinder::app::AppCocoaTouch::registerAccelerated ( std::function< bool(AccelEvent)>  callback  ) 

Registers a callback for accelerated events. Returns a unique identifier which can be used as a parameter to unregisterAccelerated().

template<typename T >
CallbackId cinder::app::AppCocoaTouch::registerAccelerated ( T *  obj,
bool(T::*)(AccelEvent callback 
)

Registers a callback for touchesEnded events. Returns a unique identifier which can be used as a parameter to unregisterTouchesEnded().

void cinder::app::AppCocoaTouch::unregisterAccelerated ( CallbackId  id  ) 

Unregisters a callback for touchesEnded events.

int cinder::app::AppCocoaTouch::getWindowWidth (  )  const [virtual]

Returns the width of the App's window measured in pixels, or the screen when in full-screen mode.

Implements cinder::app::App.

int cinder::app::AppCocoaTouch::getWindowHeight (  )  const [virtual]

Returns the height of the App's window measured in pixels, or the screen when in full-screen mode.

Implements cinder::app::App.

void cinder::app::AppCocoaTouch::setWindowWidth ( int  windowWidth  )  [virtual]

Ignored on the iPhone.

Implements cinder::app::App.

void cinder::app::AppCocoaTouch::setWindowHeight ( int  windowHeight  )  [virtual]

Ignored on the iPhone.

Implements cinder::app::App.

void cinder::app::AppCocoaTouch::setWindowSize ( int  windowWidth,
int  windowHeight 
) [virtual]

Ignored on the iPhone.

Implements cinder::app::App.

void cinder::app::AppCocoaTouch::enableAccelerometer ( float  updateFrequency = 30.0f,
float  filterFactor = 0.1f 
)

Enables the device's accelerometer and modifies its filtering. updateFrequency represents the frequency with which accelerated() is called, measured in Hz. filterFactor represents the amount to weight the current value relative to the previous.

Enables the accelerometer.

void cinder::app::AppCocoaTouch::disableAccelerometer (  ) 

Turns off the accelerometer.

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  aFrameRate  )  [virtual]

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.

Implements cinder::app::App.

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

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

Implements cinder::app::App.

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

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

Reimplemented from cinder::app::App.

std::string cinder::app::AppCocoaTouch::getAppPath (  )  [virtual]

Returns the path to the application on disk.

Implements cinder::app::App.

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

Ceases execution of the application. Not implemented yet on iPhone.

Implements cinder::app::App.

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

Returns a pointer to the current global AppBasic.

Reimplemented from cinder::app::App.

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 (  )  [virtual, inherited]

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

virtual void cinder::app::App::shutdown (  )  [virtual, inherited]

Override to perform any application cleanup before exiting.

virtual void cinder::app::App::update (  )  [virtual, inherited]

Override to perform any once-per-loop computation.

virtual void cinder::app::App::draw (  )  [virtual, inherited]

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  )  [virtual, inherited]

Override to receive mouse-down events.

virtual void cinder::app::App::mouseUp ( MouseEvent  event  )  [virtual, inherited]

Override to receive mouse-up events.

virtual void cinder::app::App::mouseWheel ( MouseEvent  event  )  [virtual, inherited]

Override to receive mouse-wheel events.

virtual void cinder::app::App::mouseMove ( MouseEvent  event  )  [virtual, inherited]

Override to receive mouse-move events.

virtual void cinder::app::App::mouseDrag ( MouseEvent  event  )  [virtual, inherited]

Override to receive mouse-drag events.

virtual void cinder::app::App::keyDown ( KeyEvent  event  )  [virtual, inherited]

Override to receive key-down events.

virtual void cinder::app::App::keyUp ( KeyEvent  event  )  [virtual, inherited]

Override to receive key-up events.

virtual void cinder::app::App::resize ( ResizeEvent  event  )  [virtual, inherited]

Override to receive window resize events.

virtual void cinder::app::App::fileDrop ( FileDropEvent  event  )  [virtual, inherited]

Override to receive file-drop events.

CallbackId cinder::app::App::registerMouseDown ( std::function< bool(MouseEvent)>  callback  )  [inherited]

Registers a callback for mouseDown events. Returns a unique identifier which can be used as a parameter to unregisterMouseDown().

template<typename T >
CallbackId cinder::app::App::registerMouseDown ( T *  obj,
bool(T::*)(MouseEvent callback 
) [inherited]

Registers a callback for mouseDown events. Returns a unique identifier which can be used as a parameter to unregisterMouseDown().

void cinder::app::App::unregisterMouseDown ( CallbackId  id  )  [inherited]

Unregisters a callback for mouseDown events.

CallbackId cinder::app::App::registerMouseUp ( std::function< bool(MouseEvent)>  callback  )  [inherited]

Registers a callback for mouseUp events. Returns a unique identifier which can be used as a parameter to unregisterMouseUp().

template<typename T >
CallbackId cinder::app::App::registerMouseUp ( T *  obj,
bool(T::*)(MouseEvent callback 
) [inherited]

Registers a callback for mouseUp events. Returns a unique identifier which can be used as a parameter to unregisterMouseUp().

void cinder::app::App::unregisterMouseUp ( CallbackId  id  )  [inherited]

Unregisters a callback for mouseUp events.

CallbackId cinder::app::App::registerMouseWheel ( std::function< bool(MouseEvent)>  callback  )  [inherited]

Registers a callback for mouseWheel events. Returns a unique identifier which can be used as a parameter to unregisterMouseWheel().

template<typename T >
CallbackId cinder::app::App::registerMouseWheel ( T *  obj,
bool(T::*)(MouseEvent callback 
) [inherited]

Registers a callback for mouseWheel events. Returns a unique identifier which can be used as a parameter to unregisterMouseWheel().

void cinder::app::App::unregisterMouseWheel ( CallbackId  id  )  [inherited]

Unregisters a callback for mouseWheel events.

CallbackId cinder::app::App::registerMouseMove ( std::function< bool(MouseEvent)>  callback  )  [inherited]

Registers a callback for mouseMove events. Returns a unique identifier which can be used as a parameter to unregisterMouseMove().

template<typename T >
CallbackId cinder::app::App::registerMouseMove ( T *  obj,
bool(T::*)(MouseEvent callback 
) [inherited]

Registers a callback for mouseMove events. Returns a unique identifier which can be used as a parameter to unregisterMouseMove().

void cinder::app::App::unregisterMouseMove ( CallbackId  id  )  [inherited]

Unregisters a callback for mouseMove events.

CallbackId cinder::app::App::registerMouseDrag ( std::function< bool(MouseEvent)>  callback  )  [inherited]

Registers a callback for mouseDrag events. Returns a unique identifier which can be used as a parameter to unregisterMouseDrag().

template<typename T >
CallbackId cinder::app::App::registerMouseDrag ( T *  obj,
bool(T::*)(MouseEvent callback 
) [inherited]

Registers a callback for mouseDrag events. Returns a unique identifier which can be used as a parameter to unregisterMouseDrag().

void cinder::app::App::unregisterMouseDrag ( CallbackId  id  )  [inherited]

Unregisters a callback for mouseDrag events.

CallbackId cinder::app::App::registerKeyDown ( std::function< bool(KeyEvent)>  callback  )  [inherited]

Registers a callback for keyDown events. Returns a unique identifier which can be used as a parameter to unregisterKeyDown().

template<typename T >
CallbackId cinder::app::App::registerKeyDown ( T *  obj,
bool(T::*)(KeyEvent callback 
) [inherited]

Registers a callback for keyDown events. Returns a unique identifier which can be used as a parameter to unregisterKeyDown().

void cinder::app::App::unregisterKeyDown ( CallbackId  id  )  [inherited]

Unregisters a callback for keyDown events.

CallbackId cinder::app::App::registerKeyUp ( std::function< bool(KeyEvent)>  callback  )  [inherited]

Registers a callback for keyUp events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().

template<typename T >
CallbackId cinder::app::App::registerKeyUp ( T *  obj,
bool(T::*)(KeyEvent callback 
) [inherited]

Registers a callback for keyUp events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().

void cinder::app::App::unregisterKeyUp ( CallbackId  id  )  [inherited]

Unregisters a callback for keyUp events.

CallbackId cinder::app::App::registerResize ( std::function< bool(ResizeEvent)>  callback  )  [inherited]

Registers a callback for resize events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().

template<typename T >
CallbackId cinder::app::App::registerResize ( T *  obj,
bool(T::*)(ResizeEvent callback 
) [inherited]

Registers a callback for resize events. Returns a unique identifier which can be used as a parameter to unregisterResize().

void cinder::app::App::unregisterResize ( CallbackId  id  )  [inherited]

Unregisters a callback for resize events.

CallbackId cinder::app::App::registerFileDrop ( std::function< bool(FileDropEvent)>  callback  )  [inherited]

Registers a callback for fileDrop events. Returns a unique identifier which can be used as a parameter to unregisterKeyUp().

template<typename T >
CallbackId cinder::app::App::registerFileDrop ( T *  obj,
bool(T::*)(FileDropEvent callback 
) [inherited]

Registers a callback for fileDrop events. Returns a unique identifier which can be used as a parameter to unregisterFileDrop().

void cinder::app::App::unregisterFileDrop ( CallbackId  id  )  [inherited]

Unregisters a callback for fileDrop events.

Renderer* cinder::app::App::getRenderer (  )  const [inherited]
void cinder::app::App::setWindowSize ( const Vec2i size  )  [inherited]

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

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

Returns the center of the App's window or the screen in full-screen mode.

Equivalent to

 Vec2f( getWindowWidth() * 0.5, getWindowHeight() * 0.5 ) 
Vec2i cinder::app::App::getWindowSize (  )  const [inherited]

Returns the size of the App's window or the screen in full-screen mode.

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

Returns the aspect ratio of the App's window or the screen in full-screen mode.

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

Returns the bounding area of the App's window or the screen in full-screen mode.

Equivalent to

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().

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

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

DataSourceRef cinder::app::App::loadResource ( const std::string &  macPath,
int  mswID,
const std::string &  mswType 
) [static, inherited]

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:
Using Resources in Cinder
DataSourcePathRef cinder::app::App::loadResource ( const std::string &  macPath  )  [static, inherited]

Returns a DataSourceRef to an application resource. macPath is a path relative to the bundle's resources folder. Throws ResourceLoadExc on failure.

See also:
Using Resources in Cinder
DataSourceBufferRef cinder::app::App::loadResource ( int  mswID,
const std::string &  mswType 
) [static, inherited]

Returns a DataSourceRef to an application resource. mswID and mswType identify the resource as defined the application's .rc file(s).

See also:
Using Resources in Cinder
string cinder::app::App::getResourcePath ( const std::string &  rsrcRelativePath  )  [static, inherited]

Returns the absolute file path to a resource located at rsrcRelativePath inside the bundle's resources folder. Throws ResourceLoadExc on failure.

See also:
Using Resources in Cinder
string cinder::app::App::getResourcePath (  )  [static, inherited]

Returns the absolute file path to the bundle's resources folder.

See also:
Using Resources in Cinder
string cinder::app::App::getOpenFilePath ( const std::string &  initialPath = "",
std::vector< std::string >  extensions = std::vector<std::string>() 
) [inherited]

Presents the user with a file-open 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.
string cinder::app::App::getFolderPath ( const std::string &  initialPath = ""  )  [inherited]

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

string cinder::app::App::getSaveFilePath ( const std::string &  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.

Surface cinder::app::App::copyWindowSurface (  )  [inherited]
Returns:
a copy of the window's contents as a Surface8u
Surface cinder::app::App::copyWindowSurface ( const Area area  )  [inherited]
Returns:
a copy of the Area area from the 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.

virtual bool cinder::app::App::getsWindowsPaintEvents (  )  [pure virtual, inherited]

Implemented in cinder::app::AppScreenSaver.

virtual bool cinder::app::App::receivesEvents (  )  const [virtual, inherited]

Reimplemented in cinder::app::AppScreenSaver.


Friends And Related Function Documentation

void setupCocoaTouchWindow ( AppCocoaTouch app  )  [friend]

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