1 #ifndef DALI_TOOLKIT_VISUAL_BASE_H
2 #define DALI_TOOLKIT_VISUAL_BASE_H
4 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include <dali/public-api/object/base-handle.h>
22 #include <dali/public-api/actors/actor.h>
25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
26 #include <dali-toolkit/public-api/visuals/visual-properties.h>
34 namespace Internal DALI_INTERNAL
46 * @brief A Visual provides a renderer for drawing a control component. A control may have multiple visuals.
48 * Visuals reuse geometry, shader etc. across controls. They ensure that the renderer and texture sets exist only when control is on-stage.
49 * Each visual also responds to actor size and color change, and provides clipping at the renderer level.
50 * Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
52 * The following properties are optional, but can be supplied in the property map to Dali::Toolkit::VisualFactory::CreateVisual().
54 * | %Property Name | Type |
55 * |-------------------------|------------------|
56 * | customShader | MAP |
59 * where \b customShader is a map with at least one of the following properties:
60 * | %Property Name | Type | Required | Default | Description |
61 * |-------------------------|----------------------------|----------|---------|-----------------------------------------|
62 * | vertexShader | STRING | No | "" | Vertex shader code |
63 * | fragmentShader | STRING | No | "" | Fragment shader code |
64 * | subdivideGridX | INTEGER | No | 1 | How to subdivide the grid along X |
65 * | subdivideGridY | INTEGER | No | 1 | How to subdivide the grid along Y |
66 * | shaderHints | INTEGER or ARRAY of STRING | No | NONE | Bitmask of hints @sa Dali::Shader::Hint |
68 * and \b transform is a map with the following properties:
69 * | %Property Name | Type | Required | Default | Description |
70 * |-------------------------|-------------------|----------|------------------------|-----------------------------------------------------|
71 * | offset | VECTOR2 | No | (0,0) | Offset of visual from origin |
72 * | size | VECTOR2 | No | (1,1) | size of visual |
73 * | origin | INTEGER or STRING | No | CENTER | origin of the visual @sa Dali::Toolkit::Align |
74 * | anchorPoint | INTEGER or STRING | No | CENTER | anchor point of the visual @sa Dali::Toolkit::Align |
75 * | offsetPolicy | VECTOR2 | No | ( RELATIVE, RELATIVE ) | @sa Dali::Toolkit::Visual::Transform::Policy |
76 * | sizePolicy | VECTOR2 | No | ( RELATIVE, RELATIVE ) | @sa Dali::Toolkit::Visual::Transform::Policy |
78 * Relative means that the component describes a factor of the parent control size;
79 * size.x = 1 means full width; size.y = 0.5 means half height.
81 * Absolute means that the component describes world units (equivalent to pixels)
84 class DALI_TOOLKIT_API Base : public BaseHandle
89 * @brief Create an empty Visual Handle
96 * This is non-virtual since derived Handle types must not contain data or virtual methods.
101 * @brief This copy constructor is required for (smart) pointer semantics.
103 * @param[in] handle A reference to the copied handle.
105 Base( const Base& handle );
108 * @brief This assignment operator is required for (smart) pointer semantics.
110 * @param [in] handle A reference to the copied handle.
111 * @return A reference to this.
113 Base& operator=( const Base& handle );
116 * @brief Set the name of the visual
118 * Used by the styling system to animate properties
119 * @param[in] name The name to give the visual
121 void SetName( const std::string& name );
124 * @brief Get the name of the visual
126 * Used by the styling system to animate properties
127 * @return The name of the visual
129 const std::string& GetName() const;
132 * @brief Sets the transform and the control size
134 * @param[in] transform A property map describing the transform
135 * @param[in] controlSize The size of the parent control for visuals that need to scale internally.
137 void SetTransformAndSize( const Dali::Property::Map& transform, Size controlSize );
140 * @brief Returns the height for a given width.
142 * @param[in] width Width to use.
144 * @return The height based on the width.
146 float GetHeightForWidth( float width );
149 * @brief Returns the width for a given height.
151 * @param[in] height Height to use.
153 * @return The width based on the height.
155 float GetWidthForHeight( float height );
158 * @brief Return the natural size of the visual.
160 * Deriving classes stipulate the natural size and by default a
161 * visual has a ZERO natural size.
163 * @note A visual may not actually have a natural size until it has
164 * been placed on stage and acquired all it's resources.
166 * @param[out] naturalSize The visual's natural size
168 void GetNaturalSize( Vector2& naturalSize );
171 * @brief Set the depth index of this visual.
173 * Depth-index controls draw-order for overlapping visuals.
174 * Visuals with higher depth indices are rendered in front of other visual with smaller values
176 * @param[in] index The depth index of this visual.
178 void SetDepthIndex( int index );
181 * @brief Get the depth index of this visual
183 * @return The depth index of this visual.
185 int GetDepthIndex() const;
188 * @brief Create the property map representing this visual.
190 * @param[out] map The visual property map.
192 void CreatePropertyMap( Dali::Property::Map& map ) const;
195 * @brief Get the type of this visual.
197 * @return The the type of this visual.
199 Visual::Type GetType() const;
201 public: // Not intended for application developers
203 explicit DALI_INTERNAL Base(Internal::Visual::Base *impl);
207 } // namespace Visual
209 } // namespace Toolkit
213 #endif /*DALI_TOOLKIT_VISUAL_BASE_H*/