Length numberOfCharacters; ///< The number of characters which fit in one line.
Length numberOfGlyphs; ///< The number of glyph which fit in one line.
float length; ///< The length of the glyphs which fit in one line.
+ float widthAdvanceDiff; ///< The difference between the width and the advance of the last glyph.
float wsLengthEndOfLine; ///< The length of the white spaces at the end of the line.
- float height; ///< The maximum height of all fonts in the line.
float ascender; ///< The maximum ascender of all fonts in the line.
+ float descender; ///< The maximum descender of all fonts in the line.
};
struct LayoutEngine::Impl
lineLayout.numberOfGlyphs = 0u;
lineLayout.length = 0.f;
lineLayout.wsLengthEndOfLine = 0.f;
- lineLayout.height = 0.f;
lineLayout.ascender = 0.f;
+ lineLayout.descender = 0.f;
// Get the last glyph index.
const GlyphIndex lastGlyphIndex = parameters.totalNumberOfGlyphs - 1u;
Text::FontMetrics fontMetrics;
mFontClient.GetFontMetrics( glyphInfo.fontId, fontMetrics );
- // Sets the maximum height.
- if( fontMetrics.height > lineLayout.height )
- {
- lineLayout.height = fontMetrics.height;
- }
-
// Sets the maximum ascender.
if( fontMetrics.ascender > lineLayout.ascender )
{
lineLayout.ascender = fontMetrics.ascender;
}
+ // Sets the maximum descender.
+ if( fontMetrics.descender > lineLayout.descender )
+ {
+ lineLayout.descender = fontMetrics.descender;
+ }
+
lastFontId = glyphInfo.fontId;
}
}
lineLayout.numberOfCharacters = 0u;
lineLayout.numberOfGlyphs = 0u;
lineLayout.length = 0.f;
+ lineLayout.widthAdvanceDiff = 0.f;
lineLayout.wsLengthEndOfLine = 0.f;
- lineLayout.height = 0.f;
lineLayout.ascender = 0.f;
+ lineLayout.descender = 0.f;
// Stores temporary line layout which has not been added to the final line layout.
LineLayout tmpLineLayout;
tmpLineLayout.numberOfCharacters = 0u;
tmpLineLayout.numberOfGlyphs = 0u;
tmpLineLayout.length = 0.f;
+ tmpLineLayout.widthAdvanceDiff = 0.f;
tmpLineLayout.wsLengthEndOfLine = 0.f;
- tmpLineLayout.height = 0.f;
tmpLineLayout.ascender = 0.f;
-
- // Get the last glyph index.
- const GlyphIndex lastGlyphIndex = parameters.totalNumberOfGlyphs - 1u;
+ tmpLineLayout.descender = 0.f;
FontId lastFontId = 0u;
for( GlyphIndex glyphIndex = lineLayout.glyphIndex;
{
// Add the length to the length of white spaces at the end of the line.
tmpLineLayout.wsLengthEndOfLine += glyphInfo.advance; // I use the advance as the width is always zero for the white spaces.
+ tmpLineLayout.widthAdvanceDiff = 0.f;
}
else
{
// Add as well any previous white space length.
- tmpLineLayout.length += tmpLineLayout.wsLengthEndOfLine + ( glyphIndex == lastGlyphIndex ) ? glyphInfo.width : glyphInfo.advance;
+ tmpLineLayout.length += tmpLineLayout.wsLengthEndOfLine + glyphInfo.advance;
+ tmpLineLayout.widthAdvanceDiff = glyphInfo.width - glyphInfo.advance;
// Clear the white space length at the end of the line.
tmpLineLayout.wsLengthEndOfLine = 0.f;
}
// Check if the accumulated length fits in the width of the box.
- if( lineLayout.length + tmpLineLayout.length + ( ( 0.f < tmpLineLayout.length ) ? lineLayout.wsLengthEndOfLine : 0.f ) > parameters.boundingBox.width )
+ if( lineLayout.length + tmpLineLayout.length + tmpLineLayout.widthAdvanceDiff + ( ( 0.f < tmpLineLayout.length ) ? lineLayout.wsLengthEndOfLine : 0.f ) > parameters.boundingBox.width )
{
// Current word does not fit in the box's width.
return;
lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters;
lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs;
lineLayout.length += tmpLineLayout.length;
+ lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff;
if( 0.f < tmpLineLayout.length )
{
lineLayout.wsLengthEndOfLine += tmpLineLayout.wsLengthEndOfLine;
}
- if( tmpLineLayout.height > lineLayout.height )
+ if( tmpLineLayout.ascender > lineLayout.ascender )
{
- lineLayout.height = tmpLineLayout.height;
+ lineLayout.ascender = tmpLineLayout.ascender;
}
- if( tmpLineLayout.ascender > lineLayout.ascender )
+ if( tmpLineLayout.descender > lineLayout.descender )
{
- lineLayout.ascender = tmpLineLayout.ascender;
+ lineLayout.descender = tmpLineLayout.descender;
}
tmpLineLayout.numberOfCharacters = 0u;
tmpLineLayout.numberOfGlyphs = 0u;
tmpLineLayout.length = 0u;
+ tmpLineLayout.widthAdvanceDiff = 0u;
tmpLineLayout.wsLengthEndOfLine = 0u;
- tmpLineLayout.height = 0.f;
tmpLineLayout.ascender = 0.f;
+ tmpLineLayout.descender = 0.f;
return;
}
lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters;
lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs;
lineLayout.length += tmpLineLayout.length;
+ lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff;
+
if( 0.f < tmpLineLayout.length )
{
lineLayout.length += lineLayout.wsLengthEndOfLine;
lineLayout.wsLengthEndOfLine += tmpLineLayout.wsLengthEndOfLine;
}
- if( tmpLineLayout.height > lineLayout.height )
+ if( tmpLineLayout.ascender > lineLayout.ascender )
{
- lineLayout.height = tmpLineLayout.height;
+ lineLayout.ascender = tmpLineLayout.ascender;
}
- if( tmpLineLayout.ascender > lineLayout.ascender )
+ if( tmpLineLayout.descender > lineLayout.descender )
{
- lineLayout.ascender = tmpLineLayout.ascender;
+ lineLayout.descender = tmpLineLayout.descender;
}
tmpLineLayout.numberOfCharacters = 0u;
tmpLineLayout.numberOfGlyphs = 0u;
tmpLineLayout.length = 0u;
+ tmpLineLayout.widthAdvanceDiff = 0u;
tmpLineLayout.wsLengthEndOfLine = 0u;
- tmpLineLayout.height = 0.f;
tmpLineLayout.ascender = 0.f;
+ tmpLineLayout.descender = 0.f;
}
if( lastFontId != glyphInfo.fontId )
Text::FontMetrics fontMetrics;
mFontClient.GetFontMetrics( glyphInfo.fontId, fontMetrics );
- // Sets the maximum height.
- if( fontMetrics.height > tmpLineLayout.height )
- {
- tmpLineLayout.height = fontMetrics.height;
- }
-
// Sets the maximum ascender.
if( fontMetrics.ascender > tmpLineLayout.ascender )
{
tmpLineLayout.ascender = fontMetrics.ascender;
}
+ // Sets the maximum descender.
+ if( -fontMetrics.descender > tmpLineLayout.descender )
+ {
+ tmpLineLayout.descender = -fontMetrics.descender;
+ }
+
lastFontId = glyphInfo.fontId;
}
}
}
void Align( const LayoutParameters& layoutParameters,
+ const Size& layoutSize,
const Vector<LineRun>& lines,
Vector<Vector2>& glyphPositions )
{
// 2) Calculate the alignment offset accordingly with the align option,
// the box width, line length, and the paragraphs direction.
- float alignOffset = CalculateAlignment( layoutParameters.boundingBox.width,
+ float alignOffset = CalculateAlignment( layoutSize.width,
line.lineSize.width,
line.extraLength,
paragraphDirection );
lineRun.characterRun.characterIndex = 0u;
lineRun.characterRun.numberOfCharacters = *( layoutParameters.glyphsToCharactersBuffer + lastGlyphIndex ) + *( layoutParameters.charactersPerGlyphBuffer + lastGlyphIndex );
lineRun.lineSize.width = layout.length;
- lineRun.lineSize.height = layout.height;
+ lineRun.lineSize.height = layout.ascender + layout.descender;
lineRun.extraLength = layout.wsLengthEndOfLine;
lines.PushBack( lineRun );
// Update the actual size.
actualSize.width = layout.length;
- actualSize.height = layout.height;
+ actualSize.height = lineRun.lineSize.height;
float penX = 0.f;
- float penY = layout.height;
+ float penY = layout.ascender;
Vector2* glyphPositionsBuffer = glyphPositions.Begin();
for( GlyphIndex glyphIndex = 0u; glyphIndex < layout.numberOfGlyphs; ++glyphIndex )
lineRun.numberOfGlyphs = layout.numberOfGlyphs;
lineRun.characterRun.characterIndex = *( layoutParameters.glyphsToCharactersBuffer + index );
lineRun.characterRun.numberOfCharacters = ( *( layoutParameters.glyphsToCharactersBuffer + lastGlyphIndex ) + *( layoutParameters.charactersPerGlyphBuffer + lastGlyphIndex ) ) - lineRun.characterRun.characterIndex;
- lineRun.lineSize.width = layout.length;
- lineRun.lineSize.height = layout.height;
+ lineRun.lineSize.width = layout.length + ( ( layout.widthAdvanceDiff > 0.f ) ? layout.widthAdvanceDiff : 0.f );
+ lineRun.lineSize.height = layout.ascender + layout.descender;
lineRun.extraLength = layout.wsLengthEndOfLine;
lines.PushBack( lineRun );
// Update the actual size.
- if( layout.length > actualSize.width )
+ if( layout.length + layout.widthAdvanceDiff > actualSize.width )
{
actualSize.width = layout.length;
}
- actualSize.height += layout.height;
+ actualSize.height += lineRun.lineSize.height;
// Traverse the glyphs and set the positions.
- penY += layout.height;
+ penY += layout.ascender;
Vector2* glyphPositionsBuffer = glyphPositions.Begin();
for( GlyphIndex i = index; i < index + layout.numberOfGlyphs; ++i )
penX += glyph.advance;
}
+ penY += layout.descender;
+
// Increase the glyph index.
index += layout.numberOfGlyphs;
}
}
void LayoutEngine::Align( const LayoutParameters& layoutParameters,
+ const Size& layoutSize,
const Vector<LineRun>& lines,
Vector<Vector2>& glyphPositions )
{
mImpl->Align( layoutParameters,
+ layoutSize,
lines,
glyphPositions );
}
/**
* @brief Helper to move the cursor, grab handle etc.
*/
- bool ProcessInputEvents( const Vector2& controlSize )
+ bool ProcessInputEvents( const Vector2& controlSize,
+ const Vector2& alignmentOffset )
{
mDecoratorUpdated = false;
}
case TAP_EVENT:
{
- OnTapEvent( *iter );
+ OnTapEvent( *iter, alignmentOffset );
break;
}
case PAN_EVENT:
{
- OnPanEvent( *iter, controlSize );
+ OnPanEvent( *iter, controlSize, alignmentOffset );
break;
}
case GRAB_HANDLE_EVENT:
// TODO
}
- void OnTapEvent( const Event& event )
+ void OnTapEvent( const Event& event,
+ const Vector2& alignmentOffset )
{
unsigned int tapCount = event.p1.mUint;
{
ChangeState( EDITING );
- float xPosition = event.p2.mFloat;
- float yPosition = event.p3.mFloat;
+ float xPosition = event.p2.mFloat - alignmentOffset.x;
+ float yPosition = event.p3.mFloat - alignmentOffset.y;
float height(0.0f);
GetClosestCursorPosition( mPrimaryCursorPosition, xPosition, yPosition, height );
mDecorator->SetPosition( PRIMARY_CURSOR, xPosition, yPosition, height );
}
}
- void OnPanEvent( const Event& event, const Vector2& controlSize )
+ void OnPanEvent( const Event& event,
+ const Vector2& controlSize,
+ const Vector2& alignmentOffset )
{
int state = event.p1.mInt;
if( mHorizontalScrollingEnabled )
{
- float displacementX = event.p2.mFloat;
+ const float displacementX = event.p2.mFloat;
mScrollPosition.x += displacementX;
- // Clamp between -space & 0
- float contentWidth = actualSize.width;
- float space = (contentWidth > controlSize.width) ? contentWidth - controlSize.width : 0.0f;
- mScrollPosition.x = ( mScrollPosition.x < -space ) ? -space : mScrollPosition.x;
- mScrollPosition.x = ( mScrollPosition.x > 0 ) ? 0 : mScrollPosition.x;
+ // Clamp between -space & 0 (and the text alignment).
+ const float contentWidth = actualSize.width;
+ if( contentWidth > controlSize.width )
+ {
+ const float space = ( contentWidth - controlSize.width ) + alignmentOffset.x;
+ mScrollPosition.x = ( mScrollPosition.x < -space ) ? -space : mScrollPosition.x;
+ mScrollPosition.x = ( mScrollPosition.x > -alignmentOffset.x ) ? -alignmentOffset.x : mScrollPosition.x;
- mDecoratorUpdated = true;
+ mDecoratorUpdated = true;
+ }
+ else
+ {
+ mScrollPosition.x = 0.f;
+ }
}
+
if( mVerticalScrollingEnabled )
{
- float displacementY = event.p3.mFloat;
+ const float displacementY = event.p3.mFloat;
mScrollPosition.y += displacementY;
- // Clamp between -space & 0
- float space = (actualSize.height > controlSize.height) ? actualSize.height - controlSize.height : 0.0f;
- mScrollPosition.y = ( mScrollPosition.y < -space ) ? -space : mScrollPosition.y;
- mScrollPosition.y = ( mScrollPosition.y > 0 ) ? 0 : mScrollPosition.y;
+ // Clamp between -space & 0 (and the text alignment).
+ if( actualSize.height > controlSize.height )
+ {
+ const float space = ( actualSize.height - controlSize.height ) + alignmentOffset.y;
+ mScrollPosition.y = ( mScrollPosition.y < -space ) ? -space : mScrollPosition.y;
+ mScrollPosition.y = ( mScrollPosition.y > -alignmentOffset.y ) ? -alignmentOffset.y : mScrollPosition.y;
- mDecoratorUpdated = true;
+ mDecoratorUpdated = true;
+ }
+ else
+ {
+ mScrollPosition.y = 0.f;
+ }
}
}
}
mLayoutEngine(),
mModifyEvents(),
mControlSize(),
+ mAlignmentOffset(),
mOperationsPending( NO_OPERATION ),
mRecalculateNaturalSize( true )
{
LayoutEngine mLayoutEngine; ///< The layout engine.
std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
Size mControlSize; ///< The size of the control.
+ Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
};
return Vector2::ZERO;
}
+const Vector2& Controller::GetAlignmentOffset() const
+{
+ return mImpl->mAlignmentOffset;
+}
+
Vector3 Controller::GetNaturalSize()
{
Vector3 naturalSize;
return layoutSize.height;
}
-bool Controller::Relayout( const Vector2& size )
+bool Controller::Relayout( const Size& size )
{
if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
{
// Do not re-do any operation until something changes.
mImpl->mOperationsPending = NO_OPERATION;
+ // After doing the text layout, the alignment offset to place the actor in the desired position can be calculated.
+ CalculateTextAlignment( size );
+
if( mImpl->mTextInput )
{
// Move the cursor, grab handle etc.
- updated = mImpl->mTextInput->ProcessInputEvents( mImpl->mControlSize ) || updated;
+ updated = mImpl->mTextInput->ProcessInputEvents( mImpl->mControlSize, mImpl->mAlignmentOffset ) || updated;
}
return updated;
}
}
-bool Controller::DoRelayout( const Vector2& size,
+bool Controller::DoRelayout( const Size& size,
OperationsMask operationsRequired,
Size& layoutSize )
{
if( ALIGN & operations )
{
mImpl->mLayoutEngine.Align( layoutParameters,
+ layoutSize,
lines,
glyphPositions );
}
return viewUpdated;
}
+void Controller::CalculateTextAlignment( const Size& size )
+{
+ // TODO : Calculate the vertical offset.
+
+ // Get the direction of the first character.
+ const CharacterDirection firstParagraphDirection = mImpl->mLogicalModel->GetCharacterDirection( 0u );
+
+ const Size& actualSize = mImpl->mVisualModel->GetActualSize();
+
+ // If the first paragraph is right to left swap ALIGN_BEGIN and ALIGN_END;
+ LayoutEngine::Alignment alignment = mImpl->mLayoutEngine.GetAlignment();
+ if( firstParagraphDirection &&
+ ( LayoutEngine::ALIGN_CENTER != alignment ) )
+ {
+ if( LayoutEngine::ALIGN_BEGIN == alignment )
+ {
+ alignment = LayoutEngine::ALIGN_END;
+ }
+ else
+ {
+ alignment = LayoutEngine::ALIGN_BEGIN;
+ }
+ }
+
+ switch( alignment )
+ {
+ case LayoutEngine::ALIGN_BEGIN:
+ {
+ mImpl->mAlignmentOffset = Vector2::ZERO;
+ break;
+ }
+ case LayoutEngine::ALIGN_CENTER:
+ {
+ mImpl->mAlignmentOffset.y = 0.f;
+ const int intOffset = static_cast<int>( 0.5f * ( size.width - actualSize.width ) ); // try to avoid pixel alignment.
+ mImpl->mAlignmentOffset.x = static_cast<float>( intOffset );
+ break;
+ }
+ case LayoutEngine::ALIGN_END:
+ {
+ mImpl->mAlignmentOffset.y = 0.f;
+ mImpl->mAlignmentOffset.x = size.width - actualSize.width;
+ break;
+ }
+ }
+}
+
View& Controller::GetView()
{
return mImpl->mView;