reckfellENGINE

TextParagraph

Содержит абзац текста.

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

Содержит абзац текста.

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

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

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

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

Свойства13

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

Горизонтальное выравнивание абзаца.

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

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

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

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

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

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

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

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

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

Правила выравнивания заливки линий.

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

Дополнительный вертикальный интервал между строками (в пикселях), интервал добавляется к спуску строки. Это значение может быть отрицательным.

MaxLinesVisibleСвойство
# MaxLinesVisible
C#
public int MaxLinesVisible { get; set; }

Ограничивает количество отображаемых строк текста.

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; }

Ширина абзаца.

Методы69

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();

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

ClearDropcapvoid
# ClearDropcap
C#
public void ClearDropcap();

Удаляет начальную букву капитель (dropcap).

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

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

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

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

dcColor

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

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

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

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

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

dcColor

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

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

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

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

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

# DrawDropcap · 2/2
C#
public void DrawDropcap(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).

DrawDropcapOutline2 перегрузки
# DrawDropcapOutline · 1/2
C#
public void DrawDropcapOutline(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).

# DrawDropcapOutline · 2/2
C#
public void DrawDropcapOutline(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).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры
ИмяТипПо умолчанию
canvasRid—
posVector2—
lineint—
outlineSizeint1
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? dcColor);

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

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

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

dcColor

Если параметр не имеет значения, то значение по умолчанию: 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, Color? dcColor = default, float oversampling = 0f);

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

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

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

dcColor

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

DuplicateTextParagraph
# Duplicate
C#
public TextParagraph Duplicate();

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

Возвращает TextParagraph
GetAlignmentHorizontalAlignment
# GetAlignment
C#
public HorizontalAlignment GetAlignment();
Возвращает HorizontalAlignment
GetBreakFlagsTextServer.LineBreakFlag
# GetBreakFlags
C#
public TextServer.LineBreakFlag GetBreakFlags();
Возвращает TextServer.LineBreakFlag
GetCustomPunctuationstring
# GetCustomPunctuation
C#
public string GetCustomPunctuation();
Возвращает string
GetDirectionTextServer.Direction
# GetDirection
C#
public TextServer.Direction GetDirection();
Возвращает TextServer.Direction
GetDropcapLinesint
# GetDropcapLines
C#
public int GetDropcapLines();

Возвращает количество строк, используемых в dropcap (буквицей).

Возвращает int
GetDropcapRidRid
# GetDropcapRid
C#
public Rid GetDropcapRid();

Возвращает RID текстового буфера буквицы.

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

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

Возвращает Vector2
GetEllipsisCharstring
# GetEllipsisChar
C#
public string GetEllipsisChar();
Возвращает string
GetInferredDirectionTextServer.Direction
# GetInferredDirection
C#
public TextServer.Direction GetInferredDirection();

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

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

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает float
GetLineCountint
# GetLineCount
C#
public int GetLineCount();

Возвращает количество строк в абзаце.

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

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает float
GetLineObjectRectRect2
# GetLineObjectRect
C#
public Rect2 GetLineObjectRect(int line, Variant key);

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

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

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает Reckfell.Collections.Array
GetLineRangeVector2I
# GetLineRange
C#
public Vector2I GetLineRange(int line);

Возвращает диапазон символов строки.

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает Vector2I
GetLineRidRid
# GetLineRid
C#
public Rid GetLineRid(int line);

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает Rid
GetLineSizeVector2
# GetLineSize
C#
public Vector2 GetLineSize(int line);

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает Vector2
GetLineSpacingfloat
# GetLineSpacing
C#
public float GetLineSpacing();
Возвращает float
GetLineUnderlinePositionfloat
# GetLineUnderlinePosition
C#
public float GetLineUnderlinePosition(int line);

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает float
GetLineUnderlineThicknessfloat
# GetLineUnderlineThickness
C#
public float GetLineUnderlineThickness(int line);

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает float
GetLineWidthfloat
# GetLineWidth
C#
public float GetLineWidth(int line);

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

Параметры
ИмяТипПо умолчанию
lineint—
Возвращает float
GetMaxLinesVisibleint
# GetMaxLinesVisible
C#
public int GetMaxLinesVisible();
Возвращает int
GetNonWrappedSizeVector2
# GetNonWrappedSize
C#
public Vector2 GetNonWrappedSize();

Возвращает размер ограничивающей рамки абзаца без переносов строк.

Возвращает Vector2
GetOrientationTextServer.Orientation
# GetOrientation
C#
public TextServer.Orientation GetOrientation();
Возвращает TextServer.Orientation
GetPreserveControlbool
# GetPreserveControl
C#
public bool GetPreserveControl();
Возвращает bool
GetPreserveInvalidbool
# GetPreserveInvalid
C#
public bool GetPreserveInvalid();
Возвращает bool
GetRangeVector2I
# GetRange
C#
public Vector2I GetRange();

Возвращает диапазон символов абзаца/параграфа.

Возвращает Vector2I
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(Vector2 coords);

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

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

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

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

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

Параметры
ИмяТипПо умолчанию
overrideReckfell.Collections.Array—
SetBreakFlagsvoid
# SetBreakFlags
C#
public void SetBreakFlags(TextServer.LineBreakFlag flags);
Параметры
ИмяТипПо умолчанию
flagsTextServer.LineBreakFlag—
SetCustomPunctuationvoid
# SetCustomPunctuation
C#
public void SetCustomPunctuation(string customPunctuation);
Параметры
ИмяТипПо умолчанию
customPunctuationstring—
SetDirectionvoid
# SetDirection
C#
public void SetDirection(TextServer.Direction direction);
Параметры
ИмяТипПо умолчанию
directionTextServer.Direction—
SetDropcapbool
# SetDropcap
C#
public bool SetDropcap(string text, Font font, int fontSize, Rect2? dropcapMargins = default, string language = "");

Устанавливает буквицу, переопределяет ранее установленную буквицу. Буквица — декоративный элемент в начале абзаца, который больше остального текста.

Параметры
ИмяТипПо умолчанию
textstring—
fontFont—
fontSizeint—
dropcapMarginsRect2?default
languagestring""
dropcapMargins

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

Возвращает bool
SetEllipsisCharvoid
# SetEllipsisChar
C#
public void SetEllipsisChar(string @char);
Параметры
ИмяТипПо умолчанию
charstring—
SetJustificationFlagsvoid
# SetJustificationFlags
C#
public void SetJustificationFlags(TextServer.JustificationFlag flags);
Параметры
ИмяТипПо умолчанию
flagsTextServer.JustificationFlag—
SetLineSpacingvoid
# SetLineSpacing
C#
public void SetLineSpacing(float lineSpacing);
Параметры
ИмяТипПо умолчанию
lineSpacingfloat—
SetMaxLinesVisiblevoid
# SetMaxLinesVisible
C#
public void SetMaxLinesVisible(int maxLinesVisible);
Параметры
ИмяТипПо умолчанию
maxLinesVisibleint—
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.