optional/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 // INTERNAL INCLUDES
  22 #include <dali/dali.h>
  23
  24 namespace Dali DALI_IMPORT_API
  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 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    * Virtual destructor.
  45    */
  46   virtual ~SpotEffect();
  47
  48   /**
  49    * Create an initialized SpotEffect.
  50    * @return A handle to a newly allocated Dali resource.
  51    */
  52   static SpotEffect New();
  53
  54   /**
  55    * Set the center of the spot.
  56    * @param[in] center The center in Vector2.
  57    */
  58   void SetCenter(const Vector2& center);
  59
  60   /**
  61    * Set the radius of the spot.
  62    * @param[in] radius The radius in float.
  63    */
  64   void SetRadius(float radius);
  65
  66   /**
  67    * Get the name for the center property
  68    * @return A std::string containing the property name
  69    */
  70   const std::string& GetCenterPropertyName() const;
  71
  72   /**
  73    * Get the name for the radius property
  74    * @return A std::string containing the property name
  75    */
  76   const std::string& GetRadiusPropertyName() const;
  77
  78 private:
  79   SpotEffect(ShaderEffect handle);
  80
  81 };
  82
  83 } // namespace Toolkit
  84
  85 } // namespace Dali
  86
  87 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SPOT_H__