###################
TutorialApplication
###################

.. cpp:namespace:: RFK::TutorialApplication

.. default-domain:: cpp

Functions
=========

=========================================================================== ==================================================================================================================================================================================================================================================================================
int                                                                         :cpp:func:`MainLoop <static int RFK::TutorialApplication::MainLoop(const RED::String &iTitle, const RED::String &iLicense, RFK::LOOP_MODE iLoopMode=RFK::LM_PASSIVE, double iFeedbackInterval=500.0, RED::WindowRenderInfo *iWindowRenderInfo=NULL, bool iUseHybridREDsdk=true)>` 
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`Close <static RED_RC RFK::TutorialApplication::Close(int iCommand=0)>`                                                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`ShowSystemInformation <static RED_RC RFK::TutorialApplication::ShowSystemInformation(int iCommand=0)>`                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`CreateCommand <static RED_RC RFK::TutorialApplication::CreateCommand(int &oCommandID, const RED::String &iDescription, const RED::String &iIconPath, const RED::String &iShortCut, RFK::COMMAND_CALLBACK iDo, RFK::COMMAND_CALLBACK iUndo=NULL, int iFlags=0)>`        
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`RunCommand <static RED_RC RFK::TutorialApplication::RunCommand(int iCommandID)>`                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`DeleteCommand <static RED_RC RFK::TutorialApplication::DeleteCommand(int iCommandID)>`                                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`RemoveCommand <static RED_RC RFK::TutorialApplication::RemoveCommand(int iCommandID, int iUIID=-1)>`                                                                                                                                                                   
int                                                                         :cpp:func:`GetCommandState <static int RFK::TutorialApplication::GetCommandState(int iCommandID)>`                                                                                                                                                                                
void                                                                        :cpp:func:`SetCommandState <static void RFK::TutorialApplication::SetCommandState(int iCommandID, int iFlags)>`                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`AddToolBar <static RED_RC RFK::TutorialApplication::AddToolBar(int &oUIID, const RED::String &iLabel)>`                                                                                                                                                                
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`AddMenu <static RED_RC RFK::TutorialApplication::AddMenu(int &oUIID, const RED::String &iLabel, int iParentID=-1)>`                                                                                                                                                    
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`RemoveUIComponent <static RED_RC RFK::TutorialApplication::RemoveUIComponent(int iUIID)>`                                                                                                                                                                              
void                                                                        :cpp:func:`EnableUI <static void RFK::TutorialApplication::EnableUI(bool iEnabled)>`                                                                                                                                                                                              
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`AddCommand <static RED_RC RFK::TutorialApplication::AddCommand(int iUIID, int iCommandID)>`                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`AddSeparator <static RED_RC RFK::TutorialApplication::AddSeparator(int iUIID)>`                                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`OpenFileDialog <static RED_RC RFK::TutorialApplication::OpenFileDialog(RED::Vector< RED::String > &oFilesList, const RED::String &iCaption, const RED::String &iDirectory, const RED::String &iFilter)>`                                                               
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`ShowInspector <static RED_RC RFK::TutorialApplication::ShowInspector(RFK::INSPECTOR iInspector, RED::Object *iObject=NULL, bool iClosable=true, const RED::Map< unsigned int, RED::String > *iIDToNames=NULL)>`                                                        
void                                                                        :cpp:func:`HideInspector <static void RFK::TutorialApplication::HideInspector(RFK::INSPECTOR iInspector)>`                                                                                                                                                                        
bool                                                                        :cpp:func:`IsInspectorVisible <static bool RFK::TutorialApplication::IsInspectorVisible(RFK::INSPECTOR iInspector)>`                                                                                                                                                              
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetInspectedObject <static RED_RC RFK::TutorialApplication::SetInspectedObject(RFK::INSPECTOR iInspector, RED::Object *iObject, const RED::Map< unsigned int, RED::String > *iIDToNames=NULL)>`                                                                        
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`GetInspectedObject <static RED_RC RFK::TutorialApplication::GetInspectedObject(RED::Object *&oObject, RFK::INSPECTOR iInspector)>`                                                                                                                                     
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`RefreshInspector <static RED_RC RFK::TutorialApplication::RefreshInspector(RFK::INSPECTOR iInspector)>`                                                                                                                                                                
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetSelectedItem <static RED_RC RFK::TutorialApplication::SetSelectedItem(RFK::INSPECTOR iInspector, const RED::ShapePath &iItem)>`                                                                                                                                     
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetUserVariables <static RED_RC RFK::TutorialApplication::SetUserVariables(const RED::Vector< RFK::UserVariable > &iUserVariables)>`                                                                                                                                   
void                                                                        :cpp:func:`UpdateUserVariables <static void RFK::TutorialApplication::UpdateUserVariables(const RED::Vector< RFK::UserVariable > &iUserVariables)>`                                                                                                                               
void                                                                        :cpp:func:`GetUserVariables <static void RFK::TutorialApplication::GetUserVariables(RED::Vector< RFK::UserVariable > &oUserVariables)>`                                                                                                                                           
void                                                                        :cpp:func:`UpdateUserVariable <static void RFK::TutorialApplication::UpdateUserVariable(const RFK::UserVariable &iUserVariable)>`                                                                                                                                                 
void                                                                        :cpp:func:`SetEventCallback <static void RFK::TutorialApplication::SetEventCallback(RFK::EVENT iEvent, RFK::EVENT_CALLBACK iCallback, void *iParam=NULL)>`                                                                                                                        
:cpp:type:`~RFK::EVENT_CALLBACK`                                            :cpp:func:`GetEventCallback <static RFK::EVENT_CALLBACK RFK::TutorialApplication::GetEventCallback(RFK::EVENT iEvent, void **iParam=NULL)>`                                                                                                                                       
void                                                                        :cpp:func:`SetMessage <static void RFK::TutorialApplication::SetMessage(const RED::String &iMessage)>`                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetViewpoint <static RED_RC RFK::TutorialApplication::SetViewpoint(RED::Object *iViewpoint)>`                                                                                                                                                                          
:doc:`classRED_1_1Object` *                                                 :cpp:func:`GetResourceManager <static RED::Object * RFK::TutorialApplication::GetResourceManager()>`                                                                                                                                                                              
:doc:`classRED_1_1Object` *                                                 :cpp:func:`GetViewpoint <static RED::Object * RFK::TutorialApplication::GetViewpoint()>`                                                                                                                                                                                          
:doc:`classRED_1_1Object` *                                                 :cpp:func:`GetWindow <static RED::Object * RFK::TutorialApplication::GetWindow()>`                                                                                                                                                                                                
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetLoopMode <static RED_RC RFK::TutorialApplication::SetLoopMode(RFK::LOOP_MODE iLoopMode)>`                                                                                                                                                                           
:cpp:enumerator:`~RFK::LOOP_MODE`                                           :cpp:func:`GetLoopMode <static LOOP_MODE RFK::TutorialApplication::GetLoopMode()>`                                                                                                                                                                                                
void                                                                        :cpp:func:`ResizeWindow <static void RFK::TutorialApplication::ResizeWindow(int iWidth, int iHeight)>`                                                                                                                                                                            
void                                                                        :cpp:func:`GetContentSize <static void RFK::TutorialApplication::GetContentSize(int &oWidth, int &oHeight)>`                                                                                                                                                                      
void                                                                        :cpp:func:`GetContentPosition <static void RFK::TutorialApplication::GetContentPosition(int &oTop, int &oLeft)>`                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SaveContent <static RED_RC RFK::TutorialApplication::SaveContent(const RED::String &iFile)>`                                                                                                                                                                           
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SendEvent <static RED_RC RFK::TutorialApplication::SendEvent(RFK::EVENT iEvent, RFK::EventInfo &iEventInfo)>`                                                                                                                                                          
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`Invalidate <static RED_RC RFK::TutorialApplication::Invalidate()>`                                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`Redraw <static RED_RC RFK::TutorialApplication::Redraw()>`                                                                                                                                                                                                             
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`StopFrameTracingIfNeeded <static RED_RC RFK::TutorialApplication::StopFrameTracingIfNeeded()>`                                                                                                                                                                         
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`AddStringsMap <static RED_RC RFK::TutorialApplication::AddStringsMap(const RED::Map< unsigned int, RED::String > &iStringsMap)>`                                                                                                                                       
const :doc:`classRED_1_1Map` < unsigned int, :doc:`classRED_1_1String` > &  :cpp:func:`GetStringsMap <static const RED::Map< unsigned int, RED::String > & RFK::TutorialApplication::GetStringsMap()>`                                                                                                                                                        
:doc:`classRED_1_1String`                                                   :cpp:func:`GetStringFromID <static RED::String RFK::TutorialApplication::GetStringFromID(unsigned int iID)>`                                                                                                                                                                      
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`TakeSnapshot <static RED_RC RFK::TutorialApplication::TakeSnapshot(int iCommand=0)>`                                                                                                                                                                                   
void                                                                        :cpp:func:`DisplayError <static void RFK::TutorialApplication::DisplayError(RED_RC iRC, const char *iCaller, const void *iObject, const char *iExpression, const char *iInfo)>`                                                                                                   
void                                                                        :cpp:func:`DisplayError <static void RFK::TutorialApplication::DisplayError(RED_RC iRC, const char *iFile, int iLine)>`                                                                                                                                                           
void                                                                        :cpp:func:`DisplayError <static void RFK::TutorialApplication::DisplayError(const RED::String &iHeader, const RED::String &iMessage)>`                                                                                                                                            
void                                                                        :cpp:func:`DisplayMessage <static void RFK::TutorialApplication::DisplayMessage(const RED::String &iHeader, const RED::String &iMessage)>`                                                                                                                                        
void                                                                        :cpp:func:`ShowProgressBar <static void RFK::TutorialApplication::ShowProgressBar(bool iShow)>`                                                                                                                                                                                   
void                                                                        :cpp:func:`UpdateProgressBar <static void RFK::TutorialApplication::UpdateProgressBar(float iValue, bool iForceRefresh=false)>`                                                                                                                                                   
void                                                                        :cpp:func:`ShowFPS <static void RFK::TutorialApplication::ShowFPS(bool iShow)>`                                                                                                                                                                                                   
void                                                                        :cpp:func:`ShowResolution <static void RFK::TutorialApplication::ShowResolution(bool iShow)>`                                                                                                                                                                                     
float                                                                       :cpp:func:`GetTime <static float RFK::TutorialApplication::GetTime()>`                                                                                                                                                                                                            
float                                                                       :cpp:func:`GetREDTimeElapsed <static float RFK::TutorialApplication::GetREDTimeElapsed()>`                                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetBackgroundColor <static RED_RC RFK::TutorialApplication::SetBackgroundColor(const RED::Color &iColor)>`                                                                                                                                                             
:doc:`classRED_1_1String`                                                   :cpp:func:`GetFilePath <static RED::String RFK::TutorialApplication::GetFilePath(const RED::String &iExtensions)>`                                                                                                                                                                
void                                                                        :cpp:func:`UpdateFPSCounter <static void RFK::TutorialApplication::UpdateFPSCounter(float iFrameTime)>`                                                                                                                                                                           
CHOICE                                                                      :cpp:func:`Ask <static CHOICE RFK::TutorialApplication::Ask(const RED::String &iQuestion)>`                                                                                                                                                                                       
bool                                                                        :cpp:func:`SaveImageStamp <static bool RFK::TutorialApplication::SaveImageStamp(const RED::String &iFilePath, unsigned char *iRGBA, int iWidth, int iHeight, RED::String iText)>`                                                                                                 
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`OpenURL <static RED_RC RFK::TutorialApplication::OpenURL(const RED::String &iURL)>`                                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`AddFrameTracingImages <static RED_RC RFK::TutorialApplication::AddFrameTracingImages(RED::Object *iColorImage, RED::Object *iDepthImage, RED::Object *iViewpoint)>`                                                                                                    
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`RemoveFrameTracingImages <static RED_RC RFK::TutorialApplication::RemoveFrameTracingImages(RED::Object *iColorImage, RED::Object *iDepthImage, RED::Object *iViewpoint)>`                                                                                              
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`ClearFrameTracingImages <static RED_RC RFK::TutorialApplication::ClearFrameTracingImages()>`                                                                                                                                                                           
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`LoadREDFile <static RED_RC RFK::TutorialApplication::LoadREDFile(RED::Object *&oCamera, unsigned int &oDataContext, RED::FileInfo *oFileInfo, const RED::String &iPath, RED::StreamingPolicy *iPolicy=NULL)>`                                                          
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`LoadFBXFile <static RED_RC RFK::TutorialApplication::LoadFBXFile(RED::Object *&oCamera, unsigned int &oDataContext, const RED::String &iPath, const RED::LayerSet *iRealTimeLayerSet, const RED::LayerSet *iPhotorealisticLayerSet)>`                                  
:cpp:enumerator:`~RED_RC`                                                   :cpp:func:`SetRecentFiles <static RED_RC RFK::TutorialApplication::SetRecentFiles(const RED::Vector< RED::String > &iRecentFiles)>`                                                                                                                                               
const :doc:`classRED_1_1Vector` < :doc:`classRED_1_1String` > &             :cpp:func:`GetRecentFiles <static const RED::Vector< RED::String > & RFK::TutorialApplication::GetRecentFiles()>`                                                                                                                                                                 
:doc:`classRED_1_1String`                                                   :cpp:func:`GetCurrentExecutablePath <static RED::String RFK::TutorialApplication::GetCurrentExecutablePath()>`                                                                                                                                                                    
void                                                                        :cpp:func:`GetMouseCursorPosition <static void RFK::TutorialApplication::GetMouseCursorPosition(int &oX, int &oY)>`                                                                                                                                                               
void                                                                        :cpp:func:`SetMouseCursorPosition <static void RFK::TutorialApplication::SetMouseCursorPosition(int iX, int iY)>`                                                                                                                                                                 
void                                                                        :cpp:func:`HideMouseCursor <static void RFK::TutorialApplication::HideMouseCursor()>`                                                                                                                                                                                             
void                                                                        :cpp:func:`ShowMouseCursor <static void RFK::TutorialApplication::ShowMouseCursor()>`                                                                                                                                                                                             
void                                                                        :cpp:func:`SetCustomLicense <static void RFK::TutorialApplication::SetCustomLicense(const RED::String &iLicenseKey, unsigned int iCustomerID)>`                                                                                                                                   
=========================================================================== ==================================================================================================================================================================================================================================================================================

.. cpp:namespace:: nullptr

Detailed Description
====================

.. doxygenclass:: RFK::TutorialApplication
   :project: RED
   :members:
   :undoc-members:



