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) 2017 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 /**
  42  * A RenderItem contains all the data needed for rendering
  43  */
  44 struct RenderItem
  45 {
  46   /**
  47    * Construct a new RenderItem
  48    * @return A pointer to a new RenderItem.
  49    */
  50   static RenderItem* New();
  51
  52   /**
  53    * Non-virtual destructor; RenderItem is not suitable as a base class.
  54    */
  55   ~RenderItem();
  56
  57   /**
  58    * @brief This method is an optimized calculation of a viewport-space AABB (Axis-Aligned-Bounding-Box).
  59    *
  60    * We use the model-view-matrix, but we do not use projection. Therefore we assume Z = 0.
  61    * As the box is Axis-Aligned (in viewport space) rotations on Z axis are correctly delt with by expanding the box as necessary.
  62    * Rotations on X & Y axis will resize the AABB, but it will not handle the projection error due to the new coordinates having non-zero Z values.
  63    *
  64    * Note: We pass in the viewport dimensions rather than allow the caller to modify the raw AABB in order to optimally generate the final result.
  65    *
  66    * @param[in]    viewportWidth     The width of the viewport to calculate for
  67    * @param[in]    viewportHeight    The height of the viewport to calculate for
  68    * @param[in]    useUpdateSizeHint Set to true if you want to use update size hint instead of item size
  69    * @return                         The AABB coordinates in viewport-space (x, y, width, height)
  70    */
  71   ClippingBox CalculateViewportSpaceAABB( const int viewportWidth, const int viewportHeight, const bool useUpdateSizeHint = false ) const;
  72
  73   /**
  74    * Overriden delete operator.
  75    * Deletes the RenderItem from its global memory pool
  76    * @param[in] A pointer to the RenderItem to delete.
  77    */
  78   void operator delete( void* ptr );
  79
  80   Matrix            mModelMatrix;
  81   Matrix            mModelViewMatrix;
  82   Vector3           mSize;
  83   Vector3           mUpdateSizeHint;
  84   Render::Renderer* mRenderer;
  85   Node*             mNode;
  86   const void*       mTextureSet;        //< Used for sorting only
  87   int               mDepthIndex;
  88   bool              mIsOpaque:1;
  89   bool              mPartialUpdateEnabled:1;
  90
  91 private:
  92
  93   /**
  94    * Private constructor. See RenderItem::New
  95    */
  96   RenderItem();
  97
  98   // RenderItems should not be copied as they are heavy
  99   RenderItem( const RenderItem& item );
 100   RenderItem& operator = ( const RenderItem& item );
 101
 102 };
 103
 104 } // namespace SceneGraph
 105
 106 } // namespace Internal
 107
 108 } // namespace Dali
 109
 110 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_ITEM_H