dali-toolkit/devel-api/controls/shadow-view/shadow-view.h

   1 #ifndef DALI_TOOLKIT_SHADOW_VIEW_H
   2 #define DALI_TOOLKIT_SHADOW_VIEW_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace Internal DALI_INTERNAL
  29 {
  30 /**
  31  * ShadowView implementation class
  32  */
  33 class ShadowView;
  34
  35 } // namespace DALI_INTERNAL
  36
  37 /**
  38  *
  39  * ShadowView is a class for applying shadows to objects present in the view.
  40  *
  41  * Basic idea:-
  42  *
  43  * 1) The ShadowView object will render all its child actors offscreen from the light's point of view projected on to the shadow plane in a seperate render task.\n
  44  * 2) The ShadowView object then blurs the result of step 1), using a two pass separated Gaussian blur.\n
  45  * 3) The ShadowView object gets rendered automatically in the default render task along with it's children.
  46  *
  47  * Fundamentally, the ShadowView is simply an Actor in the normal actor tree that affects all of its children. It should be added to your Actor tree and manipulated in the
  48  * normal way. It can be considered a 'portal' in the sense that all child actors are clipped to the ShadowView actor bounds.
  49  *
  50  * LIMITATIONS:
  51  * The ShadowView is intended to provide simple planar projection shadows, Which means it needs a flat plane to cast shadows. So Shadows can't be cast on other objects.
  52  *
  53  * ************\n
  54  * NB: It is essential to remove the ShadowView from the stage and also to call Deactivate() on it when you are not using it. This will ensure that resources are freed and
  55  * rendering stops.\n
  56  * ************\n
  57  *
  58  * Usage example:-
  59  *
  60  *  @code
  61  *  // initialise\n
  62  *  ShadowView shadowView = ShadowView::New();
  63  *
  64  *  // create and add some visible actors to the ShadowView, all these child actors will therefore cast a shadow.
  65  *  Image image = Image::New(...);
  66  *  ImageView imageView = ImageView::New(image);
  67  *  imageView.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
  68  *  imageView.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
  69  *  shadowView.Add(imageView);\n Add the renderable actor to the shadow view
  70  *
  71  *  ImageView shadowPlaneBg = ImageView::New(); //This will be the shadow plane
  72  *  shadowPlaneBg.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
  73  *  shadowPlaneBg.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
  74  *  shadowPlaneBg.SetProperty( Actor::Property::SIZE, Vector2(700.0f, 700.0f) );
  75  *  shadowPlaneBg.SetProperty( Actor::Property::POSITION, Vector3(0.0f, 0.0f, -30.0f) ); //Just behind the image view.
  76  *  shadowView.SetShadowPlaneBackground(ShadowPlane);
  77  *
  78  *  Actor pointLight = Actor::New(); // This will be the light source
  79  *  pointLight.SetProperty( Actor::Property::POSITION, Vector3(300.0f, 250.0f, 600.0f) );
  80  *  Stage::GetCurrent().Add(pointLight);
  81  *  shadowView.SetPointLight(pointLight);
  82  *
  83  *  // Start rendering the ShadowView
  84  *  Stage::GetCurrent().Add(ShadowPlane);
  85  *  shadowView.Activate();
  86  *  ...
  87  *
  88  *  // animate the strength of the blur - this can fade between no blur and full blur. See GetBlurStrengthPropertyIndex().
  89  *  Animation blurAnimation = Animation::New( ... );
  90  *  blurAnimation.AnimateTo( Property( shadowView, shadowView.GetBlurStrengthPropertyIndex() ), ... );
  91  *  blurAnimation.Play();
  92  *
  93  *  ...
  94  *  // Stop rendering the ShadowView
  95  *  Stage::GetCurrent().Remove(shadowView);
  96  *  shadowView.Deactivate();
  97  *  @endcode
  98  */
  99 class DALI_TOOLKIT_API ShadowView : public Control
 100 {
 101 public:
 102   /**
 103    * Create an uninitialized ShadowView; this can be initialized with ShadowView::New()
 104    * Calling member functions with an uninitialized Dali::Object is not allowed.
 105    */
 106   ShadowView();
 107
 108   /**
 109    * Copy constructor. Creates another handle that points to the same real object
 110    */
 111   ShadowView(const ShadowView& handle);
 112
 113   /**
 114    * Assignment operator. Changes this handle to point to another real object
 115    */
 116   ShadowView& operator=(const ShadowView& view);
 117
 118   /**
 119    * @brief Destructor
 120    *
 121    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 122    */
 123   ~ShadowView();
 124
 125   /**
 126    * Downcast an Object handle to ShadowView. If handle points to a ShadowView the
 127    * downcast produces valid handle. If not the returned handle is left uninitialized.
 128    * @param[in] handle Handle to an object
 129    * @return handle to a ShadowView or an uninitialized handle
 130    */
 131   static ShadowView DownCast(BaseHandle handle);
 132
 133   /**
 134   * Create an initialized ShadowView. Add children and call SetShadowPlane to make shadows visible\n
 135   * @return A handle to a newly allocated Dali resource
 136   */
 137   static ShadowView New();
 138
 139   /**
 140    * Create an initialized ShadowView. Add children and call SetShadowPlane to make shadows visible\n
 141    * @param[in] downsampleWidthScale The width scale factor applied during the blur process, scaling the size of the source image to the size of the final blurred image output.
 142    * Useful for downsampling - trades visual quality for processing speed. A value of 1.0f results in no scaling applied.
 143    * @param[in] downsampleHeightScale The height scale factor applied during the blur process, scaling the size of the source image to the size of the final blurred image output.
 144    * Useful for downsampling - trades visual quality for processing speed. A value of 1.0f results in no scaling applied.
 145    * @return A handle to a newly allocated Dali resource
 146    */
 147   static ShadowView New(float downsampleWidthScale, float downsampleHeightScale);
 148
 149   /**
 150    * Set the Shadow Plane Background for the shadow effect.
 151    *
 152    * @param[in] shadowPlaneBackground An actor representing the shadow
 153    * plane. The position of the actor represents the origin of the
 154    * plane, and the orientation of the actor represents the direction
 155    * of the plane normal. Make the plane sufficiently large if the shadows are
 156    * clipped.
 157    */
 158   void SetShadowPlaneBackground(Actor shadowPlaneBackground);
 159
 160   /**
 161    * Set the Point Light for the shadow effect. This is usually NOT a renderable actor.
 162    * The orientation of the actor is not considered for the shadow calculation.
 163    * @param[in] pointLight An actor representing the location of the
 164    * directionless light source that casts the shadow.
 165    */
 166   void SetPointLight(Actor pointLight);
 167
 168   /**
 169    * Set the field of view of the point light source. This will be used by an additional
 170    * internal camera to look at the scene form the light source. If you notice any aritifacts
 171    * when the light position is near to the object, Increase the field of view.
 172    * @param[in] fieldOfView  New field of view in radians, Typical values are  Math::PI / 4.0f,
 173    *  Math::PI / 2.0f
 174    */
 175   void SetPointLightFieldOfView(float fieldOfView);
 176
 177   /**
 178    * Set shadow color.
 179    * @param[in] color The shadow color
 180    */
 181   void SetShadowColor(Vector4 color);
 182
 183   /**
 184    * Start rendering the ShadowView. Must be called after you Add() it to the stage.
 185    * @pre This Actor has been added to the stage.
 186    */
 187   void Activate();
 188
 189   /**
 190    * Stop rendering the ShadowView. Must be called after you Remove() it from the stage.
 191    * @pre This Actor has been removed from the stage.
 192    */
 193   void Deactivate();
 194
 195   /**
 196    * Get the property index that controls the strength of the blur applied to the shadow. Useful for animating this property.
 197    * This property represents a value in the range [0.0 - 1.0] where 0.0 is no blur and 1.0 is full blur. Default 0.2.
 198    * @return The property index that can be used with e.g. AnimateTo( ... )
 199    */
 200   Dali::Property::Index GetBlurStrengthPropertyIndex() const;
 201
 202   /**
 203    * Get the property index that controls the color of the shadow. Useful for animating this property.
 204    * This property represents a value in the Vector4 format. Default color value is Vector4(0.2f, 0.2f, 0.2f, 0.8f) (i.e grey color).
 205    * @return The property index that can be used with e.g. AnimateTo( ... )
 206    */
 207   Dali::Property::Index GetShadowColorPropertyIndex() const;
 208
 209 public:
 210   /**
 211    * Creates a handle using the Toolkit::Internal implementation.
 212    * @param[in]  implementation  The UI Control implementation.
 213    */
 214   DALI_INTERNAL ShadowView(Internal::ShadowView& implementation);
 215
 216   /**
 217    * Allows the creation of this UI Control from an Internal::CustomActor pointer.
 218    * @param[in]  internal  A pointer to the internal CustomActor.
 219    */
 220   explicit DALI_INTERNAL ShadowView(Dali::Internal::CustomActor* internal);
 221 };
 222
 223 } // namespace Toolkit
 224
 225 } // namespace Dali
 226
 227 #endif // DALI_TOOLKIT_SHADOW_VIEW_H