dali-toolkit/internal/visuals/visual-base-data-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_BASE_DATA_IMPL_H
   2 #define DALI_TOOLKIT_INTERNAL_VISUAL_BASE_DATA_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2022 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/math/vector2.h>
  23 #include <dali/public-api/rendering/renderer.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  27 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  28 #include <dali-toolkit/internal/visuals/visual-event-observer.h>
  29 #include <dali-toolkit/public-api/align-enumerations.h>
  30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  31
  32 namespace Dali
  33 {
  34 namespace Toolkit
  35 {
  36 namespace Internal
  37 {
  38 namespace Visual
  39 {
  40 struct Base::Impl
  41 {
  42   /**
  43    * Constructor
  44    * @param [in] fittingMode that the derived class prefers
  45    * @param [in] type The type of the this visual
  46    */
  47   Impl(FittingMode fittingMode, Toolkit::Visual::Type type);
  48
  49   /**
  50    * Destructor
  51    */
  52   ~Impl();
  53
  54   enum Flags
  55   {
  56     IS_ON_SCENE                     = 1,
  57     IS_ATLASING_APPLIED             = 1 << 1,
  58     IS_PREMULTIPLIED_ALPHA          = 1 << 2,
  59     IS_SYNCHRONOUS_RESOURCE_LOADING = 1 << 3
  60   };
  61
  62   struct CustomShader
  63   {
  64     CustomShader(const Property::Map& map);
  65     void SetPropertyMap(const Property::Map& map);
  66     void CreatePropertyMap(Property::Map& map) const;
  67
  68     std::string               mVertexShader;
  69     std::string               mFragmentShader;
  70     Dali::ImageDimensions     mGridSize;
  71     Dali::Shader::Hint::Value mHints; //(bitfield) values from enum Shader::Hint
  72   };
  73
  74   struct Transform
  75   {
  76     /**
  77      * Default constructor ensures the visual fills the control
  78      */
  79     Transform();
  80
  81     /**
  82      * Use the property map to set zero or more of the transform
  83      * attributes, and sets the remaining attributes to their default
  84      * values.
  85      */
  86     void SetPropertyMap(const Property::Map& map);
  87
  88     /**
  89      * Add the transform attributes to the map (using integer keys)
  90      */
  91     void GetPropertyMap(Property::Map& map) const;
  92
  93     /**
  94      * Update zero or more attributes from the property map.
  95      */
  96     void UpdatePropertyMap(const Property::Map& map);
  97
  98     /**
  99      * Register the uniform properties onto the renderer
 100      */
 101     void RegisterUniforms(Renderer renderer, Toolkit::Direction::Type direction);
 102
 103     /**
 104      * Set the uniform properties onto the renderer
 105      */
 106     void SetUniforms(Renderer renderer, Toolkit::Direction::Type direction);
 107
 108     /**
 109      * Convert the control size and the transform attributes into the actual
 110      * size of the visual.
 111      */
 112     Vector2 GetVisualSize(const Vector2& controlSize);
 113
 114     Vector2              mOffset;
 115     Vector2              mSize;
 116     Vector2              mExtraSize;
 117     Vector4              mOffsetSizeMode;
 118     Toolkit::Align::Type mOrigin;
 119     Toolkit::Align::Type mAnchorPoint;
 120     Property::Index      mOffsetIndex{Property::INVALID_INDEX};
 121     Property::Index      mSizeIndex{Property::INVALID_INDEX};
 122   };
 123
 124   Renderer                        mRenderer;
 125   CustomShader*                   mCustomShader;
 126   EventObserver*                  mEventObserver; ///< Allows controls to observe when the visual has events to notify
 127   std::string                     mName;
 128   Transform                       mTransform;
 129   Vector4                         mMixColor;
 130   Size                            mControlSize;
 131   float                           mBorderlineWidth;
 132   Vector4                         mBorderlineColor;
 133   float                           mBorderlineOffset;
 134   Vector4                         mCornerRadius;
 135   float                           mCornerRadiusPolicy;
 136   int                             mDepthIndex;
 137   Property::Index                 mMixColorIndex;
 138   Property::Index                 mBorderlineWidthIndex;
 139   Property::Index                 mBorderlineColorIndex;
 140   Property::Index                 mBorderlineOffsetIndex;
 141   Property::Index                 mCornerRadiusIndex;
 142   FittingMode                     mFittingMode; ///< How the contents should fit the view
 143   int                             mFlags;
 144   Toolkit::Visual::ResourceStatus mResourceStatus;
 145   const Toolkit::Visual::Type     mType;
 146   bool                            mAlwaysUsingBorderline : 1;   ///< Whether we need the borderline in shader always.
 147   bool                            mAlwaysUsingCornerRadius : 1; ///< Whether we need the corner radius in shader always.
 148 };
 149
 150 } // namespace Visual
 151
 152 } // namespace Internal
 153
 154 } // namespace Toolkit
 155
 156 } // namespace Dali
 157
 158 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_BASE_DATA_IMPL_H