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 * @return A smart-pointer to the newly allocated visual.
61 static BorderVisualPtr New( VisualFactoryCache& factoryCache );
68 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
70 BorderVisual( VisualFactoryCache& factoryCache );
73 * @brief A reference counted object may only be deleted by calling Unreference().
75 virtual ~BorderVisual();
78 * @copydoc Visual::Base::DoInitialize
80 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
83 * @copydoc Visual::Base::DoSetOnStage
85 virtual void DoSetOnStage( Actor& actor );
88 * @copydoc Visual::Base::CreatePropertyMap
90 virtual void DoCreatePropertyMap( Property::Map& map ) const;
93 * @copydoc Visual::Base::DoSetProperty
95 virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
98 * @copydoc Visual::Base::DoGetProperty
100 virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
105 * Set the color of the border.
106 * @param[in] color The border color.
108 void SetBorderColor( const Vector4& color);
111 * Set the size of the border.
112 * @param[in] size The border size.
114 void SetBorderSize( float size );
117 * Enable/Disable the anti-aliasing.
118 * @param[in] enable Whether the anti-aliasing be enabled or not.
120 void RequireAntiAliasing( bool antiAliasing );
125 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
127 void InitializeRenderer();
130 * Request the border shader from the factory cache. If fail, create tha shader and add it to cache.
131 * @return The border shader.
133 Shader GetBorderShader();
136 * Create the geometry which presents the border.
137 * @return The border geometry
139 Geometry CreateBorderGeometry();
142 BorderVisual( const BorderVisual& borderRenderer );
145 BorderVisual& operator=( const BorderVisual& borderRenderer );
149 Vector4 mBorderColor;
152 Property::Index mBorderColorIndex;
153 Property::Index mBorderSizeIndex;
158 } // namespace Internal
160 } // namespace Toolkit
164 #endif // DALI_TOOLKIT_INTERNAL_BORDER_VISUAL_H