Dali 3D User Interface Engine
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
Dali::Internal::ActorAttachment Class Referenceabstract

An abstract base class for attachments, such a renderable objects and lights. More...

#include <actor-attachment-impl.h>

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

Public Member Functions

bool OnStage () const
 Query whether the attachment is connected to the stage. More...
 
void Connect ()
 Called by the attached actor, when connected to the Stage. More...
 
void Disconnect ()
 Called by the attached actor, when the actor is disconnected from the Stage. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 

Protected Member Functions

 ActorAttachment (EventThreadServices &eventThreadServices)
 Construct a new attachment. More...
 
virtual ~ActorAttachment ()
 A reference counted object may only be deleted by calling Unreference() More...
 
EventThreadServicesGetEventThreadServices ()
 For use in message sending to and property reading from the scene graph Inlined for speed. More...
 
const EventThreadServicesGetEventThreadServices () const
 For use in message sending to and property reading from the scene graph Inlined for speed. More...
 
- Protected Member Functions inherited from Dali::RefObject
 RefObject ()
 Default constructor. More...
 
virtual ~RefObject ()
 RefObject is intended as a base class. More...
 
 RefObject (const RefObject &rhs)
 Copy constructor. More...
 
RefObjectoperator= (const RefObject &rhs)
 Assignment operator. More...
 

Protected Attributes

bool mIsOnStage: 1
 Flag to identify whether the attachment is on-stage. More...
 

Private Member Functions

 ActorAttachment (const ActorAttachment &)
 
ActorAttachmentoperator= (const ActorAttachment &rhs)
 
virtual void OnStageConnection ()=0
 For use in derived classes, called after ConnectToStage() More...
 
virtual void OnStageDisconnection ()=0
 For use in derived classes, called after DisconnectFromStage() More...
 

Private Attributes

EventThreadServicesmEventThreadServices
 Used to send messages to scene-graph; valid until Core destruction. More...
 

Detailed Description

An abstract base class for attachments, such a renderable objects and lights.

ActorAttachments must be attached to an actor, in order to be displayed.

Definition at line 36 of file actor-attachment-impl.h.

Constructor & Destructor Documentation

Dali::Internal::ActorAttachment::ActorAttachment ( EventThreadServices eventThreadServices)
protected

Construct a new attachment.

Parameters
[in]eventThreadServicesUsed for messaging to and reading from scene-graph.

Definition at line 54 of file actor-attachment-impl.cpp.

Dali::Internal::ActorAttachment::~ActorAttachment ( )
protectedvirtual

A reference counted object may only be deleted by calling Unreference()

Definition at line 60 of file actor-attachment-impl.cpp.

Dali::Internal::ActorAttachment::ActorAttachment ( const ActorAttachment )
private

Member Function Documentation

void Dali::Internal::ActorAttachment::Connect ( )

Called by the attached actor, when connected to the Stage.

This method is called by the parent actor.

Definition at line 35 of file actor-attachment-impl.cpp.

References mIsOnStage, and OnStageConnection().

Referenced by Dali::Internal::Actor::Attach().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Internal::ActorAttachment::Disconnect ( )

Called by the attached actor, when the actor is disconnected from the Stage.

This method is called by the parent actor.

Definition at line 46 of file actor-attachment-impl.cpp.

References mIsOnStage, and OnStageDisconnection().

Here is the call graph for this function:

EventThreadServices& Dali::Internal::ActorAttachment::GetEventThreadServices ( )
inlineprotected
const EventThreadServices& Dali::Internal::ActorAttachment::GetEventThreadServices ( ) const
inlineprotected

For use in message sending to and property reading from the scene graph Inlined for speed.

Definition at line 102 of file actor-attachment-impl.h.

References mEventThreadServices.

bool Dali::Internal::ActorAttachment::OnStage ( ) const

Query whether the attachment is connected to the stage.

Returns
True if the attachment is connected to the stage.

Definition at line 27 of file actor-attachment-impl.cpp.

References mIsOnStage.

Referenced by Dali::Internal::CameraAttachment::GetProjectionMatrixProperty(), and Dali::Internal::CameraAttachment::GetViewMatrixProperty().

Here is the caller graph for this function:

virtual void Dali::Internal::ActorAttachment::OnStageConnection ( )
privatepure virtual

For use in derived classes, called after ConnectToStage()

Implemented in Dali::Internal::CameraAttachment.

Referenced by Connect().

Here is the caller graph for this function:

virtual void Dali::Internal::ActorAttachment::OnStageDisconnection ( )
privatepure virtual

For use in derived classes, called after DisconnectFromStage()

Implemented in Dali::Internal::CameraAttachment.

Referenced by Disconnect().

Here is the caller graph for this function:

ActorAttachment& Dali::Internal::ActorAttachment::operator= ( const ActorAttachment rhs)
private

Member Data Documentation

EventThreadServices& Dali::Internal::ActorAttachment::mEventThreadServices
private

Used to send messages to scene-graph; valid until Core destruction.

Definition at line 108 of file actor-attachment-impl.h.

Referenced by GetEventThreadServices().

bool Dali::Internal::ActorAttachment::mIsOnStage
protected

Flag to identify whether the attachment is on-stage.

Definition at line 111 of file actor-attachment-impl.h.

Referenced by Connect(), Disconnect(), and OnStage().


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