1 #ifndef DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_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.
22 #include <dali/public-api/common/intrusive-ptr.h>
23 #include <dali/public-api/rendering/geometry.h>
26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
35 typedef IntrusivePtr<BorderVisual> BorderVisualPtr;
38 * The visual which renders a solid color to the control's quad border fixed to a specified size.
40 * The following properties are required for create a BorderRender
42 * | %Property Name | Type |
43 * |-----------------|-------------|
44 * | borderColor | VECTOR4 |
45 * | borderSize | FLOAT |
46 * | antiAliasing | BOOLEAN |
48 class BorderVisual : public Visual::Base
52 * @brief Create a new border visual.
54 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
55 * @param[in] properties A Property::Map containing settings for this visual
56 * @return A smart-pointer to the newly allocated visual.
58 static BorderVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
64 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
66 BorderVisual(VisualFactoryCache& factoryCache);
69 * @brief A reference counted object may only be deleted by calling Unreference().
71 virtual ~BorderVisual();
74 * @copydoc Visual::Base::OnInitialize
76 void OnInitialize() override;
79 * @copydoc Visual::Base::DoSetProperties
81 void DoSetProperties(const Property::Map& propertyMap) override;
84 * @copydoc Visual::Base::DoSetOnScene
86 void DoSetOnScene(Actor& actor) override;
89 * @copydoc Visual::Base::CreatePropertyMap
91 void DoCreatePropertyMap(Property::Map& map) const override;
94 * @copydoc Visual::Base::CreateInstancePropertyMap
96 void DoCreateInstancePropertyMap(Property::Map& map) const override;
99 * @copydoc Visual::Base::OnSetTransform
101 void OnSetTransform() override;
105 * Request the border shader from the factory cache. If fail, create tha shader and add it to cache.
106 * @return The border shader.
108 Shader GetBorderShader();
111 * Create the geometry which presents the border.
112 * @return The border geometry
114 Geometry CreateBorderGeometry();
117 * Helper method to set individual values by index key.
118 * @param[in] index The index key of the value
119 * @param[in] value The value
121 void DoSetProperty(Property::Index index, const Property::Value& value);
124 BorderVisual(const BorderVisual& borderRenderer);
127 BorderVisual& operator=(const BorderVisual& borderRenderer);
130 Vector4 mBorderColor;
133 Property::Index mBorderColorIndex;
134 Property::Index mBorderSizeIndex;
139 } // namespace Internal
141 } // namespace Toolkit
145 #endif // DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H