2 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 // Licensed under the Flora License, Version 1.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://floralicense.org/license/
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an AS IS BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
18 #include "relayout-utilities.h"
24 #include <dali/dali.h>
25 #include <dali-toolkit/public-api/controls/text-view/text-view.h>
26 #include "text-view-line-processor.h"
27 #include "text-view-word-processor.h"
28 #include "text-view-processor-helper-functions.h"
29 #include "text-view-processor-dbg.h"
40 namespace TextViewRelayout
43 const float MINIMUM_FADE_BOUNDARY = 0.05f; // When the fade boundary is the same as the text-view boundary, this constant reduces it in order to avoid a zero division.
45 RelayoutParameters::RelayoutParameters()
51 mCharacterGlobalIndex( 0u ),
52 mIsFirstCharacter( false ),
53 mIsFirstCharacterOfWord( false ),
55 mIsNewLineCharacter( false ),
56 mIsWhiteSpace( false ),
61 RelayoutParameters::~RelayoutParameters()
65 FadeParameters::FadeParameters()
66 : mRightFadeBoundary( 0.f ),
67 mRightFadeThreshold( 0.f ),
68 mRightFadeBoundaryOffset( 0.f ),
69 mRightFadeThresholdOffset( 0.f ),
70 mRightAlphaCoeficients(),
71 mLeftFadeBoundary( 0.f ),
72 mLeftFadeThreshold( 0.f ),
73 mLeftFadeBoundaryOffset( 0.f ),
74 mLeftFadeThresholdOffset( 0.f ),
75 mLeftAlphaCoeficients(),
76 mTopFadeBoundary( 0.f ),
77 mTopFadeThreshold( 0.f ),
78 mTopFadeBoundaryOffset( 0.f ),
79 mTopFadeThresholdOffset( 0.f ),
80 mTopAlphaCoeficients(),
81 mBottomFadeBoundary( 0.f ),
82 mBottomFadeThreshold( 0.f ),
83 mBottomFadeBoundaryOffset( 0.f ),
84 mBottomFadeThresholdOffset( 0.f ),
85 mBottomAlphaCoeficients(),
86 mIsPartiallyVisible( false )
90 FadeParameters::~FadeParameters()
94 EllipsizeParameters::EllipsizeParameters()
96 mLineDescender( 0.f ),
101 mEllipsizeLine( false ),
102 mIsLineWidthFullyVisible( false ),
103 mIsLineHeightFullyVisible( false ),
104 mIsNextLineFullyVisibleHeight( false ),
105 mCreateEllipsizedTextActors( false ),
111 EllipsizeParameters::~EllipsizeParameters()
115 UnderlineInfo::UnderlineInfo()
117 mMaxThickness( 0.f ),
122 UnderlineInfo::~UnderlineInfo()
126 TextUnderlineStatus::TextUnderlineStatus()
128 mCharacterGlobalIndex( 0u ),
129 mLineGlobalIndex( 0u ),
130 mCurrentUnderlineStatus( false )
134 TextUnderlineStatus::~TextUnderlineStatus()
138 SubLineLayoutInfo::SubLineLayoutInfo()
139 : mLineLength( 0.f ),
140 mMaxCharHeight( 0.f ),
145 SubLineLayoutInfo::~SubLineLayoutInfo()
150 * Whether the given text-actor exceeds the left or the right boundary of the text-view.
152 * @param[in] position The position of the text-actor.
153 * @param[in] size The size of the text-actor.
154 * @param[in] parantSize The size of the text-view.
156 * @return \e true if the text-actor exceeds the left or the right boundary of the text-view.
158 bool IsExceedingWidth( const Vector3& position, const Size& size, const Size& parentSize )
160 return ( ( position.x < 0.f ) ||
161 ( position.x + size.width > parentSize.width ) );
165 * Whether the given text-actor exceeds the top or the bottom boundary of the text-view.
167 * @param[in] position The position of the text-actor.
168 * @param[in] size The size of the text-actor.
169 * @param[in] parantSize The size of the text-view.
171 * @return \e true if the text-actor exceeds the top or the bottom boundary of the text-view.
173 bool IsExceedingHeight( const Vector3& position, const Size& size, const Size& parentSize )
175 return ( ( position.y > parentSize.height ) ||
176 ( position.y < size.height ) );
180 * Calculates the line length adding the new word or character width.
182 * It also returns the length of white spaces if they are at the end of the line.
184 * @param[in] isWhiteSpace Whether the word is a white space.
185 * @param[in] width The width of the character or word.
186 * @param[in] parentWidth The parent width.
187 * @param[out] found Whether the sum of the new character or word is exceding the parent's width.
188 * @param[out] lineLength The length of the portion of line which doesn't exceed the parant's width
189 * @param[out] endWhiteSpaceLength The length of white spaces which are at the end of the line.
191 void CalculateLineLength( const bool isWhiteSpace, const float width, const float parentWidth, bool& found, float& lineLength, float& endWhiteSpaceLength )
193 if( lineLength + width > parentWidth )
196 lineLength -= endWhiteSpaceLength;
204 endWhiteSpaceLength += width;
208 endWhiteSpaceLength = 0.f;
213 struct CurrentTextActorInfo
220 Vector4 gradientColor;
225 void SetVisualParameters( CurrentTextActorInfo& currentTextActorInfo,
226 const TextView::VisualParameters& visualParameters,
227 TextView::RelayoutData& relayoutData,
228 const float lineHeight )
230 currentTextActorInfo.textActor.SetTextColor( currentTextActorInfo.color );
231 currentTextActorInfo.textActor.SetGradientColor( currentTextActorInfo.gradientColor );
232 currentTextActorInfo.textActor.SetGradientStartPoint( currentTextActorInfo.startPoint );
233 currentTextActorInfo.textActor.SetGradientEndPoint( currentTextActorInfo.endPoint );
235 // The italics offset is used in the offscreen rendering. When text is in italics, it may exceed the text-view's boundary
236 // due to the trick used to implement it.
237 const Radian& italicsAngle = currentTextActorInfo.textActor.GetItalicsAngle();
238 const float italicsOffset = lineHeight * std::tan( italicsAngle );
239 relayoutData.mTextLayoutInfo.mMaxItalicsOffset = std::max( relayoutData.mTextLayoutInfo.mMaxItalicsOffset, italicsOffset );
241 // Sets the sort modifier value.
242 currentTextActorInfo.textActor.SetSortModifier( visualParameters.mSortModifier );
244 // Enables or disables the blending.
245 currentTextActorInfo.textActor.SetBlendMode( !visualParameters.mSnapshotModeEnabled ? BlendingMode::ON : BlendingMode::OFF );
248 void CalculateSubLineLayout( const float parentWidth,
249 const TextViewProcessor::TextInfoIndices& indices,
250 const TextViewProcessor::LineLayoutInfo& lineLayoutInfo,
251 const HorizontalWrapType splitPolicy,
252 const float shrinkFactor,
253 SubLineLayoutInfo& subLineInfo )
255 subLineInfo.mLineLength = 0.f;
256 subLineInfo.mMaxCharHeight = 0.f;
257 subLineInfo.mMaxAscender = 0.f;
259 float endWhiteSpaceLength = 0.f;
261 std::size_t wordIndex = indices.mWordIndex;
262 std::size_t characterIndex = indices.mCharacterIndex;
263 float lineOffset = 0.f;
265 bool isFirstCharacter = true;
266 for( TextViewProcessor::WordGroupLayoutInfoContainer::const_iterator wordGroupIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin() + indices.mGroupIndex,
267 wordGroupEndIt = lineLayoutInfo.mWordGroupsLayoutInfo.end();
268 ( wordGroupIt != wordGroupEndIt ) && !found;
271 const TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *wordGroupIt );
273 for( TextViewProcessor::WordLayoutInfoContainer::const_iterator wordIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin() + wordIndex,
274 wordEndIt = wordGroupLayoutInfo.mWordsLayoutInfo.end();
275 ( wordIt != wordEndIt ) && !found;
278 const TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordIt );
280 const float shrunkWordWidth = wordLayoutInfo.mSize.width * shrinkFactor;
281 const bool isWhiteSpace = TextViewProcessor::WordSeparator == wordLayoutInfo.mType;
283 bool splitByCharacter = false;
285 switch( splitPolicy )
287 case WrapByCharacter:
289 splitByCharacter = true;
293 case WrapByLine: // Fall through
295 splitByCharacter = false;
298 case WrapByWordAndSplit:
300 splitByCharacter = ( shrunkWordWidth > parentWidth );
303 case WrapByLineAndSplit:
305 if( ( 0 != characterIndex ) ||
306 ( ( 0 == characterIndex ) && ( lineOffset + shrunkWordWidth > parentWidth ) ) )
308 splitByCharacter = true;
312 lineOffset += shrunkWordWidth;
313 splitByCharacter = false;
318 if( splitByCharacter )
320 for( TextViewProcessor::CharacterLayoutInfoContainer::const_iterator charIt = wordLayoutInfo.mCharactersLayoutInfo.begin() + characterIndex,
321 charEndIt = wordLayoutInfo.mCharactersLayoutInfo.end();
322 ( charIt != charEndIt ) && !found;
325 const TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *charIt );
326 CalculateLineLength( isWhiteSpace, characterLayoutInfo.mSize.width * shrinkFactor, parentWidth, found, subLineInfo.mLineLength, endWhiteSpaceLength );
327 if( !found || isFirstCharacter )
329 subLineInfo.mMaxCharHeight = std::max( subLineInfo.mMaxCharHeight, characterLayoutInfo.mSize.height );
330 subLineInfo.mMaxAscender = std::max( subLineInfo.mMaxAscender, characterLayoutInfo.mAscender );
333 // All characters for word 'wordIndex' have been processed.
334 // Next word need to process all characters, so the characterIndex is reset to 0.
336 isFirstCharacter = false;
339 lineOffset += subLineInfo.mLineLength;
343 CalculateLineLength( isWhiteSpace, shrunkWordWidth, parentWidth, found, subLineInfo.mLineLength, endWhiteSpaceLength );
344 if( !found || isFirstCharacter )
346 subLineInfo.mMaxCharHeight = std::max( subLineInfo.mMaxCharHeight, wordLayoutInfo.mSize.height );
347 subLineInfo.mMaxAscender = std::max( subLineInfo.mMaxAscender, wordLayoutInfo.mAscender );
349 isFirstCharacter = false;
353 // All words for group 'groupIndex' have been processed.
354 // Next group need to process all words, so the wordIndex is reset to 0.
358 subLineInfo.mMaxCharHeight *= shrinkFactor;
359 subLineInfo.mMaxAscender *= shrinkFactor;
362 float CalculateXoffset( const Toolkit::Alignment::Type horizontalTextAlignment, const float parentWidth, const float wholeTextWidth )
364 float xOffset( 0.f );
365 switch( horizontalTextAlignment )
367 case Toolkit::Alignment::HorizontalLeft:
372 case Toolkit::Alignment::HorizontalCenter:
374 xOffset = 0.5f * ( parentWidth - wholeTextWidth );
377 case Toolkit::Alignment::HorizontalRight:
379 xOffset = parentWidth - wholeTextWidth;
384 DALI_ASSERT_ALWAYS( !"TextViewRelayout::CalculateXoffset: Wrong horizontal text alignment. Did you set a vertical one?" );
391 float CalculateYoffset( const Toolkit::Alignment::Type verticalTextAlignment, const float parentHeight, const float wholeTextHeight )
393 float yOffset( 0.f );
394 switch( verticalTextAlignment )
396 case Toolkit::Alignment::VerticalTop:
401 case Toolkit::Alignment::VerticalCenter:
403 yOffset = 0.5f * ( parentHeight - wholeTextHeight );
406 case Toolkit::Alignment::VerticalBottom:
408 yOffset = parentHeight - wholeTextHeight;
413 DALI_ASSERT_ALWAYS( !"TextViewRelayout::CalculateXoffset: Wrong vertical text alignment. Did you set an horizontal one?" );
420 float CalculateJustificationOffset( const Toolkit::TextView::LineJustification justification, const float wholeTextWidth, const float lineLength )
423 switch( justification )
425 case Toolkit::TextView::Left:
430 case Toolkit::TextView::Center:
432 offset = 0.5f * ( wholeTextWidth - lineLength );
435 case Toolkit::TextView::Right:
437 offset = wholeTextWidth - lineLength;
440 case Toolkit::TextView::Justified:
450 bool IsVisible( const Vector3& position, const Size& size, const Size& parentSize, const VisibilityTestType type )
452 bool visible = false;
458 // Whether the text-actor is fully inside the boundaries of the text-view.
459 visible = ( ( position.x >= 0.f ) && ( position.x + size.width <= parentSize.width ) &&
460 ( position.y >= size.height ) && ( position.y <= parentSize.height ) );
463 case FULLY_VISIBLE_WIDTH:
465 // Whether the text-actor is between the left and right boundaries of the text-view.
466 visible = ( ( position.x >= 0.f ) && ( position.x + size.width <= parentSize.width ) );
469 case FULLY_VISIBLE_HEIGHT:
471 // Whether the text-actor is between the top and bottom boundaries of the text-view.
472 visible = ( ( position.y >= size.height ) && ( position.y <= parentSize.height ) );
475 case PARTIALLY_VISIBLE:
477 // Whether the text-actor is partially inside the boundaries of the text-view.
478 visible = ( ( position.x < parentSize.width ) &&
479 ( position.x + size.width > 0.f ) &&
480 ( position.y > 0.f ) &&
481 ( position.y - size.height < parentSize.height ) );
484 case PARTIALLY_VISIBLE_WIDTH:
486 // Whether the text-actor is partially inside the area defined by the left and the right boundaries of the text-view.
487 // It may not be partially inside the text-view.
488 visible = ( ( position.x < parentSize.width ) &&
489 ( position.x + size.width > 0.f ) );
492 case PARTIALLY_VISIBLE_HEIGHT:
494 // Whether the text-actor is partially inside the area defined by the top and the bottom boundaries of the text-view.
495 // It may not be partially inside the text-view.
496 visible = ( ( position.y > 0.f ) &&
497 ( position.y - size.height < parentSize.height ) );
505 Vector2 CalculateRectParameters( const Vector2& p0, const Vector2& p1 )
507 const float gradient = ( p1.y - p0.y ) / ( p1.x - p0.x );
509 return Vector2( gradient, p0.y - gradient * p0.x );
512 void UpdateAlignment( const TextView::LayoutParameters& layoutParameters,
513 TextView::RelayoutData& relayoutData )
515 // Calculates an offset to align the whole text within the text-view's boundary accordingly with the set alignment and justification options.
516 // The offset could be negative if the whole text is bigger than the boundary of the text-view.
518 // If the exceed policy is ellipsize at the end, negative offsets are not wanted.
519 // In that case, it will align the line to the left and/or top, and ellipsize the end.
520 const bool ellipsizeAlignToLeft = ( layoutParameters.mExceedPolicy == TextView::EllipsizeEndOriginal ) || ( layoutParameters.mExceedPolicy == TextView::EllipsizeEnd );
521 const bool ellipsizeAlignToTop = ( layoutParameters.mExceedPolicy == TextView::EllipsizeEnd );
523 RelayoutParameters relayoutParameters;
525 // Calculates the vertical and horizontal offsets.
526 const float textHorizontalOffset = CalculateXoffset( layoutParameters.mHorizontalAlignment, relayoutData.mTextViewSize.width, relayoutData.mTextSizeForRelayoutOption.width );
527 const float textVerticalOffset = CalculateYoffset( layoutParameters.mVerticalAlignment, relayoutData.mTextViewSize.height, relayoutData.mTextSizeForRelayoutOption.height );
529 std::size_t lineJustificationIndex = 0; // Index to the first position of the vector which stores all line justification info.
530 std::size_t infoTableCharacterIndex = 0;
532 relayoutParameters.mIndices.mLineIndex = 0;
534 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(),
535 endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
536 lineLayoutIt != endLineLayoutIt;
537 ++lineLayoutIt, ++relayoutParameters.mIndices.mLineIndex )
539 TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
541 relayoutParameters.mIndices.mGroupIndex = 0;
542 float justificationOffset = 0.f;
544 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin(),
545 endGroupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.end();
546 groupLayoutIt != endGroupLayoutIt;
547 ++groupLayoutIt, ++relayoutParameters.mIndices.mGroupIndex )
549 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *groupLayoutIt );
551 relayoutParameters.mIndices.mWordIndex = 0;
553 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin(),
554 endWordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.end();
555 wordLayoutIt != endWordLayoutIt;
556 ++wordLayoutIt, ++relayoutParameters.mIndices.mWordIndex )
558 TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
560 relayoutParameters.mIndices.mCharacterIndex = 0;
562 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin(),
563 endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.end();
564 characterLayoutIt != endCharacterLayoutIt;
565 ++characterLayoutIt, ++relayoutParameters.mIndices.mCharacterIndex, ++infoTableCharacterIndex )
567 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
569 // Calculate line justification offset.
570 if( lineJustificationIndex < relayoutData.mLineJustificationInfo.size() )
572 const TextView::LineJustificationInfo lineJustificationInfo( *( relayoutData.mLineJustificationInfo.begin() + lineJustificationIndex ) );
574 if( relayoutParameters.mIndices == lineJustificationInfo.mIndices )
576 justificationOffset = CalculateJustificationOffset( layoutParameters.mLineJustification, relayoutData.mTextSizeForRelayoutOption.width, lineJustificationInfo.mLineLength );
577 ++lineJustificationIndex; // increase the index to point the next position in the vector.
581 // Deletes the offsets if the exceed policies are EllipsizeEnd.
582 const float horizontalOffset = textHorizontalOffset + justificationOffset;
583 characterLayoutInfo.mOffset.x = ( ellipsizeAlignToLeft && ( horizontalOffset < 0.f ) ) ? 0.f : horizontalOffset;
584 characterLayoutInfo.mOffset.y = ( ellipsizeAlignToTop && ( textVerticalOffset < 0.f ) ) ? 0.f : textVerticalOffset;
586 // Updates the size and position table for text-input with the alignment offset.
587 Vector3 positionOffset( characterLayoutInfo.mPosition );
589 std::vector<Toolkit::TextView::CharacterLayoutInfo>::iterator infoTableIt = relayoutData.mCharacterLayoutInfoTable.begin() + infoTableCharacterIndex;
590 Toolkit::TextView::CharacterLayoutInfo& characterTableInfo( *infoTableIt );
592 characterTableInfo.mPosition.x = positionOffset.x + characterLayoutInfo.mOffset.x;
593 characterTableInfo.mPosition.y = positionOffset.y + characterLayoutInfo.mOffset.y;
595 positionOffset.x += characterLayoutInfo.mAdvance * relayoutData.mShrinkFactor;
598 } // end group of words
602 void CalculateBearing( TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo,
603 TextView::RelayoutData& relayoutData )
615 // ggggg gggggggggg bb ggggg
616 // gg gg gggggggggg bb gg gg
617 // gg gg gggg bb gg gg
618 // gg gg gggg bb gg gg
619 // ggggg gg gggg bbbbbbb ggggg
620 // gg gg gggg bb bb gg
621 // g gg gggggggggg bb bb g gg
622 // ggggg gggggggggg bbbbbbb ggggg
631 // ggggg gggg gggg bb ggggg
632 // gg gg gggg gggg bbbbbbb gg gg
633 // gg gg gggg gggg bb bb gg gg
634 // gg gg gggggggggg bb bb gg gg
635 // ggggg gggggggggg bbbbbbb ggggg
638 // ggggg gg gggg ggggg
643 const Toolkit::TextView::LineLayoutInfo& lineInfo( *( relayoutData.mLines.end() - 1 ) );
644 const float bearingOffset = ( lineInfo.mSize.height - lineInfo.mAscender ) - ( characterLayoutInfo.mSize.height - characterLayoutInfo.mAscender );
646 characterLayoutInfo.mPosition.y -= bearingOffset * relayoutData.mShrinkFactor;
649 void UpdateLayoutInfoTable( Vector4& minMaxXY,
650 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo,
651 TextViewProcessor::WordLayoutInfo& wordLayoutInfo,
652 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo,
653 RelayoutParameters& relayoutParameters,
654 TextView::RelayoutData& relayoutData )
656 // updates min and max position to calculate the text size for multiline policies.
657 minMaxXY.x = std::min( minMaxXY.x, characterLayoutInfo.mPosition.x );
658 minMaxXY.z = std::max( minMaxXY.z, characterLayoutInfo.mPosition.x + characterLayoutInfo.mSize.width * relayoutData.mShrinkFactor );
660 minMaxXY.y = std::min( minMaxXY.y, characterLayoutInfo.mPosition.y - characterLayoutInfo.mSize.height * relayoutData.mShrinkFactor );
661 minMaxXY.w = std::max( minMaxXY.w, characterLayoutInfo.mPosition.y );
663 // Adds layout info to be retrieved by external controls or applications.
664 Vector3 positionOffset( characterLayoutInfo.mPosition );
666 const float descender = characterLayoutInfo.mSize.height - characterLayoutInfo.mAscender;
668 const Toolkit::TextView::CharacterLayoutInfo characterLayoutTableInfo( Size( characterLayoutInfo.mAdvance * relayoutData.mShrinkFactor,
669 characterLayoutInfo.mHeight * relayoutData.mShrinkFactor ),
671 ( TextViewProcessor::LineSeparator == wordLayoutInfo.mType ),
672 ( TextViewProcessor::RTL == wordGroupLayoutInfo.mDirection ),
676 relayoutData.mCharacterLayoutInfoTable.push_back( characterLayoutTableInfo );
678 positionOffset.x += characterLayoutInfo.mAdvance * relayoutData.mShrinkFactor;
681 void CalculateVisibilityForFade( const Internal::TextView::LayoutParameters& layoutParameters,
682 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo,
683 RelayoutParameters& relayoutParameters,
684 FadeParameters& fadeParameters,
685 TextView::RelayoutData& relayoutData )
687 if( ( TextView::Fade != layoutParameters.mExceedPolicy ) &&
688 ( TextView::SplitFade != layoutParameters.mExceedPolicy ) &&
689 ( TextView::FadeOriginal != layoutParameters.mExceedPolicy ) &&
690 ( TextView::OriginalFade != layoutParameters.mExceedPolicy ) )
696 // Calculates visibility of a text-actor according the exceed policies.
698 // position + alignment offset.
699 const Vector3 position( characterLayoutInfo.mPosition.x + characterLayoutInfo.mOffset.x,
700 characterLayoutInfo.mPosition.y + characterLayoutInfo.mOffset.y,
701 characterLayoutInfo.mPosition.z );
703 // Whether the text actor is fully, partially or non visible (according exceed policies).
704 switch( layoutParameters.mExceedPolicy )
708 // All text-actors which are not completely inside the text-view's boundaries are set as non visible.
709 // All text-actors which are partially inside the text-view's boundaries are set as partially visible.
710 if( !IsVisible( position,
711 characterLayoutInfo.mSize,
712 relayoutData.mTextViewSize,
715 relayoutParameters.mIsVisible = false;
716 if( IsVisible( position,
717 characterLayoutInfo.mSize,
718 relayoutData.mTextViewSize,
719 PARTIALLY_VISIBLE ) )
721 fadeParameters.mIsPartiallyVisible = true;
723 // Checks if a text-actor is exceeding more than one boundary as this case is not supported.
724 if( IsExceedingWidth( position,
725 characterLayoutInfo.mSize,
726 relayoutData.mTextViewSize ) &&
727 IsExceedingHeight( position,
728 characterLayoutInfo.mSize,
729 relayoutData.mTextViewSize ) )
731 // Combination not fully supported by text-view.
732 // Need to check if text-actor really supports this combination.
733 fadeParameters.mIsPartiallyVisible = false;
739 case TextView::FadeOriginal:
741 // All text-actors which are not completely between the left and right text-view's boundaries are set as non visible.
742 // All text-actors which are partially inside the text-view's boundaries are set as partially visible.
743 if( !IsVisible( position,
744 characterLayoutInfo.mSize,
745 relayoutData.mTextViewSize,
746 FULLY_VISIBLE_WIDTH ) )
748 relayoutParameters.mIsVisible = false;
749 if( IsVisible( position,
750 characterLayoutInfo.mSize,
751 relayoutData.mTextViewSize,
752 PARTIALLY_VISIBLE_WIDTH ) )
754 fadeParameters.mIsPartiallyVisible = true;
759 case TextView::OriginalFade:
760 case TextView::SplitFade: // Fallthrough
762 // All text-actors which are not completely between the top and bottom text-view's boundaries are set as non visible.
763 // All text-actors which are partially inside the text-view's boundaries are set as partially visible.
764 if( !IsVisible( position,
765 characterLayoutInfo.mSize,
766 relayoutData.mTextViewSize,
767 FULLY_VISIBLE_HEIGHT ) )
769 relayoutParameters.mIsVisible = false;
770 if( IsVisible( position,
771 characterLayoutInfo.mSize,
772 relayoutData.mTextViewSize,
773 PARTIALLY_VISIBLE_HEIGHT ) )
775 fadeParameters.mIsPartiallyVisible = true;
782 DALI_ASSERT_ALWAYS( !"TextViewRelayout::CalculateVisibilityForFade. Wrong exceed policies." )
787 if( relayoutParameters.mIsVisible || fadeParameters.mIsPartiallyVisible )
789 characterLayoutInfo.mIsVisible = true;
791 const Size size = characterLayoutInfo.mSize * relayoutData.mShrinkFactor;
792 const float characterPositionPlusWidth = position.x + size.width;
793 const float characterPositionMinusHeight = position.y - size.height;
795 // Calculates which edges need to be faded-out.
796 bool rightFadeOut = false;
797 bool leftFadeOut = false;
798 bool bottomFadeOut = false;
799 bool topFadeOut = false;
801 switch( layoutParameters.mExceedPolicy )
805 // All text-actors exceeding any of the boundaries will be faded-out.
806 rightFadeOut = ( characterPositionPlusWidth > fadeParameters.mRightFadeThreshold );
807 leftFadeOut = ( position.x < fadeParameters.mLeftFadeThreshold );
808 bottomFadeOut = ( position.y > fadeParameters.mBottomFadeThreshold );
809 topFadeOut = ( characterPositionMinusHeight < fadeParameters.mTopFadeThreshold );
812 case TextView::FadeOriginal:
814 // Only text-actors exceeding the left or the right boundaries will be faded-out.
815 rightFadeOut = ( characterPositionPlusWidth > fadeParameters.mRightFadeThreshold );
816 leftFadeOut = ( position.x < fadeParameters.mLeftFadeThreshold );
819 case TextView::SplitFade:
820 case TextView::OriginalFade: //Fallthrough
822 // Only text-actors exceeding the top or the bottom boundaries will be faded-out.
823 bottomFadeOut = ( position.y > fadeParameters.mBottomFadeThreshold );
824 topFadeOut = ( characterPositionMinusHeight < fadeParameters.mTopFadeThreshold );
829 DALI_ASSERT_ALWAYS( !"TextViewRelayout::CalculateVisibilityForFade. Wrong exceed policies." );
834 // Calculates gradient parameters for a text-actor.
835 Vector4 gradientColor = Vector4::ZERO;
836 Vector2 startPoint = Vector2::ZERO;
837 Vector2 endPoint = Vector2::ZERO;
839 if( !( rightFadeOut && leftFadeOut ) )
841 // Current implementation can't set gradient parameters for a text-actor exceeding at the same time the left and the right boundaries.
844 gradientColor = characterLayoutInfo.mStyledText.mStyle.GetTextColor();
846 // Calculates gradient coeficients.
847 characterLayoutInfo.mColorAlpha = gradientColor.a * std::min( 1.f, fadeParameters.mRightAlphaCoeficients.x * position.x + fadeParameters.mRightAlphaCoeficients.y );
848 gradientColor.a *= std::max( 0.f, fadeParameters.mRightAlphaCoeficients.x * characterPositionPlusWidth + fadeParameters.mRightAlphaCoeficients.y );
850 startPoint = Vector2( std::max( 0.f, ( fadeParameters.mRightFadeThresholdOffset - position.x ) / size.width ), 0.5f );
851 endPoint = Vector2( std::min( 1.f, ( relayoutData.mTextViewSize.width - position.x ) / size.width ), 0.5f );
853 else if( leftFadeOut )
855 gradientColor = characterLayoutInfo.mStyledText.mStyle.GetTextColor();
857 // Calculates gradient coeficients.
858 characterLayoutInfo.mColorAlpha = std::min( 1.f, fadeParameters.mLeftAlphaCoeficients.x * characterPositionPlusWidth + fadeParameters.mLeftAlphaCoeficients.y );
859 gradientColor.a *= gradientColor.a * std::max( 0.f, fadeParameters.mLeftAlphaCoeficients.x * position.x + fadeParameters.mLeftAlphaCoeficients.y );
861 startPoint = Vector2( std::max( 0.f, ( fadeParameters.mLeftFadeThresholdOffset - position.x ) / size.width ), 0.5f );
862 endPoint = Vector2( std::min( 1.f, -position.x / size.width ), 0.5f );
866 if( !( bottomFadeOut && topFadeOut ) )
868 // Current implementation can't set gradient parameters for a text-actor exceeding at the same time the top and the bottom boundaries.
871 gradientColor = characterLayoutInfo.mStyledText.mStyle.GetTextColor();
873 // Calculates gradient coeficients.
874 characterLayoutInfo.mColorAlpha = gradientColor.a * std::min( 1.f, fadeParameters.mBottomAlphaCoeficients.x * characterPositionMinusHeight + fadeParameters.mBottomAlphaCoeficients.y );
875 gradientColor.a *= std::max( 0.f, fadeParameters.mBottomAlphaCoeficients.x * position.y + fadeParameters.mBottomAlphaCoeficients.y );
877 startPoint = Vector2( 0.5f, std::max( 0.f, ( fadeParameters.mBottomFadeThresholdOffset - characterPositionMinusHeight ) / size.height ) );
878 endPoint = Vector2( 0.5f, std::min( 1.f, ( relayoutData.mTextViewSize.height - characterPositionMinusHeight ) / size.height ) );
880 else if( topFadeOut )
882 gradientColor = characterLayoutInfo.mStyledText.mStyle.GetTextColor();
884 // Calculates gradient coeficients.
885 characterLayoutInfo.mColorAlpha *= gradientColor.a * std::min( 1.f, fadeParameters.mTopAlphaCoeficients.x * position.y + fadeParameters.mTopAlphaCoeficients.y );
886 gradientColor.a *= std::max( 0.f, fadeParameters.mTopAlphaCoeficients.x * characterPositionMinusHeight + fadeParameters.mTopAlphaCoeficients.y );
888 startPoint = Vector2( 0.5f, std::max( 0.f, ( fadeParameters.mTopFadeThresholdOffset - characterPositionMinusHeight ) / size.height ) );
889 endPoint = Vector2( 0.5f, std::min( 1.f, -characterPositionMinusHeight / size.height ) );
893 characterLayoutInfo.mGradientColor = gradientColor;
894 characterLayoutInfo.mStartPoint = startPoint;
895 characterLayoutInfo.mEndPoint = endPoint;
899 characterLayoutInfo.mIsVisible = false;
903 bool CalculateVisibilityForEllipsizeEndOriginal( TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo,
904 const EllipsizeParameters& ellipsizeParameters )
906 bool isPartiallyVisible = false;
908 if( !IsVisible( ellipsizeParameters.mPosition,
909 characterLayoutInfo.mSize,
910 ellipsizeParameters.mEllipsizeBoundary,
911 FULLY_VISIBLE_WIDTH ) )
913 // The character doesn't fit in the text-view's width.
914 characterLayoutInfo.mIsVisible = false;
916 // Checks if the character is partially visible (it's cut by the boundary)
917 isPartiallyVisible = IsVisible( ellipsizeParameters.mPosition,
918 characterLayoutInfo.mSize,
919 ellipsizeParameters.mEllipsizeBoundary,
920 PARTIALLY_VISIBLE_WIDTH );
924 // The character fits in the text-view's width. Set it to visible.
925 characterLayoutInfo.mIsVisible = true;
928 return isPartiallyVisible;
931 bool CalculateVisibilityForEllipsizeEnd( TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo,
932 const EllipsizeParameters& ellipsizeParameters )
934 bool isPartiallyVisible = false;
936 if( !IsVisible( ellipsizeParameters.mPosition,
937 characterLayoutInfo.mSize,
938 ellipsizeParameters.mEllipsizeBoundary,
941 // The character is not fully visible. Needs to check if it's partially visible.
942 characterLayoutInfo.mIsVisible = false;
944 // Checks if the character doesn't cut the bottom edge of the text-view.
945 const bool fullyVisibleHeight = IsVisible( ellipsizeParameters.mPosition,
946 characterLayoutInfo.mSize,
947 ellipsizeParameters.mEllipsizeBoundary,
948 FULLY_VISIBLE_HEIGHT );
950 // Checks if the character cuts the right edge of the text-view.
951 const bool partiallyVisibleWidth = IsVisible( ellipsizeParameters.mPosition,
952 characterLayoutInfo.mSize,
953 ellipsizeParameters.mEllipsizeBoundary,
954 PARTIALLY_VISIBLE_WIDTH );
956 // Character will be ellipsized if it cuts the right edge of the text-view but fits completely in the text-view's height.
957 isPartiallyVisible = ( fullyVisibleHeight && partiallyVisibleWidth );
961 // The character fits in the boundary of the text-view. Set it to visible.
962 characterLayoutInfo.mIsVisible = true;
965 return isPartiallyVisible;
968 void CalculateVisibilityForEllipsize( const Internal::TextView::LayoutParameters& layoutParameters,
969 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo,
970 EllipsizeParameters& ellipsizeParameters,
971 TextView::RelayoutData& relayoutData )
973 // Calculates visibility for EllipsizeEnd exceed policies.
975 // It defines a boundary on the right side of the text-view by substracting the ellipsize-text's size (...) to the text-view's size.
976 // If a character is cut by this boundary and the whole line (if the multi-line policy is split-by-new-line-char)
977 // or the whole word (if the multi-line policy is split-by-word) doesn't fit in the text-view's width, then it's replaced by the ellipsize-text.
979 // Position of the character used to do the visibility test.
980 ellipsizeParameters.mPosition = Vector3( characterLayoutInfo.mPosition.x + characterLayoutInfo.mOffset.x,
981 characterLayoutInfo.mPosition.y + characterLayoutInfo.mOffset.y,
982 characterLayoutInfo.mPosition.z );
984 // Text will be ellipsized if a character is partially visible (it's cut by the boundary defined in the right side of the text-view).
985 bool isPartiallyVisible = false;
987 // Checks if the whole line or the whole word fits in the text-view's width accordingly with the multiline policy.
988 const bool fitsInWidth = ( Toolkit::TextView::SplitByNewLineChar == layoutParameters.mMultilinePolicy ) ? ellipsizeParameters.mLineFits: ellipsizeParameters.mWordFits;
990 // Will only ellipsize the text if it cuts the right vertical edge and it doesn't fit in the text-view's width.
993 // The line or word fits completely inside the text-view's width. Nothing else to do.
994 characterLayoutInfo.mIsVisible = true;
998 // The line or word doesn't fit in the text-view's width.
1000 // Calculates visibility for each type of ellipsize policies.
1001 switch( layoutParameters.mExceedPolicy )
1003 case TextView::EllipsizeEndOriginal:
1005 // Ellipsizes the text if it doesn't fit in the width but it doesn't ellipsize if the text doesn't fit in the height.
1007 isPartiallyVisible = CalculateVisibilityForEllipsizeEndOriginal( characterLayoutInfo,
1008 ellipsizeParameters );
1012 case TextView::EllipsizeEnd:
1014 // Ellipsizes the text if it doesn't fit in the width and fully fits in the text-view's height.
1016 isPartiallyVisible = CalculateVisibilityForEllipsizeEnd( characterLayoutInfo,
1017 ellipsizeParameters );
1023 DALI_ASSERT_DEBUG( !"TextViewRelayout::CalculateVisibilityForEllipsize. Wrong exceed value." );
1029 // If the current character is not fully visible but is partially visible, it is cut by the boundary of the text-view.
1030 // In that case, the charater needs to be replaced by the ellipsize text.
1031 ellipsizeParameters.mCreateEllipsizedTextActors = ( !characterLayoutInfo.mIsVisible && isPartiallyVisible );
1034 void CreateEllipsizeTextActor( const EllipsizeParameters& ellipsizeParameters,
1035 TextView::RelayoutData& relayoutData )
1037 // The default ellipsize text is '...' and all dots have the same style. However, a differernt ellipsize text could be set and it can have characters with differernt styles.
1038 // The code bellow creates the text-actors needed for the ellipsize text.
1040 // Set ellipsize's position by the end of visible text.
1041 Vector3 ellipsizePosition = ellipsizeParameters.mPosition;
1042 // Stores current ellipsize text.
1044 // Stores current ellipsize style.
1045 TextStyle ellipsizeStyle;
1046 // Stores the current size.
1048 //Whether current glyph is an emoticon.
1049 bool isColorGlyph = false;
1051 float bearingOffset = 0.f;
1053 // Create ellipsize text-actor.
1054 for( TextViewProcessor::CharacterLayoutInfoContainer::const_iterator ellipsizeCharacterLayoutIt = relayoutData.mTextLayoutInfo.mEllipsizeLayoutInfo.mCharactersLayoutInfo.begin(),
1055 endEllipsizeCharacterLayoutIt = relayoutData.mTextLayoutInfo.mEllipsizeLayoutInfo.mCharactersLayoutInfo.end();
1056 ellipsizeCharacterLayoutIt != endEllipsizeCharacterLayoutIt;
1057 ++ellipsizeCharacterLayoutIt )
1059 const TextViewProcessor::CharacterLayoutInfo& ellipsizeCharacterLayoutInfo( *ellipsizeCharacterLayoutIt );
1062 ( isColorGlyph != ellipsizeCharacterLayoutInfo.mIsColorGlyph ) ||
1063 ( ellipsizeStyle != ellipsizeCharacterLayoutInfo.mStyledText.mStyle ) )
1065 // The style is different, so a new text-actor is needed.
1066 if( !ellipsizeText.IsEmpty() )
1068 // It only creates a text-actor if there is any text.
1069 RenderableActor ellipsizeGlyphActor = CreateGlyphActor( ellipsizeText, ellipsizeStyle, relayoutData.mTextActorCache );
1070 ellipsizeGlyphActor.SetSize( ellipsizeSize );
1071 ellipsizeGlyphActor.SetPosition( Vector3( ellipsizePosition.x, ellipsizePosition.y - bearingOffset, ellipsizePosition.z ) );
1073 // Updates the position for the next text-actor.
1074 ellipsizePosition.x += ellipsizeSize.width;
1076 // Adds the text-actor to the list.
1077 relayoutData.mEllipsizedGlyphActors.push_back( ellipsizeGlyphActor );
1080 // Resets the current ellipsize info.
1081 ellipsizeText = ellipsizeCharacterLayoutInfo.mStyledText.mText;
1082 ellipsizeStyle = ellipsizeCharacterLayoutInfo.mStyledText.mStyle;
1083 ellipsizeSize = ellipsizeCharacterLayoutInfo.mSize;
1084 isColorGlyph = ellipsizeCharacterLayoutInfo.mIsColorGlyph;
1086 bearingOffset = ( ellipsizeParameters.mLineDescender - ( ellipsizeCharacterLayoutInfo.mSize.height - ellipsizeCharacterLayoutInfo.mAscender ) ) * relayoutData.mShrinkFactor;
1090 // Updates text and size with the new character.
1091 ellipsizeText.Append( ellipsizeCharacterLayoutInfo.mStyledText.mText );
1092 TextViewProcessor::UpdateSize( ellipsizeSize, ellipsizeCharacterLayoutInfo.mSize );
1097 if( !ellipsizeText.IsEmpty() )
1099 // Creates the last glyph-actor.
1100 RenderableActor ellipsizeGlyphActor = CreateGlyphActor( ellipsizeText, ellipsizeStyle, relayoutData.mTextActorCache );
1101 ellipsizeGlyphActor.SetSize( ellipsizeSize );
1102 ellipsizeGlyphActor.SetPosition( Vector3( ellipsizePosition.x, ellipsizePosition.y - bearingOffset, ellipsizePosition.z ) );
1104 // Adds the glyph-actor to the list.
1105 relayoutData.mEllipsizedGlyphActors.push_back( ellipsizeGlyphActor );
1109 void EllipsizeLine( const TextView::LayoutParameters& layoutParameters,
1110 EllipsizeParameters& ellipsizeParameters,
1111 TextView::RelayoutData& relayoutData )
1113 // Traverses the text layout info from the first character of the laid out line
1114 // to the last one setting to each character its visibility. If needed, it adds the ellipsize text (...).
1116 // Indices to the first character of the laid out line.
1117 TextViewProcessor::TextInfoIndices firstIndices;
1118 TextViewProcessor::GetIndicesFromGlobalCharacterIndex( ellipsizeParameters.mFirstIndex,
1119 relayoutData.mTextLayoutInfo,
1122 // Indices to the last character of the laid out line.
1123 TextViewProcessor::TextInfoIndices lastIndices;
1124 TextViewProcessor::GetIndicesFromGlobalCharacterIndex( ellipsizeParameters.mLastIndex,
1125 relayoutData.mTextLayoutInfo,
1128 // Defines a boundary by substracting the ellipsize-text's width to the text-view's width.
1129 // This is the boundary used to check if a character have to be ellipsized.
1130 ellipsizeParameters.mEllipsizeBoundary = relayoutData.mTextViewSize;
1131 ellipsizeParameters.mEllipsizeBoundary.width -= relayoutData.mTextLayoutInfo.mEllipsizeLayoutInfo.mSize.width;
1133 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin() + firstIndices.mLineIndex,
1134 endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin() + lastIndices.mLineIndex + 1;
1135 lineLayoutIt != endLineLayoutIt;
1138 TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
1140 ellipsizeParameters.mLineFits = ellipsizeParameters.mIsLineWidthFullyVisible && ellipsizeParameters.mIsLineHeightFullyVisible && ellipsizeParameters.mIsNextLineFullyVisibleHeight;
1142 if( !ellipsizeParameters.mIsNextLineFullyVisibleHeight )
1144 ellipsizeParameters.mEllipsizeBoundary.width = ellipsizeParameters.mLineWidth;
1147 bool firstGroup = true;
1148 bool lastGroup = false;
1149 std::size_t groupCount = 0;
1151 bool firstWord = true;
1152 bool lastWord = false;
1154 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin() + firstIndices.mGroupIndex,
1155 endGroupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin() + lastIndices.mGroupIndex + 1;
1156 groupLayoutIt != endGroupLayoutIt;
1157 ++groupLayoutIt, ++groupCount )
1159 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *groupLayoutIt );
1161 if( groupCount == lastIndices.mGroupIndex - firstIndices.mGroupIndex )
1166 std::size_t wordCount = 0;
1167 const std::size_t firstWordIndex = firstGroup ? firstIndices.mWordIndex : 0u;
1168 const std::size_t lastWordIndex = lastGroup ? lastIndices.mWordIndex : wordGroupLayoutInfo.mWordsLayoutInfo.size() - 1;
1170 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin() + firstWordIndex,
1171 endWordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin() + lastWordIndex + 1;
1172 wordLayoutIt != endWordLayoutIt;
1173 ++wordLayoutIt, ++wordCount )
1175 TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
1177 if( lastGroup && ( wordCount == lastIndices.mWordIndex - firstWordIndex ) )
1182 const std::size_t firstCharacterIndex = firstWord ? firstIndices.mCharacterIndex : 0u;
1183 const std::size_t lastCharacterIndex = lastWord ? lastIndices.mCharacterIndex : wordLayoutInfo.mCharactersLayoutInfo.size() - 1;
1184 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin() + firstCharacterIndex,
1185 endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin() + lastCharacterIndex + 1;
1186 characterLayoutIt != endCharacterLayoutIt;
1187 ++characterLayoutIt )
1189 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
1191 if( ellipsizeParameters.mEllipsizeLine )
1193 // Calculates the character visibility and whether it needs to be replace by ellipsized text.
1194 CalculateVisibilityForEllipsize( layoutParameters,
1195 characterLayoutInfo,
1196 ellipsizeParameters,
1199 if( ellipsizeParameters.mCreateEllipsizedTextActors )
1201 // Create ellipsize text-actors if the character needs to be replaced.
1202 CreateEllipsizeTextActor( ellipsizeParameters,
1208 if( TextView::EllipsizeEnd == layoutParameters.mExceedPolicy )
1210 if( !ellipsizeParameters.mIsLineHeightFullyVisible )
1212 // Make characters invisible.
1213 characterLayoutInfo.mIsVisible = false;
1225 void SetTextVisible( TextView::RelayoutData& relayoutData )
1227 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(),
1228 endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
1229 lineLayoutIt != endLineLayoutIt;
1232 TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
1234 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin(),
1235 endGroupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.end();
1236 groupLayoutIt != endGroupLayoutIt;
1239 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *groupLayoutIt );
1241 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin(),
1242 endWordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.end();
1243 wordLayoutIt != endWordLayoutIt;
1246 TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
1248 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin(),
1249 endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.end();
1250 characterLayoutIt != endCharacterLayoutIt;
1251 ++characterLayoutIt )
1253 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
1255 characterLayoutInfo.mIsVisible = true;
1256 characterLayoutInfo.mGradientColor = Vector4::ZERO;
1257 characterLayoutInfo.mStartPoint = Vector2::ZERO;
1258 characterLayoutInfo.mEndPoint = Vector2::ZERO;
1261 } // end group of words
1264 // Updates the visibility for text-input..
1265 for( std::vector<Toolkit::TextView::CharacterLayoutInfo>::iterator it = relayoutData.mCharacterLayoutInfoTable.begin(),
1266 endIt = relayoutData.mCharacterLayoutInfoTable.end();
1270 Toolkit::TextView::CharacterLayoutInfo& characterLayoutInfo( *it );
1272 characterLayoutInfo.mIsVisible = true;
1276 void UpdateVisibilityForFade( const TextView::LayoutParameters& layoutParameters,
1277 const TextView::VisualParameters& visualParameters,
1278 TextView::RelayoutData& relayoutData )
1280 RelayoutParameters relayoutParameters;
1281 FadeParameters fadeParameters;
1283 // Calculates the fade thresholds (from where the text starts to fade out). If any of the fade boundaries is zero, it sets a very small value just to avoid a zero division.
1284 fadeParameters.mRightFadeBoundary = static_cast<float>( visualParameters.mFadeBoundary.mRight );
1285 fadeParameters.mRightFadeBoundaryOffset = ( visualParameters.mFadeBoundary.mRight > 0 ? fadeParameters.mRightFadeBoundary : MINIMUM_FADE_BOUNDARY );
1286 fadeParameters.mRightFadeThreshold = relayoutData.mTextViewSize.width - fadeParameters.mRightFadeBoundary;
1287 fadeParameters.mRightFadeThresholdOffset = relayoutData.mTextViewSize.width - fadeParameters.mRightFadeBoundaryOffset;
1288 fadeParameters.mLeftFadeBoundary = static_cast<float>( visualParameters.mFadeBoundary.mLeft );
1289 fadeParameters.mLeftFadeBoundaryOffset = ( visualParameters.mFadeBoundary.mLeft > 0 ? fadeParameters.mLeftFadeBoundary : MINIMUM_FADE_BOUNDARY );
1290 fadeParameters.mLeftFadeThreshold = fadeParameters.mLeftFadeBoundary;
1291 fadeParameters.mLeftFadeThresholdOffset = fadeParameters.mLeftFadeBoundaryOffset;
1292 fadeParameters.mTopFadeBoundary = static_cast<float>( visualParameters.mFadeBoundary.mTop );
1293 fadeParameters.mTopFadeBoundaryOffset = ( visualParameters.mFadeBoundary.mTop > 0 ? fadeParameters.mTopFadeBoundary : MINIMUM_FADE_BOUNDARY );
1294 fadeParameters.mTopFadeThreshold = fadeParameters.mTopFadeBoundary;
1295 fadeParameters.mTopFadeThresholdOffset = fadeParameters.mTopFadeBoundaryOffset;
1296 fadeParameters.mBottomFadeBoundary = static_cast<float>( visualParameters.mFadeBoundary.mBottom );
1297 fadeParameters.mBottomFadeBoundaryOffset = ( visualParameters.mFadeBoundary.mBottom > 0 ? fadeParameters.mBottomFadeBoundary : MINIMUM_FADE_BOUNDARY );
1298 fadeParameters.mBottomFadeThreshold = relayoutData.mTextViewSize.height - fadeParameters.mBottomFadeBoundary;
1299 fadeParameters.mBottomFadeThresholdOffset = relayoutData.mTextViewSize.height - fadeParameters.mBottomFadeBoundaryOffset;
1301 // Calculates the fade out rect coeficients for the right, left, top and bottom sides of the text-view.
1302 fadeParameters.mRightAlphaCoeficients = CalculateRectParameters( Vector2( fadeParameters.mRightFadeThresholdOffset, 1.f ), Vector2( relayoutData.mTextViewSize.width, 0.f ) );
1303 fadeParameters.mLeftAlphaCoeficients = CalculateRectParameters( Vector2( fadeParameters.mLeftFadeThresholdOffset, 1.f ), Vector2( 0.f, 0.f ) );
1304 fadeParameters.mTopAlphaCoeficients = CalculateRectParameters( Vector2( fadeParameters.mTopFadeThresholdOffset, 1.f ), Vector2( 0.f, 0.f ) );
1305 fadeParameters.mBottomAlphaCoeficients = CalculateRectParameters( Vector2( fadeParameters.mBottomFadeThresholdOffset, 1.f ), Vector2( relayoutData.mTextViewSize.height, 0.f ) );
1307 // Traverses all groups of characters and calculates the visibility.
1309 std::size_t infoTableCharacterIndex = 0;
1311 relayoutParameters.mIndices.mLineIndex = 0;
1313 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(),
1314 endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
1315 lineLayoutIt != endLineLayoutIt;
1316 ++lineLayoutIt, ++relayoutParameters.mIndices.mLineIndex )
1318 TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
1320 relayoutParameters.mIndices.mGroupIndex = 0;
1322 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin(),
1323 endGroupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.end();
1324 groupLayoutIt != endGroupLayoutIt;
1325 ++groupLayoutIt, ++relayoutParameters.mIndices.mGroupIndex )
1327 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *groupLayoutIt );
1329 relayoutParameters.mIndices.mWordIndex = 0;
1331 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin(),
1332 endWordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.end();
1333 wordLayoutIt != endWordLayoutIt;
1334 ++wordLayoutIt, ++relayoutParameters.mIndices.mWordIndex )
1336 TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
1338 relayoutParameters.mIsFirstCharacterOfWord = true;
1339 relayoutParameters.mWordSize = wordLayoutInfo.mSize;
1340 relayoutParameters.mIndices.mCharacterIndex = 0;
1342 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin(),
1343 endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.end();
1344 characterLayoutIt != endCharacterLayoutIt;
1345 ++characterLayoutIt, ++relayoutParameters.mIndices.mCharacterIndex, ++infoTableCharacterIndex )
1347 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
1349 relayoutParameters.mIsVisible = true;
1350 fadeParameters.mIsPartiallyVisible = false;
1352 // Calculates the visibility for the current group of characters.
1353 CalculateVisibilityForFade( layoutParameters,
1354 characterLayoutInfo,
1359 // Updates the visibility for text-input..
1360 std::vector<Toolkit::TextView::CharacterLayoutInfo>::iterator it = relayoutData.mCharacterLayoutInfoTable.begin() + infoTableCharacterIndex;
1362 Toolkit::TextView::CharacterLayoutInfo& characterLayoutTableInfo( *it );
1364 characterLayoutTableInfo.mIsVisible = relayoutParameters.mIsVisible;
1366 relayoutParameters.mIsFirstCharacterOfWord = false;
1367 } // end group of character
1369 } // end group of words
1373 void UpdateVisibilityForEllipsize( const TextView::LayoutParameters& layoutParameters,
1374 const TextView::VisualParameters& visualParameters,
1375 TextView::RelayoutData& relayoutData )
1377 // Traverses the laid-out lines and checks which ones doesn't fit in the text-view's boundary.
1378 for( Toolkit::TextView::LineLayoutInfoContainer::const_iterator lineInfoIt = relayoutData.mLines.begin(), endLineInfoIt = relayoutData.mLines.end();
1379 lineInfoIt != endLineInfoIt;
1382 const Toolkit::TextView::LineLayoutInfo& lineInfo( *lineInfoIt );
1384 // To check if a laid-out line fits in the text-view's boundary,
1385 // get the position of the first character is needed and do the test
1386 // with the laid-out line size.
1388 // An bearing offset may have been applied to the first character so it's needed to
1389 // get the start position of the line.
1391 // Some parameters used in the CalculateVisibilityForEllipsize() function.
1392 EllipsizeParameters ellipsizeParameters;
1394 // Retrieves the first index and the last index of the line.
1395 ellipsizeParameters.mFirstIndex = lineInfo.mCharacterGlobalIndex;
1396 ellipsizeParameters.mLastIndex = 0;
1397 if( ( lineInfoIt + 1 ) != endLineInfoIt )
1399 const Toolkit::TextView::LineLayoutInfo& nextLineInfo( *( lineInfoIt + 1 ) );
1400 ellipsizeParameters.mLastIndex = nextLineInfo.mCharacterGlobalIndex - 1;
1404 ellipsizeParameters.mLastIndex = relayoutData.mCharacterLayoutInfoTable.size() - 1;
1407 // Retrieves the first character of the line and build the position of the line with the bearing.
1408 const Toolkit::TextView::CharacterLayoutInfo& characterInfo = *( relayoutData.mCharacterLayoutInfoTable.begin() + ellipsizeParameters.mFirstIndex );
1410 // Calculates the bearing offset applied to the first character.
1411 const float bearingOffset = ( lineInfo.mSize.height - lineInfo.mAscender ) - characterInfo.mDescender;
1413 // Build the position of the line by removing the bearing offset from the first character's position.
1414 const Vector3 position( characterInfo.mPosition.x,
1415 characterInfo.mPosition.y + bearingOffset,
1416 characterInfo.mPosition.z );
1418 // Checks if the line needs to be ellipsized,
1419 ellipsizeParameters.mIsLineWidthFullyVisible = IsVisible( position,
1421 relayoutData.mTextViewSize,
1422 FULLY_VISIBLE_WIDTH );
1424 // If the exceed policy is EllipsizeEndOriginal it's enough to check
1425 // if the line fits in the width.
1426 ellipsizeParameters.mEllipsizeLine = !ellipsizeParameters.mIsLineWidthFullyVisible;
1428 // If the exceed policy is EllipsizeEnd, it's needed to check if the next line exceeds the text-view's height.
1429 // If the next line exceeds the text-view height then it's going to be invisible and current line needs to be ellipsized.
1430 ellipsizeParameters.mIsLineHeightFullyVisible = true;
1431 ellipsizeParameters.mIsNextLineFullyVisibleHeight = true;
1432 if( TextView::EllipsizeEnd == layoutParameters.mExceedPolicy )
1434 // Need to check if there is lines which doesn't fit in the height.
1436 ellipsizeParameters.mIsLineHeightFullyVisible = IsVisible( position,
1438 relayoutData.mTextViewSize,
1439 FULLY_VISIBLE_HEIGHT );
1441 ellipsizeParameters.mEllipsizeLine = ellipsizeParameters.mEllipsizeLine && ellipsizeParameters.mIsLineHeightFullyVisible;
1443 if( ellipsizeParameters.mIsLineHeightFullyVisible && !ellipsizeParameters.mEllipsizeLine )
1445 // Current line is not ellipsized.
1446 // Need to check if there is a next line and if it's not visible. If there is, current line needs to be ellipsized.
1447 Toolkit::TextView::LineLayoutInfoContainer::const_iterator nextLineInfoIt = lineInfoIt + 1;
1448 if( nextLineInfoIt != endLineInfoIt )
1450 // Retrives the position of the first character of the line and remove
1451 // the bearing offset to build to build the position of the line.
1452 const Toolkit::TextView::LineLayoutInfo& nextLineInfo( *nextLineInfoIt );
1453 const Toolkit::TextView::CharacterLayoutInfo& characterInfo = *( relayoutData.mCharacterLayoutInfoTable.begin() + nextLineInfo.mCharacterGlobalIndex );
1455 const float bearingOffset = ( ( lineInfo.mSize.height - lineInfo.mAscender ) - characterInfo.mDescender ) * relayoutData.mShrinkFactor;
1457 const Vector3 position( characterInfo.mPosition.x,
1458 characterInfo.mPosition.y + bearingOffset,
1459 characterInfo.mPosition.z );
1461 ellipsizeParameters.mIsNextLineFullyVisibleHeight = IsVisible( position,
1463 relayoutData.mTextViewSize,
1464 FULLY_VISIBLE_HEIGHT );
1466 // If the next line is not visible, current line have to be ellipsized.
1467 ellipsizeParameters.mEllipsizeLine = !ellipsizeParameters.mIsNextLineFullyVisibleHeight;
1472 if( !ellipsizeParameters.mIsNextLineFullyVisibleHeight )
1474 ellipsizeParameters.mLineWidth = position.x + lineInfo.mSize.width - relayoutData.mTextLayoutInfo.mEllipsizeLayoutInfo.mSize.width;
1477 // Sets the line descender.
1478 ellipsizeParameters.mLineDescender = lineInfo.mSize.height - lineInfo.mAscender;
1480 // At this point, ellipsizeLine distinguish if a piece of line have to be ellipsized or not.
1481 EllipsizeLine( layoutParameters, ellipsizeParameters, relayoutData );
1485 void UpdateVisibility( const TextView::LayoutParameters& layoutParameters,
1486 const TextView::VisualParameters& visualParameters,
1487 TextView::RelayoutData& relayoutData )
1489 switch( layoutParameters.mExceedPolicy )
1491 case TextView::FadeOriginal:
1492 case TextView::OriginalFade:
1493 case TextView::Fade:
1494 case TextView::SplitFade: // Fall through
1496 UpdateVisibilityForFade( layoutParameters,
1501 case TextView::EllipsizeEndOriginal:
1502 case TextView::EllipsizeEnd: // Fall through
1504 // Set first all characters to visible as UpdateVisibilityForEllipsize() doesn't traverse all of them.
1505 SetTextVisible( relayoutData );
1507 UpdateVisibilityForEllipsize( layoutParameters,
1514 SetTextVisible( relayoutData );
1520 void UpdateTextActorInfo( const TextView::VisualParameters& visualParameters,
1521 TextView::RelayoutData& relayoutData )
1523 CurrentTextActorInfo currentTextActorInfo;
1525 // Traverses the text-actor and layout info data structures.
1526 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(),
1527 endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
1528 lineLayoutIt != endLineLayoutIt;
1531 TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
1533 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin(),
1534 endGroupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.end();
1535 groupLayoutIt != endGroupLayoutIt;
1538 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *groupLayoutIt );
1540 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin(),
1541 endWordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.end();
1542 wordLayoutIt != endWordLayoutIt;
1545 TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
1547 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin(),
1548 endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.end();
1549 characterLayoutIt != endCharacterLayoutIt;
1550 ++characterLayoutIt )
1552 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
1554 if( characterLayoutInfo.mIsColorGlyph )
1556 ImageActor imageActor = ImageActor::DownCast( characterLayoutInfo.mGlyphActor );
1558 if( characterLayoutInfo.mSetText )
1560 GlyphImage image = GlyphImage::New( characterLayoutInfo.mStyledText.mText[0] );
1564 imageActor.SetImage( image );
1566 characterLayoutInfo.mSetText = false;
1569 imageActor.SetPosition( Vector3( characterLayoutInfo.mPosition.x + characterLayoutInfo.mOffset.x,
1570 characterLayoutInfo.mPosition.y + characterLayoutInfo.mOffset.y,
1571 characterLayoutInfo.mPosition.z ) );
1572 imageActor.SetSize( characterLayoutInfo.mSize );
1574 // Sets the sort modifier value.
1575 imageActor.SetSortModifier( visualParameters.mSortModifier );
1579 TextActor textActor = TextActor::DownCast( characterLayoutInfo.mGlyphActor );
1582 // There is a new text-actor. Set text and everything to the previous one.
1583 if( currentTextActorInfo.textActor )
1585 currentTextActorInfo.textActor.SetText( currentTextActorInfo.text );
1586 currentTextActorInfo.textActor.SetPosition( currentTextActorInfo.position );
1587 currentTextActorInfo.textActor.SetSize( currentTextActorInfo.size );
1589 SetVisualParameters( currentTextActorInfo,
1592 lineLayoutInfo.mSize.height );
1595 currentTextActorInfo.text = characterLayoutInfo.mStyledText.mText;
1596 currentTextActorInfo.position = Vector3( characterLayoutInfo.mPosition.x + characterLayoutInfo.mOffset.x,
1597 characterLayoutInfo.mPosition.y + characterLayoutInfo.mOffset.y,
1598 characterLayoutInfo.mPosition.z );
1599 currentTextActorInfo.size = characterLayoutInfo.mSize * relayoutData.mShrinkFactor;
1601 currentTextActorInfo.color = characterLayoutInfo.mStyledText.mStyle.GetTextColor();
1602 currentTextActorInfo.color.a = characterLayoutInfo.mColorAlpha;
1604 currentTextActorInfo.gradientColor = characterLayoutInfo.mGradientColor;
1605 currentTextActorInfo.startPoint = characterLayoutInfo.mStartPoint;
1606 currentTextActorInfo.endPoint = characterLayoutInfo.mEndPoint;
1608 // Update the current text-actor.
1609 currentTextActorInfo.textActor = textActor;
1613 // If this character layout has no text-actor is because this character has the same style than previous one.
1614 // Add the character to the current text-actor and update the size.
1615 if( characterLayoutInfo.mIsVisible && ( TextViewProcessor::LineSeparator != wordLayoutInfo.mType ) )
1617 currentTextActorInfo.text.Append( characterLayoutInfo.mStyledText.mText );
1619 currentTextActorInfo.position.y = std::min( currentTextActorInfo.position.y, ( characterLayoutInfo.mPosition.y + characterLayoutInfo.mOffset.y ) );
1620 currentTextActorInfo.size.width += characterLayoutInfo.mSize.width * relayoutData.mShrinkFactor;
1621 currentTextActorInfo.size.height = std::max( currentTextActorInfo.size.height, characterLayoutInfo.mSize.height * relayoutData.mShrinkFactor );
1628 if( !currentTextActorInfo.text.IsEmpty() )
1630 if( currentTextActorInfo.textActor )
1632 currentTextActorInfo.textActor.SetText( currentTextActorInfo.text );
1633 currentTextActorInfo.textActor.SetPosition( currentTextActorInfo.position );
1634 currentTextActorInfo.textActor.SetSize( currentTextActorInfo.size );
1636 SetVisualParameters( currentTextActorInfo,
1639 lineLayoutInfo.mSize.height );
1642 } //end groups of words
1645 for( std::vector<RenderableActor>::iterator it = relayoutData.mEllipsizedGlyphActors.begin(),
1646 endIt = relayoutData.mEllipsizedGlyphActors.end();
1650 RenderableActor glyphActor = ( *it );
1652 glyphActor.SetParentOrigin( ParentOrigin::TOP_LEFT );
1653 glyphActor.SetAnchorPoint( AnchorPoint::BOTTOM_LEFT );
1655 // Sets the sort modifier value.
1656 glyphActor.SetSortModifier( visualParameters.mSortModifier );
1658 // Enables or disables the blending.
1659 glyphActor.SetBlendMode( !visualParameters.mSnapshotModeEnabled ? BlendingMode::ON : BlendingMode::OFF );
1663 void CalculateUnderlineInfo( TextView::RelayoutData& relayoutData, TextViewRelayout::TextUnderlineStatus& textUnderlineStatus )
1665 // Traverse the whole text to find all groups of consecutive underlined characters in the same laid-out line.
1667 // Note that relayoutData.mTextLayoutInfo contains layout info per line but these lines are the result of split the whole text every time a '\n' is found.
1668 // According with the layout option, one of this lines could be laid-out in more than one.
1670 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(), lineEndIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
1671 lineIt != lineEndIt;
1674 TextViewProcessor::LineLayoutInfo& line( *lineIt );
1676 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupIt = line.mWordGroupsLayoutInfo.begin(), groupEndIt = line.mWordGroupsLayoutInfo.end();
1677 groupIt != groupEndIt;
1680 TextViewProcessor::WordGroupLayoutInfo& group( *groupIt );
1682 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordIt = group.mWordsLayoutInfo.begin(), wordEndIt = group.mWordsLayoutInfo.end();
1683 wordIt != wordEndIt;
1686 TextViewProcessor::WordLayoutInfo& word( *wordIt );
1688 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterIt = word.mCharactersLayoutInfo.begin(), characterEndIt = word.mCharactersLayoutInfo.end();
1689 characterIt != characterEndIt;
1692 TextViewProcessor::CharacterLayoutInfo& characterGroup( *characterIt );
1694 // Check if current character is the first of a new laid-out line
1695 const bool isNewLine = ( textUnderlineStatus.mLineGlobalIndex < relayoutData.mLines.size() ) &&
1696 ( textUnderlineStatus.mCharacterGlobalIndex == ( *( relayoutData.mLines.begin() + textUnderlineStatus.mLineGlobalIndex ) ).mCharacterGlobalIndex );
1699 ++textUnderlineStatus.mLineGlobalIndex; // If it's a new line, point to the next one.
1702 if( characterGroup.mStyledText.mStyle.GetUnderline() )
1704 if( !textUnderlineStatus.mCurrentUnderlineStatus || // Current character is underlined but previous one it wasn't.
1705 isNewLine ) // Current character is underlined and is the first of current laid-out line.
1707 // Create a new underline info for the current underlined characters.
1708 UnderlineInfo underlineInfo;
1709 underlineInfo.mMaxHeight = characterGroup.mSize.height;
1710 underlineInfo.mMaxThickness = characterGroup.mUnderlineThickness;
1711 underlineInfo.mPosition = characterGroup.mUnderlinePosition;
1713 textUnderlineStatus.mUnderlineInfo.push_back( underlineInfo );
1715 textUnderlineStatus.mCurrentUnderlineStatus = true; // Set the current text is underlined.
1719 // Retrieve last underline info and update it if current underline thickness is bigger.
1720 UnderlineInfo& underlineInfo( *( textUnderlineStatus.mUnderlineInfo.end() - 1 ) );
1722 underlineInfo.mMaxHeight = std::max( underlineInfo.mMaxHeight, characterGroup.mSize.height );
1724 if( characterGroup.mUnderlineThickness > underlineInfo.mMaxThickness )
1726 underlineInfo.mMaxThickness = characterGroup.mUnderlineThickness;
1727 underlineInfo.mPosition = characterGroup.mUnderlinePosition;
1733 textUnderlineStatus.mCurrentUnderlineStatus = false;
1736 ++textUnderlineStatus.mCharacterGlobalIndex;
1737 } // end group of characters.
1739 } // end group of words.
1743 void SetUnderlineInfo( TextView::RelayoutData& relayoutData )
1745 // Stores for each group of consecutive underlined text in each laid-out line its maximum thicknes, its position of that thickness and the maximum character's height.
1746 TextViewRelayout::TextUnderlineStatus textUnderlineStatus;
1748 // Traverse the whole text to find all groups of consecutive underlined characters in the same laid-out line.
1749 CalculateUnderlineInfo( relayoutData, textUnderlineStatus );
1751 if( textUnderlineStatus.mUnderlineInfo.empty() )
1753 // There is no underlined text. Just exit.
1757 // At this point textUnderlineStatus.mUnderlineInfo has for each group of consecutive underlined characters their maximum thickness, position and maximum height.
1758 // Traverse the whole text and set the previously stored underline info in the text style.
1760 std::vector<UnderlineInfo>::const_iterator underlineInfoIt = textUnderlineStatus.mUnderlineInfo.begin();
1761 std::vector<UnderlineInfo>::const_iterator underlineInfoEndIt = textUnderlineStatus.mUnderlineInfo.end();
1763 UnderlineInfo underlineInfo;
1765 if( underlineInfoIt < underlineInfoEndIt )
1767 underlineInfo = ( *underlineInfoIt );
1770 // Whether current text is underlined.
1771 textUnderlineStatus.mCurrentUnderlineStatus = false;
1772 textUnderlineStatus.mCharacterGlobalIndex = 0;
1773 textUnderlineStatus.mLineGlobalIndex = 0;
1775 float currentLineHeight = 0.f;
1776 float currentLineAscender = 0.f;
1778 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(), lineEndIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
1779 lineIt != lineEndIt;
1782 TextViewProcessor::LineLayoutInfo& line( *lineIt );
1784 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupIt = line.mWordGroupsLayoutInfo.begin(), groupEndIt = line.mWordGroupsLayoutInfo.end();
1785 groupIt != groupEndIt;
1788 TextViewProcessor::WordGroupLayoutInfo& group( *groupIt );
1790 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordIt = group.mWordsLayoutInfo.begin(), wordEndIt = group.mWordsLayoutInfo.end();
1791 wordIt != wordEndIt;
1794 TextViewProcessor::WordLayoutInfo& word( *wordIt );
1796 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterIt = word.mCharactersLayoutInfo.begin(), characterEndIt = word.mCharactersLayoutInfo.end();
1797 characterIt != characterEndIt;
1800 TextViewProcessor::CharacterLayoutInfo& characterGroup( *characterIt );
1802 // Check if current character is the first of a new laid-out line
1804 bool isNewLine = false;
1806 if( textUnderlineStatus.mLineGlobalIndex < relayoutData.mLines.size() )
1808 const Toolkit::TextView::LineLayoutInfo& lineLayoutInfo( *( relayoutData.mLines.begin() + textUnderlineStatus.mLineGlobalIndex ) );
1809 isNewLine = ( textUnderlineStatus.mCharacterGlobalIndex == lineLayoutInfo.mCharacterGlobalIndex );
1813 currentLineHeight = lineLayoutInfo.mSize.height;
1814 currentLineAscender = lineLayoutInfo.mAscender;
1815 ++textUnderlineStatus.mLineGlobalIndex; // If it's a new line, point to the next one.
1819 if( characterGroup.mStyledText.mStyle.GetUnderline() )
1821 if( textUnderlineStatus.mCurrentUnderlineStatus )
1825 // Retrieves the thickness and position for the next piece of underlined text.
1826 if( underlineInfoIt < underlineInfoEndIt )
1829 if( underlineInfoIt < underlineInfoEndIt )
1831 underlineInfo = *underlineInfoIt;
1837 textUnderlineStatus.mCurrentUnderlineStatus = true;
1839 // Sets the underline's thickness.
1840 characterGroup.mStyledText.mStyle.SetUnderlineThickness( underlineInfo.mMaxThickness );
1842 // Before setting the position it needs to be adjusted to match the base line.
1843 const float bearingOffset = ( currentLineHeight - currentLineAscender ) - ( characterGroup.mSize.height - characterGroup.mAscender );
1844 const float positionOffset = ( underlineInfo.mMaxHeight - characterGroup.mSize.height ) - bearingOffset;
1846 // Sets the underline's position.
1847 characterGroup.mStyledText.mStyle.SetUnderlinePosition( underlineInfo.mPosition - positionOffset );
1849 // Mark the group of characters to be set the new style into the text-actor.
1850 characterGroup.mSetStyle = true;
1854 if( textUnderlineStatus.mCurrentUnderlineStatus )
1856 textUnderlineStatus.mCurrentUnderlineStatus = false;
1858 // Retrieves the thickness and position for the next piece of underlined text.
1859 if( underlineInfoIt < underlineInfoEndIt )
1862 if( underlineInfoIt < underlineInfoEndIt )
1864 underlineInfo = *underlineInfoIt;
1870 ++textUnderlineStatus.mCharacterGlobalIndex;
1871 } // end of group of characters.
1873 } // end of group of words.
1877 void RemoveGlyphActors( Actor textView,
1878 const std::vector<RenderableActor>& glyphActors )
1880 // Removes previously inserted renderable-actors.
1881 // The SplitByNewLineChar::Relayout(), SplitByWord::Relayout() and SplitByChar::Relayout() functions add
1882 // renderable-actors to the text-view. A handle to these renderable-actors are stored and passed to this function
1883 // in order to remove 'only' renderable-actors added by these functions.
1884 // Any other actor added by a programmer or application won't be removed.
1886 for( std::vector<RenderableActor>::const_reverse_iterator it = glyphActors.rbegin(), endIt = glyphActors.rend(); it != endIt; ++it )
1888 textView.Remove( *it );
1892 void InsertToTextView( const TextView::RelayoutOperationMask relayoutOperationMask,
1894 TextView::RelayoutData& relayoutData )
1896 const bool insertToTextView = relayoutOperationMask & TextView::RELAYOUT_INSERT_TO_TEXT_VIEW;
1897 const bool insertToTextActorList = relayoutOperationMask & TextView::RELAYOUT_INSERT_TO_TEXT_ACTOR_LIST;
1899 // Add text-actors to the text-view.
1901 for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(),
1902 endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
1903 lineLayoutIt != endLineLayoutIt;
1906 TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
1908 for( TextViewProcessor::WordGroupLayoutInfoContainer::iterator groupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.begin(),
1909 endGroupLayoutIt = lineLayoutInfo.mWordGroupsLayoutInfo.end();
1910 groupLayoutIt != endGroupLayoutIt;
1913 TextViewProcessor::WordGroupLayoutInfo& wordGroupLayoutInfo( *groupLayoutIt );
1915 for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.begin(),
1916 endWordLayoutIt = wordGroupLayoutInfo.mWordsLayoutInfo.end();
1917 wordLayoutIt != endWordLayoutIt;
1920 TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
1922 for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin(),
1923 endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.end();
1924 characterLayoutIt != endCharacterLayoutIt;
1925 ++characterLayoutIt )
1927 TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
1929 if( characterLayoutInfo.mIsVisible && characterLayoutInfo.mGlyphActor ) // White spaces and '\n' characters doesn't have a text-actor.
1931 //Add to the text-view.
1932 if( insertToTextView )
1934 textView.Add( characterLayoutInfo.mGlyphActor );
1936 if( insertToTextActorList )
1938 relayoutData.mGlyphActors.push_back( characterLayoutInfo.mGlyphActor );
1941 } // end group of character
1943 } // end group of words
1946 for( std::vector<RenderableActor>::iterator it = relayoutData.mEllipsizedGlyphActors.begin(),
1947 endIt = relayoutData.mEllipsizedGlyphActors.end();
1951 RenderableActor glyphActor = ( *it );
1953 //Add to the text-view.
1954 if( insertToTextView )
1956 textView.Add( glyphActor );
1958 if( insertToTextActorList )
1960 relayoutData.mGlyphActors.push_back( glyphActor );
1963 relayoutData.mEllipsizedGlyphActors.clear();
1966 RenderableActor CreateGlyphActor( const Text& text, const TextStyle& style, TextActorCache& cache )
1968 TextActor textActor = cache.RetrieveTextActor();
1972 // Update the text-actor.
1973 textActor.SetText( text );
1974 textActor.SetTextStyle( style );
1978 // The text-actor cache is empty. Create a new one.
1979 textActor = TextActor::New( text, style, false, true );
1985 } // namespace TextViewRelayout
1987 } // namespace Internal
1989 } // namespace Toolkit