Urho3D::SplashScreen Class Reference
Splash screen application state. More...
#include <Urho3D/UI/SplashScreen.h>
Inheritance diagram for Urho3D::SplashScreen:
Public Member Functions | |
| SplashScreen (Context *context) | |
| Construct. | |
| void | Activate (StringVariantMap &bundle) override |
| Activate game screen. Executed by StateManager. | |
| bool | CanLeaveState () const override |
| Return true if state is ready to be deactivated. Executed by StateManager. | |
| void | Deactivate () override |
| Deactivate game screen. Executed by StateManager. | |
| void | Update (float timeStep) override |
| Handle the logic update event. | |
| bool | QueueSceneResourcesAsync (const ea::string &fileName) |
| Background load all resources referenced by a scene. | |
| template<class T> | |
| bool | QueueResource (const ea::string &name, bool sendEventOnFailure=true) |
| Template version of queueing a resource background load. | |
| bool | QueueResource (StringHash type, const ea::string &name, bool sendEventOnFailure=true) |
| void | SetBackgroundImage (Texture *image) |
| void | SetForegroundImage (Texture *image) |
| void | SetProgressImage (Texture *image) |
| void | SetProgressColor (const Color &color) |
| void | SetSound (Sound *sound, float gain) |
| void | SetDuration (float durationInSeconds) |
| void | SetSkippable (bool skippable) |
| Texture * | GetBackgroundImage () const |
| Texture * | GetForegroundImage () const |
| Texture * | GetProgressImage () const |
| const Color & | GetProgressColor () const |
| float | GetDuration () const |
| bool | IsSkippable () const |
| Public Member Functions inherited from Urho3D::ApplicationState | |
| ApplicationState (Context *context) | |
| Construct. | |
| virtual | ~ApplicationState () override |
| Destruct. | |
| virtual void | TransitionComplete () |
| Transition into the state complete. Executed by StateManager. | |
| virtual void | TransitionStarted () |
| Transition out of the state started. Executed by StateManager. | |
| bool | IsActive () const |
| Get activation flag. Returns true if game screen is active. | |
| void | SetMouseVisible (bool enable) |
| Set whether the operating system mouse cursor is visible. | |
| void | SetMouseGrabbed (bool grab) |
| Set whether the mouse is currently being grabbed by an operation. | |
| void | SetMouseMode (MouseMode mode) |
| Set the mouse mode. | |
| void | SetCursor (Cursor *cursor) |
| Set cursor UI element. | |
| Cursor * | GetCursor () const |
| Return cursor. | |
| bool | IsMouseVisible () const |
| bool | IsMouseGrabbed () const |
| MouseMode | GetMouseMode () const |
| UIElement * | GetUIRoot () const |
| void | SetUICustomSize (const IntVector2 &size) |
| void | SetUICustomSize (int width, int height) |
| Set custom size of the root element. | |
| const IntVector2 & | GetUICustomSize () const |
| void | SetNumViewports (unsigned num) |
| void | SetViewport (unsigned index, Viewport *viewport) |
| void | SetDefaultFogColor (const Color &color) |
| Set default zone fog color. | |
| Viewport * | GetViewport (unsigned index) const |
| Viewport * | GetViewportForScene (Scene *scene, unsigned index) const |
| Return nth backbuffer viewport associated to a scene. Index 0 returns the first. | |
| const Color & | GetDefaultFogColor () const |
| Get default zone fog color. | |
| Public Member Functions inherited from Urho3D::Object | |
| Object (Context *context) | |
| Construct. | |
| ~Object () override | |
| Destruct. Clean up self from event sender & receiver structures. | |
| virtual StringHash | GetType () const =0 |
| virtual const ea::string & | GetTypeName () const =0 |
| virtual const TypeInfo * | GetTypeInfo () const =0 |
| Return type info. | |
| virtual bool | IsInstanceOf (StringHash type) const =0 |
| Check whether current instance implements specified type. | |
| virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event. | |
| virtual void | SerializeInBlock (Archive &archive) |
| Serialize content from/to archive. May throw ArchiveException. | |
| template<typename T> | |
| bool | IsInstanceOf () const |
| Check current instance is type of specified class. | |
| template<typename T> | |
| T * | Cast () |
| Cast the object to specified most derived class. | |
| template<typename T> | |
| const T * | Cast () const |
| Cast the object to specified most derived class. | |
| void | SubscribeToEventManual (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender. | |
| void | SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event. | |
| template<class T> | |
| void | SubscribeToEvent (StringHash eventType, T handler) |
| Subscribe to an event that can be sent by any sender. | |
| template<class T> | |
| void | SubscribeToEvent (Object *sender, StringHash eventType, T handler) |
| Subscribe to a specific sender's event. | |
| void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event. | |
| void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event. | |
| void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events. | |
| void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events. | |
| void | UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions) |
| Unsubscribe from all events except those listed. | |
| void | UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions) |
| Unsubscribe from all events except those with listed senders. | |
| void | SendEvent (StringHash eventType) |
| Send event to all subscribers. | |
| void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| VariantMap & | GetEventDataMap () const |
| Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps. | |
| template<typename... Args> | |
| void | SendEvent (StringHash eventType, const Args &... args) |
| Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs. | |
| Context * | GetContext () const |
| Return execution context. | |
| const Variant & | GetGlobalVar (StringHash key) const |
| const VariantMap & | GetGlobalVars () const |
| void | SetGlobalVar (StringHash key, const Variant &value) |
| Object * | GetSubsystem (StringHash type) const |
| Return subsystem by type. | |
| Object * | GetEventSender () const |
| Return active event sender. Null outside event handling. | |
| EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling. | |
| bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender. | |
| bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event. | |
| bool | HasEventHandlers () const |
| Return whether has subscribed to any event. | |
| template<class T> | |
| T * | GetSubsystem () const |
| Template version of returning a subsystem. | |
| const ea::string & | GetCategory () const |
| void | SendEvent (StringHash eventType, const VariantMap &eventData) |
| Send event with parameters to all subscribers. | |
| void | SetBlockEvents (bool block) |
| Block object from sending and receiving events. | |
| bool | GetBlockEvents () const |
| Return sending and receiving events blocking status. | |
| Public Member Functions inherited from Urho3D::RefCounted | |
| RefCounted () | |
| Construct. Allocate the reference count structure and set an initial self weak reference. | |
| virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist. | |
| RefCounted (const RefCounted &rhs)=delete | |
| Prevent copy construction. | |
| RefCounted & | operator= (const RefCounted &rhs)=delete |
| Prevent assignment. | |
| int | AddRef () const |
| int | ReleaseRef () const |
| int | Refs () const |
| int | WeakRefs () const |
| RefCount * | RefCountPtr () const |
| Return pointer to the reference count structure. | |
| bool | HasScriptObject () const |
| Return true if script runtime object wrapping this native object exists. | |
| bool | IsScriptStrongRef () const |
| Return true if script reference is strong. | |
Private Member Functions | |
| void | HandleKeyUp (StringHash eventType, VariantMap &args) |
| void | UpdateLayout (float ratio) |
| void | UpdateState (float timeStep, unsigned resourceCounter) |
Private Attributes | |
| bool | skippable_ {true} |
| bool | exitRequested_ {} |
| unsigned | maxResourceCounter_ {0} |
| float | timeAcc_ {0.0f} |
| float | duration_ {0.0f} |
| SharedPtr< Scene > | scene_ |
| SharedPtr< SoundSource > | soundSource_ |
| SharedPtr< Sprite > | background_ |
| SharedPtr< Sprite > | foreground_ |
| SharedPtr< Sprite > | progressBar_ |
| SharedPtr< Sound > | sound_ |
Additional Inherited Members | |
| Static Public Member Functions inherited from Urho3D::ApplicationState | |
| static void | RegisterObject (Context *context) |
| Register object factory. | |
| Static Public Member Functions inherited from Urho3D::Object | |
| static const TypeInfo * | GetTypeInfoStatic () |
| Return type info static. | |
| Static Public Attributes inherited from Urho3D::Object | |
| static constexpr ea::array< StringHash, 0 > | TypeHierarchy {} |
| Protected Attributes inherited from Urho3D::Object | |
| WeakPtr< Context > | context_ |
| Execution context. | |
Detailed Description
Splash screen application state.
Member Function Documentation
◆ Activate()
|
overridevirtual |
Activate game screen. Executed by StateManager.
Reimplemented from Urho3D::ApplicationState.
◆ CanLeaveState()
|
overridevirtual |
Return true if state is ready to be deactivated. Executed by StateManager.
Reimplemented from Urho3D::ApplicationState.
◆ Deactivate()
|
overridevirtual |
Deactivate game screen. Executed by StateManager.
Reimplemented from Urho3D::ApplicationState.
◆ QueueResource()
| bool Urho3D::SplashScreen::QueueResource | ( | StringHash | type, |
| const ea::string & | name, | ||
| bool | sendEventOnFailure = true ) |
Background load a resource. Return true if successfully stored to the load queue, false if eg. already exists. Can be called from outside the main thread.
◆ Update()
|
overridevirtual |
Handle the logic update event.
Reimplemented from Urho3D::ApplicationState.
The documentation for this class was generated from the following files:
- Urho3D/UI/SplashScreen.h
- Urho3D/UI/SplashScreen.cpp