TextLine
Содержит строку текста.
Содержит строку текста.
Абстракция над TextServer для обработки одной строки текста.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
TextLineКонструктор
public TextLine();Свойства9
AlignmentСвойство
public HorizontalAlignment Alignment { get; set; }Устанавливает выравнивание текста внутри строки так, как если бы строка была горизонтальной.
DirectionСвойство
public TextServer.Direction Direction { get; set; }Направление написания текста.
EllipsisCharСвойство
public string EllipsisChar { get; set; }Символ многоточия, используемый для обрезки текста.
FlagsСвойство
public TextServer.JustificationFlag Flags { get; set; }Правила выравнивания строк. Для получения дополнительной информации см. TextServer.
OrientationСвойство
public TextServer.Orientation Orientation { get; set; }Ориентация текста.
PreserveControlСвойство
public bool PreserveControl { get; set; }Если установлено значение true, текст будет отображать управляющие символы.
PreserveInvalidСвойство
public bool PreserveInvalid { get; set; }Если установлено значение true, в тексте будут отображаться недопустимые символы.
TextOverrunBehaviorСвойство
public TextServer.OverrunBehavior TextOverrunBehavior { get; set; }Поведение обрезки, когда текст превышает установленную ширину текстовой строки.
WidthСвойство
public float Width { get; set; }Ширина текстовой строки.
Методы42
AddObjectbool
public bool AddObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, int length = 1, float baseline = 0f);Добавляет встроенный объект в текстовый буфер, key должен быть уникальным. В тексте объект представлен как length символов замены объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
size | Vector2 | — |
inlineAlign | InlineAlignment | InlineAlignment.Center |
length | int | 1 |
baseline | float | 0f |
boolAddStringbool
public bool AddString(string text, Font font, int fontSize, string language = "", Variant meta = default);Добавляет текстовый диапазон и шрифт для его отрисовки.
| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
font | Font | — |
fontSize | int | — |
language | string | "" |
meta | Variant | default |
boolClearvoid
public void Clear();Очищает текстовую строку (удаляет текст и встроенные объекты).
Draw2 перегрузки
public void Draw(Rid canvas, Vector2 pos, Color? color);Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
color | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void Draw(Rid canvas, Vector2 pos, Color? color = default, float oversampling = 0f);Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
color | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DrawOutline2 перегрузки
public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize, Color? color);Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
outlineSize | int | — |
color | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize = 1, Color? color = default, float oversampling = 0f);Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
outlineSize | int | 1 |
color | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DuplicateTextLine
public TextLine Duplicate();Дублирует этот TextLine.
TextLineGetDirectionTextServer.Direction
public TextServer.Direction GetDirection();TextServer.DirectionGetEllipsisCharstring
public string GetEllipsisChar();stringGetFlagsTextServer.JustificationFlag
public TextServer.JustificationFlag GetFlags();TextServer.JustificationFlagGetHorizontalAlignmentHorizontalAlignment
public HorizontalAlignment GetHorizontalAlignment();HorizontalAlignmentGetInferredDirectionTextServer.Direction
public TextServer.Direction GetInferredDirection();Возвращает направление написания текста, выведенное алгоритмом BiDi.
TextServer.DirectionGetLineAscentfloat
public float GetLineAscent();Возвращает высоту текста (количество пикселей над базовой линией для горизонтального расположения или слева от базовой линии для вертикального расположения).
floatGetLineDescentfloat
public float GetLineDescent();Возвращает смещение текста (количество пикселей ниже базовой линии для горизонтальной компоновки или справа от базовой линии для вертикальной).
floatGetLineUnderlinePositionfloat
public float GetLineUnderlinePosition();Возвращает смещение подчеркивания в пикселях относительно базовой линии.
floatGetLineUnderlineThicknessfloat
public float GetLineUnderlineThickness();Возвращает толщину подчеркивания.
floatGetLineWidthfloat
public float GetLineWidth();Возвращает ширину (для горизонтального расположения) или высоту (для вертикального расположения) текста.
floatGetObjectRectRect2
public Rect2 GetObjectRect(Variant key);Возвращает ограничивающий прямоугольник встроенного объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
Rect2GetObjectsReckfell.Collections.Array
public Reckfell.Collections.Array GetObjects();Возвращает массив встроенных объектов.
Reckfell.Collections.ArrayGetOrientationTextServer.Orientation
public TextServer.Orientation GetOrientation();TextServer.OrientationGetPreserveControlbool
public bool GetPreserveControl();boolGetPreserveInvalidbool
public bool GetPreserveInvalid();boolGetRidRid
public Rid GetRid();Возвращает RID буфера TextServer.
RidGetSizeVector2
public Vector2 GetSize();Возвращает размер ограничивающего прямоугольника текста.
Vector2GetTextOverrunBehaviorTextServer.OverrunBehavior
public TextServer.OverrunBehavior GetTextOverrunBehavior();TextServer.OverrunBehaviorGetWidthfloat
public float GetWidth();floatHasObjectbool
public bool HasObject(Variant key);Возвращает true, если в эту строку встроен объект с key.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
boolHitTestint
public int HitTest(float coords);Возвращает смещение символа каретки на указанное смещение пикселей на базовой линии. Эта функция всегда возвращает допустимую позицию.
| Имя | Тип | По умолчанию |
|---|---|---|
coords | float | — |
intResizeObjectbool
public bool ResizeObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, float baseline = 0f);Устанавливает новый размер и выравнивание внедренного объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
size | Vector2 | — |
inlineAlign | InlineAlignment | InlineAlignment.Center |
baseline | float | 0f |
boolSetBidiOverridevoid
public void SetBidiOverride(Reckfell.Collections.Array @override);Переопределяет BiDi для структурированного текста. Диапазоны переопределения должны охватывать весь исходный текст без перекрытий. Алгоритм BiDi будет использоваться для каждого диапазона отдельно.
| Имя | Тип | По умолчанию |
|---|---|---|
override | Reckfell.Collections.Array | — |
SetDirectionvoid
public void SetDirection(TextServer.Direction direction);| Имя | Тип | По умолчанию |
|---|---|---|
direction | TextServer.Direction | — |
SetEllipsisCharvoid
public void SetEllipsisChar(string @char);| Имя | Тип | По умолчанию |
|---|---|---|
char | string | — |
SetFlagsvoid
public void SetFlags(TextServer.JustificationFlag flags);| Имя | Тип | По умолчанию |
|---|---|---|
flags | TextServer.JustificationFlag | — |
SetHorizontalAlignmentvoid
public void SetHorizontalAlignment(HorizontalAlignment alignment);| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
SetOrientationvoid
public void SetOrientation(TextServer.Orientation orientation);| Имя | Тип | По умолчанию |
|---|---|---|
orientation | TextServer.Orientation | — |
SetPreserveControlvoid
public void SetPreserveControl(bool enabled);| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
SetPreserveInvalidvoid
public void SetPreserveInvalid(bool enabled);| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
SetTextOverrunBehaviorvoid
public void SetTextOverrunBehavior(TextServer.OverrunBehavior overrunBehavior);| Имя | Тип | По умолчанию |
|---|---|---|
overrunBehavior | TextServer.OverrunBehavior | — |
SetWidthvoid
public void SetWidth(float width);| Имя | Тип | По умолчанию |
|---|---|---|
width | float | — |
TabAlign2 перегрузки
public void TabAlign(ReadOnlySpan<float> tabStops);Выравнивает текст по указанным позициям табуляции.
| Имя | Тип | По умолчанию |
|---|---|---|
tabStops | ReadOnlySpan<float> | — |
public void TabAlign(float[] tabStops);Выравнивает текст по указанным позициям табуляции.
| Имя | Тип | По умолчанию |
|---|---|---|
tabStops | float[] | — |