#define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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/devel-api/object/weak-handle.h>
-#include <dali/public-api/common/intrusive-ptr.h>
+#include <dali/public-api/object/base-object.h>
+#include <dali/public-api/object/weak-handle.h>
// INTERNAL INCLUDES
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
-#include <dali-toolkit/internal/text/rendering/text-renderer.h>
+#include <dali-toolkit/internal/text/rendering/text-typesetter.h>
#include <dali-toolkit/internal/text/text-controller.h>
namespace Dali
* | 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;
+ };
+
+ /**
+ * @brief Instantly updates the renderer
+ * @param[in] visual The text visual.
+ */
+ static void UpdateRenderer( Toolkit::Visual::Base visual )
+ {
+ GetVisualObject( visual ).UpdateRenderer();
+ };
public: // from Visual::Base
/**
* @copydoc Visual::Base::GetHeightForWidth()
*/
- virtual float GetHeightForWidth( float width ) const;
+ float GetHeightForWidth( float width ) override;
/**
* @copydoc Visual::Base::GetNaturalSize()
*/
- virtual void GetNaturalSize( Vector2& naturalSize );
+ void GetNaturalSize( Vector2& naturalSize ) override;
/**
* @copydoc Visual::Base::CreatePropertyMap()
*/
- virtual void DoCreatePropertyMap( Property::Map& map ) const;
+ void DoCreatePropertyMap( Property::Map& map ) const override;
+
+ /**
+ * @copydoc Visual::Base::CreateInstancePropertyMap
+ */
+ void DoCreateInstancePropertyMap( Property::Map& map ) const override;
protected:
/**
* @copydoc Visual::Base::DoSetProperties()
*/
- virtual void DoSetProperties( const Property::Map& propertyMap );
+ void DoSetProperties( const Property::Map& propertyMap ) override;
/**
* @copydoc Visual::Base::DoSetOnStage()
*/
- virtual void DoSetOnStage( Actor& actor );
+ void DoSetOnStage( Actor& actor ) override;
/**
* @copydoc Visual::Base::DoSetOffStage()
*/
- virtual void DoSetOffStage( Actor& actor );
+ void DoSetOffStage( Actor& actor ) override;
/**
- *@copydoc Visual::Base::DoSetProperty
+ * @copydoc Visual::Base::OnSetTransform
*/
- virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
+ void OnSetTransform() override;
+private:
/**
- * @copydoc Visual::Base::DoGetProperty
+ * @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.
*/
- virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
+ void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
/**
- * @copydoc Visual::Base::OnSetTransform
+ * @brief Updates the text's renderer.
*/
- virtual void OnSetTransform();
+ void UpdateRenderer();
-private:
+ /**
+ * @brief Removes the texture set from the renderer.
+ */
+ void RemoveTextureSet();
+
+ /**
+ * Get the texture of the text for rendering.
+ * @param[in] size The texture size.
+ * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
+ * @param[in] containsColorGlyph Whether the text contains color glyph.
+ * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
+ */
+ TextureSet GetTextTexture( const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled );
/**
- * @brief Render view, create and attach actor(s) to this TextView.
- * @todo In a next patch a new text render back-end won't add extra actors.
+ * Get the text rendering shader.
+ * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
+ * @param[in] containsColorGlyph Whether the text contains color glyph.
+ * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
*/
- void RenderText();
+ Shader GetTextShader( VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled );
+
+ /**
+ * @brief Retrieve the TextVisual object.
+ * @param[in] visual A handle to the TextVisual
+ * @return The TextVisual object
+ */
+ static TextVisual& GetVisualObject( Toolkit::Visual::Base visual )
+ {
+ return static_cast< TextVisual& >( Toolkit::GetImplementation( visual ).GetVisualObject() );
+ };
private:
- Text::ControllerPtr mController; ///< The text's controller.
- WeakHandle<Actor> mSelf;
- Text::RendererPtr mRenderer;
- Actor mRenderableActor;
+ /**
+ * Used as an alternative to boolean so that it is obvious whether the text contains single or multiple text colors, and emoji and styles.
+ */
+ struct TextType
+ {
+ enum Type
+ {
+ SINGLE_COLOR_TEXT = 0, ///< The text contains single color only.
+ MULTI_COLOR_TEXT = 1, ///< The text contains multiple colors.
+ NO_EMOJI = 0, ///< The text contains no emoji.
+ HAS_EMOJI = 1, ///< The text contains emoji.
+ NO_STYLES = 0, ///< The text contains contains no styles.
+ HAS_SYLES = 1 ///< The text contains contains styles.
+ };
+ };
- int mRenderingBackend;
- bool mHasBeenStaged : 1;
+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.
+ 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