1 #ifndef DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H
5 * Copyright (c) 2019 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/rendering/geometry.h>
23 #include <dali/public-api/common/intrusive-ptr.h>
26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
38 typedef IntrusivePtr< BorderVisual > BorderVisualPtr;
41 * The visual which renders a solid color to the control's quad border fixed to a specified size.
43 * The following properties are required for create a BorderRender
45 * | %Property Name | Type |
46 * |-----------------|-------------|
47 * | borderColor | VECTOR4 |
48 * | borderSize | FLOAT |
49 * | antiAliasing | BOOLEAN |
51 class BorderVisual : public Visual::Base
56 * @brief Create a new border visual.
58 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
59 * @param[in] properties A Property::Map containing settings for this visual
60 * @return A smart-pointer to the newly allocated visual.
62 static BorderVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
69 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
71 BorderVisual( VisualFactoryCache& factoryCache );
74 * @brief A reference counted object may only be deleted by calling Unreference().
76 virtual ~BorderVisual();
79 * @copydoc Visual::Base::DoSetProperties
81 void DoSetProperties( const Property::Map& propertyMap ) override;
84 * @copydoc Visual::Base::DoSetOnStage
86 void DoSetOnStage( 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;
106 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
108 void InitializeRenderer();
111 * Request the border shader from the factory cache. If fail, create tha shader and add it to cache.
112 * @return The border shader.
114 Shader GetBorderShader();
117 * Create the geometry which presents the border.
118 * @return The border geometry
120 Geometry CreateBorderGeometry();
123 * Helper method to set individual values by index key.
124 * @param[in] index The index key of the value
125 * @param[in] value The value
127 void DoSetProperty( Property::Index index, const Property::Value& value );
130 BorderVisual( const BorderVisual& borderRenderer );
133 BorderVisual& operator=( const BorderVisual& borderRenderer );
137 Vector4 mBorderColor;
140 Property::Index mBorderColorIndex;
141 Property::Index mBorderSizeIndex;
146 } // namespace Internal
148 } // namespace Toolkit
152 #endif // DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H