[dali_1.9.30] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / visual-base-impl.h
1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_VISUAL_H
3
4 /*
5  * Copyright (c) 2018 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/animation/animation.h>
23 #include <dali/public-api/common/intrusive-ptr.h>
24 #include <dali/public-api/images/image-operations.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/public-api/rendering/renderer.h>
27 #include <dali/public-api/rendering/shader.h>
28
29 // INTERNAL INCLUDES
30 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
31 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
32 #include <dali-toolkit/internal/visuals/transition-data-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
34 #include <dali-toolkit/devel-api/direction-enums.h>
35 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
37
38 namespace Dali
39 {
40
41 namespace Toolkit
42 {
43
44 namespace Internal
45 {
46
47 namespace Visual
48 {
49
50 class EventObserver;
51
52 using FittingMode = DevelVisual::FittingMode;
53
54 /**
55  * Base class for all Control rendering logic. A control may have multiple visuals.
56  *
57  * Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
58  *
59  * The following properties are optional
60  *
61  * | %Property Name          | Type             |
62  * |-------------------------|------------------|
63  * | customShader            | MAP              |
64  *
65  * where custom-shader is a map with the following properties:
66  * | %Property Name          | Type             |
67  * |-------------------------|------------------|
68  * | vertexShader            | STRING           |
69  * | fragmentShader          | STRING           |
70  * | subdivideGridX          | INT              |
71  * | subdivideGridY          | INT              |
72  * | shaderHints             | INT              |
73  */
74 class Base : public BaseObject
75 {
76 public:
77
78   /**
79    * Setting the properties of the visual, this API should only called by the VisualFactory
80    * @param[in] propertyMap The properties for the requested Visual object.
81    */
82   void SetProperties( const Property::Map& propertyMap );
83
84   /**
85    * @copydoc Toolkit::Visual::Base::SetName
86    */
87   void SetName( const std::string& name );
88
89   /**
90    * @copydoc Toolkit::Visual::Base::GetName
91    */
92   const std::string& GetName() const;
93
94   /**
95    * @copydoc Toolkit::Visual::Base::SetSize
96    */
97   void SetTransformAndSize( const Property::Map& transform, Size controlSize );
98
99   /**
100    * @brief Performs an action on the visual with the given action name and attributes.
101    *
102    * @param[in] actionName The name of the action to perform this API only takes an Index
103    * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content )
104    */
105   void DoAction( const Dali::Property::Index actionName, const Dali::Property::Value attributes );
106
107   /**
108    * @copydoc Toolkit::Visual::Base::GetHeightForWidth
109    */
110   virtual float GetHeightForWidth( float width );
111
112   /**
113    * @copydoc Toolkit::Visual::Base::GetWidthForHeight
114    */
115   virtual float GetWidthForHeight( float height );
116
117   /**
118    * @copydoc Toolkit::Visual::Base::GetNaturalSize
119    */
120   virtual void GetNaturalSize( Vector2& naturalSize );
121
122   /**
123    * @copydoc Toolkit::Visual::Base::SetDepthIndex
124    */
125   void SetDepthIndex( int index );
126
127   /**
128    * @copydoc Toolkit::Visual::Base::GetDepthIndex
129    */
130   int GetDepthIndex() const;
131
132   /**
133    * @copydoc Toolkit::Visual::Base::SetOnScene
134    * @pre Impl->mGeometry must be created before this method is called
135    */
136   void SetOnScene( Actor& actor );
137
138   /**
139    * @copydoc Toolkit::Visual::Base::SetOffScene
140    */
141   void SetOffScene( Actor& actor );
142
143   /**
144    * @copydoc Toolkit::Visual::Base::CreatePropertyMap
145    */
146   void CreatePropertyMap( Property::Map& map ) const;
147
148   /**
149    * @brief Create a property map containing per-instance visual properties.
150    *
151    * This will enable creation of new visuals on control state change with
152    * any alternative style properties and the relevant instance properties
153    * (e.g. for image visual, the desired size, and for text visual, the actual text).
154    * @param[in] map The property map into which to write
155    */
156   void CreateInstancePropertyMap( Property::Map& map ) const;
157
158   /**
159    * @brief Set whether the Pre-multiplied Alpha Blending is required
160    *
161    * @param[in] preMultiplied whether alpha is pre-multiplied.
162    */
163   void EnablePreMultipliedAlpha( bool preMultiplied );
164
165   /**
166    * @brief Query whether alpha is pre-multiplied.
167    *
168    * @return True is alpha is pre-multiplied, false otherwise.
169    */
170   bool IsPreMultipliedAlphaEnabled() const;
171
172   /**
173    * @brief Sets properties of custom shader
174    * @param[in] propertyMap Property map containing the custom shader data
175    */
176   void SetCustomShader( const Property::Map& propertyMap );
177
178   /**
179    * @copydoc Toolkit::Visual::Base::SetProperty
180    */
181   void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
182
183   /**
184    * @copydoc Toolkit::Visual::Base::GetProperty
185    */
186   Dali::Property::Value GetProperty( Dali::Property::Index index );
187
188   /**
189    * Gets currently staged renderer, or an empty handle if not staged
190    */
191   Renderer GetRenderer();
192
193   /**
194    * Sets the mix color ( including opacity )  of the visual.
195    * @param[in] mixColor The new mix color
196    */
197   void SetMixColor( const Vector4& color );
198
199   /**
200    * Sets the mix color of the visual.
201    * @param[in] mixColor The new mix color
202    */
203   void SetMixColor( const Vector3& color );
204
205   /**
206    * Gets the mix color of the visual.
207    * @return The mix color
208    */
209   const Vector4& GetMixColor() const;
210
211   /**
212    * Animate the property if it exists in the visual or renderer.
213    *
214    * If it's a visual property such as mix color or a transform property,
215    * saves the target value to the local data.
216    *
217    * If the visual isn't staged (i.e. it doesn't have a renderer),
218    * then this will not add an animation.
219    *
220    * If the animator is valid and the transition handle is empty - it will
221    * be created.
222    *
223    * @param[in] transition The animation to create or attach to
224    * @param[in] animator The animation parameters of the property.
225    */
226   void AnimateProperty( Dali::Animation& transition,
227                         Internal::TransitionData::Animator& animator );
228
229   /**
230    * @brief Add an observer to watch for when the Visuals have events to notify
231    * Currently only supports a single observer
232    */
233   void AddEventObserver( Visual::EventObserver& observer );
234
235   /**
236    * @brief Remove an observer
237    */
238   void RemoveEventObserver( Visual::EventObserver& observer );
239
240   /**
241    * @brief Called when the visuals resources are loaded / ready
242    */
243   void ResourceReady( Toolkit::Visual::ResourceStatus resourceStatus );
244
245   /**
246    * @brief Called when the visuals resources are loaded / ready
247    * @return true if ready, false otherwise
248    */
249   virtual bool IsResourceReady() const;
250
251   /**
252    * @brief Get the loading state of the visual resource
253    * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
254    */
255   Toolkit::Visual::ResourceStatus GetResourceStatus() const;
256
257   /**
258    * @brief Get the fitting mode for the visual
259    */
260   FittingMode GetFittingMode() const;
261
262   /**
263    * @brief Get the actual Visual Object.
264    * @return The actual visual object
265    * @note Should be overridden by deriving controls if they are acting as a proxy to other visual objects.
266    */
267   virtual Base& GetVisualObject();
268
269   /**
270    * @brief Query whether resources requires to be loaded synchronously.
271    * @return Returns true if synchronous resource loading is required, false otherwise.
272    */
273   bool IsSynchronousLoadingRequired() const;
274
275   /**
276    * @brief Get the type of this visual.
277    *
278    * @return The the type of this visual.
279    */
280   Toolkit::Visual::Type GetType() const;
281
282  protected:
283
284   /**
285    * @brief Constructor.
286    *
287    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
288    * @param[in] fittingMode The value that determines how the visual should be fit to the view
289    * @param[in] type The type of the this visual
290    */
291   Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type );
292
293   /**
294    * @brief A reference counted object may only be deleted by calling Unreference().
295    */
296   virtual ~Base();
297
298 protected:
299
300   /**
301    * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
302    *
303    * @param[out] map The visual property map.
304    */
305   virtual void DoCreatePropertyMap( Property::Map& map ) const = 0;
306
307   /**
308    * @brief Called by CreateInstancePropertyMap() allowing derived
309    * classes to store instanced data (separate to styled data) that
310    * needs copying between visuals on state change.
311    *
312    * @param[out] map The visual property map
313    */
314   virtual void DoCreateInstancePropertyMap( Property::Map& map ) const = 0;
315
316   /**
317    * @brief Called by SetProperties() allowing sub classes to set their properties
318    *
319    * @param[in] propertyMap The properties for the requested Visual object.
320    */
321   virtual void DoSetProperties( const Property::Map& propertyMap ) = 0;
322
323   /**
324    * @brief Called when transform or control size changes
325    * ( Of use to SVG and Text visuals )
326    */
327   virtual void OnSetTransform() = 0;
328
329   /**
330    * @brief Called by SetOnScene() allowing sub classes to respond to the SetOnScene event
331    *
332    * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
333    *
334    * @param[in] actor The actor applying this visual.
335    */
336   virtual void DoSetOnScene( Actor& actor ) = 0;
337
338   /**
339    * @brief Called by SetOffScene() allowing sub classes to respond to the SetOffScene event
340    *
341    * @param[in] actor The actor applying this visual.
342    */
343   virtual void DoSetOffScene( Actor& actor );
344
345   /**
346    * @brief Called by DoAction() allowing sub classes to do the given action.
347    *
348    * @param[in] actionId The action to perform
349    * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content )
350    */
351   virtual void OnDoAction( const Property::Index actionId, const Property::Value& attributes );
352
353 protected:
354
355   /**
356    * @brief Gets the on scene state for this Visual
357    *
358    * @return Returns true if this Visual is on the scene, false if it is off the scene
359    */
360   bool IsOnScene() const;
361
362   /**
363    * @brief Query whether the corners of the visual requires to be rounded.
364    *
365    * @return Returns true if the rounded corner is required, false otherwise.
366    */
367   bool IsRoundedCornerRequired() const;
368
369 private:
370
371   /**
372    * Register the mix color uniform on the Renderer and store the property index.
373    * Note, this is not used by Color or Primitive Visuals, which will use their
374    * own property index.
375    */
376   void RegisterMixColor();
377
378   /**
379    * Find the matching property on the renderer or shader. If it's a shader
380    * property, register it on the renderer in order to animate it for this
381    * visual independently.
382    * @param[in] key The key to match.
383    * @return the matching index, or INVALID_INDEX if it's not found
384    */
385   Property::Index GetPropertyIndex( Property::Key key );
386
387   /**
388    * Set up the transition. If no animation is required, then
389    * transition will be untouched.
390    *
391    * @param[in] transition The transition to use or set up.
392    * @param[in] animator The animation data to use
393    * @param[in] index The property index on the renderer to animate
394    * @param[in] initialValue The optional initial value
395    * @param[in] targetValue The target value to use
396    */
397   void SetupTransition( Dali::Animation& transition,
398                         Internal::TransitionData::Animator& animator,
399                         Property::Index index,
400                         Property::Value& initialValue,
401                         Property::Value& targetValue );
402
403   /**
404    * Animate the opacity property - Special handling to
405    * ensure that the blend mode is set to ON whilst animating,
406    * and set back to AUTO if it's opaque at the end of the
407    * animation.
408    *
409    * @param[in] transition The transition to use or set up.
410    * @param[in] animator The animation data to use
411    */
412   void AnimateOpacityProperty( Dali::Animation& transition,
413                                Internal::TransitionData::Animator& animator );
414
415   /**
416    * Animate the renderer property - no special handling
417    *
418    * @param[in] transition The transition to use or set up.
419    * @param[in] animator The animation data to use
420    */
421   void AnimateRendererProperty( Dali::Animation& transition,
422                                 Internal::TransitionData::Animator& animator );
423
424   /**
425    * Animate the mix color property.
426    *
427    * If the animator is a vec3, then it only animates the color
428    * channels without animating the opacity.  If it's a vec4, then it
429    * runs 2 animators, one for the the vec3 mixColor, and one for the
430    * opacity. (They are separate uniforms in the shader )
431    *
432    * @param[in] transition The transition to use or set up.
433    * @param[in] animator The animation data to use
434    */
435   void AnimateMixColorProperty( Dali::Animation& transition,
436                                 Internal::TransitionData::Animator& animator );
437
438   /**
439    * Set up the right blend mode if the opacity is being animated.
440    * Also ensure that when the animation finishes, the blend mode is
441    * set to the appropriate value. It also uses the target value as
442    * set into mMixColor.
443    *
444    * @param[in] transition The transition to listen to
445    * @param[in] isInitialOpaque Whether the initial value is opaque
446    * @param[in] animating If the transition animates the value.
447    */
448   void SetupBlendMode( Dali::Animation& transition,
449                        bool isInitialOpaque, bool animating );
450
451   /**
452    * When a mix color animation has finished, ensure the blend mode is set back
453    * to the right value for the target opacity.
454    */
455   void OnMixColorFinished( Animation& animation );
456
457   // Undefined
458   Base( const Visual::Base& visual );
459
460   // Undefined
461   Base& operator=( const Visual::Base& visual );
462
463 protected:
464   struct Impl;
465   Impl* mImpl;
466   VisualFactoryCache& mFactoryCache;
467 };
468
469 typedef IntrusivePtr<Base> BasePtr;
470
471 } // namspace Visual
472
473 } // namespace Internal
474
475 inline const Internal::Visual::Base& GetImplementation(const Toolkit::Visual::Base& visualBase )
476 {
477   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
478
479   const BaseObject& handle = visualBase.GetBaseObject();
480
481   return static_cast<const Internal::Visual::Base&>(handle);
482 }
483
484 inline Internal::Visual::Base& GetImplementation(Toolkit::Visual::Base& visualBase)
485 {
486   DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
487
488   BaseObject& handle = visualBase.GetBaseObject();
489
490   return static_cast<Internal::Visual::Base&>(handle);
491 }
492
493 } // namespace Toolkit
494
495 } // namespace Dali
496
497 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_H