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::SetName
80 void SetName( const std::string& name );
83 * @copydoc Toolkit::Visual::Base::GetName
85 const std::string& GetName();
88 * @copydoc Toolkit::Visual::Base::SetSize
90 virtual void SetSize( const Vector2& size );
93 * @copydoc Toolkit::Visual::Base::GetSize
95 const Vector2& GetSize() const;
98 * @copydoc Toolkit::Visual::Base::GetNaturalSize
100 virtual void GetNaturalSize( Vector2& naturalSize ) const;
103 * @copydoc Toolkit::Visual::Base::SetDepthIndex
105 void SetDepthIndex( float index );
108 * @copydoc Toolkit::Visual::Base::GetDepthIndex
110 float GetDepthIndex() const;
113 * @copydoc Toolkit::Visual::Base::SetOnStage
114 * @pre Impl->mGeometry must be created before this method is called
116 void SetOnStage( Actor& actor );
119 * @copydoc Toolkit::Visual::Base::SetOffStage
121 void SetOffStage( Actor& actor );
124 * @copydoc Toolkit::Visual::Base::CreatePropertyMap
126 void CreatePropertyMap( Property::Map& map ) const;
129 * @brief Set whether the Pre-multiplied Alpha Blending is required
131 * @param[in] preMultipled whether alpha is pre-multiplied.
133 void EnablePreMultipliedAlpha( bool preMultipled );
136 * @brief Query whether alpha is pre-multiplied.
138 * @return True is alpha is pre-multiplied, false otherwise.
140 bool IsPreMultipliedAlphaEnabled() const;
143 * @brief Sets properties of custom shader
144 * @param[in] propertyMap Property map containing the custom shader data
146 void SetCustomShader( const Property::Map& propertyMap );
149 * @copydoc Toolkit::Visual::Base::SetProperty
151 void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
154 * @copydoc Toolkit::Visual::Base::GetProperty
156 Dali::Property::Value GetProperty( Dali::Property::Index index );
161 * @brief Constructor.
163 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
165 Base( VisualFactoryCache& factoryCache );
168 * @brief A reference counted object may only be deleted by calling Unreference().
174 * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
176 * @param[out] map The visual property map.
178 virtual void DoCreatePropertyMap( Property::Map& map ) const = 0;
181 * @brief Called by Initialize() allowing sub classes to respond to the Initialize event
183 * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor
184 * @param[in] propertyMap The properties for the requested Visual object.
186 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ) {}
191 * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
193 * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place.
195 * @param[in] actor The actor applying this visual.
197 virtual void DoSetOnStage( Actor& actor )=0;
200 * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
202 * @param[in] actor The actor applying this visual.
204 virtual void DoSetOffStage( Actor& actor );
208 * @brief Gets the on stage state for this Visual
210 * @return Returns true if this Visual is on stage, false if it is off the stage
212 bool GetIsOnStage() const;
215 * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer)
217 * @return Returns true if the renderer is from shared cache, false otherwise
219 bool GetIsFromCache() const;
223 * @brief Called by SetProperty(). To be overriden by derived clases in order to set properties.
225 * @param [in] index The index of the property.
226 * @param [in] propertyValue The new value of the property.
228 virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ) = 0;
231 * @brief Called by GetProperty(). To be overriden by derived classes in order to retrieve properties.
233 * @param [in] index The index of the property.
235 * @return The property value.
237 virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ) = 0;
242 Base( const Visual::Base& visual );
245 Base& operator=( const Visual::Base& visual );
250 VisualFactoryCache& mFactoryCache;
255 } // namespace Internal
257 inline const Internal::Visual::Base& GetImplementation(const Toolkit::Visual::Base& visualBase )
259 DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
261 const BaseObject& handle = visualBase.GetBaseObject();
263 return static_cast<const Internal::Visual::Base&>(handle);
266 inline Internal::Visual::Base& GetImplementation(Toolkit::Visual::Base& visualBase)
268 DALI_ASSERT_ALWAYS( visualBase && "visual base handle is empty" );
270 BaseObject& handle = visualBase.GetBaseObject();
272 return static_cast<Internal::Visual::Base&>(handle);
275 } // namespace Toolkit
279 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_H