1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H
5 * Copyright (c) 2022 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.
21 #include <dali/public-api/object/base-object.h>
24 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
25 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
26 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
27 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
28 #include <dali-toolkit/public-api/styling/style-manager.h>
36 class VisualFactoryCache;
37 class ImageVisualShaderFactory;
38 class TextVisualShaderFactory;
41 * @copydoc Toolkit::VisualFactory
43 class VisualFactory : public BaseObject
49 * @param[in] debugEnabled If true, use debug renderer to replace all the concrete renderer.
51 VisualFactory(bool debugEnabled);
54 * @brief StyleChanged callback
56 * @param[in] styleManager Handle for style manager.
57 * @param[in] type Style change type.
59 void OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type);
62 * @brief BrokenImageChanged callback
64 * @param[in] styleManager Handle for style manager.
66 void OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager);
69 * @copydoc Toolkit::VisualFactory::CreateVisual( const Property::Map& )
71 Toolkit::Visual::Base CreateVisual(const Property::Map& propertyMap);
74 * @copydoc Toolkit::VisualFactory::CreateVisual( const std::string&, ImageDimensions )
76 Toolkit::Visual::Base CreateVisual(const std::string& image, ImageDimensions size);
79 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
81 void SetPreMultiplyOnLoad(bool preMultiply);
84 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
86 bool GetPreMultiplyOnLoad() const;
89 * @return the reference to texture manager
91 Internal::TextureManager& GetTextureManager();
95 * A reference counted object may only be deleted by calling Unreference()
97 ~VisualFactory() override;
101 * @brief Set the Broken Image url
102 * @param[in] styleManager The instance of StyleManager
104 void SetBrokenImageUrl(Toolkit::StyleManager& styleManager);
107 * Get the factory cache, creating it if necessary.
109 Internal::VisualFactoryCache& GetFactoryCache();
112 * Get the image visual shader factory, creating it if necessary.
114 ImageVisualShaderFactory& GetImageVisualShaderFactory();
117 * Get the text visual shader factory, creating it if necessary.
119 TextVisualShaderFactory& GetTextVisualShaderFactory();
121 VisualFactory(const VisualFactory&) = delete;
123 VisualFactory& operator=(const VisualFactory& rhs) = delete;
126 std::unique_ptr<VisualFactoryCache> mFactoryCache;
127 std::unique_ptr<ImageVisualShaderFactory> mImageVisualShaderFactory;
128 std::unique_ptr<TextVisualShaderFactory> mTextVisualShaderFactory;
129 SlotDelegate<VisualFactory> mSlotDelegate;
130 bool mDebugEnabled : 1;
131 bool mPreMultiplyOnLoad : 1; ///< Local store for this flag
135 * @brief Template to allow discard old visual, get new one and set it on stage if possible
137 * @tparam ParameterType0 The type of first argument passed to the CreateVisual()
138 * @tparam ParameterType1 The type of second argument passed to the CreateVisual()
140 * @param[in] actor Actor for which the visual will be replaced
141 * @param[in,out] visual The visual to be replaced
142 * @param[in] param0 First template based argument passed to the visual factory
143 * @param[in] param1 Second template based argument passed to the visual factory
145 template<class ParameterType0, class ParameterType1>
146 void InitializeVisual(Actor& actor, Toolkit::Visual::Base& visual, ParameterType0& param0, ParameterType1& param1)
150 Toolkit::GetImplementation(visual).SetOffScene(actor);
152 visual = Toolkit::VisualFactory::Get().CreateVisual(param0, param1);
153 if(visual && actor && actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
155 Toolkit::GetImplementation(visual).SetOnScene(actor);
160 * @brief Template to allow discard old visual, get new one and set it on stage if possible
162 * @tparam ParameterType The type of argument passed to the CreateVisual()
164 * @param[in] actor Actor for which the visual will be replaced
165 * @param[in,out] visual The visual to be replaced
166 * @param[in] param Template based argument passed to the visual factory
168 template<class ParameterType>
169 void InitializeVisual(Actor& actor, Toolkit::Visual::Base& visual, ParameterType& param)
173 Toolkit::GetImplementation(visual).SetOffScene(actor);
175 visual = Toolkit::VisualFactory::Get().CreateVisual(param);
176 if(visual && actor && actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
178 Toolkit::GetImplementation(visual).SetOnScene(actor);
182 } // namespace Internal
184 inline const Internal::VisualFactory& GetImplementation(const Toolkit::VisualFactory& factory)
186 DALI_ASSERT_ALWAYS(factory && "VisualFactory handle is empty");
188 const BaseObject& handle = factory.GetBaseObject();
190 return static_cast<const Internal::VisualFactory&>(handle);
193 inline Internal::VisualFactory& GetImplementation(Toolkit::VisualFactory& factory)
195 DALI_ASSERT_ALWAYS(factory && "VisualFactory handle is empty");
197 BaseObject& handle = factory.GetBaseObject();
199 return static_cast<Internal::VisualFactory&>(handle);
202 } // namespace Toolkit
206 #endif /* DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H */