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

   1 #ifndef __DALI_TOOLKIT_MIRROR_EFFECT_H__
   2 #define __DALI_TOOLKIT_MIRROR_EFFECT_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 // 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  * MirrorEffect is a custom shader effect to achieve square effects in Image actors
  32  */
  33 class DALI_IMPORT_API MirrorEffect : public ShaderEffect
  34 {
  35 public:
  36
  37   /**
  38    * Create an uninitialized MirrorEffect; this can be initialized with MirrorEffect::New()
  39    * Calling member functions with an uninitialized Dali::Object is not allowed.
  40    */
  41   MirrorEffect();
  42
  43   /**
  44    * @brief Destructor
  45    *
  46    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  47    */
  48   ~MirrorEffect();
  49
  50   /**
  51    * Create an initialized MirrorEffect.
  52    * @return A handle to a newly allocated Dali resource.
  53    */
  54   static MirrorEffect New();
  55
  56   /**
  57    * Set the depth of the mirror effect.
  58    * @param [in] depth The new mirror depth value.
  59    */
  60   void SetDepth(float depth);
  61
  62   /**
  63    * Set the alpha of the mirror effect.
  64    * @param [in] alpha The new mirror alpha value.
  65    */
  66   void SetAlpha(float alpha);
  67
  68   /**
  69    * Get the name for the depth property
  70    * which can be used in Animation API's
  71    * @return A std::string containing the property name
  72    */
  73   const std::string& GetDepthPropertyName() const;
  74
  75   /**
  76    * Get the name for the alpha property
  77    * which can be used in Animation API's
  78    * @return A std::string containing the property name
  79    */
  80   const std::string& GetAlphaPropertyName() const;
  81
  82 private: // Not intended for application developers
  83   DALI_INTERNAL MirrorEffect(ShaderEffect handle);
  84 };
  85
  86 } // namespace Toolkit
  87
  88 } // namespace Dali
  89
  90 #endif // __DALI_TOOLKIT_MIRROR_EFFECT_H__