/**
* @brief ControlRenderer provides renderer for rendering the controls. A control may have multiple ControlRenders.
*
- * ControlRenderers reuses geometry, shader etc. across controls and manages the renderer and material to exist only when control is on-stage.
+ * ControlRenderers reuses geometry, shader etc. across controls and manages the renderer and texture sets to exist only when control is on-stage.
* It also responds to actor size and color change, and provides the clipping at the renderer level.
* Note: The control renderer responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
*/
void SetSize( const Vector2& size );
/**
+ * @brief Get the size of the painting area.
+ *
+ * @return The size of the renderer's painting area.
+ */
+ const Vector2& GetSize() const;
+
+ /**
+ * @brief Return the natural size of the renderer.
+ *
+ * Deriving classes stipulate the natural size and by default a renderer has a ZERO natural size.
+ *
+ * @param[out] naturalSize The renderer's natural size
+ */
+ void GetNaturalSize( Vector2& naturalSize ) const;
+
+ /**
* @brief Set the depth index of this renderer.
*
* Depth-index controls draw-order for overlapping renderers.
* Renderer with higher depth indices are rendered in front of other renderer with smaller values
*
- * @param[in] depthIndex The depth index of this renderer.
+ * @param[in] index The depth index of this renderer.
*/
void SetDepthIndex( float index );
/**
+ * @brief Get the depth index of this renderer
+ *
+ * @return The depth index of this renderer.
+ */
+ float GetDepthIndex() const;
+
+ /**
* @brief Renderer only exists when control is on stage.
*
* This function should be called when the control put on stage.
*
* @param[in] actor The actor applying this renderer.
+ * @post SetOffStage should be called with the same actor when the control is put off stage otherwise memory will be leaked
*/
void SetOnStage( Actor& actor );
void SetOffStage( Actor& actor );
/**
+ * @brief Remove the renderer from actor and reset the control renderer self.
+ *
+ * This function can be called with an empty handle. If the control renderer is empty, do nothing.
+ *
+ * @param[in] actor The actor to be set off stage.
+ */
+ void RemoveAndReset( Actor& actor );
+
+ /**
* @brief Create the property map representing this renderer.
*
* @param[out] map The renderer property map.