dali-toolkit/internal/text/visual-model-impl.h

   1 #ifndef __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__
   2 #define __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23 #include <dali/public-api/common/intrusive-ptr.h>
  24 #include <dali/public-api/math/vector2.h>
  25 #include <dali/public-api/math/vector4.h>
  26 #include <dali/public-api/object/ref-object.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/internal/text/line-run.h>
  30 #include <dali-toolkit/internal/text/color-run.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Text
  39 {
  40
  41 class VisualModel;
  42 typedef IntrusivePtr<VisualModel> VisualModelPtr;
  43
  44 /**
  45  * @brief A visual text model contains layout specific information.
  46  *
  47  * This includes:
  48  * - A series of glyphs in visual order i.e. after the bidirectional reordering.
  49  * - The position of each glyph within a 2D bounding box.
  50  */
  51 class VisualModel : public RefObject
  52 {
  53 public:
  54
  55   /**
  56    * @brief Create a new instance of a VisualModel.
  57    *
  58    * @return A pointer to a new VisualModel.
  59    */
  60   static VisualModelPtr New();
  61
  62   // Glyph interface.
  63
  64   /**
  65    * @brief Creates the character to glyph conversion table.
  66    *
  67    * @pre The glyphs per character table needs to be created first.
  68    *
  69    * @param[in] numberOfCharacters The number of characters.
  70    */
  71   void CreateCharacterToGlyphTable( Length numberOfCharacters = 0u );
  72
  73   /**
  74    * @brief Creates an array containing the number of glyphs per character.
  75    *
  76    * @param[in] numberOfCharacters The number of characters.
  77    */
  78   void CreateGlyphsPerCharacterTable( Length numberOfCharacters = 0u );
  79
  80   /**
  81    * @brief Retrieves glyphs in the given buffer.
  82    *
  83    * The size of the @p glyphs buffer needs to be big enough to copy the @p numberOfGlyphs.
  84    * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
  85    * @param[in] glyphIndex Index to the first glyph.
  86    * @param[in] numberOfGlyphs Number of glyphs to be copied.
  87    */
  88   void GetGlyphs( GlyphInfo* glyphs,
  89                   GlyphIndex glyphIndex,
  90                   Length numberOfGlyphs ) const;
  91
  92   // Position interface
  93
  94   /**
  95    * @brief Retrieves the glyph positions.
  96    *
  97    * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions.
  98    * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
  99    * @param[in] glyphIndex Index to the first glyph position.
 100    * @param[in] numberOfGlyphs The number of positions to be copied.
 101    */
 102   void GetGlyphPositions( Vector2* glyphPositions,
 103                           GlyphIndex glyphIndex,
 104                           Length numberOfGlyphs ) const;
 105
 106   // Line interface.
 107
 108   /**
 109    * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out.
 110    *
 111    * @param[in] glyphIndex Index to the first glyph.
 112    * @param[in] numberOfGlyphs The number of glyph.
 113    * @param[out] firstLine Index to the line containing the glyph index.
 114    * @param[out] numberOfLines The number of lines.
 115    */
 116   void GetNumberOfLines( GlyphIndex glyphIndex,
 117                          Length numberOfGlyphs,
 118                          LineIndex& firstLine,
 119                          Length& numberOfLines ) const;
 120
 121   /**
 122    * @brief Retrieves the lines where the given range of glyphs is laid out.
 123    *
 124    * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
 125    *
 126    * @param[out] lines Pointer to a buffer where the lines are copied.
 127    * @param[in] glyphIndex Index to the first glyphs of the range.
 128    * @param[in] numberOfGlyphs Number of glyphs in the range.
 129    */
 130   void GetLinesOfGlyphRange( LineRun* lines,
 131                              GlyphIndex glyphIndex,
 132                              Length numberOfGlyphs ) const;
 133
 134   /**
 135    * @brief Retrieves the line index where the character is laid-out.
 136    *
 137    * @param[in] characterIndex The character's index.
 138    *
 139    * @return The line index.
 140    */
 141   LineIndex GetLineOfCharacter( CharacterIndex characterIndex );
 142
 143   // Underline runs
 144
 145   /**
 146    * @brief Retrieves the underline runs.
 147    *
 148    * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
 149    * @param[in] index Index of the first underline run to be copied.
 150    * @param[in] numberOfRuns Number of underline runs to be copied.
 151    */
 152   void GetUnderlineRuns( GlyphRun* underlineRuns,
 153                          UnderlineRunIndex index,
 154                          Length numberOfRuns ) const;
 155
 156   // Size interface
 157
 158   /**
 159    * @brief Sets the natural size.
 160    *
 161    * @param[in] size The text's natural size.
 162    */
 163   void SetNaturalSize( const Vector2& size  );
 164
 165   /**
 166    * @brief Retrieves the natural size.
 167    *
 168    * @return The text's natural size.
 169    */
 170   const Vector2& GetNaturalSize() const;
 171
 172   /**
 173    * @brief Sets the text's actual size after it has been laid out.
 174    *
 175    * @param[in] size The text's size.
 176    */
 177   void SetActualSize( const Vector2& size );
 178
 179   /**
 180    * @brief Retrieves the text's actual size after it has been laid out.
 181    *
 182    * @return The text's size.
 183    */
 184   const Vector2& GetActualSize() const;
 185
 186   /**
 187    * @brief Set the text's color
 188    *
 189    * @param[in] textColor The text's color
 190    */
 191   void SetTextColor( const Vector4& textColor );
 192
 193   /**
 194    * @brief Retrieve the text's color
 195    *
 196    * @return The text's color
 197    */
 198   const Vector4& GetTextColor() const;
 199
 200   /**
 201    * @brief Sets the text's shadow offset.
 202    *
 203    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 204    */
 205   void SetShadowOffset( const Vector2& shadowOffset );
 206
 207   /**
 208    * @brief Retrieves the text's shadow offset.
 209    *
 210    * @return The text's shadow offset, 0,0 indicates no shadow.
 211    */
 212   const Vector2& GetShadowOffset() const;
 213
 214   /**
 215    * @brief Sets the text's shadow color.
 216    *
 217    * @param[in] shadowColor The shadow color.
 218    */
 219   void SetShadowColor( const Vector4& shadowColor );
 220
 221   /**
 222    * @brief Retrieves the text's shadow color.
 223    *
 224    * @return The text's shadow color.
 225    */
 226   const Vector4& GetShadowColor() const;
 227
 228   /**
 229    * @brief Sets the text's underline color.
 230    *
 231    * @param[in] color The text's underline color.
 232    */
 233   void SetUnderlineColor( const Vector4& color );
 234
 235   /**
 236    * @brief Retrieves the text's underline color.
 237    *
 238    * @return The text's underline color.
 239    */
 240   const Vector4& GetUnderlineColor() const;
 241
 242   /**
 243    * @brief Sets the text underline flag.
 244    *
 245    * @param[in] enabled true if underlined.
 246    */
 247   void SetUnderlineEnabled( bool enabled );
 248
 249   /**
 250    * @brief Returns whether the text is underlined or not.
 251    *
 252    * @return underline state.
 253    */
 254   bool IsUnderlineEnabled() const;
 255
 256   /**
 257    * @brief Clear the caches.
 258    */
 259   void ClearCaches();
 260
 261   /**
 262    * @brief Set the override used for underline height, 0 indicates height will be come from font metrics
 263    *
 264    * @param[in] height The height in pixels of the underline
 265    */
 266   void SetUnderlineHeight( float height );
 267
 268   /**
 269    * @brief Retrieves the underline height override
 270    *
 271    * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height
 272    */
 273   float GetUnderlineHeight() const;
 274
 275 protected:
 276
 277   /**
 278    * @brief A reference counted object may only be deleted by calling Unreference().
 279    */
 280   virtual ~VisualModel();
 281
 282 private:
 283
 284   /**
 285    * @brief Private constructor.
 286    */
 287   VisualModel();
 288
 289   // Undefined
 290   VisualModel( const VisualModel& handle );
 291
 292   // Undefined
 293   VisualModel& operator=( const VisualModel& handle );
 294
 295 public:
 296
 297   Vector<GlyphInfo>      mGlyphs;               ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
 298   Vector<CharacterIndex> mGlyphsToCharacters;   ///< For each glyph, the index of the first character.
 299   Vector<GlyphIndex>     mCharactersToGlyph;    ///< For each character, the index of the first glyph.
 300   Vector<Length>         mCharactersPerGlyph;   ///< For each glyph, the number of characters that form the glyph.
 301   Vector<Length>         mGlyphsPerCharacter;   ///< For each character, the number of glyphs that are shaped.
 302   Vector<Vector2>        mGlyphPositions;       ///< For each glyph, the position.
 303   Vector<LineRun>        mLines;                ///< The laid out lines.
 304   Vector<GlyphRun>       mUnderlineRuns;        ///< Runs of glyphs that are underlined.
 305   Vector<ColorGlyphRun>  mColorRuns;            ///< Runs of glyphs with the same color.
 306
 307   Vector2                mControlSize;           ///< The size of the UI control the decorator is adding it's decorations to.
 308   Vector4                mTextColor;            ///< The text color
 309   Vector4                mShadowColor;          ///< Color of drop shadow
 310   Vector4                mUnderlineColor;       ///< Color of underline
 311   Vector2                mShadowOffset;         ///< Offset for drop shadow, 0 indicates no shadow
 312   float                  mUnderlineHeight;      ///< Fixed height for underline to override font metrics.
 313
 314 private:
 315
 316   Size                   mNaturalSize;        ///< Size of the text with no line wrapping.
 317   Size                   mActualSize;         ///< Size of the laid-out text considering the layout properties set.
 318
 319   // Caches to increase performance in some consecutive operations.
 320   LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
 321
 322 public:
 323
 324   bool                   mUnderlineEnabled:1;   ///< Underline enabled flag
 325   bool                   mUnderlineColorSet:1;  ///< Has the underline color been explicitly set?
 326
 327 };
 328
 329 } // namespace Text
 330
 331 } // namespace Toolkit
 332
 333 } // namespace Dali
 334
 335 #endif // __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__