1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_VISUAL_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/images/image-operations.h>
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/rendering/shader.h>
27 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
28 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
29 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
44 * Base class for all Control rendering logic. A control may have multiple visuals.
46 * Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
48 * The following properties are optional
50 * | %Property Name | Type |
51 * |-------------------------|------------------|
52 * | customShader | MAP |
54 * where custom-shader is a map with the following properties:
55 * | %Property Name | Type |
56 * |-------------------------|------------------|
57 * | vertexShader | STRING |
58 * | fragmentShader | STRING |
59 * | subdivideGridX | INT |
60 * | subdivideGridY | INT |
61 * | shaderHints | INT |
63 class Base : public BaseObject
68 * Initialisation of the visual, this API should only called by the VisualFactory:
69 * request the geometry and shader from the cache, if not available, create and save to the cache for sharing;
70 * record the property values.
72 * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor
73 * @param[in] propertyMap The properties for the requested Visual object.
75 void Initialize( Actor& actor, const Property::Map& propertyMap );
78 * @copydoc Toolkit::Visual::Base::SetSize
80 virtual void SetSize( const Vector2& size );
83 * @copydoc Toolkit::Visual::Base::GetSize
85 const Vector2& GetSize() const;
88 * @copydoc Toolkit::Visual::Base::GetNaturalSize
90 virtual void GetNaturalSize( Vector2& naturalSize ) const;
93 * @copydoc Toolkit::Visual::Base::SetDepthIndex
95 void SetDepthIndex( float index );
98 * @copydoc Toolkit::Visual::Base::GetDepthIndex
100 float GetDepthIndex() const;
103 * @copydoc Toolkit::Visual::Base::SetOnStage
104 * @pre Impl->mGeometry must be created before this method is called
106 void SetOnStage( Actor& actor );
109 * @copydoc Toolkit::Visual::Base::SetOffStage
111 void SetOffStage( Actor& actor );
114 * @copydoc Toolkit::Visual::Base::CreatePropertyMap
116 void CreatePropertyMap( Property::Map& map ) const;
119 * @brief Set whether the Pre-multiplied Alpha Blending is required
121 * @param[in] preMultipled whether alpha is pre-multiplied.
123 void EnablePreMultipliedAlpha( bool preMultipled );
126 * @brief Query whether alpha is pre-multiplied.
128 * @return True is alpha is pre-multiplied, false otherwise.
130 bool IsPreMultipliedAlphaEnabled() const;
133 * @brief Sets properties of custom shader
134 * @param[in] propertyMap Property map containing the custom shader data
136 void SetCustomShader( const Property::Map& propertyMap );
141 * @brief Constructor.
143 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
145 Base( VisualFactoryCache& factoryCache );
148 * @brief A reference counted object may only be deleted by calling Unreference().
154 * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
156 * @param[out] map The visual property map.
158 virtual void DoCreatePropertyMap( Property::Map& map ) const = 0;
161 * @brief Called by Initialize() allowing sub classes to respond to the Initialize event
163 * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor
164 * @param[in] propertyMap The properties for the requested Visual object.
166 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ) {}
171 * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
173 * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
175 * @param[in] actor The actor applying this visual.
177 virtual void DoSetOnStage( Actor& actor )=0;
180 * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
182 * @param[in] actor The actor applying this visual.
184 virtual void DoSetOffStage( Actor& actor );
188 * @brief Gets the on stage state for this Visual
190 * @return Returns true if this Visual is on stage, false if it is off the stage
192 bool GetIsOnStage() const;
195 * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer)
197 * @return Returns true if the renderer is from shared cache, false otherwise
199 bool GetIsFromCache() const;
204 Base( const Visual::Base& visual );
207 Base& operator=( const Visual::Base& visual );
212 VisualFactoryCache& mFactoryCache;
217 } // namespace Internal
219 inline const Internal::Visual::Base& GetImplementation(const Toolkit::Visual::Base& visualBase )
221 DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
223 const BaseObject& handle = visualBase.GetBaseObject();
225 return static_cast<const Internal::Visual::Base&>(handle);
228 inline Internal::Visual::Base& GetImplementation(Toolkit::Visual::Base& visualBase)
230 DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
232 BaseObject& handle = visualBase.GetBaseObject();
234 return static_cast<Internal::Visual::Base&>(handle);
237 } // namespace Toolkit
241 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_H