Dali 3D User Interface Engine
List of all members | Public Types | Public Member Functions | Private Attributes
Dali::Internal::SceneGraph::ObjectOwnerContainer< Type > Class Template Reference

ObjectOwnerContainer is an object which owns SceneGraph Objects. More...

#include <object-owner-container.h>

Inheritance diagram for Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >:
Collaboration graph
[legend]

Public Types

typedef Dali::OwnerContainer
< Type * > 
ObjectContainer
 
typedef Dali::OwnerContainer
< Type * >::Iterator 
Iterator
 

Public Member Functions

 ObjectOwnerContainer (SceneGraphBuffers &sceneGraphBuffers, DiscardQueue &discardQueue)
 Constructor - create a new object container. More...
 
void SetSceneController (SceneController &sceneController)
 Set the SceneController on this owner. More...
 
void Add (Type *pointer)
 Add an object to the owner. More...
 
void Remove (Type *pointer)
 Remove an object from the owner. More...
 
void ResetToBaseValues (BufferIndex bufferIndex)
 Method to call ResetToBaseValues on all the objects owned. More...
 
void ConstrainObjects (BufferIndex bufferIndex)
 Method to call ConstrainObjects on all the objects owned. More...
 
const ObjectContainerGetObjectContainer ()
 

Private Attributes

SceneControllermSceneController
 SceneController used to send messages. More...
 
ObjectContainer mObjectContainer
 Container for the objects owned. More...
 
SceneGraphBuffersmSceneGraphBuffers
 Reference to a SceneGraphBuffers to get the indexBuffer. More...
 
DiscardQueuemDiscardQueue
 Discard queue used for removed objects. More...
 

Detailed Description

template<class Type>
class Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >

ObjectOwnerContainer is an object which owns SceneGraph Objects.

It is responsible for ensuring they are placed on a discard queue when removed from the container.

Definition at line 42 of file object-owner-container.h.

Member Typedef Documentation

Definition at line 46 of file object-owner-container.h.

Definition at line 45 of file object-owner-container.h.

Constructor & Destructor Documentation

template<class Type>
Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::ObjectOwnerContainer ( SceneGraphBuffers sceneGraphBuffers,
DiscardQueue discardQueue 
)
inline

Constructor - create a new object container.

Object container own update side objects

Parameters
[in]sceneGraphBuffersHelper to get the correct buffer index
[in]discardQueueQueue to discard objects that might still be in use in the render thread.

Definition at line 56 of file object-owner-container.h.

Member Function Documentation

template<class Type>
void Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::Add ( Type *  pointer)
inline

Add an object to the owner.

Parameters
[in]objectPointer to the object that will be owned

Definition at line 78 of file object-owner-container.h.

template<class Type>
void Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::ConstrainObjects ( BufferIndex  bufferIndex)
inline

Method to call ConstrainObjects on all the objects owned.

Parameters
[in]bufferIndexBuffer index for double buffered values.

Definition at line 125 of file object-owner-container.h.

template<class Type>
const ObjectContainer& Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::GetObjectContainer ( )
inline

Definition at line 134 of file object-owner-container.h.

template<class Type>
void Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::Remove ( Type *  pointer)
inline

Remove an object from the owner.

The object is put on the discard queue.

Parameters
[in]objectPointer to the object to be removed

Definition at line 94 of file object-owner-container.h.

template<class Type>
void Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::ResetToBaseValues ( BufferIndex  bufferIndex)
inline

Method to call ResetToBaseValues on all the objects owned.

Parameters
[in]bufferIndexBuffer index for double buffered values.

Definition at line 111 of file object-owner-container.h.

template<class Type>
void Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::SetSceneController ( SceneController sceneController)
inline

Set the SceneController on this owner.

Parameters
[in]sceneControllerThe SceneController

Definition at line 68 of file object-owner-container.h.

Member Data Documentation

template<class Type>
DiscardQueue& Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::mDiscardQueue
private

Discard queue used for removed objects.

Definition at line 143 of file object-owner-container.h.

Referenced by Dali::Internal::SceneGraph::ObjectOwnerContainer< Dali::Internal::SceneGraph::Renderer >::Remove().

template<class Type>
ObjectContainer Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::mObjectContainer
private
template<class Type>
SceneController* Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::mSceneController
private
template<class Type>
SceneGraphBuffers& Dali::Internal::SceneGraph::ObjectOwnerContainer< Type >::mSceneGraphBuffers
private

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