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 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/shader-effects/shader-effect.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 /**
  31  * SpotEffect2D is a custom shader effect to achieve spot effects on Image actors
  32  */
  33 class DALI_IMPORT_API SpotEffect : public ShaderEffect
  34 {
  35 public:
  36
  37   /**
  38    * Create an uninitialized SpotEffect; this can be initialized with SpotEffect::New()
  39    * Calling member functions with an uninitialized Dali::Object is not allowed.
  40    */
  41   SpotEffect();
  42
  43   /**
  44    * @brief Destructor
  45    *
  46    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  47    */
  48   ~SpotEffect();
  49
  50   /**
  51    * Create an initialized SpotEffect.
  52    * @return A handle to a newly allocated Dali resource.
  53    */
  54   static SpotEffect New();
  55
  56   /**
  57    * Set the center of the spot.
  58    * @param[in] center The center in Vector2.
  59    */
  60   void SetCenter(const Vector2& center);
  61
  62   /**
  63    * Set the radius of the spot.
  64    * @param[in] radius The radius in float.
  65    */
  66   void SetRadius(float radius);
  67
  68   /**
  69    * Get the name for the center property
  70    * @return A std::string containing the property name
  71    */
  72   const std::string& GetCenterPropertyName() const;
  73
  74   /**
  75    * Get the name for the radius property
  76    * @return A std::string containing the property name
  77    */
  78   const std::string& GetRadiusPropertyName() const;
  79
  80 private:
  81   DALI_INTERNAL SpotEffect(ShaderEffect handle);
  82 };
  83
  84 } // namespace Toolkit
  85
  86 } // namespace Dali
  87
  88 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SPOT_H__