dali/internal/event/actor-attachments/actor-attachment-impl.h

   1 #ifndef __DALI_INTERNAL_ACTOR_ATTACHMENT_H__
   2 #define __DALI_INTERNAL_ACTOR_ATTACHMENT_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/ref-object.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 class Stage;
  31
  32 /**
  33  * An abstract base class for attachments, such a renderable objects and lights.
  34  * ActorAttachments must be attached to an actor, in order to be displayed.
  35  */
  36 class ActorAttachment : public Dali::RefObject
  37 {
  38 public:
  39
  40   /**
  41    * Query whether the attachment is connected to the stage.
  42    * @return True if the attachment is connected to the stage.
  43    */
  44   bool OnStage() const;
  45
  46   /**
  47    * Called by the attached actor, when connected to the Stage.
  48    */
  49   void Connect();
  50
  51   /**
  52    * Called by the attached actor, when the actor is disconnected from the Stage.
  53    */
  54   void Disconnect();
  55
  56   /**
  57    * Sets whether a renderable attachment is visible.
  58    * By default attachments are visible.
  59    * @param[in] visible True if the object is visible.
  60    */
  61   void SetVisible(bool visible);
  62
  63   /**
  64    * Retrieve whether a renderable attachment is visible.
  65    * @return True if the object is visible.
  66    */
  67   bool IsVisible() const;
  68
  69 protected:
  70
  71   /**
  72    * Construct a new attachment.
  73    * @param[in] stage Used to send messages to scene-graph.
  74    */
  75   ActorAttachment( Stage& stage );
  76
  77   /**
  78    * A reference counted object may only be deleted by calling Unreference()
  79    */
  80   virtual ~ActorAttachment();
  81
  82 private:
  83
  84   // Undefined
  85   ActorAttachment(const ActorAttachment&);
  86
  87   // Undefined
  88   ActorAttachment& operator=(const ActorAttachment& rhs);
  89
  90   /**
  91    * For use in derived classes, called after ConnectToStage()
  92    */
  93   virtual void OnStageConnection() = 0;
  94
  95   /**
  96    * For use in derived classes, called after DisconnectFromStage()
  97    */
  98   virtual void OnStageDisconnection() = 0;
  99
 100 protected:
 101
 102   Stage* mStage; ///< Used to send messages to scene-graph; valid until Core destruction
 103
 104   bool mIsOnStage : 1; ///< Flag to identify whether the attachment is on-stage
 105 };
 106
 107 } // namespace Internal
 108
 109 } // namespace Dali
 110
 111 #endif // __DALI_INTERNAL_ACTOR_ATTACHMENT_H__