reckfellENGINE

TextLine

Содержит строку текста.

На этой странице
class TextLineReckfellSharpНаследует RefCounted

Содержит строку текста.

Абстракция над TextServer для обработки одной строки текста.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

TextLineКонструктор
# TextLine
C#
public TextLine();

Свойства9

AlignmentСвойство
# Alignment
C#
public HorizontalAlignment Alignment { get; set; }

Устанавливает выравнивание текста внутри строки так, как если бы строка была горизонтальной.

DirectionСвойство
# Direction
C#
public TextServer.Direction Direction { get; set; }

Направление написания текста.

EllipsisCharСвойство
# EllipsisChar
C#
public string EllipsisChar { get; set; }

Символ многоточия, используемый для обрезки текста.

FlagsСвойство
# Flags
C#
public TextServer.JustificationFlag Flags { get; set; }

Правила выравнивания строк. Для получения дополнительной информации см. TextServer.

OrientationСвойство
# Orientation
C#
public TextServer.Orientation Orientation { get; set; }

Ориентация текста.

PreserveControlСвойство
# PreserveControl
C#
public bool PreserveControl { get; set; }

Если установлено значение true, текст будет отображать управляющие символы.

PreserveInvalidСвойство
# PreserveInvalid
C#
public bool PreserveInvalid { get; set; }

Если установлено значение true, в тексте будут отображаться недопустимые символы.

TextOverrunBehaviorСвойство
# TextOverrunBehavior
C#
public TextServer.OverrunBehavior TextOverrunBehavior { get; set; }

Поведение обрезки, когда текст превышает установленную ширину текстовой строки.

WidthСвойство
# Width
C#
public float Width { get; set; }

Ширина текстовой строки.

Методы42

AddObjectbool
# AddObject
C#
public bool AddObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, int length = 1, float baseline = 0f);

Добавляет встроенный объект в текстовый буфер, key должен быть уникальным. В тексте объект представлен как length символов замены объекта.

Параметры
ИмяТипПо умолчанию
keyVariant—
sizeVector2—
inlineAlignInlineAlignmentInlineAlignment.Center
lengthint1
baselinefloat0f
Возвращает bool
AddStringbool
# AddString
C#
public bool AddString(string text, Font font, int fontSize, string language = "", Variant meta = default);

Добавляет текстовый диапазон и шрифт для его отрисовки.

Параметры
ИмяТипПо умолчанию
textstring—
fontFont—
fontSizeint—
languagestring""
metaVariantdefault
Возвращает bool
Clearvoid
# Clear
C#
public void Clear();

Очищает текстовую строку (удаляет текст и встроенные объекты).

Draw2 перегрузки
# Draw · 1/2
C#
public void Draw(Rid canvas, Vector2 pos, Color? color);

Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.

Параметры
ИмяТипПо умолчанию
canvasRid—
posVector2—
colorColor?—
color

Если параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).

# Draw · 2/2
C#
public void Draw(Rid canvas, Vector2 pos, Color? color = default, float oversampling = 0f);

Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.

Параметры
ИмяТипПо умолчанию
canvasRid—
posVector2—
colorColor?default
oversamplingfloat0f
color

Если параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).

DrawOutline2 перегрузки
# DrawOutline · 1/2
C#
public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize, Color? color);

Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.

Параметры
ИмяТипПо умолчанию
canvasRid—
posVector2—
outlineSizeint—
colorColor?—
color

Если параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).

# DrawOutline · 2/2
C#
public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize = 1, Color? color = default, float oversampling = 0f);

Нарисовать текст на холсте в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.

Параметры
ИмяТипПо умолчанию
canvasRid—
posVector2—
outlineSizeint1
colorColor?default
oversamplingfloat0f
color

Если параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).

DuplicateTextLine
# Duplicate
C#
public TextLine Duplicate();

Дублирует этот TextLine.

Возвращает TextLine
GetDirectionTextServer.Direction
# GetDirection
C#
public TextServer.Direction GetDirection();
Возвращает TextServer.Direction
GetEllipsisCharstring
# GetEllipsisChar
C#
public string GetEllipsisChar();
Возвращает string
GetFlagsTextServer.JustificationFlag
# GetFlags
C#
public TextServer.JustificationFlag GetFlags();
Возвращает TextServer.JustificationFlag
GetHorizontalAlignmentHorizontalAlignment
# GetHorizontalAlignment
C#
public HorizontalAlignment GetHorizontalAlignment();
Возвращает HorizontalAlignment
GetInferredDirectionTextServer.Direction
# GetInferredDirection
C#
public TextServer.Direction GetInferredDirection();

Возвращает направление написания текста, выведенное алгоритмом BiDi.

Возвращает TextServer.Direction
GetLineAscentfloat
# GetLineAscent
C#
public float GetLineAscent();

Возвращает высоту текста (количество пикселей над базовой линией для горизонтального расположения или слева от базовой линии для вертикального расположения).

Возвращает float
GetLineDescentfloat
# GetLineDescent
C#
public float GetLineDescent();

Возвращает смещение текста (количество пикселей ниже базовой линии для горизонтальной компоновки или справа от базовой линии для вертикальной).

Возвращает float
GetLineUnderlinePositionfloat
# GetLineUnderlinePosition
C#
public float GetLineUnderlinePosition();

Возвращает смещение подчеркивания в пикселях относительно базовой линии.

Возвращает float
GetLineUnderlineThicknessfloat
# GetLineUnderlineThickness
C#
public float GetLineUnderlineThickness();

Возвращает толщину подчеркивания.

Возвращает float
GetLineWidthfloat
# GetLineWidth
C#
public float GetLineWidth();

Возвращает ширину (для горизонтального расположения) или высоту (для вертикального расположения) текста.

Возвращает float
GetObjectRectRect2
# GetObjectRect
C#
public Rect2 GetObjectRect(Variant key);

Возвращает ограничивающий прямоугольник встроенного объекта.

Параметры
ИмяТипПо умолчанию
keyVariant—
Возвращает Rect2
GetObjectsReckfell.Collections.Array
# GetObjects
C#
public Reckfell.Collections.Array GetObjects();

Возвращает массив встроенных объектов.

Возвращает Reckfell.Collections.Array
GetOrientationTextServer.Orientation
# GetOrientation
C#
public TextServer.Orientation GetOrientation();
Возвращает TextServer.Orientation
GetPreserveControlbool
# GetPreserveControl
C#
public bool GetPreserveControl();
Возвращает bool
GetPreserveInvalidbool
# GetPreserveInvalid
C#
public bool GetPreserveInvalid();
Возвращает bool
GetRidRid
# GetRid
C#
public Rid GetRid();

Возвращает RID буфера TextServer.

Возвращает Rid
GetSizeVector2
# GetSize
C#
public Vector2 GetSize();

Возвращает размер ограничивающего прямоугольника текста.

Возвращает Vector2
GetTextOverrunBehaviorTextServer.OverrunBehavior
# GetTextOverrunBehavior
C#
public TextServer.OverrunBehavior GetTextOverrunBehavior();
Возвращает TextServer.OverrunBehavior
GetWidthfloat
# GetWidth
C#
public float GetWidth();
Возвращает float
HasObjectbool
# HasObject
C#
public bool HasObject(Variant key);

Возвращает true, если в эту строку встроен объект с key.

Параметры
ИмяТипПо умолчанию
keyVariant—
Возвращает bool
HitTestint
# HitTest
C#
public int HitTest(float coords);

Возвращает смещение символа каретки на указанное смещение пикселей на базовой линии. Эта функция всегда возвращает допустимую позицию.

Параметры
ИмяТипПо умолчанию
coordsfloat—
Возвращает int
ResizeObjectbool
# ResizeObject
C#
public bool ResizeObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, float baseline = 0f);

Устанавливает новый размер и выравнивание внедренного объекта.

Параметры
ИмяТипПо умолчанию
keyVariant—
sizeVector2—
inlineAlignInlineAlignmentInlineAlignment.Center
baselinefloat0f
Возвращает bool
SetBidiOverridevoid
# SetBidiOverride
C#
public void SetBidiOverride(Reckfell.Collections.Array @override);

Переопределяет BiDi для структурированного текста. Диапазоны переопределения должны охватывать весь исходный текст без перекрытий. Алгоритм BiDi будет использоваться для каждого диапазона отдельно.

Параметры
ИмяТипПо умолчанию
overrideReckfell.Collections.Array—
SetDirectionvoid
# SetDirection
C#
public void SetDirection(TextServer.Direction direction);
Параметры
ИмяТипПо умолчанию
directionTextServer.Direction—
SetEllipsisCharvoid
# SetEllipsisChar
C#
public void SetEllipsisChar(string @char);
Параметры
ИмяТипПо умолчанию
charstring—
SetFlagsvoid
# SetFlags
C#
public void SetFlags(TextServer.JustificationFlag flags);
Параметры
ИмяТипПо умолчанию
flagsTextServer.JustificationFlag—
SetHorizontalAlignmentvoid
# SetHorizontalAlignment
C#
public void SetHorizontalAlignment(HorizontalAlignment alignment);
Параметры
ИмяТипПо умолчанию
alignmentHorizontalAlignment—
SetOrientationvoid
# SetOrientation
C#
public void SetOrientation(TextServer.Orientation orientation);
Параметры
ИмяТипПо умолчанию
orientationTextServer.Orientation—
SetPreserveControlvoid
# SetPreserveControl
C#
public void SetPreserveControl(bool enabled);
Параметры
ИмяТипПо умолчанию
enabledbool—
SetPreserveInvalidvoid
# SetPreserveInvalid
C#
public void SetPreserveInvalid(bool enabled);
Параметры
ИмяТипПо умолчанию
enabledbool—
SetTextOverrunBehaviorvoid
# SetTextOverrunBehavior
C#
public void SetTextOverrunBehavior(TextServer.OverrunBehavior overrunBehavior);
Параметры
ИмяТипПо умолчанию
overrunBehaviorTextServer.OverrunBehavior—
SetWidthvoid
# SetWidth
C#
public void SetWidth(float width);
Параметры
ИмяТипПо умолчанию
widthfloat—
TabAlign2 перегрузки
# TabAlign · 1/2
C#
public void TabAlign(ReadOnlySpan<float> tabStops);

Выравнивает текст по указанным позициям табуляции.

Параметры
ИмяТипПо умолчанию
tabStopsReadOnlySpan<float>—
# TabAlign · 2/2
C#
public void TabAlign(float[] tabStops);

Выравнивает текст по указанным позициям табуляции.

Параметры
ИмяТипПо умолчанию
tabStopsfloat[]—
Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.