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

   1 /*
   2  * Copyright (c) 2024 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  23 #include <dali/devel-api/scripting/enum-helper.h>
  24 #include <dali/devel-api/scripting/scripting.h>
  25 #include <dali/integration-api/debug.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  29 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  30 #include <dali-toolkit/internal/helpers/property-helper.h>
  31 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  32 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  33
  34 namespace Dali
  35 {
  36 namespace Toolkit
  37 {
  38 namespace Internal
  39 {
  40 namespace
  41 {
  42 DALI_ENUM_TO_STRING_TABLE_BEGIN(SHADER_HINT)
  43   DALI_ENUM_TO_STRING_WITH_SCOPE(Shader::Hint, NONE)
  44   DALI_ENUM_TO_STRING_WITH_SCOPE(Shader::Hint, OUTPUT_IS_TRANSPARENT)
  45   DALI_ENUM_TO_STRING_WITH_SCOPE(Shader::Hint, MODIFIES_GEOMETRY)
  46 DALI_ENUM_TO_STRING_TABLE_END(SHADER_HINT)
  47
  48 DALI_ENUM_TO_STRING_TABLE_BEGIN(ALIGN)
  49   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, TOP_BEGIN)
  50   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, TOP_CENTER)
  51   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, TOP_END)
  52   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, CENTER_BEGIN)
  53   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, CENTER)
  54   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, CENTER_END)
  55   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, BOTTOM_BEGIN)
  56   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, BOTTOM_CENTER)
  57   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Align, BOTTOM_END)
  58 DALI_ENUM_TO_STRING_TABLE_END(ALIGN)
  59
  60 DALI_ENUM_TO_STRING_TABLE_BEGIN(POLICY)
  61   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Visual::Transform::Policy, RELATIVE)
  62   DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::Visual::Transform::Policy, ABSOLUTE)
  63 DALI_ENUM_TO_STRING_TABLE_END(POLICY)
  64
  65 Dali::Vector2 PointToVector2(Toolkit::Align::Type point, Toolkit::Direction::Type direction)
  66 {
  67   // clang-format off
  68   static const float pointToVector2[] = {0.0f,0.0f,
  69                                          0.5f,0.0f,
  70                                          1.0f,0.0f,
  71                                          0.0f,0.5f,
  72                                          0.5f,0.5f,
  73                                          1.0f,0.5f,
  74                                          0.0f,1.0f,
  75                                          0.5f,1.0f,
  76                                          1.0f,1.0f};
  77
  78   // clang-format on
  79
  80   Vector2 result(&pointToVector2[point * 2]);
  81   if(direction == Direction::RIGHT_TO_LEFT)
  82   {
  83     result.x = 1.0f - result.x;
  84   }
  85
  86   return result;
  87 }
  88
  89 bool GetPolicyFromValue(const Property::Value& value, Vector2& policy)
  90 {
  91   bool success = false;
  92   if(value.Get(policy))
  93   {
  94     success = true;
  95   }
  96   else
  97   {
  98     const Property::Array* array = value.GetArray();
  99     if(array && array->Size() == 2)
 100     {
 101       Toolkit::Visual::Transform::Policy::Type xPolicy = static_cast<Toolkit::Visual::Transform::Policy::Type>(-1); // Assign an invalid value so definitely changes
 102       Toolkit::Visual::Transform::Policy::Type yPolicy = static_cast<Toolkit::Visual::Transform::Policy::Type>(-1); // Assign an invalid value so definitely changes
 103
 104       if(Scripting::GetEnumerationProperty<Toolkit::Visual::Transform::Policy::Type>(array->GetElementAt(0), POLICY_TABLE, POLICY_TABLE_COUNT, xPolicy) &&
 105          Scripting::GetEnumerationProperty<Toolkit::Visual::Transform::Policy::Type>(array->GetElementAt(1), POLICY_TABLE, POLICY_TABLE_COUNT, yPolicy))
 106       {
 107         policy.x = xPolicy;
 108         policy.y = yPolicy;
 109         success  = true;
 110       }
 111     }
 112   }
 113   return success;
 114 }
 115
 116 } // unnamed namespace
 117
 118 Internal::Visual::Base::Impl::Impl(FittingMode fittingMode, Toolkit::Visual::Type type)
 119 : mCustomShader(nullptr),
 120   mEventObserver(nullptr),
 121   mTransform(),
 122   mMixColor(Color::WHITE),
 123   mControlSize(Vector2::ZERO),
 124   mDecorationData(nullptr),
 125   mDepthIndex(Toolkit::DepthIndex::AUTO_INDEX),
 126   mFittingMode(fittingMode),
 127   mFlags(0),
 128   mResourceStatus(Toolkit::Visual::ResourceStatus::PREPARING),
 129   mType(type),
 130   mAlwaysUsingBorderline(false),
 131   mAlwaysUsingCornerRadius(false)
 132 {
 133 }
 134
 135 Internal::Visual::Base::Impl::~Impl()
 136 {
 137   delete mCustomShader;
 138   if(mDecorationData)
 139   {
 140     delete mDecorationData;
 141   }
 142 }
 143
 144 Internal::Visual::Base::Impl::CustomShader::CustomShader(const Property::Map& map)
 145 : mGridSize(1, 1),
 146   mHints(Shader::Hint::NONE)
 147 {
 148   SetPropertyMap(map);
 149 }
 150
 151 void Internal::Visual::Base::Impl::CustomShader::SetPropertyMap(const Property::Map& shaderMap)
 152 {
 153   mVertexShader.clear();
 154   mFragmentShader.clear();
 155   mGridSize = ImageDimensions(1, 1);
 156   mHints    = Shader::Hint::NONE;
 157
 158   Property::Value* vertexShaderValue = shaderMap.Find(Toolkit::Visual::Shader::Property::VERTEX_SHADER, CUSTOM_VERTEX_SHADER);
 159   if(vertexShaderValue)
 160   {
 161     if(!GetStringFromProperty(*vertexShaderValue, mVertexShader))
 162     {
 163       DALI_LOG_ERROR("'%s' parameter does not correctly specify a string\n", CUSTOM_VERTEX_SHADER);
 164     }
 165   }
 166
 167   Property::Value* fragmentShaderValue = shaderMap.Find(Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, CUSTOM_FRAGMENT_SHADER);
 168   if(fragmentShaderValue)
 169   {
 170     if(!GetStringFromProperty(*fragmentShaderValue, mFragmentShader))
 171     {
 172       DALI_LOG_ERROR("'%s' parameter does not correctly specify a string\n", CUSTOM_FRAGMENT_SHADER);
 173     }
 174   }
 175
 176   Property::Value* subdivideXValue = shaderMap.Find(Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, CUSTOM_SUBDIVIDE_GRID_X);
 177   if(subdivideXValue)
 178   {
 179     int subdivideX;
 180     if(!subdivideXValue->Get(subdivideX) || subdivideX < 1)
 181     {
 182       DALI_LOG_ERROR("'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_X);
 183     }
 184     else
 185     {
 186       mGridSize = ImageDimensions(subdivideX, mGridSize.GetY());
 187     }
 188   }
 189
 190   Property::Value* subdivideYValue = shaderMap.Find(Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, CUSTOM_SUBDIVIDE_GRID_Y);
 191   if(subdivideYValue)
 192   {
 193     int subdivideY;
 194     if(!subdivideYValue->Get(subdivideY) || subdivideY < 1)
 195     {
 196       DALI_LOG_ERROR("'%s' parameter does not correctly specify a value greater than 1\n", CUSTOM_SUBDIVIDE_GRID_Y);
 197     }
 198     else
 199     {
 200       mGridSize = ImageDimensions(mGridSize.GetX(), subdivideY);
 201     }
 202   }
 203
 204   Property::Value* hintsValue = shaderMap.Find(Toolkit::Visual::Shader::Property::HINTS, CUSTOM_SHADER_HINTS);
 205   if(hintsValue)
 206   {
 207     if(!Scripting::GetBitmaskEnumerationProperty(*hintsValue, SHADER_HINT_TABLE, SHADER_HINT_TABLE_COUNT, mHints))
 208     {
 209       DALI_LOG_ERROR("'%s' parameter does not correctly specify a hint or an array of hint strings\n", CUSTOM_SHADER_HINTS);
 210     }
 211   }
 212 }
 213
 214 void Internal::Visual::Base::Impl::CustomShader::CreatePropertyMap(Property::Map& map) const
 215 {
 216   if(!mVertexShader.empty() || !mFragmentShader.empty())
 217   {
 218     Property::Map customShader;
 219     if(!mVertexShader.empty())
 220     {
 221       customShader.Insert(Toolkit::Visual::Shader::Property::VERTEX_SHADER, mVertexShader);
 222     }
 223     if(!mFragmentShader.empty())
 224     {
 225       customShader.Insert(Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, mFragmentShader);
 226     }
 227
 228     if(mGridSize.GetWidth() != 1)
 229     {
 230       customShader.Insert(Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_X, mGridSize.GetWidth());
 231     }
 232     if(mGridSize.GetHeight() != 1)
 233     {
 234       customShader.Insert(Toolkit::Visual::Shader::Property::SUBDIVIDE_GRID_Y, mGridSize.GetHeight());
 235     }
 236
 237     if(mHints != Dali::Shader::Hint::NONE)
 238     {
 239       customShader.Insert(Toolkit::Visual::Shader::Property::HINTS, static_cast<int>(mHints));
 240     }
 241
 242     map.Insert(Toolkit::Visual::Property::SHADER, customShader);
 243   }
 244 }
 245
 246 Internal::Visual::Base::Impl::Transform::Transform()
 247 : mOffset(0.0f, 0.0f),
 248   mSize(1.0f, 1.0f),
 249   mExtraSize(0.0f, 0.0f),
 250   mOffsetSizeMode(0.0f, 0.0f, 0.0f, 0.0f),
 251   mOrigin(Toolkit::Align::TOP_BEGIN),
 252   mAnchorPoint(Toolkit::Align::TOP_BEGIN)
 253 {
 254 }
 255
 256 void Internal::Visual::Base::Impl::Transform::SetPropertyMap(const Property::Map& map)
 257 {
 258   // Set default values
 259   mOffset         = Vector2(0.0f, 0.0f);
 260   mSize           = Vector2(1.0f, 1.0f);
 261   mExtraSize      = Vector2(0.0f, 0.0f);
 262   mOffsetSizeMode = Vector4(0.0f, 0.0f, 0.0f, 0.0f);
 263   mOrigin         = Toolkit::Align::TOP_BEGIN;
 264   mAnchorPoint    = Toolkit::Align::TOP_BEGIN;
 265
 266   UpdatePropertyMap(map);
 267 }
 268
 269 void Internal::Visual::Base::Impl::Transform::UpdatePropertyMap(const Property::Map& map)
 270 {
 271   for(Property::Map::SizeType i(0); i < map.Count(); ++i)
 272   {
 273     KeyValuePair keyValue = map.GetKeyValue(i);
 274     switch(Visual::Base::GetIntKey(keyValue.first))
 275     {
 276       case Toolkit::Visual::Transform::Property::OFFSET:
 277       {
 278         keyValue.second.Get(mOffset);
 279         break;
 280       }
 281       case Toolkit::Visual::Transform::Property::SIZE:
 282       {
 283         keyValue.second.Get(mSize);
 284         break;
 285       }
 286       case Toolkit::Visual::Transform::Property::ORIGIN:
 287       {
 288         Scripting::GetEnumerationProperty<Toolkit::Align::Type>(keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mOrigin);
 289         break;
 290       }
 291       case Toolkit::Visual::Transform::Property::ANCHOR_POINT:
 292       {
 293         Scripting::GetEnumerationProperty<Toolkit::Align::Type>(keyValue.second, ALIGN_TABLE, ALIGN_TABLE_COUNT, mAnchorPoint);
 294         break;
 295       }
 296       case Toolkit::Visual::Transform::Property::OFFSET_POLICY:
 297       {
 298         Vector2 policy;
 299         if(GetPolicyFromValue(keyValue.second, policy))
 300         {
 301           mOffsetSizeMode.x = policy.x;
 302           mOffsetSizeMode.y = policy.y;
 303         }
 304         break;
 305       }
 306       case Toolkit::Visual::Transform::Property::SIZE_POLICY:
 307       {
 308         Vector2 policy;
 309         if(GetPolicyFromValue(keyValue.second, policy))
 310         {
 311           mOffsetSizeMode.z = policy.x;
 312           mOffsetSizeMode.w = policy.y;
 313         }
 314         break;
 315       }
 316       case Toolkit::DevelVisual::Transform::Property::EXTRA_SIZE:
 317       {
 318         keyValue.second.Get(mExtraSize);
 319         break;
 320       }
 321     }
 322   }
 323 }
 324
 325 void Internal::Visual::Base::Impl::Transform::GetPropertyMap(Property::Map& map) const
 326 {
 327   map.Clear();
 328   map
 329     .Add(Toolkit::Visual::Transform::Property::OFFSET, mOffset)
 330     .Add(Toolkit::Visual::Transform::Property::SIZE, mSize)
 331     .Add(Toolkit::Visual::Transform::Property::ORIGIN, mOrigin)
 332     .Add(Toolkit::Visual::Transform::Property::ANCHOR_POINT, mAnchorPoint)
 333     .Add(Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2(mOffsetSizeMode.x, mOffsetSizeMode.y))
 334     .Add(Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2(mOffsetSizeMode.z, mOffsetSizeMode.w))
 335     .Add(Toolkit::DevelVisual::Transform::Property::EXTRA_SIZE, mExtraSize);
 336 }
 337
 338 void Internal::Visual::Base::Impl::Transform::SetUniforms(Dali::VisualRenderer renderer, Toolkit::Direction::Type direction)
 339 {
 340   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_SIZE, mSize);
 341   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_OFFSET,
 342                        direction == Toolkit::Direction::LEFT_TO_RIGHT ? mOffset : mOffset * Vector2(-1.0f, 1.0f));
 343   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_OFFSET_SIZE_MODE, mOffsetSizeMode);
 344   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_ORIGIN, PointToVector2(mOrigin, direction) - Vector2(0.5, 0.5));
 345   renderer.SetProperty(VisualRenderer::Property::TRANSFORM_ANCHOR_POINT,
 346                        Vector2(0.5, 0.5) - PointToVector2(mAnchorPoint, direction));
 347   renderer.SetProperty(VisualRenderer::Property::EXTRA_SIZE, mExtraSize);
 348 }
 349
 350 Vector2 Internal::Visual::Base::Impl::Transform::GetVisualSize(const Vector2& controlSize)
 351 {
 352   return Vector2(Lerp(mOffsetSizeMode.z, mSize.x * controlSize.x, mSize.x),
 353                  Lerp(mOffsetSizeMode.w, mSize.y * controlSize.y, mSize.y)) +
 354          mExtraSize;
 355 }
 356
 357 } // namespace Internal
 358
 359 } // namespace Toolkit
 360
 361 } // namespace Dali