1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H
5 * Copyright (c) 2021 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;
40 * @copydoc Toolkit::VisualFactory
42 class VisualFactory : public BaseObject
48 * @param[in] debugEnabled If true, use debug renderer to replace all the concrete renderer.
50 VisualFactory(bool debugEnabled);
53 * @brief StyleChanged callback
55 * @param[in] styleManager Handle for style manager.
56 * @param[in] type Style change type.
58 void OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type);
61 * @copydoc Toolkit::VisualFactory::CreateVisual( const Property::Map& )
63 Toolkit::Visual::Base CreateVisual(const Property::Map& propertyMap);
66 * @copydoc Toolkit::VisualFactory::CreateVisual( const std::string&, ImageDimensions )
68 Toolkit::Visual::Base CreateVisual(const std::string& image, ImageDimensions size);
71 * @copydoc Toolkit::VisualFactory::SetPreMultiplyOnLoad()
73 void SetPreMultiplyOnLoad(bool preMultiply);
76 * @copydoc Toolkit::VisualFactory::GetPreMultiplyOnLoad()
78 bool GetPreMultiplyOnLoad() const;
81 * @return the reference to texture manager
83 Internal::TextureManager& GetTextureManager();
87 * A reference counted object may only be deleted by calling Unreference()
89 ~VisualFactory() override;
93 * @brief Set the Broken Image url
96 void SetBrokenImageUrl(Toolkit::StyleManager& styleManager);
99 * Get the factory cache, creating it if necessary.
101 Internal::VisualFactoryCache& GetFactoryCache();
104 * Get the image visual shader factory, creating it if necessary.
106 ImageVisualShaderFactory& GetImageVisualShaderFactory();
108 VisualFactory(const VisualFactory&) = delete;
110 VisualFactory& operator=(const VisualFactory& rhs) = delete;
113 std::unique_ptr<VisualFactoryCache> mFactoryCache;
114 std::unique_ptr<ImageVisualShaderFactory> mImageVisualShaderFactory;
115 SlotDelegate<VisualFactory> mSlotDelegate;
116 bool mDebugEnabled : 1;
117 bool mPreMultiplyOnLoad : 1; ///< Local store for this flag
121 * @brief Template to allow discard old visual, get new one and set it on stage if possible
123 * @tparam ParameterType0 The type of first argument passed to the CreateVisual()
124 * @tparam ParameterType1 The type of second argument passed to the CreateVisual()
126 * @param[in] actor Actor for which the visual will be replaced
127 * @param[in,out] visual The visual to be replaced
128 * @param[in] param0 First template based argument passed to the visual factory
129 * @param[in] param1 Second template based argument passed to the visual factory
131 template<class ParameterType0, class ParameterType1>
132 void InitializeVisual(Actor& actor, Toolkit::Visual::Base& visual, ParameterType0& param0, ParameterType1& param1)
136 Toolkit::GetImplementation(visual).SetOffScene(actor);
138 visual = Toolkit::VisualFactory::Get().CreateVisual(param0, param1);
139 if(visual && actor && actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
141 Toolkit::GetImplementation(visual).SetOnScene(actor);
146 * @brief Template to allow discard old visual, get new one and set it on stage if possible
148 * @tparam ParameterType The type of argument passed to the CreateVisual()
150 * @param[in] actor Actor for which the visual will be replaced
151 * @param[in,out] visual The visual to be replaced
152 * @param[in] param Template based argument passed to the visual factory
154 template<class ParameterType>
155 void InitializeVisual(Actor& actor, Toolkit::Visual::Base& visual, ParameterType& param)
159 Toolkit::GetImplementation(visual).SetOffScene(actor);
161 visual = Toolkit::VisualFactory::Get().CreateVisual(param);
162 if(visual && actor && actor.GetProperty<bool>(Actor::Property::CONNECTED_TO_SCENE))
164 Toolkit::GetImplementation(visual).SetOnScene(actor);
168 } // namespace Internal
170 inline const Internal::VisualFactory& GetImplementation(const Toolkit::VisualFactory& factory)
172 DALI_ASSERT_ALWAYS(factory && "VisualFactory handle is empty");
174 const BaseObject& handle = factory.GetBaseObject();
176 return static_cast<const Internal::VisualFactory&>(handle);
179 inline Internal::VisualFactory& GetImplementation(Toolkit::VisualFactory& factory)
181 DALI_ASSERT_ALWAYS(factory && "VisualFactory handle is empty");
183 BaseObject& handle = factory.GetBaseObject();
185 return static_cast<Internal::VisualFactory&>(handle);
188 } // namespace Toolkit
192 #endif /* DALI_TOOLKIT_VISUAL_FACTORY_IMPL_H */