dali/internal/render/common/render-item.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_ITEM_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDER_ITEM_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/common/vector-wrapper.h>
  23 #include <dali/public-api/actors/layer.h>
  24 #include <dali/public-api/math/matrix.h>
  25 #include <dali/internal/update/nodes/node.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Internal
  31 {
  32
  33 namespace Render
  34 {
  35 class Renderer;
  36 }
  37
  38 namespace SceneGraph
  39 {
  40
  41 class RenderItem;
  42
  43 typedef std::vector< RenderItem > RendererItemContainer;
  44
  45 /**
  46  * A render-item is a renderer & modelView matrix pair.
  47  */
  48 class RenderItem
  49 {
  50 public:
  51
  52   /**
  53    * Construct a new RenderItem
  54    */
  55   static RenderItem* New();
  56
  57   /**
  58    * Non-virtual destructor; RenderItem is not suitable as a base class.
  59    */
  60   ~RenderItem();
  61
  62   /**
  63    * Overriden delete operator.
  64    * Deletes the RenderItem from its global memory pool
  65    */
  66   void operator delete( void* ptr );
  67
  68   /**
  69    * Reset the render-item.
  70    */
  71   void Reset();
  72
  73   /**
  74    * Retrieve the renderer.
  75    * @return The renderer.
  76    */
  77   Render::Renderer& GetRenderer() const;
  78
  79   /**
  80    * Set the renderer
  81    * @param[in] renderer The renderer
  82    */
  83   void SetRenderer( Render::Renderer* renderer );
  84
  85   /**
  86    * Set the node
  87    * @param[in] node The node
  88    */
  89   void SetNode( Node* node );
  90
  91   /**
  92    * Retrieve the node
  93    * @return The node
  94    */
  95   const Node& GetNode() const
  96   {
  97     return *mNode;
  98   }
  99   /**
 100    * Retrieve the modelView matrix.
 101    * @return The modelView matrix.
 102    */
 103   Matrix& GetModelViewMatrix();
 104
 105   /**
 106    * Retrieve the modelView matrix.
 107    * @return The modelView matrix.
 108    */
 109   const Matrix& GetModelViewMatrix() const;
 110
 111   /**
 112    * Retrieve the depth index
 113    */
 114   int GetDepthIndex() const
 115   {
 116     return mDepthIndex;
 117   }
 118
 119   /**
 120    * Set the depth index
 121    */
 122   void SetDepthIndex( int depthIndex );
 123
 124   /**
 125    * Set if the RenderItem is opaque
 126    * @param[in] isOpaque true if the RenderItem is opaque, false otherwise
 127    */
 128   void SetIsOpaque( bool isOpaque );
 129
 130   /**
 131    * Check if the RenderItem is opaque
 132    * @return True if it is opaque, false otherwise
 133    */
 134   bool IsOpaque() const
 135   {
 136     return mIsOpaque;
 137   }
 138
 139   /**
 140    * Sets the size of the render item
 141    * @param[in] size The size of the render item
 142    */
 143   void SetSize( const Vector3& size)
 144   {
 145     mSize = size;
 146   }
 147
 148   /**
 149    * Retrives the size of the render item
 150    * @return The size of the render item
 151    */
 152   const Vector3& GetSize() const
 153   {
 154     return mSize;
 155   }
 156
 157 private:
 158
 159   /**
 160    * Private constructor. See RenderItem::New
 161    */
 162   RenderItem();
 163
 164   // RenderItems should not be copied as they are heavy
 165   RenderItem( const RenderItem& item );
 166   RenderItem& operator = ( const RenderItem& item );
 167
 168   Matrix            mModelViewMatrix;
 169   Vector3           mSize;
 170   Render::Renderer* mRenderer;
 171   Node*             mNode;
 172   int               mDepthIndex;
 173   bool              mIsOpaque:1;
 174 };
 175
 176 } // namespace SceneGraph
 177
 178 } // namespace Internal
 179
 180 } // namespace Dali
 181
 182 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_ITEM_H__