dali-toolkit/internal/controls/shadow-view/shadow-view-impl.cpp

   1 /*
   2  * Copyright (c) 2014 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 "shadow-view-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <sstream>
  23 #include <iomanip>
  24 #include <dali/public-api/animation/active-constraint.h>
  25 #include <dali/public-api/animation/constraint.h>
  26 #include <dali/public-api/common/stage.h>
  27 #include <dali/public-api/object/type-registry.h>
  28 #include <dali/public-api/object/type-registry-helper.h>
  29 #include <dali/public-api/render-tasks/render-task-list.h>
  30 #include <dali/integration-api/debug.h>
  31
  32 // INTERNAL INCLUDES
  33 #include <dali-toolkit/internal/controls/shadow-view/shadow-view-impl.h>
  34 #include <dali-toolkit/internal/filters/blur-two-pass-filter.h>
  35
  36 // TODO:
  37 // pixel format / size - set from JSON
  38 // aspect ratio property needs to be able to be constrained also for cameras. (now do-able)
  39 // default near clip value
  40 // mChildrenRoot Add()/Remove() overloads - better solution
  41
  42
  43 /////////////////////////////////////////////////////////
  44 // IMPLEMENTATION NOTES
  45
  46 // As the ShadowView actor changes size, the amount of pixels we need to blur changes. Therefore we need some way of doing this. However:-
  47 // OnSetSize() does not get called when ShadowView object size is modified using a Constraint.
  48 // OnSizeAnimation() only gets called once per AnimateTo/By() and if an Animation has N such calls then only the final one will end up being used. Therefore we can't use
  49 // OnSizeAnimation() to alter render target sizes.
  50 // To get around the above problems, we use fixed sized render targets, from the last SetSize() call (which calls OnSetSize()), then we adjust the internal cameras / actors
  51 // to take account of the changed ShadowView object size, projecting to the unchanged render target sizes. This is done relative to the fixed render target / actor sizes
  52 // by using constraints relative to the ShadowView actor size.
  53
  54 namespace Dali
  55 {
  56
  57 namespace Toolkit
  58 {
  59
  60 namespace Internal
  61 {
  62
  63 namespace
  64 {
  65
  66 using namespace Dali;
  67
  68 BaseHandle Create()
  69 {
  70   return Toolkit::ShadowView::New();
  71 }
  72
  73 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ShadowView, Toolkit::Control, Create )
  74 DALI_TYPE_REGISTRATION_END()
  75
  76 const float BLUR_STRENGTH_DEFAULT = 1.0f;
  77
  78 const Vector3 DEFAULT_LIGHT_POSITION(300.0f, 250.0f, 600.0f);
  79 const float DEFAULT_FIELD_OF_VIEW_RADIANS = Math::PI / 4.0f; // 45 degrees
  80
  81 const Vector4 DEFAULT_SHADOW_COLOR = Vector4(0.2f, 0.2f, 0.2f, 0.8f);
  82
  83 const char* const SHADER_LIGHT_CAMERA_PROJECTION_MATRIX_PROPERTY_NAME = "uLightCameraProjectionMatrix";
  84 const char* const SHADER_LIGHT_CAMERA_VIEW_MATRIX_PROPERTY_NAME = "uLightCameraViewMatrix";
  85 const char* const SHADER_SHADOW_COLOR_PROPERTY_NAME = "uShadowColor";
  86 const char* const BLUR_STRENGTH_PROPERTY_NAME = "BlurStrengthProperty";
  87 const char* const SHADOW_COLOR_PROPERTY_NAME = "ShadowColorProperty";
  88
  89 const char* const RENDER_SHADOW_VERTEX_SOURCE =
  90   " uniform mediump mat4 uLightCameraProjectionMatrix;\n"
  91   " uniform mediump mat4 uLightCameraViewMatrix;\n"
  92   "\n"
  93   "void main()\n"
  94   "{\n"
  95     "  gl_Position = uProjection * uModelView * vec4(aPosition,1.0);\n"
  96     "  vec4 textureCoords = uLightCameraProjectionMatrix * uLightCameraViewMatrix * uModelMatrix  * vec4(aPosition,1.0);\n"
  97     "  vTexCoord = 0.5 + 0.5 * (textureCoords.xy/textureCoords.w);\n"
  98   "}\n";
  99
 100 const char* const RENDER_SHADOW_FRAGMENT_SOURCE =
 101   "uniform lowp vec4 uShadowColor;\n"
 102   "void main()\n"
 103   "{\n"
 104   "  lowp float alpha;\n"
 105   "  alpha = texture2D(sTexture, vec2(vTexCoord.x, vTexCoord.y)).a;\n"
 106   "  gl_FragColor = vec4(uShadowColor.rgb, uShadowColor.a * alpha);\n"
 107   "}\n";
 108
 109 // TODO: Add this to dali-core constraints.h
 110 /**
 111  * EqualToConstraintMatrix
 112  *
 113  * f(current, property) = property
 114  */
 115 struct EqualToConstraintMatrix
 116 {
 117   EqualToConstraintMatrix(){}
 118
 119   Dali::Matrix operator()(const Dali::Matrix& current, const PropertyInput& property) {return property.GetMatrix();}
 120 };
 121
 122 } // namespace
 123
 124 ShadowView::ShadowView( float downsampleWidthScale, float downsampleHeightScale )
 125 : Control( CONTROL_BEHAVIOUR_NONE ),
 126   mChildrenRoot(Actor::New()),
 127   mCachedShadowColor(DEFAULT_SHADOW_COLOR),
 128   mCachedBackgroundColor(DEFAULT_SHADOW_COLOR.r, DEFAULT_SHADOW_COLOR.g, DEFAULT_SHADOW_COLOR.b, 0.0f),
 129   mBlurStrengthPropertyIndex(Property::INVALID_INDEX),
 130   mShadowColorPropertyIndex(Property::INVALID_INDEX),
 131   mDownsampleWidthScale(downsampleWidthScale),
 132   mDownsampleHeightScale(downsampleHeightScale)
 133 {
 134 }
 135
 136 ShadowView::~ShadowView()
 137 {
 138 }
 139
 140 Toolkit::ShadowView ShadowView::New(float downsampleWidthScale, float downsampleHeightScale)
 141 {
 142   ShadowView* impl = new ShadowView(downsampleWidthScale, downsampleHeightScale);
 143
 144   Dali::Toolkit::ShadowView handle = Dali::Toolkit::ShadowView( *impl );
 145
 146   // Second-phase init of the implementation
 147   // This can only be done after the CustomActor connection has been made...
 148   impl->Initialize();
 149
 150   return handle;
 151 }
 152
 153 /////////////////////////////////////////////////////////////
 154 // for creating a subtree for all user added child actors.
 155 // TODO: overloading Actor::Add()/Remove() not nice since breaks polymorphism. Need another method to pass ownership of added child actors to our internal actor root.
 156 void ShadowView::Add(Actor child)
 157 {
 158   mChildrenRoot.Add(child);
 159 }
 160
 161 void ShadowView::Remove(Actor child)
 162 {
 163   mChildrenRoot.Remove(child);
 164 }
 165
 166 void ShadowView::SetShadowPlane(Actor shadowPlane)
 167 {
 168   mShadowPlaneBg = shadowPlane;
 169
 170   mShadowPlane = ImageActor::New();
 171   mShadowPlane.SetParentOrigin(ParentOrigin::CENTER);
 172   mShadowPlane.SetAnchorPoint(AnchorPoint::CENTER);
 173
 174   mShadowPlane.SetImage(mOutputImage);
 175   mShadowPlane.SetShaderEffect(mShadowRenderShader);
 176
 177   // Rather than parent the shadow plane drawable and have constraints to move it to the same
 178   // position, instead parent the shadow plane drawable on the shadow plane passed in.
 179   mShadowPlaneBg.Add(mShadowPlane);
 180   mShadowPlane.SetParentOrigin(ParentOrigin::CENTER);
 181   mShadowPlane.SetZ(1.0f);
 182
 183   ConstrainCamera();
 184
 185   mShadowPlane.SetResizePolicy( FILL_TO_PARENT, ALL_DIMENSIONS );
 186
 187   mBlurRootActor.SetResizePolicy( FILL_TO_PARENT, ALL_DIMENSIONS );
 188 }
 189
 190 void ShadowView::SetPointLight(Actor pointLight)
 191 {
 192   mPointLight = pointLight;
 193
 194   ConstrainCamera();
 195 }
 196
 197 void ShadowView::SetPointLightFieldOfView(float fieldOfView)
 198 {
 199   mCameraActor.SetFieldOfView(fieldOfView);
 200 }
 201
 202 void ShadowView::SetShadowColor(Vector4 color)
 203 {
 204   mCachedShadowColor = color;
 205   mCachedBackgroundColor.r = color.r;
 206   mCachedBackgroundColor.g = color.g;
 207   mCachedBackgroundColor.b = color.b;
 208
 209   Self().SetProperty( mShadowColorPropertyIndex, mCachedShadowColor );
 210   if(mRenderSceneTask)
 211   {
 212     mRenderSceneTask.SetClearColor( mCachedBackgroundColor );
 213   }
 214 }
 215
 216 void ShadowView::Activate()
 217 {
 218   DALI_ASSERT_ALWAYS( Self().OnStage() && "ShadowView should be on stage before calling Activate()\n" );
 219
 220   // make sure resources are allocated and start the render tasks processing
 221   CreateRenderTasks();
 222 }
 223
 224 void ShadowView::Deactivate()
 225 {
 226   DALI_ASSERT_ALWAYS( Self().OnStage() && "ShadowView should be on stage before calling Deactivate()\n" )
 227
 228   // stop render tasks processing
 229   // Note: render target resources are automatically freed since we set the Image::Unused flag
 230   RemoveRenderTasks();
 231 }
 232
 233 ///////////////////////////////////////////////////////////
 234 //
 235 // Private methods
 236 //
 237
 238 void ShadowView::OnInitialize()
 239 {
 240   // root actor to parent all user added actors. Used as source actor for shadow render task.
 241   mChildrenRoot.SetPositionInheritanceMode( Dali::USE_PARENT_POSITION );
 242   mChildrenRoot.SetRelayoutEnabled( true );
 243   mChildrenRoot.SetResizePolicy( FILL_TO_PARENT, ALL_DIMENSIONS );
 244
 245   Vector2 stageSize = Stage::GetCurrent().GetSize();
 246   mCameraActor = CameraActor::New(stageSize);
 247
 248   mCameraActor.SetParentOrigin( ParentOrigin::CENTER );
 249
 250   // Target is constrained to point at the shadow plane origin
 251   mCameraActor.SetNearClippingPlane( 1.0f );
 252   mCameraActor.SetType( Dali::Camera::FREE_LOOK ); // Camera orientation constrained to point at shadow plane world position
 253   mCameraActor.SetOrientation(Radian(Degree(180)), Vector3::YAXIS);
 254   mCameraActor.SetPosition(DEFAULT_LIGHT_POSITION);
 255
 256   mShadowRenderShader = ShaderEffect::New( RENDER_SHADOW_VERTEX_SOURCE, RENDER_SHADOW_FRAGMENT_SOURCE,
 257                                            Dali::GeometryType( GEOMETRY_TYPE_IMAGE ),
 258                                            ShaderEffect::GeometryHints( ShaderEffect::HINT_GRID | ShaderEffect::HINT_BLENDING ));
 259
 260   // Create render targets needed for rendering from light's point of view
 261   mSceneFromLightRenderTarget = FrameBufferImage::New( stageSize.width, stageSize.height, Pixel::RGBA8888 );
 262
 263   mOutputImage = FrameBufferImage::New( stageSize.width * 0.5f, stageSize.height * 0.5f, Pixel::RGBA8888 );
 264
 265   //////////////////////////////////////////////////////
 266   // Connect to actor tree
 267
 268   Self().Add( mChildrenRoot );
 269   Stage::GetCurrent().Add( mCameraActor );
 270
 271   mBlurFilter.SetRefreshOnDemand(false);
 272   mBlurFilter.SetInputImage(mSceneFromLightRenderTarget);
 273   mBlurFilter.SetOutputImage(mOutputImage);
 274   mBlurFilter.SetSize(stageSize * 0.5f);
 275   mBlurFilter.SetPixelFormat(Pixel::RGBA8888);
 276
 277   mBlurRootActor = Actor::New();
 278
 279   mBlurRootActor.SetRelayoutEnabled( true );
 280   // Turn off inheritance to ensure filter renders properly
 281   mBlurRootActor.SetPositionInheritanceMode(USE_PARENT_POSITION);
 282   mBlurRootActor.SetInheritOrientation(false);
 283   mBlurRootActor.SetInheritScale(false);
 284   mBlurRootActor.SetColorMode(USE_OWN_COLOR);
 285
 286   Self().Add(mBlurRootActor);
 287
 288   mBlurFilter.SetRootActor(mBlurRootActor);
 289   mBlurFilter.SetBackgroundColor(Vector4::ZERO);
 290
 291   SetShaderConstants();
 292 }
 293
 294 void ShadowView::OnSizeSet(const Vector3& targetSize)
 295 {
 296 }
 297
 298 void ShadowView::OnStageConnection()
 299 {
 300   // TODO: can't call this here, since SetImage() calls fail to connect images to stage, since parent chain not fully on stage yet
 301   // Need to fix the stage connection so this callback can be used arbitrarily. At that point we  can simplify the API by removing the need for Activate() / Deactivate()
 302   //Activate();
 303 }
 304
 305 void ShadowView::OnStageDisconnection()
 306 {
 307   // TODO: can't call this here, since SetImage() calls fails similarly to above
 308   // Need to fix the stage connection so this callback can be used arbitrarily. At that point we  can simplify the API by removing the need for Activate() / Deactivate()
 309   //Deactivate();
 310 }
 311
 312 void ShadowView::ConstrainCamera()
 313 {
 314   if( mPointLight && mShadowPlane )
 315   {
 316     // Constrain camera to look directly at center of shadow plane. (mPointLight position
 317     // is under control of application, can't use transform inheritance)
 318
 319     Constraint cameraOrientationConstraint =
 320       Constraint::New<Quaternion> ( Actor::Property::ORIENTATION,
 321                                     Source( mShadowPlane, Actor::Property::WORLD_POSITION ),
 322                                     Source( mPointLight,  Actor::Property::WORLD_POSITION ),
 323                                     Source( mShadowPlane, Actor::Property::WORLD_ORIENTATION ),
 324                                     &LookAt );
 325
 326     mCameraActor.ApplyConstraint( cameraOrientationConstraint );
 327
 328     Constraint pointLightPositionConstraint = Constraint::New<Vector3>( Actor::Property::POSITION, Source( mPointLight, Actor::Property::WORLD_POSITION ), EqualToConstraint() );
 329
 330     mCameraActor.ApplyConstraint( pointLightPositionConstraint );
 331   }
 332 }
 333
 334 void ShadowView::CreateRenderTasks()
 335 {
 336   RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
 337
 338   // We want the first task to render the scene from the light
 339   mRenderSceneTask = taskList.CreateTask();
 340
 341   mRenderSceneTask.SetCameraActor( mCameraActor );
 342   mRenderSceneTask.SetSourceActor( mChildrenRoot );
 343   mRenderSceneTask.SetTargetFrameBuffer( mSceneFromLightRenderTarget );
 344   mRenderSceneTask.SetInputEnabled( false );
 345   mRenderSceneTask.SetClearEnabled( true );
 346
 347   // background color for render task should be the shadow color, but with alpha 0
 348   // we don't want to blend the edges of the content with a BLACK at alpha 0, but
 349   // the same shadow color at alpha 0.
 350   mRenderSceneTask.SetClearColor( mCachedBackgroundColor );
 351
 352   mBlurFilter.Enable();
 353 }
 354
 355 void ShadowView::RemoveRenderTasks()
 356 {
 357   RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
 358
 359   taskList.RemoveTask(mRenderSceneTask);
 360   mRenderSceneTask.Reset();
 361
 362   mBlurFilter.Disable();
 363 }
 364
 365 void ShadowView::SetShaderConstants()
 366 {
 367   CustomActor self = Self();
 368
 369   mShadowRenderShader.SetUniform( SHADER_LIGHT_CAMERA_PROJECTION_MATRIX_PROPERTY_NAME, Matrix::IDENTITY );
 370   mShadowRenderShader.SetUniform( SHADER_LIGHT_CAMERA_VIEW_MATRIX_PROPERTY_NAME, Matrix::IDENTITY );
 371   mShadowRenderShader.SetUniform( SHADER_SHADOW_COLOR_PROPERTY_NAME, mCachedShadowColor );
 372
 373   Property::Index lightCameraProjectionMatrixPropertyIndex = mShadowRenderShader.GetPropertyIndex(SHADER_LIGHT_CAMERA_PROJECTION_MATRIX_PROPERTY_NAME);
 374   Property::Index lightCameraViewMatrixPropertyIndex = mShadowRenderShader.GetPropertyIndex(SHADER_LIGHT_CAMERA_VIEW_MATRIX_PROPERTY_NAME);
 375
 376   Constraint projectionMatrixConstraint = Constraint::New<Dali::Matrix>( lightCameraProjectionMatrixPropertyIndex, Source( mCameraActor, CameraActor::Property::PROJECTION_MATRIX ), EqualToConstraintMatrix());
 377   Constraint viewMatrixConstraint = Constraint::New<Dali::Matrix>( lightCameraViewMatrixPropertyIndex, Source( mCameraActor, CameraActor::Property::VIEW_MATRIX ), EqualToConstraintMatrix());
 378
 379   mShadowRenderShader.ApplyConstraint(projectionMatrixConstraint);
 380   mShadowRenderShader.ApplyConstraint(viewMatrixConstraint);
 381
 382   // Register a property that the user can use to control the blur in the internal object
 383   mBlurStrengthPropertyIndex = self.RegisterProperty(BLUR_STRENGTH_PROPERTY_NAME, BLUR_STRENGTH_DEFAULT);
 384   mBlurFilter.GetHandleForAnimateBlurStrength().ApplyConstraint( Constraint::New<float>( mBlurFilter.GetBlurStrengthPropertyIndex() ,
 385                                                                            Source( self, mBlurStrengthPropertyIndex),
 386                                                                            EqualToConstraint()) );
 387
 388   //  Register a property that the user can use to control the color of the shadow.
 389   Property::Index index = mShadowRenderShader.GetPropertyIndex(SHADER_SHADOW_COLOR_PROPERTY_NAME);
 390   mShadowColorPropertyIndex = self.RegisterProperty(SHADOW_COLOR_PROPERTY_NAME, mCachedShadowColor);
 391
 392   mShadowRenderShader.ApplyConstraint(Constraint::New<Dali::Vector4>( index, Source( self, mShadowColorPropertyIndex ), EqualToConstraint()) );
 393 }
 394
 395 } // namespace Internal
 396
 397 } // namespace Toolkit
 398
 399 } // namespace Dali