Outline effect has been fixed to be not front cropped.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / layouts / layout-parameters.h
index 808e1ae..7f3e169 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H__
-#define __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H__
+#ifndef DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H
+#define DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H
 
 /*
- * Copyright (c) 2015 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.
@@ -22,6 +22,7 @@
 #include <dali/public-api/math/vector2.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/public-api/text/text-enumerations.h>
 #include <dali-toolkit/internal/text/text-definitions.h>
 
 namespace Dali
@@ -35,59 +36,97 @@ namespace Text
 
 struct BidirectionalLineInfoRun;
 
+namespace Layout
+{
+
 /**
  * @brief Struct used to pass parameters.
  */
-struct LayoutParameters
+struct Parameters
 {
   /**
    * Constructor with the needed parameters to layout the text.
    *
    * @param[in] boundingBox The size of the box containing the text.
+   * @param[in] textBuffer The text buffer.
    * @param[in] lineBreakInfoBuffer The line break info.
    * @param[in] wordBreakInfoBuffer The word break info.
-   * @param[in] totalNumberOfGlyphs The number of glyphs.
-   * @param[in] glyphsBuffer A vector with glyphs.
+   * @param[in] characterDirectionBuffer Vector with the direction of each character.
+   * @param[in] glyphsBuffer Vector with glyphs.
    * @param[in] glyphsToCharactersBuffer Vector with indices pointing the first character of each glyph.
    * @param[in] charactersPerGlyphBuffer Vector with the number of characters that forms each glyph.
+   * @param[in] charactersToGlyphsBuffer Vector with indices pointing the first glyph of each character.
+   * @param[in] glyphsPerCharacterBuffer Vector with the number of glyphs shaped from the character.
+   * @param[in] totalNumberOfGlyphs The number of glyphs.
+   * @param[in] horizontalAlignment The horizontal alignment.
+   * @param[in] lineWrapMode The text wrap mode.
    */
-  LayoutParameters( const Vector2& boundingBox,
-                    const LineBreakInfo* const lineBreakInfoBuffer,
-                    const WordBreakInfo* const wordBreakInfoBuffer,
-                    Length totalNumberOfGlyphs,
-                    const GlyphInfo* const glyphsBuffer,
-                    const CharacterIndex* const glyphsToCharactersBuffer,
-                    const Length* const charactersPerGlyphBuffer )
+  Parameters( const Vector2& boundingBox,
+              const Character* const textBuffer,
+              const LineBreakInfo* const lineBreakInfoBuffer,
+              const WordBreakInfo* const wordBreakInfoBuffer,
+              const CharacterDirection* const characterDirectionBuffer,
+              const GlyphInfo* const glyphsBuffer,
+              const CharacterIndex* const glyphsToCharactersBuffer,
+              const Length* const charactersPerGlyphBuffer,
+              const GlyphIndex* const charactersToGlyphsBuffer,
+              const Length* const glyphsPerCharacterBuffer,
+              Length totalNumberOfGlyphs,
+              Text::HorizontalAlignment::Type horizontalAlignment,
+              Text::LineWrap::Mode lineWrapMode,
+              float outlineWidth )
   : boundingBox( boundingBox ),
+    textBuffer( textBuffer ),
     lineBreakInfoBuffer( lineBreakInfoBuffer ),
     wordBreakInfoBuffer( wordBreakInfoBuffer ),
-    totalNumberOfGlyphs( totalNumberOfGlyphs ),
+    characterDirectionBuffer( characterDirectionBuffer ),
     glyphsBuffer( glyphsBuffer ),
     glyphsToCharactersBuffer( glyphsToCharactersBuffer ),
     charactersPerGlyphBuffer( charactersPerGlyphBuffer ),
-    charactersToGlyphsBuffer( NULL ),
-    glyphsPerCharacterBuffer( NULL ),
+    charactersToGlyphsBuffer( charactersToGlyphsBuffer ),
+    glyphsPerCharacterBuffer( glyphsPerCharacterBuffer ),
     lineBidirectionalInfoRunsBuffer( NULL ),
-    numberOfBidirectionalInfoRuns( 0u )
+    numberOfBidirectionalInfoRuns( 0u ),
+    startGlyphIndex( 0u ),
+    numberOfGlyphs( 0u ),
+    totalNumberOfGlyphs( totalNumberOfGlyphs ),
+    horizontalAlignment( horizontalAlignment ),
+    startLineIndex( 0u ),
+    estimatedNumberOfLines( 0u ),
+    lineWrapMode( lineWrapMode ),
+    isLastNewParagraph( false ),
+    outlineWidth( outlineWidth )
   {}
 
-  Vector2                     boundingBox;
-  const LineBreakInfo* const  lineBreakInfoBuffer;
-  const WordBreakInfo* const  wordBreakInfoBuffer;
-  Length                      totalNumberOfGlyphs;
-  const GlyphInfo* const      glyphsBuffer;
-  const CharacterIndex* const glyphsToCharactersBuffer;
-  const Length* const         charactersPerGlyphBuffer;
-  GlyphIndex*                 charactersToGlyphsBuffer;        ///< The character to glyph conversion table.
-  Length*                     glyphsPerCharacterBuffer;        ///< The number of glyphs per character.
-  BidirectionalLineInfoRun*   lineBidirectionalInfoRunsBuffer; ///< Bidirectional conversion tables per line.
-  Length                      numberOfBidirectionalInfoRuns;   ///< The number of lines with bidirectional info.
+  Vector2                         boundingBox;                     ///< The size of the box containing the text.
+  const Character* const          textBuffer;                      ///< The text buffer.
+  const LineBreakInfo* const      lineBreakInfoBuffer;             ///< The line break info.
+  const WordBreakInfo* const      wordBreakInfoBuffer;             ///< The word break info.
+  const CharacterDirection* const characterDirectionBuffer;        ///< Vector with the direction of each character.
+  const GlyphInfo* const          glyphsBuffer;                    ///< Vector with glyphs.
+  const CharacterIndex* const     glyphsToCharactersBuffer;        ///< Vector with indices pointing the first character of each glyph.
+  const Length* const             charactersPerGlyphBuffer;        ///< Vector with the number of characters that forms each glyph.
+  const GlyphIndex* const         charactersToGlyphsBuffer;        ///< Vector with indices pointing the first glyph of each character.
+  const Length* const             glyphsPerCharacterBuffer;        ///< Vector with the number of glyphs shaped from the character.
+  BidirectionalLineInfoRun*       lineBidirectionalInfoRunsBuffer; ///< Bidirectional conversion tables per line.
+  Length                          numberOfBidirectionalInfoRuns;   ///< The number of lines with bidirectional info.
+  GlyphIndex                      startGlyphIndex;                 ///< Index to the first glyph to layout.
+  Length                          numberOfGlyphs;                  ///< The number of glyphs to layout.
+  Length                          totalNumberOfGlyphs;             ///< The number of glyphs.
+  HorizontalAlignment::Type       horizontalAlignment;             ///< The horizontal alignment.
+  LineIndex                       startLineIndex;                  ///< The line index where to insert the new lines.
+  Length                          estimatedNumberOfLines;          ///< The estimated number of lines.
+  Text::LineWrap::Mode            lineWrapMode;                    ///< The line wrap mode for moving to next line.
+  bool                            isLastNewParagraph;              ///< Whether the last character is a new paragraph character.
+  float                           outlineWidth;                    ///< The outline width.
 };
 
+} // namespace Layout
+
 } // namespace Text
 
 } // namespace Toolkit
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H__
+#endif // DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H