reckfellENGINE

Label3D

Узел для отображения простого текста в 3D-пространстве.

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

Узел для отображения простого текста в 3D-пространстве.

Узел для отображения обычного текста в 3D-пространстве. Регулируя различные свойства этого узла, вы можете настроить такие вещи, как внешний вид текста и то, всегда ли он обращен к камере.

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

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

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

Свойства33

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

Порог, при котором к альфа-каналу будет применено сглаживание.

AlphaAntialiasingModeСвойство
# AlphaAntialiasingMode
C#
public BaseMaterial3D.AlphaAntiAliasing AlphaAntialiasingMode { get; set; }

Тип применяемого альфа-сглаживания.

AlphaCutСвойство
# AlphaCut
C#
public Label3D.AlphaCutMode AlphaCut { get; set; }

Режим альфа-резки, используемый для спрайта.

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

Масштаб хеширования для Альфа-хэш. Рекомендуемые значения между 0 и 2.

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

Порог, при котором альфа-ножницы будут отбрасывать значения.

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

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

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

Флаги обрезки пространства автопереноса. См. TextServer.LineBreakFlag.TrimStartEdgeSpaces и TextServer.LineBreakFlag.TrimEndEdgeSpaces для получения дополнительной информации.

BillboardСвойство
# Billboard
C#
public BaseMaterial3D.BillboardModeEnum Billboard { get; set; }

Режим поворота надписи к камере. Enabled разворачивает её к наблюдателю; FixedY сохраняет вертикальную ось. Не управляет видимостью сквозь стены или постоянством экранного размера: это отдельные свойства.

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

Если true, текст также виден сзади, если false, он невидим, если смотреть на него сзади.

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

Снижает изменение видимого размера надписи при изменении дистанции перспективной камеры. Это не гарантия одинакового размера в пикселях при любом FOV, DPI или размере окна. Для экранного интерфейса используйте Control.

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

Font Конфигурация, используемая для отображения текста.

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

Размер шрифта, используемый при формировании надписи. Мировой размер также зависит от PixelSize и трансформации Entity3D. Увеличение FontSize с уменьшением PixelSize не является универсальной заменой подбора шрифта и качества отображения.

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

Управляет горизонтальным выравниванием текста. Поддерживает выравнивание по левому краю, по центру, по правому краю и заполнение (также известное как выравнивание по ширине).

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

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

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

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

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

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

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

Текст Color Label3D.

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

Отключает проверку глубины надписи: текст может быть виден сквозь стены. Это не создаёт экранный интерфейс и не решает порядок всех прозрачных объектов. Оставьте false, если стены должны скрывать подпись.

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

Смещение отрисовки текста (в пикселях).

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

Оттенок контура текста.

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

Устанавливает приоритет рендеринга для контура текста. Объекты с более высоким приоритетом будут сортироваться перед объектами с более низким приоритетом. Примечание: Это применимо только в том случае, если Label3D.AlphaCut установлен на Label3D.AlphaCutMode.Disabled (значение по умолчанию). Примечание: Это применимо только к сортировке прозрачных объектов. Это не повлияет на то, как прозрачные объекты сортируются относительно непрозрачных объектов. Это связано с тем, что непрозрачные объекты не сортируются, в то время как прозрачные объекты сортируются сзади вперед (в зависимости от приоритета).

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

Размер обводки текста.

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

Масштаб пикселя текста в единицах 3D-мира. Вместе с FontSize определяет геометрический размер надписи; это не размер экранного пикселя. При обычной перспективной проекции дальняя надпись выглядит меньше.

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

Устанавливает приоритет рендеринга для текста. Объекты с более высоким приоритетом будут сортироваться перед объектами с более низким приоритетом. Примечание: Это применимо только в том случае, если Label3D.AlphaCut установлен на Label3D.AlphaCutMode.Disabled (значение по умолчанию). Примечание: Это применимо только к сортировке прозрачных объектов. Это не повлияет на то, как прозрачные объекты сортируются относительно непрозрачных объектов. Это связано с тем, что непрозрачные объекты не сортируются, в то время как прозрачные объекты сортируются сзади вперед (в зависимости от приоритета).

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

Если true, Light3D в Environment оказывает влияние на метку.

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

Установите переопределение алгоритма BiDi для структурированного текста.

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

Установите дополнительные параметры для переопределения BiDi.

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

Текст надписи в 3D-мире. Изменение ставит обновление геометрии в очередь, поэтому чтение результата отрисовки в той же строке не подтверждает обновлённый кадр. Для выбранных языков назначьте шрифт с нужными глифами.

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

Направление написания базового текста.

TextureFilterСвойство
# TextureFilter
C#
public BaseMaterial3D.TextureFilterEnum TextureFilter { get; set; }

Флаги фильтра для текстуры.

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

Если true, весь текст отображается в ЗАГЛАВНОМ регистре.

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

Управляет вертикальным выравниванием текста. Поддерживает верх, центр и низ.

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

Ширина текста (в пикселях), используемая для автоматического переноса и выравнивания заливки.

Методы61

GenerateTriangleMeshTriangleMesh
# GenerateTriangleMesh
C#
public TriangleMesh GenerateTriangleMesh();

Создаёт геометрию прямоугольной области текста для дальнейшего использования. В проверенном движке это две треугольные грани границ надписи, а не контуры глифов. Не создаёт CollisionShape3D автоматически.

Возвращает TriangleMesh

TriangleMesh из двух треугольников для непустой проверенной надписи; не объёмные буквы. Для геометрии глифов используйте TextMesh.

GetAlphaAntialiasingBaseMaterial3D.AlphaAntiAliasing
# GetAlphaAntialiasing
C#
public BaseMaterial3D.AlphaAntiAliasing GetAlphaAntialiasing();
Возвращает BaseMaterial3D.AlphaAntiAliasing
GetAlphaAntialiasingEdgefloat
# GetAlphaAntialiasingEdge
C#
public float GetAlphaAntialiasingEdge();
Возвращает float
GetAlphaCutModeLabel3D.AlphaCutMode
# GetAlphaCutMode
C#
public Label3D.AlphaCutMode GetAlphaCutMode();
Возвращает Label3D.AlphaCutMode
GetAlphaHashScalefloat
# GetAlphaHashScale
C#
public float GetAlphaHashScale();
Возвращает float
GetAlphaScissorThresholdfloat
# GetAlphaScissorThreshold
C#
public float GetAlphaScissorThreshold();
Возвращает float
GetAutowrapModeTextServer.AutowrapMode
# GetAutowrapMode
C#
public TextServer.AutowrapMode GetAutowrapMode();
Возвращает TextServer.AutowrapMode
GetAutowrapTrimFlagsTextServer.LineBreakFlag
# GetAutowrapTrimFlags
C#
public TextServer.LineBreakFlag GetAutowrapTrimFlags();
Возвращает TextServer.LineBreakFlag
GetBillboardModeBaseMaterial3D.BillboardModeEnum
# GetBillboardMode
C#
public BaseMaterial3D.BillboardModeEnum GetBillboardMode();
Возвращает BaseMaterial3D.BillboardModeEnum
GetDrawFlagbool
# GetDrawFlag
C#
public bool GetDrawFlag(Label3D.DrawFlags flag);

Возвращает значение указанного флага.

Параметры
ИмяТипПо умолчанию
flagLabel3D.DrawFlags—
Возвращает bool
GetFontFont
# GetFont
C#
public Font GetFont();
Возвращает Font
GetFontSizeint
# GetFontSize
C#
public int GetFontSize();
Возвращает int
GetHorizontalAlignmentHorizontalAlignment
# GetHorizontalAlignment
C#
public HorizontalAlignment GetHorizontalAlignment();
Возвращает HorizontalAlignment
GetJustificationFlagsTextServer.JustificationFlag
# GetJustificationFlags
C#
public TextServer.JustificationFlag GetJustificationFlags();
Возвращает TextServer.JustificationFlag
GetLanguagestring
# GetLanguage
C#
public string GetLanguage();
Возвращает string
GetLineSpacingfloat
# GetLineSpacing
C#
public float GetLineSpacing();
Возвращает float
GetModulateColor
# GetModulate
C#
public Color GetModulate();
Возвращает Color
GetOffsetVector2
# GetOffset
C#
public Vector2 GetOffset();
Возвращает Vector2
GetOutlineModulateColor
# GetOutlineModulate
C#
public Color GetOutlineModulate();
Возвращает Color
GetOutlineRenderPriorityint
# GetOutlineRenderPriority
C#
public int GetOutlineRenderPriority();
Возвращает int
GetOutlineSizeint
# GetOutlineSize
C#
public int GetOutlineSize();
Возвращает int
GetPixelSizefloat
# GetPixelSize
C#
public float GetPixelSize();
Возвращает float
GetRenderPriorityint
# GetRenderPriority
C#
public int GetRenderPriority();
Возвращает int
GetStructuredTextBidiOverrideTextServer.StructuredTextParser
# GetStructuredTextBidiOverride
C#
public TextServer.StructuredTextParser GetStructuredTextBidiOverride();
Возвращает TextServer.StructuredTextParser
GetStructuredTextBidiOverrideOptionsReckfell.Collections.Array
# GetStructuredTextBidiOverrideOptions
C#
public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();
Возвращает Reckfell.Collections.Array
GetTextstring
# GetText
C#
public string GetText();
Возвращает string
GetTextDirectionTextServer.Direction
# GetTextDirection
C#
public TextServer.Direction GetTextDirection();
Возвращает TextServer.Direction
GetTextureFilterBaseMaterial3D.TextureFilterEnum
# GetTextureFilter
C#
public BaseMaterial3D.TextureFilterEnum GetTextureFilter();
Возвращает BaseMaterial3D.TextureFilterEnum
GetVerticalAlignmentVerticalAlignment
# GetVerticalAlignment
C#
public VerticalAlignment GetVerticalAlignment();
Возвращает VerticalAlignment
GetWidthfloat
# GetWidth
C#
public float GetWidth();
Возвращает float
IsUppercasebool
# IsUppercase
C#
public bool IsUppercase();
Возвращает bool
SetAlphaAntialiasingvoid
# SetAlphaAntialiasing
C#
public void SetAlphaAntialiasing(BaseMaterial3D.AlphaAntiAliasing alphaAA);
Параметры
ИмяТипПо умолчанию
alphaAABaseMaterial3D.AlphaAntiAliasing—
SetAlphaAntialiasingEdgevoid
# SetAlphaAntialiasingEdge
C#
public void SetAlphaAntialiasingEdge(float edge);
Параметры
ИмяТипПо умолчанию
edgefloat—
SetAlphaCutModevoid
# SetAlphaCutMode
C#
public void SetAlphaCutMode(Label3D.AlphaCutMode mode);
Параметры
ИмяТипПо умолчанию
modeLabel3D.AlphaCutMode—
SetAlphaHashScalevoid
# SetAlphaHashScale
C#
public void SetAlphaHashScale(float threshold);
Параметры
ИмяТипПо умолчанию
thresholdfloat—
SetAlphaScissorThresholdvoid
# SetAlphaScissorThreshold
C#
public void SetAlphaScissorThreshold(float threshold);
Параметры
ИмяТипПо умолчанию
thresholdfloat—
SetAutowrapModevoid
# SetAutowrapMode
C#
public void SetAutowrapMode(TextServer.AutowrapMode autowrapMode);
Параметры
ИмяТипПо умолчанию
autowrapModeTextServer.AutowrapMode—
SetAutowrapTrimFlagsvoid
# SetAutowrapTrimFlags
C#
public void SetAutowrapTrimFlags(TextServer.LineBreakFlag autowrapTrimFlags);
Параметры
ИмяТипПо умолчанию
autowrapTrimFlagsTextServer.LineBreakFlag—
SetBillboardModevoid
# SetBillboardMode
C#
public void SetBillboardMode(BaseMaterial3D.BillboardModeEnum mode);
Параметры
ИмяТипПо умолчанию
modeBaseMaterial3D.BillboardModeEnum—
SetDrawFlagvoid
# SetDrawFlag
C#
public void SetDrawFlag(Label3D.DrawFlags flag, bool enabled);

Если true, указанный flag будет включен.

Параметры
ИмяТипПо умолчанию
flagLabel3D.DrawFlags—
enabledbool—
SetFontvoid
# SetFont
C#
public void SetFont(Font font);
Параметры
ИмяТипПо умолчанию
fontFont—
SetFontSizevoid
# SetFontSize
C#
public void SetFontSize(int size);
Параметры
ИмяТипПо умолчанию
sizeint—
SetHorizontalAlignmentvoid
# SetHorizontalAlignment
C#
public void SetHorizontalAlignment(HorizontalAlignment alignment);
Параметры
ИмяТипПо умолчанию
alignmentHorizontalAlignment—
SetJustificationFlagsvoid
# SetJustificationFlags
C#
public void SetJustificationFlags(TextServer.JustificationFlag justificationFlags);
Параметры
ИмяТипПо умолчанию
justificationFlagsTextServer.JustificationFlag—
SetLanguagevoid
# SetLanguage
C#
public void SetLanguage(string language);
Параметры
ИмяТипПо умолчанию
languagestring—
SetLineSpacingvoid
# SetLineSpacing
C#
public void SetLineSpacing(float lineSpacing);
Параметры
ИмяТипПо умолчанию
lineSpacingfloat—
SetModulatevoid
# SetModulate
C#
public void SetModulate(Color modulate);
Параметры
ИмяТипПо умолчанию
modulateColor—
SetOffsetvoid
# SetOffset
C#
public void SetOffset(Vector2 offset);
Параметры
ИмяТипПо умолчанию
offsetVector2—
SetOutlineModulatevoid
# SetOutlineModulate
C#
public void SetOutlineModulate(Color modulate);
Параметры
ИмяТипПо умолчанию
modulateColor—
SetOutlineRenderPriorityvoid
# SetOutlineRenderPriority
C#
public void SetOutlineRenderPriority(int priority);
Параметры
ИмяТипПо умолчанию
priorityint—
SetOutlineSizevoid
# SetOutlineSize
C#
public void SetOutlineSize(int outlineSize);
Параметры
ИмяТипПо умолчанию
outlineSizeint—
SetPixelSizevoid
# SetPixelSize
C#
public void SetPixelSize(float pixelSize);
Параметры
ИмяТипПо умолчанию
pixelSizefloat—
SetRenderPriorityvoid
# SetRenderPriority
C#
public void SetRenderPriority(int priority);
Параметры
ИмяТипПо умолчанию
priorityint—
SetStructuredTextBidiOverridevoid
# SetStructuredTextBidiOverride
C#
public void SetStructuredTextBidiOverride(TextServer.StructuredTextParser parser);
Параметры
ИмяТипПо умолчанию
parserTextServer.StructuredTextParser—
SetStructuredTextBidiOverrideOptionsvoid
# SetStructuredTextBidiOverrideOptions
C#
public void SetStructuredTextBidiOverrideOptions(Reckfell.Collections.Array args);
Параметры
ИмяТипПо умолчанию
argsReckfell.Collections.Array—
SetTextvoid
# SetText
C#
public void SetText(string text);
Параметры
ИмяТипПо умолчанию
textstring—
SetTextDirectionvoid
# SetTextDirection
C#
public void SetTextDirection(TextServer.Direction direction);
Параметры
ИмяТипПо умолчанию
directionTextServer.Direction—
SetTextureFiltervoid
# SetTextureFilter
C#
public void SetTextureFilter(BaseMaterial3D.TextureFilterEnum mode);
Параметры
ИмяТипПо умолчанию
modeBaseMaterial3D.TextureFilterEnum—
SetUppercasevoid
# SetUppercase
C#
public void SetUppercase(bool enable);
Параметры
ИмяТипПо умолчанию
enablebool—
SetVerticalAlignmentvoid
# SetVerticalAlignment
C#
public void SetVerticalAlignment(VerticalAlignment alignment);
Параметры
ИмяТипПо умолчанию
alignmentVerticalAlignment—
SetWidthvoid
# SetWidth
C#
public void SetWidth(float width);
Параметры
ИмяТипПо умолчанию
widthfloat—

Label3D.AlphaCutMode

ЗначениеОписание
Disabled = 0

Этот режим выполняет стандартное альфа-смешивание. Он может отображать полупрозрачные области, но проблемы с сортировкой прозрачности могут быть видны, когда накладываются несколько прозрачных материалов. GeometryInstance3D.CastShadow не имеет никакого эффекта при использовании этого режима прозрачности; Label3D никогда не будет отбрасывать тени.

Discard = 1

Этот режим допускает только полностью прозрачные или полностью непрозрачные пиксели. Резкие края будут видны, если не включена какая-либо форма сглаживания экранного пространства (см. ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa). Этот режим также известен как альфа-тестирование или 1-битная прозрачность. Примечание: В этом режиме могут возникнуть проблемы со сглаженными шрифтами и контурами, попробуйте настроить Label3D.AlphaScissorThreshold или использовать шрифт MSDF. Примечание: При использовании текста с перекрывающимися глифами (например, курсивные шрифты) в этом режиме могут возникнуть проблемы с сортировкой прозрачности между основным текстом и контуром.

Hash = 3

В этом режиме отрисовка отсекает все значения ниже пространственно-детерминированного порога, остальные остаются непрозрачными.

OpaquePrepass = 2

Этот режим рисует полностью непрозрачные пиксели в предварительном проходе глубины. Это медленнее, чем Label3D.AlphaCutMode.Disabled или Label3D.AlphaCutMode.Discard, но позволяет отображать полупрозрачные области и сглаживать края при использовании правильной сортировки. Примечание: При использовании текста с перекрывающимися глифами (например, курсивные шрифты) в этом режиме могут возникнуть проблемы с сортировкой прозрачности между основным текстом и контуром.

Label3D.DrawFlags

ЗначениеОписание
DisableDepthTest = 2

Отключает тест глубины, поэтому этот объект рисуется поверх всех остальных. Однако объекты, рисуемые после него в порядке рисования, могут его перекрывать.

DoubleSided = 1

Если установлено, текст также виден сзади. Если не установлено, текст не виден при взгляде сзади.

FixedSize = 3

Label Расширяется по глубине, чтобы на экране всегда был один и тот же размер.

Max = 4

Представляет размер перечисления Label3D.DrawFlags.

Shaded = 0

Если установлено, окружающее освещение влияет на метку.

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

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

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

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