solve issue #1158 (enabling Right-to-Left fonts) #1685

Aufricer · 2021-11-28T01:14:44Z

This pull request is solving the problem with displaying Right to Left texts in JME. fixes #1158 and would also make the additional file for testcase close #1159 unnecessary.

More info could be found in the forum or in the discussion for issue #1158.

What changed:
Beside repairing the behaviour of RtL texts, a new parameter in BitMapfont allowing to set the textdirection in the font and in Bitmaptext. Before that was not possible in the font itself.
An interface "GlyphParser" now allowing the user of Persian, Arabic or other RtL oriented fonts to use individual parsers for the correct position of letters in a text (that may differ depending on letter before or after that) something that is not needed for Left to Rights texts.
Also a new discovered bug that brings different results for linewidth from BitmapText.getLineWidth() and BitmapFont.getLineWidth() for textinput with multilines had been fixed.

We have tested it and feel the PR is ready for review.

Edit: Of course it is Right to Left texts (at least I wrote it wrong on each occasion in the text)

Some parts need testing

…nt. Not sure if that will break the import from assetmanager.loadFont

Some parts need testing

If the boolean RtL should not be set via Bitmaptext, te whole class could be unchanged

…for RtL text. (it was deducted twice before) Still not sure if it is correct that way.

If the boolean RtL should not be set via Bitmaptext, te whole class could be unchanged

…o have the same result for LtR texts as it is given by BitMapFont.getLineWidth.

…dth() and BitmapFont.getLineWidth() will now have the same results. A few open ToDo and tests have been solvd/closed.

pspeed42 · 2021-11-28T04:01:44Z

Did you mean "Right to Left" in the above?

stephengold · 2021-11-28T06:36:56Z

I appreciate the hard work that went into this PR. Thank you for contributing to the project!

Aufricer · 2021-11-28T10:01:14Z

@pspeed42 - Yes of course. Right to Left texts...

stephengold · 2021-12-02T19:05:25Z

Why was the "local.properties" file deleted?

@pspeed42 Do you have any desire to review this PR?

pspeed42 · 2021-12-02T20:31:52Z

I should probably give it a glance at least.

Aufricer · 2021-12-05T09:20:35Z

Why was the "local.properties" file deleted?

I realized it was added by my JDK. It contained a warning saying remove before publishing and contained system info of the computer I had used.

stephengold · 2021-12-05T18:50:16Z

I should probably give it a glance at least.

Will you have time to do so during the next 10 days?

stephengold · 2021-12-05T20:15:22Z

Why was the "local.properties" file deleted?

I realized it was added by my JDK. It contained a warning saying remove before publishing and contained system info of the computer I had used.

"local.properties" has been part of the Engine since 2015. I'm unsure what it does, but if it doesn't relate to this PR, please restore it.

# Conflicts: # local.properties

Aufricer · 2021-12-07T19:35:05Z

I (hope) I have just restored the local.properties

stephengold

I want to get this PR integrated before beta, and I don't know when @pspeed42 is going to get a chance to look at it, so did a quick pass. If anything's unclear, please discuss.

jme3-core/src/main/java/com/jme3/font/BitmapFont.java

jme3-examples/src/main/java/jme3test/gui/TestRtlBitmapText.java

local.properties

jme3-examples/src/main/java/jme3test/gui/TestRtlBitmapText.java

Ali-RS · 2021-12-09T09:17:43Z

I fixed some of the change requests.

Ali-RS · 2021-12-09T10:24:54Z

I have implemented GlyphParser for Persian text, should we include it in the repo as well?

stephengold · 2021-12-09T16:25:13Z

I have implemented GlyphParser for Persian text, should we include it in the repo as well?

Language-specific features seem like the sort of thing that should be in https://github.com/jMonkeyEngine-Contributions or at the JmonkeyStore, not jme3-core.

jme3-core/src/main/java/com/jme3/font/GlyphParser.java

Ali-RS · 2021-12-09T18:06:45Z

Added a commit to serialize "rightToLeft" field in BitmapFont.

Should "glyphParser" field in the BitmapFont be serialized as well? (GlyphParser interface must extend com.jme3.export.Savable?)

stephengold · 2021-12-09T21:32:26Z

Should "glyphParser" field in the BitmapFont be serialized as well?

I think if the font got saved for some reason, you'd want to serialize the parser as well. So yes.

It might be okay not to clone the glyphParser, however, at least if you document that detail.

Ali-RS · 2021-12-09T22:26:26Z

Want to mention one more thing, that's about using numbers inside RTL text (bidirectional text).
The numbers will be shown in reverse (e.g 123 will be displayed 321).

Swing uses Unicode Bidirectional Algorithm to handle RTL mixed with LTR text. In the case of JME, I managed to fix this issue inside the glyph parser simply by reversing the numbers.

stephengold · 2021-12-09T23:57:00Z

Seems worth documenting in a comment somewhere. Probably in GlyphParser.

Ali-RS · 2021-12-10T08:23:27Z

I think if the font got saved for some reason, you'd want to serialize the parser as well. So yes.

Done.

Seems worth documenting in a comment somewhere. Probably in GlyphParser.

I will document this inside the PersianGlyphParser implementation, which I will add it to jMonkeyEngine-Contributions page later. Then I will add a link to it inside GlyphParser interface.

Like this: "For an example implementation see [link to PersianGlyphParser]."

What do you think?

stephengold · 2021-12-10T18:06:49Z

Sorry, I can't follow that link. Retry?

Edit: Sorry I misunderstood. Yes, including a URL in the GlyphParser javadoc would be great.

…tToLeft" should be specified in the font.

Ali-RS · 2021-12-11T06:16:27Z

Deprecated the Deprecate BitmapText(BitmapFont font, boolean rightToLeft).

Ali-RS · 2021-12-11T12:07:07Z

I noticed setting text horizontal alignment to the Align.Right does not work when vertical alignment is set to anything other than VAlign.Top. I will submit a patch to fix it and other change requests.

… alignment was set to anything other than VAlign.Top also made some code cleanup.

Ali-RS · 2021-12-11T18:47:22Z

And this is the GlyphParser implementation for Persian text:

https://github.com/Ali-RS/JME-PersianGlyphParser/blob/8f705a291277f744a2abf6ec73b7071e3f31be61/src/main/java/com/jme3/font/plugins/PersianGlyphParser.java#L47

Ali-RS · 2021-12-12T07:29:19Z

Then I will add a link to it inside GlyphParser interface.
Like this: "For an example implementation see [link to PersianGlyphParser]."

Done

stephengold · 2021-12-14T19:18:04Z

I believe this is ready for integration.

Unless there's further discussion, I plan to fix a few stylistic issues and integrate this in about 24 hours.

stephengold · 2021-12-14T19:22:01Z

The "local.properties" file will soon be addressed by PR #1708.

Ali-RS · 2021-12-15T19:36:53Z

Thanks, @stephengold :)

stephengold · 2021-12-15T19:40:18Z

Thanks, @Aufricer and @Ali-RS!

Aufricer and others added 14 commits October 17, 2021 13:47

Display Right to Left text correctly (Issue jMonkeyEngine#1158).

329d951

Some parts need testing

Just a suggestion to set the Right to Left text parameter with the fo…

797ee94

…nt. Not sure if that will break the import from assetmanager.loadFont

Display Right to Left text correctly (Issue jMonkeyEngine#1158).

8f4f5f4

Some parts need testing

Edited out the reverse function of the textinput in BitmapText.

2c8751f

If the boolean RtL should not be set via Bitmaptext, te whole class could be unchanged

Changed the behaviour of RtL text without a textblock

d6e9f69

Updating the linewidth dor correct calculation if unbounded.

9b72b45

Changed the behaviour of how xoffset is treated while calculating x0 …

b8659cc

…for RtL text. (it was deducted twice before) Still not sure if it is correct that way.

Edited out the reverse function of the textinput in BitmapText.

c0e256d

If the boolean RtL should not be set via Bitmaptext, te whole class could be unchanged

validateSize() which is used in BitMapText.getLineWidth was changed t…

2994d80

…o have the same result for LtR texts as it is given by BitMapFont.getLineWidth.

Merge branch 'jMonkeyEngine:master' into master

a11d329

Merged with the adaptions and changes of Ali-RS. BitmapText.getLineWi…

aae5c0a

…dth() and BitmapFont.getLineWidth() will now have the same results. A few open ToDo and tests have been solvd/closed.

Removed ToDos no longer needed due to the last changes

b17e584

Detected small (incorrect) changes while comparing, fixed

4f5b941

Delete local.properties

ef404d5

stephengold added this to the v3.5.0 milestone Nov 28, 2021

Aufricer changed the title ~~Enabling Left to Right Fonts Issue #1158~~ Enabling Right to Left Fonts - Issue #1158 Nov 28, 2021

Aufricer added 2 commits December 7, 2021 20:30

Get back local.properties

0b7f1d1

Merge remote-tracking branch 'origin/master'

0fc9bd7

# Conflicts: # local.properties

stephengold requested changes Dec 8, 2021

View reviewed changes

Fix javadoc & formatting issues.

f2f12eb

stephengold reviewed Dec 9, 2021

View reviewed changes

jme3-core/src/main/java/com/jme3/font/GlyphParser.java Show resolved Hide resolved

Ali-RS added 2 commits December 9, 2021 20:45

Added license to GlyphParser.

489db71

BitmapFont: serialize "rightToLeft" boolean field.

75635a1

Made GlyphParser savable.

1797ee8

Deprecate BitmapText(BitmapFont font, boolean rightToLeft). The "righ…

f2f39b3

…tToLeft" should be specified in the font.

Fixed alignment issue where Align.Right was not working when vertical…

21134ac

… alignment was set to anything other than VAlign.Top also made some code cleanup.

GlyphParser:added link to an example implementation for Persian text.

e12275d

stephengold approved these changes Dec 14, 2021

View reviewed changes

Merge branch 'master' into master

fba37a6

stephengold changed the title ~~Enabling Right to Left Fonts - Issue #1158~~ solve issue #1158 (enabling Right-to-Left fonts) Dec 15, 2021

stephengold merged commit 118b6c8 into jMonkeyEngine:master Dec 15, 2021

stephengold mentioned this pull request Dec 17, 2021

avoid invoking the newly-deprecated BitmapText 2-arg constructor #1709

Merged

Uh oh!

solve issue #1158 (enabling Right-to-Left fonts) #1685

solve issue #1158 (enabling Right-to-Left fonts) #1685

Uh oh!

Conversation

Aufricer commented Nov 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pspeed42 commented Nov 28, 2021

Uh oh!

stephengold commented Nov 28, 2021

Uh oh!

Aufricer commented Nov 28, 2021

Uh oh!

stephengold commented Dec 2, 2021

Uh oh!

pspeed42 commented Dec 2, 2021

Uh oh!

Aufricer commented Dec 5, 2021

Uh oh!

stephengold commented Dec 5, 2021

Uh oh!

stephengold commented Dec 5, 2021

Uh oh!

Aufricer commented Dec 7, 2021

Uh oh!

stephengold left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ali-RS commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ali-RS commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stephengold commented Dec 9, 2021

Uh oh!

Uh oh!

Ali-RS commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stephengold commented Dec 9, 2021

Uh oh!

Ali-RS commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stephengold commented Dec 9, 2021

Uh oh!

Ali-RS commented Dec 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stephengold commented Dec 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ali-RS commented Dec 11, 2021

Uh oh!

Ali-RS commented Dec 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ali-RS commented Dec 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ali-RS commented Dec 12, 2021

Uh oh!

stephengold commented Dec 14, 2021

Uh oh!

stephengold commented Dec 14, 2021

Uh oh!

Ali-RS commented Dec 15, 2021

Uh oh!

Aufricer commented Nov 28, 2021 •

edited

Loading

Ali-RS commented Dec 9, 2021 •

edited

Loading

Ali-RS commented Dec 9, 2021 •

edited

Loading

Ali-RS commented Dec 9, 2021 •

edited

Loading

Ali-RS commented Dec 9, 2021 •

edited

Loading

Ali-RS commented Dec 10, 2021 •

edited

Loading

stephengold commented Dec 10, 2021 •

edited

Loading

Ali-RS commented Dec 11, 2021 •

edited

Loading

Ali-RS commented Dec 11, 2021 •

edited

Loading