dali-toolkit/public-api/shader-effects/spot-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_SPOT_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_SPOT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22
  23 namespace Dali DALI_IMPORT_API
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 /**
  30  * SpotEffect2D is a custom shader effect to achieve spot effects on Image actors
  31  */
  32 class SpotEffect : public ShaderEffect
  33 {
  34 public:
  35
  36   /**
  37    * Create an uninitialized SpotEffect; this can be initialized with SpotEffect::New()
  38    * Calling member functions with an uninitialized Dali::Object is not allowed.
  39    */
  40   SpotEffect();
  41
  42   /**
  43    * Virtual destructor.
  44    */
  45   virtual ~SpotEffect();
  46
  47   /**
  48    * Create an initialized SpotEffect.
  49    * @return A handle to a newly allocated Dali resource.
  50    */
  51   static SpotEffect New();
  52
  53   /**
  54    * Set the center of the spot.
  55    * @param[in] center The center in Vector2.
  56    */
  57   void SetCenter(const Vector2& center);
  58
  59   /**
  60    * Set the radius of the spot.
  61    * @param[in] radius The radius in float.
  62    */
  63   void SetRadius(float radius);
  64
  65   /**
  66    * Get the name for the center property
  67    * @return A std::string containing the property name
  68    */
  69   const std::string& GetCenterPropertyName() const;
  70
  71   /**
  72    * Get the name for the radius property
  73    * @return A std::string containing the property name
  74    */
  75   const std::string& GetRadiusPropertyName() const;
  76
  77 private:
  78   SpotEffect(ShaderEffect handle);
  79
  80 };
  81
  82 } // namespace Toolkit
  83
  84 } // namespace Dali
  85
  86 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SPOT_H__