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) 2021 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/internal/update/nodes/node.h>
  23 #include <dali/public-api/actors/layer.h>
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/math/matrix.h>
  26
  27 namespace Dali
  28 {
  29 namespace Internal
  30 {
  31 namespace Render
  32 {
  33 class Renderer;
  34 }
  35
  36 namespace SceneGraph
  37 {
  38 /**
  39  * A RenderItem contains all the data needed for rendering
  40  */
  41 struct RenderItem
  42 {
  43   /**
  44    * Construct a new RenderItem
  45    * @return A pointer to a new RenderItem.
  46    */
  47   static RenderItem* New();
  48
  49   /**
  50    * Non-virtual destructor; RenderItem is not suitable as a base class.
  51    */
  52   ~RenderItem();
  53
  54   /**
  55    * @brief This method is an optimized calculation of a viewport-space AABB (Axis-Aligned-Bounding-Box).
  56    *
  57    * We use the model-view-matrix, but we do not use projection. Therefore we assume Z = 0.
  58    * As the box is Axis-Aligned (in viewport space) rotations on Z axis are correctly delt with by expanding the box as necessary.
  59    * 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.
  60    *
  61    * 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.
  62    *
  63    * @param[in]    modelViewMatrix   The model view matrix
  64    * @param[in]    size              The size of the render item
  65    * @param[in]    viewportWidth     The width of the viewport to calculate for
  66    * @param[in]    viewportHeight    The height of the viewport to calculate for
  67    * @return                         The AABB coordinates in viewport-space (x, y, width, height)
  68    */
  69   static ClippingBox CalculateViewportSpaceAABB(const Matrix& modelViewMatrix, const Vector3& size, const int viewportWidth, const int viewportHeight);
  70
  71   /**
  72    * Overriden delete operator.
  73    * Deletes the RenderItem from its global memory pool
  74    * @param[in] A pointer to the RenderItem to delete.
  75    */
  76   void operator delete(void* ptr);
  77
  78   Matrix            mModelMatrix;
  79   Matrix            mModelViewMatrix;
  80   Vector4           mColor;
  81   Vector3           mSize;
  82   Vector3           mUpdateSize;
  83   Render::Renderer* mRenderer;
  84   Node*             mNode;
  85   const void*       mTextureSet; //< Used for sorting only
  86   int               mDepthIndex;
  87   bool              mIsOpaque : 1;
  88   bool              mIsUpdated : 1;
  89
  90 private:
  91   /**
  92    * Private constructor. See RenderItem::New
  93    */
  94   RenderItem();
  95
  96   // RenderItems should not be copied as they are heavy
  97   RenderItem(const RenderItem& item);
  98   RenderItem& operator=(const RenderItem& item);
  99 };
 100
 101 } // namespace SceneGraph
 102
 103 } // namespace Internal
 104
 105 } // namespace Dali
 106
 107 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_ITEM_H