cinder::app::AppCocoaTouch::Settings Class Reference

#include <AppCocoaTouch.h>

Inherits cinder::app::App::Settings.

List of all members.

Public Member Functions

 Settings ()
void enableMultiTouch (bool enable=true)
 Registers the app to receive multiTouch events from the operating system. Enabled by default. If disabled, touch events are mapped to mouse events.
bool isMultiTouchEnabled () const
 Returns whether the app is registered to receive multiTouch events from the operating system. Enabled by default. If disabled, touch events are mapped to mouse events.
(bool) - isPrepared
(void) - setWindowSize
 width and height of the window when applicable
(void) - setFrameRate
 The maximum frameRate the update/draw loop will execute at, specified in frames per second. Default value is 30 FPS.
(void) - enablePowerManagement
 a value of true allows screensavers or the system's power management to hide the app. Default value is false.
(bool) - isFullScreen
 is the application set to run at fullscreen
(int) - getWindowWidth
 width of the application's window specified in pixels
(int) - getWindowHeight
 height of the application's window specified in pixels
(Vec2i- getWindowSize
 width and height of the application's window specified in pixels
(Area- getWindowBounds
 the size of the application's window specified in pixels.
(const std::string &) - getTitle
 the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
(void) - setTitle
 the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)
(float) - getFrameRate
 maximum frameRate of the application specified in frames per second
(bool) - isResizable
 are users allowed to resize the window
(bool) - getPowerManagement
 is power management enabled, allowing screensavers and the system's power management to hide the application

Protected Attributes

bool mShouldQuit
int mWindowSizeX
int mWindowSizeY
bool mFullScreen
float mFrameRate
bool mResizable
bool mPowerManagement
std::string mTitle

Constructor & Destructor Documentation

cinder::app::AppCocoaTouch::Settings::Settings (  )

Reimplemented from cinder::app::App::Settings.


Member Function Documentation

void cinder::app::AppCocoaTouch::Settings::enableMultiTouch ( bool  enable = true )

Registers the app to receive multiTouch events from the operating system. Enabled by default. If disabled, touch events are mapped to mouse events.

bool cinder::app::AppCocoaTouch::Settings::isMultiTouchEnabled (  ) const

Returns whether the app is registered to receive multiTouch events from the operating system. Enabled by default. If disabled, touch events are mapped to mouse events.

- (bool) app: const
- (void) app: (int)  aWindowSizeX
(int)  aWindowSizeY 

width and height of the window when applicable

- (void) app: (float)  aFrameRate

The maximum frameRate the update/draw loop will execute at, specified in frames per second. Default value is 30 FPS.

- (void) app: (bool)  aPowerManagement = true

a value of true allows screensavers or the system's power management to hide the app. Default value is false.

- (bool) app: const

is the application set to run at fullscreen

- (int) app: const

width of the application's window specified in pixels

- (int) app: const

height of the application's window specified in pixels

- (Vec2i) app: const

width and height of the application's window specified in pixels

- (Area) app: const

the size of the application's window specified in pixels.

Returns:
cinder::Area( 0, 0, width in pixels, height in pixels )
- (const string&) cinder: const

the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)

- (void) app: (const std::string &)  title

the title of the app reflected in ways particular to the app type and platform (such as its Window or menu)

- (float) app: const

maximum frameRate of the application specified in frames per second

- (bool) app: const

are users allowed to resize the window

- (bool) app: const

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


Member Data Documentation

- (bool) app: [protected, inherited]
- (int) app: [protected, inherited]
- (int) app: [protected, inherited]
- (bool) app: [protected, inherited]
- (float) app: [protected, inherited]
- (bool) app: [protected, inherited]
- (bool) app: [protected, inherited]
- std: [protected, inherited]

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