SpriteBase3D
Узел 2D-спрайта в 3D-среде.
Узел 2D-спрайта в 3D-среде.
Узел, который отображает информацию о 2D-текстуре в 3D-среде. См. также Sprite3D, где определены многие другие свойства.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Свойства20
AlphaAntialiasingEdgeСвойство
public float AlphaAntialiasingEdge { get; set; }Порог, при котором к альфа-каналу будет применено сглаживание.
AlphaAntialiasingModeСвойство
public BaseMaterial3D.AlphaAntiAliasing AlphaAntialiasingMode { get; set; }Тип применяемого альфа-сглаживания.
AlphaCutСвойство
public SpriteBase3D.AlphaCutMode AlphaCut { get; set; }Режим альфа-резки, используемый для спрайта.
AlphaHashScaleСвойство
public float AlphaHashScale { get; set; }Масштаб хеширования для Альфа-хэш. Рекомендуемые значения между 0 и 2.
AlphaScissorThresholdСвойство
public float AlphaScissorThreshold { get; set; }Порог, при котором альфа-ножницы будут отбрасывать значения.
AxisСвойство
public Vector3.Axis Axis { get; set; }Направление, в котором обращена лицевая сторона текстуры.
BillboardСвойство
public BaseMaterial3D.BillboardModeEnum Billboard { get; set; }Выбирает режим ориентации спрайта к камере. Если billboard-геометрия отбрасывает тени, ориентация относительно камеры влияет и на теневой проход. При нескольких камерах проверяйте используемую ориентацию перед тем, как полагаться на форму тени.
CenteredСвойство
public bool Centered { get; set; }Если true, текстура будет центрирована.
DoubleSidedСвойство
public bool DoubleSided { get; set; }Если true, текстуру можно увидеть и сзади, если false, она невидима, если смотреть на нее сзади.
FixedSizeСвойство
public bool FixedSize { get; set; }Если true, текстура отображается с тем же размером, независимо от расстояния. Размер текстуры на экране такой же, как если бы камера находилась на расстоянии 1.0 единиц от начала текстуры, независимо от фактического расстояния от камеры. Поле зрения Camera3D (или Camera3D.Size в ортогональном/усеченном режиме) по-прежнему влияет на размер отрисовываемого спрайта.
FlipHСвойство
public bool FlipH { get; set; }Если true, текстура отражена по горизонтали.
FlipVСвойство
public bool FlipV { get; set; }Если true, текстура отражена по вертикали.
ModulateСвойство
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Свойство
public bool NoDepthTest { get; set; }Если true, проверка глубины отключена, и объект будет отрисован в порядке рендеринга.
OffsetСвойство
public Vector2 Offset { get; set; }Смещение отрисовки текстуры.
Примечание: При увеличении SpriteBase3D.Offset.y в Sprite3D спрайт перемещается вверх в мировом пространстве (т. е. +Y вверх).
PixelSizeСвойство
public float PixelSize { get; set; }Размер ширины одного пикселя спрайта для его масштабирования в 3D.
RenderPriorityСвойство
public int RenderPriority { get; set; }Устанавливает приоритет рендеринга для спрайта. Объекты с более высоким приоритетом будут сортироваться перед объектами с более низким приоритетом.
Примечание: Это применимо только в том случае, если SpriteBase3D.AlphaCut установлен на SpriteBase3D.AlphaCutMode.Disabled (значение по умолчанию).
Примечание: Это применимо только к сортировке прозрачных объектов. Это не повлияет на то, как прозрачные объекты сортируются относительно непрозрачных объектов. Это связано с тем, что непрозрачные объекты не сортируются, в то время как прозрачные объекты сортируются сзади вперед (в зависимости от приоритета).
ShadedСвойство
public bool Shaded { get; set; }Если true, Light3D в Environment оказывает влияние на спрайт.
TextureFilterСвойство
public BaseMaterial3D.TextureFilterEnum TextureFilter { get; set; }Флаги фильтра для текстуры. Примечание: Линейная фильтрация может вызывать артефакты по краям, которые особенно заметны на непрозрачных текстурах. Чтобы этого не произошло, используйте текстуры с прозрачными или идентичными цветами по краям.
TransparentСвойство
public bool Transparent { get; set; }Если true, прозрачность текстуры используются, чтобы сделать эти части спрайта невидимыми.
Методы34
GenerateTriangleMeshTriangleMesh
public TriangleMesh GenerateTriangleMesh();Возвращает TriangleMesh с вершинами спрайта, соответствующими его текущей конфигурации (например, SpriteBase3D.Axis и SpriteBase3D.PixelSize).
TriangleMeshGetAlphaAntialiasingBaseMaterial3D.AlphaAntiAliasing
public BaseMaterial3D.AlphaAntiAliasing GetAlphaAntialiasing();BaseMaterial3D.AlphaAntiAliasingGetAlphaAntialiasingEdgefloat
public float GetAlphaAntialiasingEdge();floatGetAlphaCutModeSpriteBase3D.AlphaCutMode
public SpriteBase3D.AlphaCutMode GetAlphaCutMode();SpriteBase3D.AlphaCutModeGetAlphaHashScalefloat
public float GetAlphaHashScale();floatGetAlphaScissorThresholdfloat
public float GetAlphaScissorThreshold();floatGetAxisVector3.Axis
public Vector3.Axis GetAxis();Vector3.AxisGetBillboardModeBaseMaterial3D.BillboardModeEnum
public BaseMaterial3D.BillboardModeEnum GetBillboardMode();BaseMaterial3D.BillboardModeEnumGetDrawFlagbool
public bool GetDrawFlag(SpriteBase3D.DrawFlags flag);Возвращает значение указанного флага.
| Имя | Тип | По умолчанию |
|---|---|---|
flag | SpriteBase3D.DrawFlags | — |
boolGetItemRectRect2
public Rect2 GetItemRect();Возвращает прямоугольник, представляющий этот спрайт.
Rect2GetModulateColor
public Color GetModulate();ColorGetOffsetVector2
public Vector2 GetOffset();Vector2GetPixelSizefloat
public float GetPixelSize();floatGetRenderPriorityint
public int GetRenderPriority();intGetTextureFilterBaseMaterial3D.TextureFilterEnum
public BaseMaterial3D.TextureFilterEnum GetTextureFilter();BaseMaterial3D.TextureFilterEnumIsCenteredbool
public bool IsCentered();boolIsFlippedHbool
public bool IsFlippedH();boolIsFlippedVbool
public bool IsFlippedV();boolSetAlphaAntialiasingvoid
public void SetAlphaAntialiasing(BaseMaterial3D.AlphaAntiAliasing alphaAA);| Имя | Тип | По умолчанию |
|---|---|---|
alphaAA | BaseMaterial3D.AlphaAntiAliasing | — |
SetAlphaAntialiasingEdgevoid
public void SetAlphaAntialiasingEdge(float edge);| Имя | Тип | По умолчанию |
|---|---|---|
edge | float | — |
SetAlphaCutModevoid
public void SetAlphaCutMode(SpriteBase3D.AlphaCutMode mode);| Имя | Тип | По умолчанию |
|---|---|---|
mode | SpriteBase3D.AlphaCutMode | — |
SetAlphaHashScalevoid
public void SetAlphaHashScale(float threshold);| Имя | Тип | По умолчанию |
|---|---|---|
threshold | float | — |
SetAlphaScissorThresholdvoid
public void SetAlphaScissorThreshold(float threshold);| Имя | Тип | По умолчанию |
|---|---|---|
threshold | float | — |
SetAxisvoid
public void SetAxis(Vector3.Axis axis);| Имя | Тип | По умолчанию |
|---|---|---|
axis | Vector3.Axis | — |
SetBillboardModevoid
public void SetBillboardMode(BaseMaterial3D.BillboardModeEnum mode);| Имя | Тип | По умолчанию |
|---|---|---|
mode | BaseMaterial3D.BillboardModeEnum | — |
SetCenteredvoid
public void SetCentered(bool centered);| Имя | Тип | По умолчанию |
|---|---|---|
centered | bool | — |
SetDrawFlagvoid
public void SetDrawFlag(SpriteBase3D.DrawFlags flag, bool enabled);Если true, указанный флаг будет включен.
| Имя | Тип | По умолчанию |
|---|---|---|
flag | SpriteBase3D.DrawFlags | — |
enabled | bool | — |
SetFlipHvoid
public void SetFlipH(bool flipH);| Имя | Тип | По умолчанию |
|---|---|---|
flipH | bool | — |
SetFlipVvoid
public void SetFlipV(bool flipV);| Имя | Тип | По умолчанию |
|---|---|---|
flipV | bool | — |
SetModulatevoid
public void SetModulate(Color modulate);| Имя | Тип | По умолчанию |
|---|---|---|
modulate | Color | — |
SetOffsetvoid
public void SetOffset(Vector2 offset);| Имя | Тип | По умолчанию |
|---|---|---|
offset | Vector2 | — |
SetPixelSizevoid
public void SetPixelSize(float pixelSize);| Имя | Тип | По умолчанию |
|---|---|---|
pixelSize | float | — |
SetRenderPriorityvoid
public void SetRenderPriority(int priority);| Имя | Тип | По умолчанию |
|---|---|---|
priority | int | — |
SetTextureFiltervoid
public void SetTextureFilter(BaseMaterial3D.TextureFilterEnum mode);| Имя | Тип | По умолчанию |
|---|---|---|
mode | BaseMaterial3D.TextureFilterEnum | — |
SpriteBase3D.AlphaCutMode
| Значение | Описание |
|---|---|
Disabled = 0 | Этот режим выполняет стандартное альфа-смешивание. Он может отображать полупрозрачные области, но проблемы с сортировкой прозрачности могут быть видны, когда накладываются несколько прозрачных материалов. |
Discard = 1 | Этот режим допускает только полностью прозрачные или полностью непрозрачные пиксели. Резкие края будут видны, если не включена какая-либо форма сглаживания экранного пространства (см. |
Hash = 3 | В этом режиме отрисовка отсекает все значения ниже пространственно-детерминированного порога, остальные остаются непрозрачными. |
OpaquePrepass = 2 | Этот режим рисует полностью непрозрачные пиксели в предварительном проходе глубины. Это медленнее, чем |
SpriteBase3D.DrawFlags
| Значение | Описание |
|---|---|
DisableDepthTest = 3 | Отключает тест глубины, поэтому этот объект рисуется поверх всех остальных. Однако объекты, рисуемые после него в порядке рисования, могут его перекрывать. |
DoubleSided = 2 | Если установлено, то текстура видна и сзади. Если нет, то текстура не видна, если смотреть сзади. |
FixedSize = 4 | Label Расширяется по глубине, чтобы на экране всегда был один и тот же размер. |
Max = 5 | Представляет размер перечисления |
Shaded = 1 | Если установлено, то освещение в окружающей среде влияет на спрайт. |
Transparent = 0 | Если задано, прозрачность текстуры используются, чтобы сделать эти части спрайта невидимыми. |