#define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
*/
+// EXTERNAL INCLUDES
+#include <dali/public-api/object/base-object.h>
+
// INTERNAL INCLUDES
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
#include <dali-toolkit/internal/text/rendering/text-typesetter.h>
* | underline | STRING |
* | shadow | STRING |
* | outline | STRING |
- * | batchingEnabled | BOOLEAN |
*
*/
class TextVisual : public Visual::Base
* @brief Create a new text visual.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] properties A Property::Map containing settings for this visual
* @return A smart-pointer to the newly allocated visual.
*/
- static TextVisualPtr New( VisualFactoryCache& factoryCache );
+ static TextVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
+
+ /**
+ * @brief Converts all strings keys in property map to index keys. Property Map can then be merged correctly.
+ * @param[in,out] propertyMap containing string keys or a mix of strings and indexes. Will be changed to index keys.
+ */
+ static void ConvertStringKeysToIndexKeys( Property::Map& propertyMap );
+
+ /**
+ * @brief Retrieve the text's controller.
+ * @param[in] visual The text visual.
+ * @return The text controller
+ */
+ static Text::ControllerPtr GetController( Toolkit::Visual::Base visual )
+ {
+ return GetVisualObject( visual ).mController;
+ };
+
+ /**
+ * @brief Set the index of the animatable text color property.
+ * @param[in] visual The text visual.
+ * @param[in] animatablePropertyIndex The index of the animatable property
+ */
+ static void SetAnimatableTextColorProperty( Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex )
+ {
+ GetVisualObject( visual ).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
+ };
+
+ /**
+ * @brief Set the flag to trigger the textures to be initialized and renderer to be added to the control.
+ * @param[in] visual The text visual.
+ */
+ static void EnableRendererUpdate( Toolkit::Visual::Base visual )
+ {
+ GetVisualObject( visual ).mRendererUpdateNeeded = true;
+ };
public: // from Visual::Base
/**
* @copydoc Visual::Base::GetHeightForWidth()
*/
- virtual float GetHeightForWidth( float width ) const;
+ virtual float GetHeightForWidth( float width );
/**
* @copydoc Visual::Base::GetNaturalSize()
*/
virtual void DoCreatePropertyMap( Property::Map& map ) const;
+ /**
+ * @copydoc Visual::Base::CreateInstancePropertyMap
+ */
+ virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
+
protected:
/**
virtual void OnSetTransform();
private:
+ /**
+ * @brief Set the individual property to the given value.
+ *
+ * @param[in] index The index key used to reference this value within the initial property map.
+ *
+ * @param[in] propertyValue The value to set.
+ */
+ void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
+
+ /**
+ * @brief Updates the text's renderer.
+ */
+ void UpdateRenderer();
/**
- * Set the individual property to the given value
- * @param[in] index The index key used to reference this value within the initial
- * property map.
- * @param[in] propertyValue The value to set
+ * @brief Removes the texture set from the renderer.
*/
- void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
+ void RemoveTextureSet();
/**
- * @brief Creates the text's renderer.
+ * Get the text rendering shader.
+ * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] isRgbaTexture Whether the texture is in RGBA format.
*/
- void CreateRenderer();
+ Shader GetTextShader( VisualFactoryCache& factoryCache, bool isRgbaTexture );
/**
- * @brief Destroys the text's renderer.
+ * @brief Retrieve the text's controller.
+ * @param[in] visual The text visual.
+ * @return The text controller
*/
- void DestroyRenderer();
+ static TextVisual& GetVisualObject( Toolkit::Visual::Base visual )
+ {
+ return static_cast<TextVisual&>( visual.GetBaseObject() );
+ };
private:
- Text::ControllerPtr mController; ///< The text's controller.
- Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
- WeakHandle<Actor> mControl; ///< The control where the renderer is added.
+ Text::ControllerPtr mController; ///< The text's controller.
+ Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
+ WeakHandle<Actor> mControl; ///< The control where the renderer is added.
+ Property::Index mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
+ bool mRendererUpdateNeeded:1; ///< The flag to indicate whether the renderer needs to be updated.
};
} // namespace Internal