reckfellENGINE

CharFXTransform

Контекст одного глифа для пользовательского эффекта текста.

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

CharFXTransform передаётся в RichTextEffect._ProcessCustomFX и переиспользуется. Глиф не обязательно соответствует одному символу C#: лигатуры, составные символы и разные проходы отрисовки нарушают такое соответствие. Не сохраняйте объект как снимок и не освобождайте его в callback.

Результат отрисовки читает Transform, Offset, Color, GlyphIndex и Visible. Остальные поля описывают входной контекст; их setters не превращают эффект в перераскладку текста. Для сохранения значений копируйте нужные скалярные/структурные поля, а не ссылку на контекст.

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

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

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

Создаёт отдельный контейнер контекста. Для эффекта используйте объект, переданный в callback: самостоятельное создание не подключает его к RichTextLabel.

Свойства13

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

Текущий цвет глифа с учётом ранее применённых настроек. Новый Color должен сохранять нужную альфу. Изменяет этот проход отрисовки, не цвет всех последующих символов.

ElapsedTimeСвойство
# ElapsedTime
C#
public double ElapsedTime { get; set; }

Прошедшее время области эффекта в секундах для анимации. Это не delta кадра и не время системы. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

EnvСвойство
# Env
C#
public Reckfell.Collections.Dictionary Env { get; set; }

Словарь параметров области эффекта: из BBCode либо env в PushCustomfx. Хранится по общей ссылке; не изменяйте его как временный снимок. При уничтожении CharFXTransform словарь очищается: для независимых данных передавайте отдельный Dictionary. Замена Env не меняет исходный BBCode.

FontСвойство
# Font
C#
public Rid Font { get; set; }

Заимствованный RID текущего шрифта для запросов глифов. Не освобождайте его через сервер. Изменение этого поля не переключает шрифт отрисовки; для другого шрифта используйте форматирование RichTextLabel.

GlyphCountСвойство
# GlyphCount
C#
public byte GlyphCount { get; set; }

Число глифов в связанном кластере по данным текстовой системы; не длина исходной строки. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GlyphFlagsСвойство
# GlyphFlags
C#
public ushort GlyphFlags { get; set; }

Биты свойств глифа текстовой системы, например направления и границ кластера. Не флаги эффектов. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GlyphIndexСвойство
# GlyphIndex
C#
public uint GlyphIndex { get; set; }

Индекс глифа в текущем шрифте, не код Unicode и не индекс char в C#. Можно заменить другим существующим глифом того же шрифта; раскладка и ширина при этом заново не вычисляются.

OffsetСвойство
# Offset
C#
public Vector2 Offset { get; set; }

Дополнительное смещение глифа в пикселях отрисовки. Прибавляйте к входному Offset, чтобы сохранить предыдущие эффекты. Не перемещает символ в логическом тексте.

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

true для прохода контура или тени, false для основного текста. Один глиф может вызвать callback несколько раз за кадр. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

RangeСвойство
# Range
C#
public Vector2I Range { get; set; }

Диапазон логических символов, соответствующих текущему глифу: X — начало, Y — конец. Это не диапазон UTF-16-индексов строки C# и не экранные координаты. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

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

Смещение начала глифа относительно начала области эффекта в логических символах. Не порядковый номер вызова callback: проходы могут повторяться. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

TransformСвойство
# Transform
C#
public Transform2D Transform { get; set; }

Преобразование текущего глифа, уже содержащее базовую позицию. Меняйте относительно входного значения; замена на Identity может потерять размещение. Не меняет переносы или размеры строк.

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

Разрешает отрисовку текущего глифа. false скрывает его, сохраняя занимаемое место. true не восстанавливает глиф, уже скрытый предыдущим эффектом или ограничением видимости.

Методы26

GetColorColor
# GetColor
C#
public Color GetColor();

Текущий цвет глифа с учётом ранее применённых настроек. Новый Color должен сохранять нужную альфу. Изменяет этот проход отрисовки, не цвет всех последующих символов.

Возвращает Color

Текущий цвет глифа с учётом ранее применённых настроек. Новый Color должен сохранять нужную альфу. Изменяет этот проход отрисовки, не цвет всех последующих символов.

GetElapsedTimedouble
# GetElapsedTime
C#
public double GetElapsedTime();

Прошедшее время области эффекта в секундах для анимации. Это не delta кадра и не время системы. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Возвращает double

Прошедшее время области эффекта в секундах для анимации. Это не delta кадра и не время системы. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GetEnvironmentReckfell.Collections.Dictionary
# GetEnvironment
C#
public Reckfell.Collections.Dictionary GetEnvironment();

Словарь параметров области эффекта: из BBCode либо env в PushCustomfx. Хранится по общей ссылке; не изменяйте его как временный снимок. При уничтожении CharFXTransform словарь очищается: для независимых данных передавайте отдельный Dictionary. Замена Env не меняет исходный BBCode.

Возвращает Reckfell.Collections.Dictionary

Словарь параметров области эффекта: из BBCode либо env в PushCustomfx. Хранится по общей ссылке; не изменяйте его как временный снимок. При уничтожении CharFXTransform словарь очищается: для независимых данных передавайте отдельный Dictionary. Замена Env не меняет исходный BBCode.

GetFontRid
# GetFont
C#
public Rid GetFont();

Заимствованный RID текущего шрифта для запросов глифов. Не освобождайте его через сервер. Изменение этого поля не переключает шрифт отрисовки; для другого шрифта используйте форматирование RichTextLabel.

Возвращает Rid

Заимствованный RID текущего шрифта для запросов глифов. Не освобождайте его через сервер. Изменение этого поля не переключает шрифт отрисовки; для другого шрифта используйте форматирование RichTextLabel.

GetGlyphCountbyte
# GetGlyphCount
C#
public byte GetGlyphCount();

Число глифов в связанном кластере по данным текстовой системы; не длина исходной строки. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Возвращает byte

Число глифов в связанном кластере по данным текстовой системы; не длина исходной строки. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GetGlyphFlagsushort
# GetGlyphFlags
C#
public ushort GetGlyphFlags();

Биты свойств глифа текстовой системы, например направления и границ кластера. Не флаги эффектов. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Возвращает ushort

Биты свойств глифа текстовой системы, например направления и границ кластера. Не флаги эффектов. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GetGlyphIndexuint
# GetGlyphIndex
C#
public uint GetGlyphIndex();

Индекс глифа в текущем шрифте, не код Unicode и не индекс char в C#. Можно заменить другим существующим глифом того же шрифта; раскладка и ширина при этом заново не вычисляются.

Возвращает uint

Индекс глифа в текущем шрифте, не код Unicode и не индекс char в C#. Можно заменить другим существующим глифом того же шрифта; раскладка и ширина при этом заново не вычисляются.

GetOffsetVector2
# GetOffset
C#
public Vector2 GetOffset();

Дополнительное смещение глифа в пикселях отрисовки. Прибавляйте к входному Offset, чтобы сохранить предыдущие эффекты. Не перемещает символ в логическом тексте.

Возвращает Vector2

Дополнительное смещение глифа в пикселях отрисовки. Прибавляйте к входному Offset, чтобы сохранить предыдущие эффекты. Не перемещает символ в логическом тексте.

GetRangeVector2I
# GetRange
C#
public Vector2I GetRange();

Диапазон логических символов, соответствующих текущему глифу: X — начало, Y — конец. Это не диапазон UTF-16-индексов строки C# и не экранные координаты. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Возвращает Vector2I

Диапазон логических символов, соответствующих текущему глифу: X — начало, Y — конец. Это не диапазон UTF-16-индексов строки C# и не экранные координаты. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GetRelativeIndexint
# GetRelativeIndex
C#
public int GetRelativeIndex();

Смещение начала глифа относительно начала области эффекта в логических символах. Не порядковый номер вызова callback: проходы могут повторяться. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Возвращает int

Смещение начала глифа относительно начала области эффекта в логических символах. Не порядковый номер вызова callback: проходы могут повторяться. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

GetTransformTransform2D
# GetTransform
C#
public Transform2D GetTransform();

Преобразование текущего глифа, уже содержащее базовую позицию. Меняйте относительно входного значения; замена на Identity может потерять размещение. Не меняет переносы или размеры строк.

Возвращает Transform2D

Преобразование текущего глифа, уже содержащее базовую позицию. Меняйте относительно входного значения; замена на Identity может потерять размещение. Не меняет переносы или размеры строк.

IsOutlinebool
# IsOutline
C#
public bool IsOutline();

true для прохода контура или тени, false для основного текста. Один глиф может вызвать callback несколько раз за кадр. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Возвращает bool

true для прохода контура или тени, false для основного текста. Один глиф может вызвать callback несколько раз за кадр. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

IsVisiblebool
# IsVisible
C#
public bool IsVisible();

Разрешает отрисовку текущего глифа. false скрывает его, сохраняя занимаемое место. true не восстанавливает глиф, уже скрытый предыдущим эффектом или ограничением видимости.

Возвращает bool

Разрешает отрисовку текущего глифа. false скрывает его, сохраняя занимаемое место. true не восстанавливает глиф, уже скрытый предыдущим эффектом или ограничением видимости.

SetColorvoid
# SetColor
C#
public void SetColor(Color color);

Текущий цвет глифа с учётом ранее применённых настроек. Новый Color должен сохранять нужную альфу. Изменяет этот проход отрисовки, не цвет всех последующих символов.

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

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

SetElapsedTimevoid
# SetElapsedTime
C#
public void SetElapsedTime(double time);

Прошедшее время области эффекта в секундах для анимации. Это не delta кадра и не время системы. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Параметры
ИмяТипПо умолчанию
timedouble—
time

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

SetEnvironmentvoid
# SetEnvironment
C#
public void SetEnvironment(Reckfell.Collections.Dictionary environment);

Словарь параметров области эффекта: из BBCode либо env в PushCustomfx. Хранится по общей ссылке; не изменяйте его как временный снимок. При уничтожении CharFXTransform словарь очищается: для независимых данных передавайте отдельный Dictionary. Замена Env не меняет исходный BBCode.

Параметры
ИмяТипПо умолчанию
environmentReckfell.Collections.Dictionary—
environment

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

SetFontvoid
# SetFont
C#
public void SetFont(Rid font);

Заимствованный RID текущего шрифта для запросов глифов. Не освобождайте его через сервер. Изменение этого поля не переключает шрифт отрисовки; для другого шрифта используйте форматирование RichTextLabel.

Параметры
ИмяТипПо умолчанию
fontRid—
font

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

SetGlyphCountvoid
# SetGlyphCount
C#
public void SetGlyphCount(byte glyphCount);

Число глифов в связанном кластере по данным текстовой системы; не длина исходной строки. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Параметры
ИмяТипПо умолчанию
glyphCountbyte—
glyphCount

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

SetGlyphFlagsvoid
# SetGlyphFlags
C#
public void SetGlyphFlags(ushort glyphFlags);

Биты свойств глифа текстовой системы, например направления и границ кластера. Не флаги эффектов. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Параметры
ИмяТипПо умолчанию
glyphFlagsushort—
glyphFlags

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

SetGlyphIndexvoid
# SetGlyphIndex
C#
public void SetGlyphIndex(uint glyphIndex);

Индекс глифа в текущем шрифте, не код Unicode и не индекс char в C#. Можно заменить другим существующим глифом того же шрифта; раскладка и ширина при этом заново не вычисляются.

Параметры
ИмяТипПо умолчанию
glyphIndexuint—
glyphIndex

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

SetOffsetvoid
# SetOffset
C#
public void SetOffset(Vector2 offset);

Дополнительное смещение глифа в пикселях отрисовки. Прибавляйте к входному Offset, чтобы сохранить предыдущие эффекты. Не перемещает символ в логическом тексте.

Параметры
ИмяТипПо умолчанию
offsetVector2—
offset

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

SetOutlinevoid
# SetOutline
C#
public void SetOutline(bool outline);

true для прохода контура или тени, false для основного текста. Один глиф может вызвать callback несколько раз за кадр. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Параметры
ИмяТипПо умолчанию
outlinebool—
outline

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

SetRangevoid
# SetRange
C#
public void SetRange(Vector2I range);

Диапазон логических символов, соответствующих текущему глифу: X — начало, Y — конец. Это не диапазон UTF-16-индексов строки C# и не экранные координаты. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Параметры
ИмяТипПо умолчанию
rangeVector2I—
range

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

SetRelativeIndexvoid
# SetRelativeIndex
C#
public void SetRelativeIndex(int relativeIndex);

Смещение начала глифа относительно начала области эффекта в логических символах. Не порядковый номер вызова callback: проходы могут повторяться. Входное поле текущего глифа; запись через setter не меняет раскладку текста и перезаписывается следующим вызовом движка.

Параметры
ИмяТипПо умолчанию
relativeIndexint—
relativeIndex

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

SetTransformvoid
# SetTransform
C#
public void SetTransform(Transform2D transform);

Преобразование текущего глифа, уже содержащее базовую позицию. Меняйте относительно входного значения; замена на Identity может потерять размещение. Не меняет переносы или размеры строк.

Параметры
ИмяТипПо умолчанию
transformTransform2D—
transform

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

SetVisibilityvoid
# SetVisibility
C#
public void SetVisibility(bool visibility);

Разрешает отрисовку текущего глифа. false скрывает его, сохраняя занимаемое место. true не восстанавливает глиф, уже скрытый предыдущим эффектом или ограничением видимости.

Параметры
ИмяТипПо умолчанию
visibilitybool—
visibility

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

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

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

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

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