Cinder  0.9.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cinder::app::PlatformWinRt Class Referenceabstract

#include <PlatformWinRt.h>

Inherits cinder::app::Platform.

Public Member Functions

 PlatformWinRt ()
 
DataSourceRef loadResource (const fs::path &resourcePath) override
 
fs::path getResourceDirectory () const override
 
fs::path getResourcePath (const fs::path &rsrcRelativePath) const override
 
void getOpenFilePathAsync (const std::function< void(const fs::path &)> &callback, const fs::path &initialPath=fs::path(), const std::vector< std::string > &extensions={}) override
 
void getFolderPathAsync (const std::function< void(const fs::path &)> &callback, const fs::path &initialPath="") override
 
void getSaveFilePathAsync (const std::function< void(const fs::path &)> &callback, const fs::path &initialPath, const std::vector< std::string > &extensions={}) override
 
fs::path getOpenFilePath (const fs::path &initialPath=fs::path(), const std::vector< std::string > &extensions=std::vector< std::string >()) override
 
fs::path getFolderPath (const fs::path &initialPath=fs::path()) override
 
fs::path getSaveFilePath (const fs::path &initialPath=fs::path(), const std::vector< std::string > &extensions=std::vector< std::string >()) override
 
void prepareAssetLoading () override
 
std::ostream & console () override
 
std::map< std::string, std::string > getEnvironmentVariables () override
 
fs::path expandPath (const fs::path &path) override
 
fs::path getHomeDirectory () const override
 
fs::path getDocumentsDirectory () const override
 
fs::path getDefaultExecutablePath () const override
 
void launchWebBrowser (const Url &url) override
 
void sleep (float milliseconds) override
 
std::vector< std::string > stackTrace () override
 
const std::vector< DisplayRef > & getDisplays () override
 
virtual void prepareLaunch ()
 
virtual void cleanupLaunch ()
 
DataSourceRef loadAsset (const fs::path &relativePath)
 
fs::path getAssetPath (const fs::path &relativePath) const
 
void addAssetDirectory (const fs::path &directory)
 
const std::vector< fs::path > & getAssetDirectories () const
 
virtual DataSourceRef loadResource (const fs::path &resourcePath, int mswID, const std::string &mswType)=0
 
fs::path getExecutablePath () const
 
void setExecutablePath (const fs::path &execPath)
 

Static Public Member Functions

static Platformget ()
 
static void set (Platform *platform)
 

Protected Member Functions

virtual void findAndAddDefaultAssetPath ()
 

Constructor & Destructor Documentation

cinder::app::PlatformWinRt::PlatformWinRt ( )

Member Function Documentation

DataSourceRef cinder::app::PlatformWinRt::loadResource ( const fs::path &  resourcePath)
override
fs::path cinder::app::PlatformWinRt::getResourceDirectory ( ) const
overridevirtual

Returns the absolute file path to the resources folder. Returns an empty fs::path on windows.

See also
CinderResources

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::getResourcePath ( const fs::path &  rsrcRelativePath) const
overridevirtual

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

See also
CinderResources

Implements cinder::app::Platform.

void cinder::app::PlatformWinRt::getOpenFilePathAsync ( const std::function< void(const fs::path &)> &  callback,
const fs::path &  initialPath = fs::path(),
const std::vector< std::string > &  extensions = {} 
)
override
void cinder::app::PlatformWinRt::getFolderPathAsync ( const std::function< void(const fs::path &)> &  callback,
const fs::path &  initialPath = "" 
)
override
void cinder::app::PlatformWinRt::getSaveFilePathAsync ( const std::function< void(const fs::path &)> &  callback,
const fs::path &  initialPath,
const std::vector< std::string > &  extensions = {} 
)
override
fs::path cinder::app::PlatformWinRt::getOpenFilePath ( const fs::path &  initialPath = fs::path(),
const std::vector< std::string > &  extensions = std::vector< std::string >() 
)
overridevirtual

Presents the user with an open-file 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.

Returns
the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::getFolderPath ( const fs::path &  initialPath = fs::path())
overridevirtual

Presents the user with an open-folder dialog.

Returns
the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::getSaveFilePath ( const fs::path &  initialPath = fs::path(),
const std::vector< std::string > &  extensions = std::vector< std::string >() 
)
overridevirtual

Presents the user with a save-file 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.

Returns
the selected file path, or an empty fs::path if the user cancelled or this operation isn't supported on the current platform.

Implements cinder::app::Platform.

void cinder::app::PlatformWinRt::prepareAssetLoading ( )
overridevirtual

Called when asset directories are first prepared, subclasses can override to add platform specific directories.

Reimplemented from cinder::app::Platform.

std::ostream & cinder::app::PlatformWinRt::console ( )
overridevirtual

Returns a reference to an output console, which is by default an alias to std::cout. Other platforms may override to use other necessary console mechanisms.

Reimplemented from cinder::app::Platform.

map< string, string > cinder::app::PlatformWinRt::getEnvironmentVariables ( )
overridevirtual

Returns a std::map of the system's environment variables. Empty on WinRT.

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::expandPath ( const fs::path &  path)
overridevirtual

Returns a canonical version of path. Collapses '.', ".." and "//". Converts '~' on Cocoa. Expands environment variables on MSW.

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::getHomeDirectory ( ) const
overridevirtual

Returns the path to the user's home directory.

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::getDocumentsDirectory ( ) const
overridevirtual

Returns the path to the user's documents directory.

Implements cinder::app::Platform.

fs::path cinder::app::PlatformWinRt::getDefaultExecutablePath ( ) const
overridevirtual

Returns the path used for the default executable location. Users may override this with setExecutablePath() for application specific purposes.

Implements cinder::app::Platform.

void cinder::app::PlatformWinRt::launchWebBrowser ( const Url url)
overridevirtual

Launches a path in the system's default web browser.

Implements cinder::app::Platform.

void cinder::app::PlatformWinRt::sleep ( float  milliseconds)
overridevirtual

Suspends the execution of the current thread until milliseconds have passed. Supports sub-millisecond precision only on OS X.

Implements cinder::app::Platform.

vector< string > cinder::app::PlatformWinRt::stackTrace ( )
overridevirtual

Returns a stack trace (aka backtrace) where stackTrace()[0] == caller, stackTrace()[1] == caller's parent, etc.

Implements cinder::app::Platform.

const vector< DisplayRef > & cinder::app::PlatformWinRt::getDisplays ( )
overridevirtual

Returns a std::vector of Displays connected to the system.

Implements cinder::app::Platform.

Platform * cinder::app::Platform::get ( )
staticinherited

Returns the current Platform.

void cinder::app::Platform::set ( Platform platform)
staticinherited

Sets the current Platform.

virtual void cinder::app::Platform::prepareLaunch ( )
virtualinherited

Called at the beginning of a launch, can be overridden for platform-specifc preparation.

Reimplemented in cinder::app::PlatformCocoa.

virtual void cinder::app::Platform::cleanupLaunch ( )
virtualinherited

Called at the end of a launch, can be overridden for platform-specifc cleanup.

Reimplemented in cinder::app::PlatformCocoa.

DataSourceRef cinder::app::Platform::loadAsset ( const fs::path &  relativePath)
inherited

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

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

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

void cinder::app::Platform::addAssetDirectory ( const fs::path &  directory)
inherited

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

Note
Not thread-safe, e.g. you should not call this when loadAsset() or getAssetPath() can occur from a different thread.
const vector< fs::path > & cinder::app::Platform::getAssetDirectories ( ) const
inherited

Returns a vector of directories that are searched when looking up an asset path.

virtual DataSourceRef cinder::app::Platform::loadResource ( const fs::path &  resourcePath,
int  mswID,
const std::string &  mswType 
)
pure virtualinherited

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

See also
CinderResources

Implemented in cinder::app::PlatformMsw.

fs::path cinder::app::Platform::getExecutablePath ( ) const
inherited

Returns the path to the associated executable.

void cinder::app::Platform::setExecutablePath ( const fs::path &  execPath)
inherited

Sets the path to the associated executable, overriding the default.

void cinder::app::Platform::findAndAddDefaultAssetPath ( )
protectedvirtualinherited

Called to add the default assets folder by walking up the path from the executable until a folder named 'assets' is found. Subclasses can override this method to disable this functionality.


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