Dali 3D User Interface Engine
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
Dali::Internal::SystemOverlay Class Reference

Implementation of Dali::Integration::SystemOverlay. More...

#include <system-overlay-impl.h>

Inheritance diagram for Dali::Internal::SystemOverlay:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::SystemOverlay:
Collaboration graph
[legend]

Public Member Functions

 ~SystemOverlay ()
 Non-virtual destructor; not intended as a base class. More...
 
void Add (Actor &actor)
 Add an Actor to the SystemOverlay. More...
 
void Remove (Actor &actor)
 Remove an Actor that was added to the SystemOverlay. More...
 
RenderTaskListGetOverlayRenderTasks ()
 Retrieve the list of render-tasks for system-level overlays. More...
 
void SetSize (float width, float height)
 Forwarded from Stage::SetSize(). More...
 
LayerListGetLayerList ()
 Retrieve the ordered list of system layers. More...
 
virtual ActorGetDefaultRootActor ()
 From RenderTaskDefaults. More...
 
virtual CameraActorGetDefaultCameraActor ()
 From RenderTaskDefaults. More...
 

Static Public Member Functions

static SystemOverlayNew (EventThreadServices &eventThreadServices)
 Create the SystemOverlay; This should only be done once for each Dali core. More...
 

Private Member Functions

 SystemOverlay (EventThreadServices &eventThreadServices)
 Protected constructor; see also SystemOverlay::New(). More...
 
void Initialize ()
 Second-phase construction. More...
 
void CreateRootLayer ()
 Lazy initialization of the SystemOverlay root actor. More...
 
void CreateDefaultCameraActor ()
 Lazy initialization of the default camera actor. More...
 

Private Attributes

EventThreadServicesmEventThreadServices
 
Vector2 mSize
 
IntrusivePtr< RenderTaskListmOverlayRenderTaskList
 
LayerPtr mRootLayer
 
CameraActorPtr mDefaultCameraActor
 
OwnerPointer< LayerListmLayerList
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::Internal::RenderTaskDefaults
virtual ~RenderTaskDefaults ()
 Virtual destructor. More...
 

Detailed Description

Implementation of Dali::Integration::SystemOverlay.

Definition at line 41 of file system-overlay-impl.h.

Constructor & Destructor Documentation

Dali::Internal::SystemOverlay::~SystemOverlay ( )

Non-virtual destructor; not intended as a base class.

Dali::Internal::SystemOverlay::SystemOverlay ( EventThreadServices eventThreadServices)
private

Protected constructor; see also SystemOverlay::New().

Parameters
[in]eventThreadServicesto send messaged to the scene graph.

Definition at line 115 of file system-overlay-impl.cpp.

Member Function Documentation

void Dali::Internal::SystemOverlay::Add ( Actor actor)

Add an Actor to the SystemOverlay.

Precondition
The actor handle is not empty.
Parameters
[in]actorA handle to the actor to add.
Postcondition
The actor will be referenced.
void Dali::Internal::SystemOverlay::CreateDefaultCameraActor ( )
private

Lazy initialization of the default camera actor.

Definition at line 137 of file system-overlay-impl.cpp.

References Dali::Integration::SystemOverlay::Add(), Dali::ParentOrigin::CENTER, and Dali::CameraActor::New().

Here is the call graph for this function:

void Dali::Internal::SystemOverlay::CreateRootLayer ( )
private

Lazy initialization of the SystemOverlay root actor.

Definition at line 126 of file system-overlay-impl.cpp.

CameraActor & Dali::Internal::SystemOverlay::GetDefaultCameraActor ( )
virtual

From RenderTaskDefaults.

Retrieve the default SystemOverlay camera actor.

Note
This is different to the default camera actor provided by Dali::Stage.

Implements Dali::Internal::RenderTaskDefaults.

Definition at line 108 of file system-overlay-impl.cpp.

Actor & Dali::Internal::SystemOverlay::GetDefaultRootActor ( )
virtual

From RenderTaskDefaults.

Retrieve the default SystemOverlay root actor.

Note
This is different to the root actor provided by Dali::Stage.

Implements Dali::Internal::RenderTaskDefaults.

Definition at line 101 of file system-overlay-impl.cpp.

LayerList & Dali::Internal::SystemOverlay::GetLayerList ( )

Retrieve the ordered list of system layers.

Returns
The layer-list.

Definition at line 96 of file system-overlay-impl.cpp.

RenderTaskList& Dali::Internal::SystemOverlay::GetOverlayRenderTasks ( )

Retrieve the list of render-tasks for system-level overlays.

This is a seperate list, processed after the render-tasks provided by Stage::GetRenderTaskList().

Returns
The list of overlay render-tasks.
void Dali::Internal::SystemOverlay::Initialize ( void  )
private

Second-phase construction.

Definition at line 120 of file system-overlay-impl.cpp.

References Dali::WeightObject::New().

Here is the call graph for this function:

SystemOverlay * Dali::Internal::SystemOverlay::New ( EventThreadServices eventThreadServices)
static

Create the SystemOverlay; This should only be done once for each Dali core.

Parameters
[in]eventThreadServicesto send messaged to scene graph.
Returns
The newly allocated SystemOverlay.

Definition at line 36 of file system-overlay-impl.cpp.

References Dali::Integration::SystemOverlay::SystemOverlay().

Here is the call graph for this function:

void Dali::Internal::SystemOverlay::Remove ( Actor actor)

Remove an Actor that was added to the SystemOverlay.

Precondition
The actor handle is not empty.
Parameters
[in]actorA handle to the actor to remove.
Postcondition
The actor will be unreferenced.
void Dali::Internal::SystemOverlay::SetSize ( float  width,
float  height 
)

Forwarded from Stage::SetSize().

Parameters
[in]widthThe new width.
[in]heightThe new height.

Definition at line 80 of file system-overlay-impl.cpp.

Member Data Documentation

CameraActorPtr Dali::Internal::SystemOverlay::mDefaultCameraActor
private

Definition at line 132 of file system-overlay-impl.h.

EventThreadServices& Dali::Internal::SystemOverlay::mEventThreadServices
private

Definition at line 124 of file system-overlay-impl.h.

OwnerPointer<LayerList> Dali::Internal::SystemOverlay::mLayerList
private

Definition at line 135 of file system-overlay-impl.h.

IntrusivePtr<RenderTaskList> Dali::Internal::SystemOverlay::mOverlayRenderTaskList
private

Definition at line 128 of file system-overlay-impl.h.

LayerPtr Dali::Internal::SystemOverlay::mRootLayer
private

Definition at line 130 of file system-overlay-impl.h.

Vector2 Dali::Internal::SystemOverlay::mSize
private

Definition at line 126 of file system-overlay-impl.h.


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali