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