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=6f47e45180e2330993a5c5a6b62240737b2c1ec2;hp=ebeb867edf87f1c0b137bbe44c440b6cad834d51;hb=fedd5ae8da46cd798f730fd07c942df853e055dd;hpb=b4350fdb64e7c6513f49e451b56c08adbe83df92 diff --git a/dali-toolkit/internal/visuals/text/text-visual.h b/dali-toolkit/internal/visuals/text/text-visual.h index ebeb867..6f47e45 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) 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. @@ -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 @@ -76,22 +79,71 @@ public: */ 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 ); + 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: @@ -112,22 +164,22 @@ 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::OnSetTransform */ - virtual void OnSetTransform(); + void OnSetTransform() override; private: /** @@ -141,19 +193,66 @@ private: /** * @brief Updates the text's renderer. - * @param[in] initializeRendererAndTexture Set flag to true to initialize textures and add renderer to control. */ - void UpdateRenderer( bool initializeRendererAndTexture ); + void UpdateRenderer(); /** * @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 ); + + /** + * 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: + + /** + * 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 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