Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-30 16:39:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

BitmapText.getCharacterAt is a new method that will return the character data from the BitmapText at the given x and y corodinates. The character data includes the code, position, dimensions and glyph information.

Browse source
This commit is contained in:
Richard Davey 2020-07-31 11:36:48 +01:00
parent a72fdd44f8
commit a682b83b7c
1 changed files with 8 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/gameobjects/bitmaptext/static/BitmapText.js
View file

@ -387,15 +387,17 @@ var BitmapText = new Class({
* Gets the character located at the given x/y coordinate within this Bitmap Text. * Gets the character located at the given x/y coordinate within this Bitmap Text.
* *
* The coordinates you pass in are translated into the local space of the * The coordinates you pass in are translated into the local space of the
* Bitmap Text, however, it is up to you to first translate the input coordinates. * Bitmap Text, however, it is up to you to first translate the input coordinates to world space.
* *
* If you wish to use this in combination with an input event, be sure * If you wish to use this in combination with an input event, be sure
* to pass in `Pointer.worldX` and `worldY` so they are transformed into * to pass in `Pointer.worldX` and `worldY` so they are in world space.
* camera space.
* *
* In some cases, based on kerning, characters can overlap. When this happens, * In some cases, based on kerning, characters can overlap. When this happens,
* the first character in the word is returned. * the first character in the word is returned.
* *
* Note that this does not work for DynamicBitmapText if you have changed the
* character positions during render. It will only scan characters in their un-translated state.
*
* @method Phaser.GameObjects.BitmapText#getCharacterAt * @method Phaser.GameObjects.BitmapText#getCharacterAt
* @since 3.25.0 * @since 3.25.0
* *
@ -403,19 +405,11 @@ var BitmapText = new Class({
* @param {number} y - The y position to check. * @param {number} y - The y position to check.
* @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera which is being tested against. If not given will use the Scene default camera. * @param {Phaser.Cameras.Scene2D.Camera} [camera] - The Camera which is being tested against. If not given will use the Scene default camera.
* *
* @return {Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter} The character at the given position, or `null`. * @return {Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter} The character object at the given position, or `null`.
*/ */
getCharacterAt: function (x, y, camera) getCharacterAt: function (x, y, camera)
{ {
if (camera === undefined) { camera = this.scene.sys.cameras.main; } var point = this.getLocalPoint(x, y, null, camera);
var csx = camera.scrollX;
var csy = camera.scrollY;
var px = x + (csx * this.scrollFactorX) - csx;
var py = y + (csy * this.scrollFactorY) - csy;
var point = this.getWorldTransformMatrix().applyInverse(px, py);
var bounds = this.getTextBounds(true); var bounds = this.getTextBounds(true);
@ -785,9 +779,9 @@ BitmapText.ParseFromAtlas = ParseFromAtlas;
* @since 3.17.0 * @since 3.17.0
* *
* @param {XMLDocument} xml - The XML Document to parse the font from. * @param {XMLDocument} xml - The XML Document to parse the font from.
* @param {Phaser.Textures.Frame} frame - The texture frame to take into account when creating the uv data.
* @param {integer} [xSpacing=0] - The x-axis spacing to add between each letter. * @param {integer} [xSpacing=0] - The x-axis spacing to add between each letter.
* @param {integer} [ySpacing=0] - The y-axis spacing to add to the line height. * @param {integer} [ySpacing=0] - The y-axis spacing to add to the line height.
* @param {Phaser.Textures.Frame} [frame] - The texture frame to take into account while parsing.
* *
* @return {Phaser.Types.GameObjects.BitmapText.BitmapFontData} The parsed Bitmap Font data. * @return {Phaser.Types.GameObjects.BitmapText.BitmapFontData} The parsed Bitmap Font data.
*/ */