Scene Class Reference

Screen. More...

Inherited by FocusScene, ModalScene, and NavigationScene.

List of all members.

Public Member Functions

 Scene ()
 Constructor.

Protected Member Functions

virtual void OnUpdate (float elapsedTime)
 Update processing handler of each frame.
virtual internal void OnShowing ()
 Event handler called when the screen is displayed.
virtual internal void OnShown ()
 Event handler issued when the screen is displayed.
virtual internal void OnHiding ()
 Event handler called when the screen is being turned off.
virtual internal void OnHidden ()
 Event handler called when the screen has been turned off.

Properties

string Title [get, set]
 Obtains and sets the scene title.
RootWidget RootWidget [get]
 Obtains the root of the widget tree.
Transition Transition [get, set]
 Obtains and sets the transition.
bool ShowNavigationBar [get, set]
 Obtains and sets whether to display the navigation bar.
bool Visible [get, set]
 Obtains and sets whether to display.
float DesignWidth [get, set]
 Obtains and sets the initial width of the scene for the layout.
float DesignHeight [get, set]
 Obtains and sets the initial height of the scene for the layout.
Widget FocusWidget [get, set]
 Obtains the widget that currently has focus in this scene.
Widget DefaultFocusWidget [get, set]
 Widget in focus first.

Events

EventHandler< UpdateEventArgsUpdated
 Event when updating each frame.
EventHandler Showing
 Event issued when the screen is displayed.
EventHandler Shown
 Event issued when the screen is displayed.
EventHandler Hiding
 Event issued when the screen is being turned off.
EventHandler Hidden
 Event issued when the screen is turned off.

Detailed Description

Screen.


Member Function Documentation

virtual internal void OnHidden ( ) [protected, virtual]

Event handler called when the screen has been turned off.

This is called when a set Transition is terminated. When an Override occurs, the basic class method must be called within the method.

virtual internal void OnHiding ( ) [protected, virtual]

Event handler called when the screen is being turned off.

This is called before a set Transition is started. When an Override occurs, the basic class method must be called within the method.

virtual internal void OnShowing ( ) [protected, virtual]

Event handler called when the screen is displayed.

This is called before a set Transition is started. When an Override occurs, the basic class method must be called within the method.

virtual internal void OnShown ( ) [protected, virtual]

Event handler issued when the screen is displayed.

This is called when a set Transition is terminated. When an Override occurs, the basic class method must be called within the method.

virtual void OnUpdate ( float  elapsedTime) [protected, virtual]

Update processing handler of each frame.

Parameters:
elapsedTimeElapsed time from previous update (ms)

Property Documentation

Widget DefaultFocusWidget [get, set]

Widget in focus first.

When there is null, the default widget is used.


Event Documentation

EventHandler Hidden

Event issued when the screen is turned off.

This is issued when a set Transition is terminated.

EventHandler Hiding

Event issued when the screen is being turned off.

This is issued before a set Transition is started.

EventHandler Showing

Event issued when the screen is displayed.

This is issued before a set Transition is started.

EventHandler Shown

Event issued when the screen is displayed.

This is issued when a set Transition is terminated.