Label3D
Узел для отображения простого текста в 3D-пространстве.
Узел для отображения простого текста в 3D-пространстве.
Узел для отображения обычного текста в 3D-пространстве. Регулируя различные свойства этого узла, вы можете настроить такие вещи, как внешний вид текста и то, всегда ли он обращен к камере.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
Label3DКонструктор
public Label3D();Свойства33
AlphaAntialiasingEdgeСвойство
public float AlphaAntialiasingEdge { get; set; }Порог, при котором к альфа-каналу будет применено сглаживание.
AlphaAntialiasingModeСвойство
public BaseMaterial3D.AlphaAntiAliasing AlphaAntialiasingMode { get; set; }Тип применяемого альфа-сглаживания.
AlphaCutСвойство
public Label3D.AlphaCutMode AlphaCut { get; set; }Режим альфа-резки, используемый для спрайта.
AlphaHashScaleСвойство
public float AlphaHashScale { get; set; }Масштаб хеширования для Альфа-хэш. Рекомендуемые значения между 0 и 2.
AlphaScissorThresholdСвойство
public float AlphaScissorThreshold { get; set; }Порог, при котором альфа-ножницы будут отбрасывать значения.
AutowrapModeСвойство
public TextServer.AutowrapMode AutowrapMode { get; set; }Если установлено значение, отличное от TextServer.AutowrapMode.Off, текст будет заключен в ограничивающий прямоугольник узла. Если изменить размер узла, он автоматически изменит свою высоту, чтобы показать весь текст.
AutowrapTrimFlagsСвойство
public TextServer.LineBreakFlag AutowrapTrimFlags { get; set; }Флаги обрезки пространства автопереноса. См. TextServer.LineBreakFlag.TrimStartEdgeSpaces и TextServer.LineBreakFlag.TrimEndEdgeSpaces для получения дополнительной информации.
BillboardСвойство
public BaseMaterial3D.BillboardModeEnum Billboard { get; set; }Режим поворота надписи к камере. Enabled разворачивает её к наблюдателю; FixedY сохраняет вертикальную ось. Не управляет видимостью сквозь стены или постоянством экранного размера: это отдельные свойства.
DoubleSidedСвойство
public bool DoubleSided { get; set; }Если true, текст также виден сзади, если false, он невидим, если смотреть на него сзади.
FixedSizeСвойство
public bool FixedSize { get; set; }Снижает изменение видимого размера надписи при изменении дистанции перспективной камеры. Это не гарантия одинакового размера в пикселях при любом FOV, DPI или размере окна. Для экранного интерфейса используйте Control.
FontСвойство
public Font Font { get; set; }Font Конфигурация, используемая для отображения текста.
FontSizeСвойство
public int FontSize { get; set; }Размер шрифта, используемый при формировании надписи. Мировой размер также зависит от PixelSize и трансформации Entity3D. Увеличение FontSize с уменьшением PixelSize не является универсальной заменой подбора шрифта и качества отображения.
HorizontalAlignmentСвойство
public HorizontalAlignment HorizontalAlignment { get; set; }Управляет горизонтальным выравниванием текста. Поддерживает выравнивание по левому краю, по центру, по правому краю и заполнение (также известное как выравнивание по ширине).
JustificationFlagsСвойство
public TextServer.JustificationFlag JustificationFlags { get; set; }Правила выравнивания заливки линий.
LanguageСвойство
public string Language { get; set; }Код языка, используемый алгоритмами переноса строк и форматирования текста. Если оставить поле пустым, будет использоваться текущая локаль.
LineSpacingСвойство
public float LineSpacing { get; set; }Дополнительный вертикальный интервал между строками (в пикселях), интервал добавляется к спуску строки. Это значение может быть отрицательным.
ModulateСвойство
public Color Modulate { get; set; }NoDepthTestСвойство
public bool NoDepthTest { get; set; }Отключает проверку глубины надписи: текст может быть виден сквозь стены. Это не создаёт экранный интерфейс и не решает порядок всех прозрачных объектов. Оставьте false, если стены должны скрывать подпись.
OffsetСвойство
public Vector2 Offset { get; set; }Смещение отрисовки текста (в пикселях).
OutlineModulateСвойство
public Color OutlineModulate { get; set; }Оттенок контура текста.
OutlineRenderPriorityСвойство
public int OutlineRenderPriority { get; set; }Устанавливает приоритет рендеринга для контура текста. Объекты с более высоким приоритетом будут сортироваться перед объектами с более низким приоритетом.
Примечание: Это применимо только в том случае, если Label3D.AlphaCut установлен на Label3D.AlphaCutMode.Disabled (значение по умолчанию).
Примечание: Это применимо только к сортировке прозрачных объектов. Это не повлияет на то, как прозрачные объекты сортируются относительно непрозрачных объектов. Это связано с тем, что непрозрачные объекты не сортируются, в то время как прозрачные объекты сортируются сзади вперед (в зависимости от приоритета).
OutlineSizeСвойство
public int OutlineSize { get; set; }Размер обводки текста.
PixelSizeСвойство
public float PixelSize { get; set; }Масштаб пикселя текста в единицах 3D-мира. Вместе с FontSize определяет геометрический размер надписи; это не размер экранного пикселя. При обычной перспективной проекции дальняя надпись выглядит меньше.
RenderPriorityСвойство
public int RenderPriority { get; set; }Устанавливает приоритет рендеринга для текста. Объекты с более высоким приоритетом будут сортироваться перед объектами с более низким приоритетом.
Примечание: Это применимо только в том случае, если Label3D.AlphaCut установлен на Label3D.AlphaCutMode.Disabled (значение по умолчанию).
Примечание: Это применимо только к сортировке прозрачных объектов. Это не повлияет на то, как прозрачные объекты сортируются относительно непрозрачных объектов. Это связано с тем, что непрозрачные объекты не сортируются, в то время как прозрачные объекты сортируются сзади вперед (в зависимости от приоритета).
ShadedСвойство
public bool Shaded { get; set; }Если true, Light3D в Environment оказывает влияние на метку.
StructuredTextBidiOverrideСвойство
public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }Установите переопределение алгоритма BiDi для структурированного текста.
StructuredTextBidiOverrideOptionsСвойство
public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }Установите дополнительные параметры для переопределения BiDi.
TextСвойство
public string Text { get; set; }Текст надписи в 3D-мире. Изменение ставит обновление геометрии в очередь, поэтому чтение результата отрисовки в той же строке не подтверждает обновлённый кадр. Для выбранных языков назначьте шрифт с нужными глифами.
TextDirectionСвойство
public TextServer.Direction TextDirection { get; set; }Направление написания базового текста.
TextureFilterСвойство
public BaseMaterial3D.TextureFilterEnum TextureFilter { get; set; }Флаги фильтра для текстуры.
UppercaseСвойство
public bool Uppercase { get; set; }Если true, весь текст отображается в ЗАГЛАВНОМ регистре.
VerticalAlignmentСвойство
public VerticalAlignment VerticalAlignment { get; set; }Управляет вертикальным выравниванием текста. Поддерживает верх, центр и низ.
WidthСвойство
public float Width { get; set; }Ширина текста (в пикселях), используемая для автоматического переноса и выравнивания заливки.
Методы61
GenerateTriangleMeshTriangleMesh
public TriangleMesh GenerateTriangleMesh();Создаёт геометрию прямоугольной области текста для дальнейшего использования. В проверенном движке это две треугольные грани границ надписи, а не контуры глифов. Не создаёт CollisionShape3D автоматически.
TriangleMeshTriangleMesh из двух треугольников для непустой проверенной надписи; не объёмные буквы. Для геометрии глифов используйте TextMesh.
GetAlphaAntialiasingBaseMaterial3D.AlphaAntiAliasing
public BaseMaterial3D.AlphaAntiAliasing GetAlphaAntialiasing();BaseMaterial3D.AlphaAntiAliasingGetAlphaAntialiasingEdgefloat
public float GetAlphaAntialiasingEdge();floatGetAlphaCutModeLabel3D.AlphaCutMode
public Label3D.AlphaCutMode GetAlphaCutMode();Label3D.AlphaCutModeGetAlphaHashScalefloat
public float GetAlphaHashScale();floatGetAlphaScissorThresholdfloat
public float GetAlphaScissorThreshold();floatGetAutowrapModeTextServer.AutowrapMode
public TextServer.AutowrapMode GetAutowrapMode();TextServer.AutowrapModeGetAutowrapTrimFlagsTextServer.LineBreakFlag
public TextServer.LineBreakFlag GetAutowrapTrimFlags();TextServer.LineBreakFlagGetBillboardModeBaseMaterial3D.BillboardModeEnum
public BaseMaterial3D.BillboardModeEnum GetBillboardMode();BaseMaterial3D.BillboardModeEnumGetDrawFlagbool
public bool GetDrawFlag(Label3D.DrawFlags flag);Возвращает значение указанного флага.
| Имя | Тип | По умолчанию |
|---|---|---|
flag | Label3D.DrawFlags | — |
boolGetFontFont
public Font GetFont();FontGetFontSizeint
public int GetFontSize();intGetHorizontalAlignmentHorizontalAlignment
public HorizontalAlignment GetHorizontalAlignment();HorizontalAlignmentGetJustificationFlagsTextServer.JustificationFlag
public TextServer.JustificationFlag GetJustificationFlags();TextServer.JustificationFlagGetLanguagestring
public string GetLanguage();stringGetLineSpacingfloat
public float GetLineSpacing();floatGetModulateColor
public Color GetModulate();ColorGetOffsetVector2
public Vector2 GetOffset();Vector2GetOutlineModulateColor
public Color GetOutlineModulate();ColorGetOutlineRenderPriorityint
public int GetOutlineRenderPriority();intGetOutlineSizeint
public int GetOutlineSize();intGetPixelSizefloat
public float GetPixelSize();floatGetRenderPriorityint
public int GetRenderPriority();intGetStructuredTextBidiOverrideTextServer.StructuredTextParser
public TextServer.StructuredTextParser GetStructuredTextBidiOverride();TextServer.StructuredTextParserGetStructuredTextBidiOverrideOptionsReckfell.Collections.Array
public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();Reckfell.Collections.ArrayGetTextstring
public string GetText();stringGetTextDirectionTextServer.Direction
public TextServer.Direction GetTextDirection();TextServer.DirectionGetTextureFilterBaseMaterial3D.TextureFilterEnum
public BaseMaterial3D.TextureFilterEnum GetTextureFilter();BaseMaterial3D.TextureFilterEnumGetVerticalAlignmentVerticalAlignment
public VerticalAlignment GetVerticalAlignment();VerticalAlignmentGetWidthfloat
public float GetWidth();floatIsUppercasebool
public bool IsUppercase();boolSetAlphaAntialiasingvoid
public void SetAlphaAntialiasing(BaseMaterial3D.AlphaAntiAliasing alphaAA);| Имя | Тип | По умолчанию |
|---|---|---|
alphaAA | BaseMaterial3D.AlphaAntiAliasing | — |
SetAlphaAntialiasingEdgevoid
public void SetAlphaAntialiasingEdge(float edge);| Имя | Тип | По умолчанию |
|---|---|---|
edge | float | — |
SetAlphaCutModevoid
public void SetAlphaCutMode(Label3D.AlphaCutMode mode);| Имя | Тип | По умолчанию |
|---|---|---|
mode | Label3D.AlphaCutMode | — |
SetAlphaHashScalevoid
public void SetAlphaHashScale(float threshold);| Имя | Тип | По умолчанию |
|---|---|---|
threshold | float | — |
SetAlphaScissorThresholdvoid
public void SetAlphaScissorThreshold(float threshold);| Имя | Тип | По умолчанию |
|---|---|---|
threshold | float | — |
SetAutowrapModevoid
public void SetAutowrapMode(TextServer.AutowrapMode autowrapMode);| Имя | Тип | По умолчанию |
|---|---|---|
autowrapMode | TextServer.AutowrapMode | — |
SetAutowrapTrimFlagsvoid
public void SetAutowrapTrimFlags(TextServer.LineBreakFlag autowrapTrimFlags);| Имя | Тип | По умолчанию |
|---|---|---|
autowrapTrimFlags | TextServer.LineBreakFlag | — |
SetBillboardModevoid
public void SetBillboardMode(BaseMaterial3D.BillboardModeEnum mode);| Имя | Тип | По умолчанию |
|---|---|---|
mode | BaseMaterial3D.BillboardModeEnum | — |
SetDrawFlagvoid
public void SetDrawFlag(Label3D.DrawFlags flag, bool enabled);Если true, указанный flag будет включен.
| Имя | Тип | По умолчанию |
|---|---|---|
flag | Label3D.DrawFlags | — |
enabled | bool | — |
SetFontvoid
public void SetFont(Font font);| Имя | Тип | По умолчанию |
|---|---|---|
font | Font | — |
SetFontSizevoid
public void SetFontSize(int size);| Имя | Тип | По умолчанию |
|---|---|---|
size | int | — |
SetHorizontalAlignmentvoid
public void SetHorizontalAlignment(HorizontalAlignment alignment);| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
SetJustificationFlagsvoid
public void SetJustificationFlags(TextServer.JustificationFlag justificationFlags);| Имя | Тип | По умолчанию |
|---|---|---|
justificationFlags | TextServer.JustificationFlag | — |
SetLanguagevoid
public void SetLanguage(string language);| Имя | Тип | По умолчанию |
|---|---|---|
language | string | — |
SetLineSpacingvoid
public void SetLineSpacing(float lineSpacing);| Имя | Тип | По умолчанию |
|---|---|---|
lineSpacing | float | — |
SetModulatevoid
public void SetModulate(Color modulate);| Имя | Тип | По умолчанию |
|---|---|---|
modulate | Color | — |
SetOffsetvoid
public void SetOffset(Vector2 offset);| Имя | Тип | По умолчанию |
|---|---|---|
offset | Vector2 | — |
SetOutlineModulatevoid
public void SetOutlineModulate(Color modulate);| Имя | Тип | По умолчанию |
|---|---|---|
modulate | Color | — |
SetOutlineRenderPriorityvoid
public void SetOutlineRenderPriority(int priority);| Имя | Тип | По умолчанию |
|---|---|---|
priority | int | — |
SetOutlineSizevoid
public void SetOutlineSize(int outlineSize);| Имя | Тип | По умолчанию |
|---|---|---|
outlineSize | int | — |
SetPixelSizevoid
public void SetPixelSize(float pixelSize);| Имя | Тип | По умолчанию |
|---|---|---|
pixelSize | float | — |
SetRenderPriorityvoid
public void SetRenderPriority(int priority);| Имя | Тип | По умолчанию |
|---|---|---|
priority | int | — |
SetStructuredTextBidiOverridevoid
public void SetStructuredTextBidiOverride(TextServer.StructuredTextParser parser);| Имя | Тип | По умолчанию |
|---|---|---|
parser | TextServer.StructuredTextParser | — |
SetStructuredTextBidiOverrideOptionsvoid
public void SetStructuredTextBidiOverrideOptions(Reckfell.Collections.Array args);| Имя | Тип | По умолчанию |
|---|---|---|
args | Reckfell.Collections.Array | — |
SetTextvoid
public void SetText(string text);| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
SetTextDirectionvoid
public void SetTextDirection(TextServer.Direction direction);| Имя | Тип | По умолчанию |
|---|---|---|
direction | TextServer.Direction | — |
SetTextureFiltervoid
public void SetTextureFilter(BaseMaterial3D.TextureFilterEnum mode);| Имя | Тип | По умолчанию |
|---|---|---|
mode | BaseMaterial3D.TextureFilterEnum | — |
SetUppercasevoid
public void SetUppercase(bool enable);| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
SetVerticalAlignmentvoid
public void SetVerticalAlignment(VerticalAlignment alignment);| Имя | Тип | По умолчанию |
|---|---|---|
alignment | VerticalAlignment | — |
SetWidthvoid
public void SetWidth(float width);| Имя | Тип | По умолчанию |
|---|---|---|
width | float | — |
Label3D.AlphaCutMode
| Значение | Описание |
|---|---|
Disabled = 0 | Этот режим выполняет стандартное альфа-смешивание. Он может отображать полупрозрачные области, но проблемы с сортировкой прозрачности могут быть видны, когда накладываются несколько прозрачных материалов. |
Discard = 1 | Этот режим допускает только полностью прозрачные или полностью непрозрачные пиксели. Резкие края будут видны, если не включена какая-либо форма сглаживания экранного пространства (см. |
Hash = 3 | В этом режиме отрисовка отсекает все значения ниже пространственно-детерминированного порога, остальные остаются непрозрачными. |
OpaquePrepass = 2 | Этот режим рисует полностью непрозрачные пиксели в предварительном проходе глубины. Это медленнее, чем |
Label3D.DrawFlags
| Значение | Описание |
|---|---|
DisableDepthTest = 2 | Отключает тест глубины, поэтому этот объект рисуется поверх всех остальных. Однако объекты, рисуемые после него в порядке рисования, могут его перекрывать. |
DoubleSided = 1 | Если установлено, текст также виден сзади. Если не установлено, текст не виден при взгляде сзади. |
FixedSize = 3 | Label Расширяется по глубине, чтобы на экране всегда был один и тот же размер. |
Max = 4 | Представляет размер перечисления |
Shaded = 0 | Если установлено, окружающее освещение влияет на метку. |