reckfellENGINE

SpriteBase3D

Узел 2D-спрайта в 3D-среде.

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

Узел 2D-спрайта в 3D-среде.

Узел, который отображает информацию о 2D-текстуре в 3D-среде. См. также Sprite3D, где определены многие другие свойства.

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

Свойства20

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

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

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

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

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

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

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

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

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

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

AxisСвойство
# Axis
C#
public Vector3.Axis Axis { get; set; }

Направление, в котором обращена лицевая сторона текстуры.

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

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

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

Если true, текстура будет центрирована.

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

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

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

Если true, текстура отображается с тем же размером, независимо от расстояния. Размер текстуры на экране такой же, как если бы камера находилась на расстоянии 1.0 единиц от начала текстуры, независимо от фактического расстояния от камеры. Поле зрения Camera3D (или Camera3D.Size в ортогональном/усеченном режиме) по-прежнему влияет на размер отрисовываемого спрайта.

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

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

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

Если true, текстура отражена по вертикали.

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

Значение цвета, используемое для умножения цветов текстуры. Может использоваться для придания цвета настроению или для имитации цвета окружающего света. Примечание: В отличие от CanvasItem.Modulate для 2D, цвета со значениями выше 1.0 (сверхяркий) не поддерживаются. Примечание: Если GeometryInstance3D.MaterialOverride определен в SpriteBase3D, переопределение материала должно быть настроено на учет цветов вершин для альбедо. В противном случае цвет, определенный в SpriteBase3D.Modulate, будет проигнорирован. Для BaseMaterial3D, BaseMaterial3D.VertexColorUseAsAlbedo должен быть true. Для ShaderMaterial ALBEDO *= COLOR.rgb; необходимо вставить в функцию шейдера fragment().

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

Если true, проверка глубины отключена, и объект будет отрисован в порядке рендеринга.

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

Смещение отрисовки текстуры. Примечание: При увеличении SpriteBase3D.Offset.y в Sprite3D спрайт перемещается вверх в мировом пространстве (т. е. +Y вверх).

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

Размер ширины одного пикселя спрайта для его масштабирования в 3D.

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

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

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

Если true, Light3D в Environment оказывает влияние на спрайт.

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

Флаги фильтра для текстуры. Примечание: Линейная фильтрация может вызывать артефакты по краям, которые особенно заметны на непрозрачных текстурах. Чтобы этого не произошло, используйте текстуры с прозрачными или идентичными цветами по краям.

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

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

Методы34

GenerateTriangleMeshTriangleMesh
# GenerateTriangleMesh
C#
public TriangleMesh GenerateTriangleMesh();

Возвращает TriangleMesh с вершинами спрайта, соответствующими его текущей конфигурации (например, SpriteBase3D.Axis и SpriteBase3D.PixelSize).

Возвращает TriangleMesh
GetAlphaAntialiasingBaseMaterial3D.AlphaAntiAliasing
# GetAlphaAntialiasing
C#
public BaseMaterial3D.AlphaAntiAliasing GetAlphaAntialiasing();
Возвращает BaseMaterial3D.AlphaAntiAliasing
GetAlphaAntialiasingEdgefloat
# GetAlphaAntialiasingEdge
C#
public float GetAlphaAntialiasingEdge();
Возвращает float
GetAlphaCutModeSpriteBase3D.AlphaCutMode
# GetAlphaCutMode
C#
public SpriteBase3D.AlphaCutMode GetAlphaCutMode();
Возвращает SpriteBase3D.AlphaCutMode
GetAlphaHashScalefloat
# GetAlphaHashScale
C#
public float GetAlphaHashScale();
Возвращает float
GetAlphaScissorThresholdfloat
# GetAlphaScissorThreshold
C#
public float GetAlphaScissorThreshold();
Возвращает float
GetAxisVector3.Axis
# GetAxis
C#
public Vector3.Axis GetAxis();
Возвращает Vector3.Axis
GetBillboardModeBaseMaterial3D.BillboardModeEnum
# GetBillboardMode
C#
public BaseMaterial3D.BillboardModeEnum GetBillboardMode();
Возвращает BaseMaterial3D.BillboardModeEnum
GetDrawFlagbool
# GetDrawFlag
C#
public bool GetDrawFlag(SpriteBase3D.DrawFlags flag);

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

Параметры
ИмяТипПо умолчанию
flagSpriteBase3D.DrawFlags—
Возвращает bool
GetItemRectRect2
# GetItemRect
C#
public Rect2 GetItemRect();

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

Возвращает Rect2
GetModulateColor
# GetModulate
C#
public Color GetModulate();
Возвращает Color
GetOffsetVector2
# GetOffset
C#
public Vector2 GetOffset();
Возвращает Vector2
GetPixelSizefloat
# GetPixelSize
C#
public float GetPixelSize();
Возвращает float
GetRenderPriorityint
# GetRenderPriority
C#
public int GetRenderPriority();
Возвращает int
GetTextureFilterBaseMaterial3D.TextureFilterEnum
# GetTextureFilter
C#
public BaseMaterial3D.TextureFilterEnum GetTextureFilter();
Возвращает BaseMaterial3D.TextureFilterEnum
IsCenteredbool
# IsCentered
C#
public bool IsCentered();
Возвращает bool
IsFlippedHbool
# IsFlippedH
C#
public bool IsFlippedH();
Возвращает bool
IsFlippedVbool
# IsFlippedV
C#
public bool IsFlippedV();
Возвращает 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(SpriteBase3D.AlphaCutMode mode);
Параметры
ИмяТипПо умолчанию
modeSpriteBase3D.AlphaCutMode—
SetAlphaHashScalevoid
# SetAlphaHashScale
C#
public void SetAlphaHashScale(float threshold);
Параметры
ИмяТипПо умолчанию
thresholdfloat—
SetAlphaScissorThresholdvoid
# SetAlphaScissorThreshold
C#
public void SetAlphaScissorThreshold(float threshold);
Параметры
ИмяТипПо умолчанию
thresholdfloat—
SetAxisvoid
# SetAxis
C#
public void SetAxis(Vector3.Axis axis);
Параметры
ИмяТипПо умолчанию
axisVector3.Axis—
SetBillboardModevoid
# SetBillboardMode
C#
public void SetBillboardMode(BaseMaterial3D.BillboardModeEnum mode);
Параметры
ИмяТипПо умолчанию
modeBaseMaterial3D.BillboardModeEnum—
SetCenteredvoid
# SetCentered
C#
public void SetCentered(bool centered);
Параметры
ИмяТипПо умолчанию
centeredbool—
SetDrawFlagvoid
# SetDrawFlag
C#
public void SetDrawFlag(SpriteBase3D.DrawFlags flag, bool enabled);

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

Параметры
ИмяТипПо умолчанию
flagSpriteBase3D.DrawFlags—
enabledbool—
SetFlipHvoid
# SetFlipH
C#
public void SetFlipH(bool flipH);
Параметры
ИмяТипПо умолчанию
flipHbool—
SetFlipVvoid
# SetFlipV
C#
public void SetFlipV(bool flipV);
Параметры
ИмяТипПо умолчанию
flipVbool—
SetModulatevoid
# SetModulate
C#
public void SetModulate(Color modulate);
Параметры
ИмяТипПо умолчанию
modulateColor—
SetOffsetvoid
# SetOffset
C#
public void SetOffset(Vector2 offset);
Параметры
ИмяТипПо умолчанию
offsetVector2—
SetPixelSizevoid
# SetPixelSize
C#
public void SetPixelSize(float pixelSize);
Параметры
ИмяТипПо умолчанию
pixelSizefloat—
SetRenderPriorityvoid
# SetRenderPriority
C#
public void SetRenderPriority(int priority);
Параметры
ИмяТипПо умолчанию
priorityint—
SetTextureFiltervoid
# SetTextureFilter
C#
public void SetTextureFilter(BaseMaterial3D.TextureFilterEnum mode);
Параметры
ИмяТипПо умолчанию
modeBaseMaterial3D.TextureFilterEnum—

SpriteBase3D.AlphaCutMode

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

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

Discard = 1

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

Hash = 3

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

OpaquePrepass = 2

Этот режим рисует полностью непрозрачные пиксели в предварительном проходе глубины. Это медленнее, чем SpriteBase3D.AlphaCutMode.Disabled или SpriteBase3D.AlphaCutMode.Discard, но позволяет отображать полупрозрачные области и сглаживать края при использовании правильной сортировки.

SpriteBase3D.DrawFlags

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

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

DoubleSided = 2

Если установлено, то текстура видна и сзади. Если нет, то текстура не видна, если смотреть сзади.

FixedSize = 4

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

Max = 5

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

Shaded = 1

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

Transparent = 0

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

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

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

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

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