X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Ftext%2Ftext-visual.h;h=f1d7e12ca328f96d406fba75d898bc8addf83999;hp=f3d9516c05f0f2be3a008e830ccfc87fe9bd5824;hb=8641983679bb074a9951c2df9fff7ac6cbf5f5f2;hpb=572b3ce4fcbd558fbe6a642ad3441b0a3c41e01f diff --git a/dali-toolkit/internal/visuals/text/text-visual.h b/dali-toolkit/internal/visuals/text/text-visual.h index f3d9516..f1d7e12 100644 --- a/dali-toolkit/internal/visuals/text/text-visual.h +++ b/dali-toolkit/internal/visuals/text/text-visual.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -18,6 +18,10 @@ * */ +// EXTERNAL INCLUDES +#include +#include + // INTERNAL INCLUDES #include #include @@ -60,7 +64,6 @@ typedef IntrusivePtr< TextVisual > TextVisualPtr; * | underline | STRING | * | shadow | STRING | * | outline | STRING | - * | batchingEnabled | BOOLEAN | * */ class TextVisual : public Visual::Base @@ -71,16 +74,61 @@ public: * @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; + virtual float GetHeightForWidth( float width ); /** * @copydoc Visual::Base::GetNaturalSize() @@ -92,6 +140,11 @@ public: // from Visual::Base */ virtual void DoCreatePropertyMap( Property::Map& map ) const; + /** + * @copydoc Visual::Base::CreateInstancePropertyMap + */ + virtual void DoCreateInstancePropertyMap( Property::Map& map ) const; + protected: /** @@ -129,29 +182,77 @@ 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 ); /** - * 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 Updates the text's renderer. */ - void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ); + void UpdateRenderer(); /** - * @brief Creates the text's renderer. + * @brief Removes the texture set from the renderer. */ - void CreateRenderer(); + 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 ); + + /** + * 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.). + */ + 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: /** - * @brief Destroys the text's renderer. + * Used as an alternative to boolean so that it is obvious whether the text contains single or multiple text colors, and emoji and styles. */ - void DestroyRenderer(); + struct TextType + { + enum Type + { + SINGLE_COLOR_TEXT = 0, ///< The text contains single color only. + MULTI_COLOR_TEXT = 1, ///< The text contains multiple colorｓ. + 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. + }; + }; private: - Text::ControllerPtr mController; ///< The text's controller. - Text::TypesetterPtr mTypesetter; ///< The text's typesetter. - WeakHandle mControl; ///< The control where the renderer is added. + Text::ControllerPtr mController; ///< The text's controller. + Text::TypesetterPtr mTypesetter; ///< The text's typesetter. + WeakHandle 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