1 #ifndef DALI_TOOLKIT_VISUAL_BASE_H
2 #define DALI_TOOLKIT_VISUAL_BASE_H
4 * Copyright (c) 2016 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>
30 namespace Internal DALI_INTERNAL
41 * @brief Visual provides a renderer for rendering the controls. A control may have multiple visuals.
43 * Visuals reuses geometry, shader etc. across controls and manages the renderer and texture sets to exist only when control is on-stage.
44 * It also responds to actor size and color change, and provides the clipping at the renderer level.
45 * Note: The visual responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
47 class DALI_IMPORT_API Base : public BaseHandle
52 * @brief Create an empty Visual Handle
59 * This is non-virtual since derived Handle types must not contain data or virtual methods.
64 * @brief This copy constructor is required for (smart) pointer semantics.
66 * @param[in] handle A reference to the copied handle.
68 Base( const Base& handle );
71 * @brief This assignment operator is required for (smart) pointer semantics.
73 * @param [in] handle A reference to the copied handle.
74 * @return A reference to this.
76 Base& operator=( const Base& handle );
79 * @brief Set the name of the visual
81 * Used by the styling system to animate properties
82 * @param[in] name The name to give the visual
84 void SetName( const std::string& name );
87 * @brief Get the name of the visual
89 * Used by the styling system to animate properties
90 * @return The name of the visual
92 const std::string& GetName();
95 * @brief Set the size of the painting area.
97 * @param[in] size The size of the painting area.
99 void SetSize( const Vector2& size );
102 * @brief Get the size of the painting area.
104 * @return The size of the visual's painting area.
106 const Vector2& GetSize() const;
109 * @brief Returns the height for a given width.
111 * @param[in] width Width to use.
113 * @return The height based on the width.
115 float GetHeightForWidth( float width ) const;
118 * @brief Return the natural size of the visual.
120 * Deriving classes stipulate the natural size and by default a visual has a ZERO natural size.
122 * @param[out] naturalSize The visual's natural size
124 void GetNaturalSize( Vector2& naturalSize ) const;
127 * @brief Set the depth index of this visual.
129 * Depth-index controls draw-order for overlapping visuals.
130 * Visuals with higher depth indices are rendered in front of other visual with smaller values
132 * @param[in] index The depth index of this visual.
134 void SetDepthIndex( float index );
137 * @brief Get the depth index of this visual
139 * @return The depth index of this visual.
141 float GetDepthIndex() const;
144 * @brief Visual needs to know when the control is put on to the stage to add the renderer.
146 * This function should be called when the control is put on to the stage.
148 * @param[in] actor The actor using this visual.
149 * @post SetOffStage should be called with the same actor when the control is put off stage otherwise memory will be leaked
151 void SetOnStage( Actor& actor );
154 * @brief Visual needs to know when the control is removed from the stage to remove the renderer.
156 * This function should be called when the control is removed from the stage
158 * @param[in] actor The actor using this visual.
160 void SetOffStage( Actor& actor );
163 * @brief Remove the renderer from the actor and reset the visual self.
165 * This function can be called with an empty handle. If the visual is empty, this is a no-op.
167 * @param[in] actor The actor to be set off stage.
169 void RemoveAndReset( Actor& actor );
172 * @brief Create the property map representing this visual.
174 * @param[out] map The visual property map.
176 void CreatePropertyMap( Dali::Property::Map& map ) const;
179 * @brief Sets the value of an existing property.
181 * @param [in] index The index of the property.
182 * @param [in] propertyValue The new value of the property.
184 void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
187 * @brief Retrieves a property value.
189 * @param [in] index The index of the property.
191 * @return The property value.
193 Dali::Property::Value GetProperty( Dali::Property::Index index );
195 public: // Not intended for application developers
197 explicit DALI_INTERNAL Base(Internal::Visual::Base *impl);
201 } // namespace Visual
203 } // namespace Toolkit
207 #endif /*DALI_TOOLKIT_VISUAL_BASE_H*/