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

   1 /*
   2  * Copyright (c) 2016 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 "visual-base-impl.h"
  20
  21 // EXTERNAL HEADER
  22 #include <dali/public-api/common/dali-common.h>
  23 #include <dali/integration-api/debug.h>
  24
  25 //INTERNAL HEARDER
  26 #include <dali-toolkit/devel-api/visual-factory/devel-visual-properties.h>
  27 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  28 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal
  37 {
  38
  39 Visual::Base::Base( VisualFactoryCache& factoryCache )
  40 : mImpl( new Impl() ),
  41   mFactoryCache( factoryCache )
  42 {
  43 }
  44
  45 Visual::Base::~Base()
  46 {
  47   delete mImpl;
  48 }
  49
  50 void Visual::Base::SetCustomShader( const Property::Map& shaderMap )
  51 {
  52   if( mImpl->mCustomShader )
  53   {
  54     mImpl->mCustomShader->SetPropertyMap( shaderMap );
  55   }
  56   else
  57   {
  58     mImpl->mCustomShader = new Impl::CustomShader( shaderMap );
  59   }
  60 }
  61
  62 void Visual::Base::SetProperties( const Property::Map& propertyMap )
  63 {
  64   Property::Value* customShaderValue = propertyMap.Find( VisualProperty::SHADER, CUSTOM_SHADER );
  65   if( customShaderValue )
  66   {
  67     Property::Map shaderMap;
  68     if( customShaderValue->Get( shaderMap ) )
  69     {
  70       SetCustomShader( shaderMap );
  71     }
  72   }
  73
  74   Property::Value* transform = propertyMap.Find( Toolkit::Visual::DevelProperty::TRANSFORM, TRANSFORM );
  75   if( transform )
  76   {
  77     Property::Map map;
  78     if( transform->Get( map ) )
  79     {
  80       mImpl->mTransform.SetPropertyMap( map );
  81     }
  82   }
  83
  84   DoSetProperties( propertyMap );
  85 }
  86
  87 void Visual::Base::SetName( const std::string& name )
  88 {
  89   mImpl->mName = name;
  90 }
  91
  92 const std::string& Visual::Base::GetName()
  93 {
  94   return mImpl->mName;
  95 }
  96
  97 void Visual::Base::SetSize( const Vector2& size )
  98 {
  99   mImpl->mSize = size;
 100 }
 101
 102 const Vector2& Visual::Base::GetSize() const
 103 {
 104   return mImpl->mSize;
 105 }
 106
 107 float Visual::Base::GetHeightForWidth( float width ) const
 108 {
 109   return 0.f;
 110 }
 111
 112 void Visual::Base::GetNaturalSize( Vector2& naturalSize )
 113 {
 114   naturalSize = Vector2::ZERO;
 115 }
 116
 117 void Visual::Base::SetDepthIndex( float index )
 118 {
 119   mImpl->mDepthIndex = index;
 120   if( mImpl->mRenderer )
 121   {
 122     mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
 123   }
 124 }
 125
 126 float Visual::Base::GetDepthIndex() const
 127 {
 128   return mImpl->mDepthIndex;
 129 }
 130
 131 void Visual::Base::SetOnStage( Actor& actor )
 132 {
 133   // To display the actor correctly, renderer should not be added to actor until all required resources are ready.
 134   // Thus the calling of actor.AddRenderer() should happen inside derived class as base class does not know the exact timing.
 135   DoSetOnStage( actor );
 136
 137   if( mImpl->mRenderer )
 138   {
 139     mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, IsPreMultipliedAlphaEnabled());
 140     mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
 141     mImpl->mFlags |= Impl::IS_ON_STAGE; // Only sets the flag if renderer exists
 142   }
 143 }
 144
 145 void Visual::Base::SetOffStage( Actor& actor )
 146 {
 147   if( IsOnStage() )
 148   {
 149     DoSetOffStage( actor );
 150
 151     mImpl->mFlags &= ~Impl::IS_ON_STAGE;
 152   }
 153 }
 154
 155 void Visual::Base::CreatePropertyMap( Property::Map& map ) const
 156 {
 157   DoCreatePropertyMap( map );
 158
 159   if( mImpl->mCustomShader )
 160   {
 161     mImpl->mCustomShader->CreatePropertyMap( map );
 162   }
 163
 164   Property::Map transform;
 165   mImpl->mTransform.GetPropertyMap( transform );
 166   map.Insert( Toolkit::Visual::DevelProperty::TRANSFORM, transform );
 167 }
 168
 169 void Visual::Base::EnablePreMultipliedAlpha( bool preMultipled )
 170 {
 171   if(preMultipled)
 172   {
 173     mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
 174   }
 175   else
 176   {
 177     mImpl->mFlags &= ~Impl::IS_PREMULTIPLIED_ALPHA;
 178   }
 179
 180   if( mImpl->mRenderer )
 181   {
 182     mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, preMultipled);
 183   }
 184 }
 185
 186 bool Visual::Base::IsPreMultipliedAlphaEnabled() const
 187 {
 188   return mImpl->mFlags & Impl::IS_PREMULTIPLIED_ALPHA;
 189 }
 190
 191 void Visual::Base::DoSetOffStage( Actor& actor )
 192 {
 193   actor.RemoveRenderer( mImpl->mRenderer );
 194   mImpl->mRenderer.Reset();
 195 }
 196
 197 bool Visual::Base::IsOnStage() const
 198 {
 199   return mImpl->mFlags & Impl::IS_ON_STAGE;
 200 }
 201
 202 bool Visual::Base::IsFromCache() const
 203 {
 204   return mImpl->mFlags & Impl::IS_FROM_CACHE;
 205 }
 206
 207 void Visual::Base::SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
 208 {
 209   DALI_ASSERT_ALWAYS( ( index > Property::INVALID_INDEX ) &&
 210                       ( index > VISUAL_PROPERTY_BASE_START_INDEX ) && // Change the type of visual is not allowed.
 211                       "Property index is out of bounds" );
 212
 213   if( index < VISUAL_PROPERTY_START_INDEX )
 214   {
 215     if( index == Dali::Toolkit::Visual::DevelProperty::TRANSFORM )
 216     {
 217       Property::Map* map = propertyValue.GetMap();
 218       if( map )
 219       {
 220         mImpl->mTransform.SetPropertyMap( *map );
 221         OnSetTransform();
 222       }
 223     }
 224
 225     // TODO set the properties of the visual base.
 226   }
 227   else
 228   {
 229     DoSetProperty( index, propertyValue );
 230   }
 231 }
 232
 233 Dali::Property::Value Visual::Base::GetProperty( Dali::Property::Index index )
 234 {
 235   DALI_ASSERT_ALWAYS( ( index > Property::INVALID_INDEX ) &&
 236                       ( index >= VISUAL_PROPERTY_BASE_START_INDEX ) &&
 237                       "Property index is out of bounds" );
 238
 239   Dali::Property::Value value;
 240
 241   if( index < VISUAL_PROPERTY_START_INDEX )
 242   {
 243     if( index == Dali::Toolkit::Visual::DevelProperty::TRANSFORM )
 244     {
 245       Property::Map map;
 246       mImpl->mTransform.GetPropertyMap( map );
 247       return map;
 248     }
 249     // TODO retrieve the properties of the visual base.
 250   }
 251   else
 252   {
 253     value = DoGetProperty( index );
 254   }
 255
 256   return value;
 257 }
 258
 259 } // namespace Internal
 260
 261 } // namespace Toolkit
 262
 263 } // namespace Dali