Crazy Eddie's GUI System  ${CEGUI_VERSION}
SamplesFramework Class Reference

This is. More...

+ Inheritance diagram for SamplesFramework:
+ Collaboration diagram for SamplesFramework:

Public Member Functions

 SamplesFramework (const CEGUI::String &xml_filename)
 
bool initialise (const CEGUI::String &logFile, const CEGUI::String &dataPathPrefixOverride)
 Initialises the sample system, this includes asking the user for a render to use and the subsequent creation of the required systems to support that renderer. More...
 
void cleanup ()
 
void addSampleDataCppModule (CEGUI::String sampleName, CEGUI::String summary, CEGUI::String description, SampleType sampleTypeEnum, CEGUI::String credits)
 
void handleSampleSelection (CEGUI::Window *sampleWindow)
 
void handleStartDisplaySample (CEGUI::Window *sampleWindow)
 
virtual void update (float passedTime)
 Update function called before rendering.
 
virtual void handleNewWindowSize (float width, float height)
 Update function for window size changes.
 
virtual void renderGUIContexts ()
 Draw function to draw GUIContexts.
 
SampleDatafindSampleData (CEGUI::Window *sampleWindow)
 
virtual bool injectKeyDown (const CEGUI::Key::Scan &ceguiKey)
 Function to inject key down to GUIContexts. More...
 
virtual bool injectKeyUp (const CEGUI::Key::Scan &ceguiKey)
 Function to inject key up to GUIContexts. More...
 
virtual bool injectChar (int character)
 Function to inject characters to GUIContexts. More...
 
virtual bool injectMouseButtonDown (const CEGUI::MouseButton &ceguiMouseButton)
 Function to inject mouse button down to GUIContexts. More...
 
virtual bool injectMouseButtonUp (const CEGUI::MouseButton &ceguiMouseButton)
 Function to inject mouse button up to GUIContexts. More...
 
virtual bool injectMouseWheelChange (float position)
 Function to inject mouse wheel changes to GUIContexts. More...
 
virtual bool injectMousePosition (float x, float y)
 Function to inject the mouse position to GUIContexts. More...
 
- Public Member Functions inherited from SamplesFrameworkBase
 SamplesFrameworkBase ()
 Constructor.
 
virtual ~SamplesFrameworkBase ()
 Destructor.
 
int run (const CEGUI::String &dataPathPrefixOverride)
 Application entry point. More...
 
void renderSingleFrame (float elapsed)
 
virtual void setQuitting (bool quit)
 Function to set the bool defining if the application should quit as soon as possible.
 
bool isQuitting ()
 Function returning if the application should quit as soon as possible. More...
 
void setApplicationWindowSize (int width, int height)
 Function setting the application window's size.
 
void outputExceptionMessage (const char *message)
 Output a message to the user in some OS independant way.
 

Static Public Member Functions

static void setDefaultResourceGroup (const CEGUI::String &resourceGroup)
 

Static Public Attributes

static const CEGUI::String XMLSchemaName
 

Protected Member Functions

void initialiseLoadScreenLayout ()
 
void initialiseSampleBrowserLayout ()
 
void loadSamplesDataFromXML (const CEGUI::String &filename)
 
void getSampleInstanceFromDLL (SampleData &sampleData)
 
void addSample (SampleData *sampleData)
 
bool initialiseSampleStepwise (int sampleNumber)
 
void displaySampleLoadProgress (int sampleNumber)
 
void initialisationFinalisation ()
 
void unloadSamples ()
 
void stopDisplaySample ()
 
void updateSamples (float passedTime)
 
bool updateInitialisationStep ()
 
void displaySampleBrowserLayoutLoadProgress ()
 
bool handleSampleExitButtonClicked (const CEGUI::EventArgs &args)
 
void renderSampleGUIContexts ()
 
bool areWindowsIntersecting (CEGUI::Window *window1, CEGUI::Window *window2)
 

Protected Attributes

CEGUI::Windowd_root
 
CEGUI::PushButtond_sampleExitButton
 
std::vector< SampleData * > d_samples
 
MetaDataWindowManagerd_metaDataWinMgr
 
SamplesBrowserManagerd_samplesWinMgr
 
SampleDatad_selectedSampleData
 
CEGUI::ProgressBard_loadingProgressBar
 
CEGUI::Windowd_loadingScreenText
 
CEGUI::Windowd_loadScreenChunkProgressText
 
bool d_quittingSampleView
 
CEGUI::String d_samplesXMLFilename
 
- Protected Attributes inherited from SamplesFrameworkBase
CEGuiRendererSelectord_rendererSelector
 Points to the renderer selector object.
 
CEGuiBaseApplicationd_baseApp
 Pointer to the base application object.
 
bool d_quitting
 Bool defining if application should quit.
 
int d_appWindowWidth
 Int defining the application window's width.
 
int d_appWindowHeight
 Int defining the application window's height.
 

Detailed Description

This is.

Member Function Documentation

bool SamplesFramework::initialise ( const CEGUI::String logFile,
const CEGUI::String dataPathPrefixOverride 
)
virtual

Initialises the sample system, this includes asking the user for a render to use and the subsequent creation of the required systems to support that renderer.

Returns
false if anything went wrong.

Reimplemented from SamplesFrameworkBase.

References CEGUI::String::empty(), CEGUI::Errors, CEGUI::Window::getChild(), CEGUI::System::getSingleton(), SamplesFrameworkBase::initialise(), CEGUI::WindowManager::loadLayoutFromFile(), CEGUI::GUIContext::setDefaultFont(), and CEGUI::Window::setText().

bool SamplesFramework::injectChar ( int  character)
virtual

Function to inject characters to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().

bool SamplesFramework::injectKeyDown ( const CEGUI::Key::Scan &  ceguiKey)
virtual

Function to inject key down to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().

bool SamplesFramework::injectKeyUp ( const CEGUI::Key::Scan &  ceguiKey)
virtual

Function to inject key up to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().

bool SamplesFramework::injectMouseButtonDown ( const CEGUI::MouseButton ceguiMouseButton)
virtual

Function to inject mouse button down to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().

bool SamplesFramework::injectMouseButtonUp ( const CEGUI::MouseButton ceguiMouseButton)
virtual

Function to inject mouse button up to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().

bool SamplesFramework::injectMousePosition ( float  x,
float  y 
)
virtual

Function to inject the mouse position to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().

bool SamplesFramework::injectMouseWheelChange ( float  position)
virtual

Function to inject mouse wheel changes to GUIContexts.

Returns
true if event was handled.

Implements SamplesFrameworkBase.

References CEGUI::System::getSingletonPtr().