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