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/public-api/visuals/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::Initialize( Actor& actor, const Property::Map& propertyMap )
  63 {
  64   Property::Value* customShaderValue = propertyMap.Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
  65   if( customShaderValue )
  66   {
  67     Property::Map shaderMap;
  68     if( customShaderValue->Get( shaderMap ) )
  69     {
  70       SetCustomShader( shaderMap );
  71     }
  72   }
  73
  74   DoInitialize( actor, propertyMap );
  75 }
  76
  77 void Visual::Base::SetName( const std::string& name )
  78 {
  79   mImpl->mName = name;
  80 }
  81
  82 const std::string& Visual::Base::GetName()
  83 {
  84   return mImpl->mName;
  85 }
  86
  87 void Visual::Base::SetSize( const Vector2& size )
  88 {
  89   mImpl->mSize = size;
  90 }
  91
  92 const Vector2& Visual::Base::GetSize() const
  93 {
  94   return mImpl->mSize;
  95 }
  96
  97 float Visual::Base::GetHeightForWidth( float width ) const
  98 {
  99   return 0.f;
 100 }
 101
 102 void Visual::Base::GetNaturalSize( Vector2& naturalSize ) const
 103 {
 104   naturalSize = Vector2::ZERO;
 105 }
 106
 107 void Visual::Base::SetDepthIndex( float index )
 108 {
 109   mImpl->mDepthIndex = index;
 110   if( mImpl->mRenderer )
 111   {
 112     mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
 113   }
 114 }
 115
 116 float Visual::Base::GetDepthIndex() const
 117 {
 118   return mImpl->mDepthIndex;
 119 }
 120
 121 void Visual::Base::SetOnStage( Actor& actor )
 122 {
 123   // To display the actor correctly, renderer should not be added to actor until all required resources are ready.
 124   // Thus the calling of actor.AddRenderer() should happen inside derived class as base class does not know the exact timing.
 125   DoSetOnStage( actor );
 126
 127   mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, IsPreMultipliedAlphaEnabled());
 128   mImpl->mRenderer.SetProperty( Renderer::Property::DEPTH_INDEX, mImpl->mDepthIndex );
 129   mImpl->mFlags |= Impl::IS_ON_STAGE;
 130 }
 131
 132 void Visual::Base::SetOffStage( Actor& actor )
 133 {
 134   if( IsOnStage() )
 135   {
 136     DoSetOffStage( actor );
 137
 138     mImpl->mFlags &= ~Impl::IS_ON_STAGE;
 139   }
 140 }
 141
 142 void Visual::Base::CreatePropertyMap( Property::Map& map ) const
 143 {
 144   DoCreatePropertyMap( map );
 145
 146   if( mImpl->mCustomShader )
 147   {
 148     mImpl->mCustomShader->CreatePropertyMap( map );
 149   }
 150 }
 151
 152 void Visual::Base::EnablePreMultipliedAlpha( bool preMultipled )
 153 {
 154   if(preMultipled)
 155   {
 156     mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
 157   }
 158   else
 159   {
 160     mImpl->mFlags &= ~Impl::IS_PREMULTIPLIED_ALPHA;
 161   }
 162
 163   if( mImpl->mRenderer )
 164   {
 165     mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_PRE_MULTIPLIED_ALPHA, preMultipled);
 166   }
 167 }
 168
 169 bool Visual::Base::IsPreMultipliedAlphaEnabled() const
 170 {
 171   return mImpl->mFlags & Impl::IS_PREMULTIPLIED_ALPHA;
 172 }
 173
 174 void Visual::Base::DoSetOffStage( Actor& actor )
 175 {
 176   actor.RemoveRenderer( mImpl->mRenderer );
 177   mImpl->mRenderer.Reset();
 178 }
 179
 180 bool Visual::Base::IsOnStage() const
 181 {
 182   return mImpl->mFlags & Impl::IS_ON_STAGE;
 183 }
 184
 185 bool Visual::Base::IsFromCache() const
 186 {
 187   return mImpl->mFlags & Impl::IS_FROM_CACHE;
 188 }
 189
 190 void Visual::Base::SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
 191 {
 192   DALI_ASSERT_ALWAYS( ( index > Property::INVALID_INDEX ) &&
 193                       ( index > VISUAL_PROPERTY_BASE_START_INDEX ) && // Change the type of visual is not allowed.
 194                       "Property index is out of bounds" );
 195
 196   if( index < VISUAL_PROPERTY_START_INDEX )
 197   {
 198     // TODO set the properties of the visual base.
 199   }
 200   else
 201   {
 202     DoSetProperty( index, propertyValue );
 203   }
 204 }
 205
 206 Dali::Property::Value Visual::Base::GetProperty( Dali::Property::Index index )
 207 {
 208   DALI_ASSERT_ALWAYS( ( index > Property::INVALID_INDEX ) &&
 209                       ( index >= VISUAL_PROPERTY_BASE_START_INDEX ) &&
 210                       "Property index is out of bounds" );
 211
 212   Dali::Property::Value value;
 213
 214   if( index < VISUAL_PROPERTY_START_INDEX )
 215   {
 216     // TODO retrieve the properties of the visual base.
 217   }
 218   else
 219   {
 220     value = DoGetProperty( index );
 221   }
 222
 223   return value;
 224 }
 225
 226 } // namespace Internal
 227
 228 } // namespace Toolkit
 229
 230 } // namespace Dali