cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-03 20:37:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add some documentation of SVG calculations

Browse Source
This commit is contained in:
Pokey Rule 2021-07-06 19:40:40 +01:00
parent 5cf8a8db87
commit 89501db38a
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
images/svg-calculations.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 508 KiB

10
src/Decorations.ts
View File

@ -107,6 +107,16 @@ export default class Decorations {
return vscode.Uri.parse(`data:image/svg+xml;base64,${encoded}`);
}
/**
* Creates an SVG from the hat SVG that pads, offsets and scales it to end up
* in the right size / place relative to the character it will be placed over.
* [This image](../images/svg-calculations.png) may or may not be helpful.
*
* @param fontMeasurements Info about the user's font
* @param hatWidthToCharacterWidthRatio How wide should hats be relative to character width
* @param hatVerticalOffset How far off top of characters should hats be
* @returns An object with the new SVG and its measurements
*/
private processSvg(
fontMeasurements: FontMeasurements,
hatWidthToCharacterWidthRatio: number,