All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::ExampleApplication Class Reference

#include <kanzi/example_application.hpp>

Inheritance diagram for kanzi::ExampleApplication:
kanzi::Application kanzi::Module

Public Member Functions

virtual void onConfigure (ApplicationProperties &configuration) KZ_OVERRIDE
 User-defined configuration. More...
 
virtual void registerMetadataOverride (ObjectFactory &) KZ_OVERRIDE
 
virtual void onKeyInputEvent (const KzsInputEventKey *inputData) KZ_OVERRIDE
 Event callback for keyboard input events. More...
 
- Public Member Functions inherited from kanzi::Application
 Application ()
 Constructs the application object. More...
 
virtual ~Application ()
 Destructs the application object. More...
 
void initialize (const SystemProperties &systemProperties)
 Initializes the application to a consistent state. More...
 
void uninitialize ()
 Uninitializes the application. More...
 
void initializeGL ()
 Initializes the graphics language subsystem. More...
 
void uninitializeGL ()
 Uninitializes the graphics language subsystem. More...
 
void suspendGL ()
 Suspends the graphics language subsystem. More...
 
void resumeGL ()
 Resumes the graphics language subsystem. More...
 
DomaingetDomain () const
 Access domain. More...
 
Renderer3DgetRenderer () const
 Access the renderer. More...
 
Node2DSharedPtr getRoot () const
 Access root node. More...
 
ScreenSharedPtr getScreen () const
 Access screen. More...
 
void setScreen (ScreenSharedPtr screen)
 Set screen. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Access engine task scheduler. More...
 
ResourceManagergetResourceManager () const
 Access resource manager. More...
 
KzuInputManagergetInputManager () const
 Access input manager. More...
 
KzuBinaryLoadergetBinaryLoader () const
 Access binary loader. More...
 
KzuPreviewSystemgetPreviewSystem () const
 Access preview system. More...
 
LayerRenderpassgetNode2DRenderpass () const
 Access layer composer. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Access message dispatcher. More...
 
TransformedScene2DgetNode2DTransformedScene () const
 Access layer transformed scene. More...
 
kzFloat getFramesPerSecond () const
 Access FPS info. More...
 
void enablePreviewSystem ()
 Initializes the subsystem for preview features. More...
 
size_t getRenderTargetCount () const
 Access render target count. More...
 
RenderTargetSharedPtr getRenderTarget (size_t index=0) const
 Access render targets. More...
 
void appendRenderTarget (RenderTargetSharedPtr renderTarget)
 Attach render target. More...
 
void removeRenderTarget (size_t index=0)
 Remove render target. More...
 
size_t getEventSourceCount () const
 Access event source count. More...
 
EventSourceSharedPtr getEventSource (size_t index=0) const
 Access event sources. More...
 
void appendEventSource (EventSourceSharedPtr eventSource)
 Attach event source. More...
 
void removeEventSource (size_t index=0)
 Remove event source. More...
 
State getState ()
 Access application state. More...
 
ApplicationProperties getApplicationProperties () const
 Access application properties. More...
 
void main (const SystemProperties &systemProperties)
 Application entry point. More...
 
void update (chrono::milliseconds deltaTime)
 Updates application logic. More...
 
void render ()
 Renders the root layer. More...
 
void progressDeploymentQueue ()
 Processes the deployment queue for asynchronous loading tasks. More...
 
void suspend ()
 Suspends the application as soon as possible. More...
 
void resume ()
 Resumes the application as soon as possible. More...
 
void quit ()
 Quits the application as soon as possible. More...
 
- Public Member Functions inherited from kanzi::Module
 Module ()
 
virtual MetaclassContainer getMetaclassesOverride ()
 
virtual void destroy ()
 

Additional Inherited Members

- Public Types inherited from kanzi::Application
enum  State {
  Uninitialized, Running, Suspended, Quitting,
  Error
}
 Enumeration for different application states. More...
 
- Public Types inherited from kanzi::Module
typedef vector< const Metaclass * > MetaclassContainer
 
typedef
MetaclassContainer::iterator 
MetaclassIterator
 
- Protected Member Functions inherited from kanzi::Application
virtual void onStartup ()
 Function callback for application start. More...
 
virtual void onShutdown ()
 Function callback for application end. More...
 
virtual void onProjectLoaded ()
 Function callback for initialization that is using the .KZB data. This function is called right after the .KZB binaries have been loaded. More...
 
virtual void onUpdate (chrono::milliseconds deltaTime)
 Function callback for updating logic. More...
 
virtual void onPreRender ()
 Function callback for rendering. This function is called for every frame before any other rendering function. More...
 
virtual void onPostRender ()
 Function callback for rendering. This function is called for every frame after the root layer has been rendered. More...
 
virtual void onPointerInputEvent (const KzsInputEventPointer *inputData)
 Event callback for pointing device (e.g. mouse or touch screen) input events. More...
 
virtual void onIdle ()
 Event callback for idle loop. More...
 
virtual void onSuspend ()
 Event callback for application suspension. More...
 
virtual void onResume ()
 Event callback for application resume. More...
 
virtual void initializeOverride (const SystemProperties &systemProperties)
 Override function for initialize(). More...
 
virtual void uninitializeOverride ()
 Override function for uninitialize(). More...
 
virtual void initializeGLOverride ()
 Override function for initializeGL(). More...
 
virtual void uninitializeGLOverride ()
 Override function for uninitializeGL(). More...
 
virtual void suspendGLOverride ()
 Override function for suspendGL(). More...
 
virtual void resumeGLOverride ()
 Override function for resumeGL(). More...
 
virtual void mainOverride (const SystemProperties &systemProperties)
 Override function for main(). More...
 
virtual void updateOverride (chrono::milliseconds deltaTime)
 Override function for update(). More...
 
virtual void renderOverride ()
 Override function for render(). More...
 
virtual void progressDeploymentQueueOverride ()
 Override function for progressDeploymentQueue(). More...
 
virtual void initializeProperties (const SystemProperties &systemProperties)
 
virtual void initializeProfiling ()
 
virtual void initializeEngine ()
 
virtual void initializeSystem ()
 
void projectLoaded ()
 
virtual void handleEvents (const KzsEventQueue *eventQueue)
 
virtual bool isToolPresent () const
 
virtual void run ()
 
void idle ()
 
void idleLoop ()
 
void loadPlugins ()
 
KzuEnginegetEngine () const
 Acces engine. More...
 
- Protected Member Functions inherited from kanzi::Module
virtual ~Module ()
 
- Protected Attributes inherited from kanzi::Application
vector< EventSourceSharedPtrm_eventSources
 Container for event sources. More...
 
vector< RenderTargetSharedPtrm_renderTargets
 Container for render targets. More...
 
State m_state
 Current state of the application. More...
 
SystemProperties m_systemProperties
 System properties. More...
 
ApplicationProperties m_applicationProperties
 Application properties. More...
 
KzcMemoryManagerm_systemMemoryManager
 System memory manager. More...
 
KzsEventQueue * m_eventQueue
 The event queue for user input and window events. More...
 
KzsEventQueue * m_eventQueueBuffer
 Temporary event queue used for combining similar events. More...
 
KzuEnginem_engine
 Engine instance. More...
 
shared_ptr< Schedulerm_scheduler
 Execution scheduler. More...
 

Member Function Documentation

virtual void kanzi::ExampleApplication::onConfigure ( ApplicationProperties configuration)
inlinevirtual

User-defined configuration.

This callback is called after application.cfg is read, but before the graphics language subsystem is initialized.

Parameters
configurationAllows modification of the application properties.

Reimplemented from kanzi::Application.

virtual void kanzi::ExampleApplication::registerMetadataOverride ( ObjectFactory )
inlinevirtual

Reimplemented from kanzi::Module.

virtual void kanzi::ExampleApplication::onKeyInputEvent ( const KzsInputEventKey *  inputData)
inlinevirtual

Event callback for keyboard input events.

Reimplemented from kanzi::Application.


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