1 #ifndef DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H
5 * Copyright (c) 2016 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 virtual void DoSetProperties( const Property::Map& propertyMap );
84 * @copydoc Visual::Base::DoSetOnStage
86 virtual void DoSetOnStage( Actor& actor );
89 * @copydoc Visual::Base::CreatePropertyMap
91 virtual void DoCreatePropertyMap( Property::Map& map ) const;
94 * @copydoc Visual::Base::CreateInstancePropertyMap
96 virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
99 * @copydoc Visual::Base::OnSetTransform
101 virtual void OnSetTransform();
106 * Set the color of the border.
107 * @param[in] color The border color.
109 void SetBorderColor( const Vector4& color);
112 * Set the size of the border.
113 * @param[in] size The border size.
115 void SetBorderSize( float size );
118 * Enable/Disable the anti-aliasing.
119 * @param[in] enable Whether the anti-aliasing be enabled or not.
121 void RequireAntiAliasing( bool antiAliasing );
126 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
128 void InitializeRenderer();
131 * Request the border shader from the factory cache. If fail, create tha shader and add it to cache.
132 * @return The border shader.
134 Shader GetBorderShader();
137 * Create the geometry which presents the border.
138 * @return The border geometry
140 Geometry CreateBorderGeometry();
143 * Helper method to set individual values by index key.
144 * @param[in] index The index key of the value
145 * @param[in] value The value
147 void DoSetProperty( Property::Index index, const Property::Value& value );
150 BorderVisual( const BorderVisual& borderRenderer );
153 BorderVisual& operator=( const BorderVisual& borderRenderer );
157 Vector4 mBorderColor;
160 Property::Index mBorderColorIndex;
161 Property::Index mBorderSizeIndex;
166 } // namespace Internal
168 } // namespace Toolkit
172 #endif // DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H