1 #ifndef DALI_TOOLKIT_INTERNAL_COLOR_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_COLOR_VISUAL_H
5 * Copyright (c) 2020 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/common/intrusive-ptr.h>
25 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
37 typedef IntrusivePtr< ColorVisual > ColorVisualPtr;
40 * The visual which renders a solid color to the control's quad
42 * The following properties are required for create a ColorRender
44 * | %Property Name | Type |
45 * |-----------------|-------------|
46 * | mixColor | VECTOR4 |
48 class ColorVisual: public Visual::Base
53 * @brief Create a new color visual.
55 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
56 * @param[in] properties A Property::Map containing settings for this visual
57 * @return A smart-pointer to the newly allocated visual.
59 static ColorVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
61 public: // from Visual
64 * @copydoc Visual::Base::CreatePropertyMap
66 void DoCreatePropertyMap( Property::Map& map ) const override;
69 * @copydoc Visual::Base::CreateInstancePropertyMap
71 void DoCreateInstancePropertyMap( Property::Map& map ) const override;
78 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
80 ColorVisual( VisualFactoryCache& factoryCache );
83 * @brief A reference counted object may only be deleted by calling Unreference().
85 virtual ~ColorVisual();
88 * @copydoc Visual::Base::DoSetProperties
90 void DoSetProperties( const Property::Map& propertyMap ) override;
93 * @copydoc Visual::Base::DoSetOnScene
95 void DoSetOnScene( Actor& actor ) override;
98 * @copydoc Visual::Base::DoSetOffScene
100 void DoSetOffScene(Actor& actor) override;
103 * @copydoc Visual::Base::OnSetTransform
105 void OnSetTransform() override;
108 * @copydoc Visual::Base::OnDoAction
110 void OnDoAction( const Property::Index actionId, const Property::Value& attributes ) override;
113 * @copydoc Visual::Base::UpdateShader
115 void UpdateShader() override;
118 * @copydoc Visual::Base::OnGetPropertyObject
120 Dali::Property OnGetPropertyObject(Dali::Property::Key key) override;
124 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
126 void InitializeRenderer();
129 * @brief Get a shader for the current properties.
130 * @return The shader for the current properties.
137 ColorVisual( const ColorVisual& colorRenderer );
140 ColorVisual& operator=( const ColorVisual& colorRenderer );
143 float mBlurRadius; ///< The blur radius
144 Property::Index mBlurRadiusIndex; ///< The blur radius property index
145 bool mRenderIfTransparent; ///< Whether we should render even if the mix-color is transparent.
146 bool mNeedBlurRadius; ///< Whether we need the blur radius in shader.
149 } // namespace Internal
151 } // namespace Toolkit
155 #endif /* DALI_TOOLKIT_INTERNAL_COLOR_VISUAL_H */