Sprite3D — C# API

class Sprite3DReckfellSharpНаследует SpriteBase3D

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

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

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

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

Sprite3DКонструктор

# Sprite3D

C#
public Sprite3D();

Свойства7

FrameСвойство

# Frame

C#
public int Frame { get; set; }

Текущий кадр для отображения из таблицы спрайтов. Sprite3D.Hframes или Sprite3D.Vframes должны быть больше 1. Это свойство автоматически корректируется, когда Sprite3D.Hframes или Sprite3D.Vframes изменяются, чтобы продолжать указывать на тот же визуальный кадр (тот же столбец и строку). Если это невозможно, это значение сбрасывается до 0.

FrameCoordsСвойство

# FrameCoords

C#
public Vector2I FrameCoords { get; set; }

Координаты кадра для отображения из таблицы спрайтов. Это псевдоним для свойства Sprite3D.Frame. Sprite3D.Hframes или Sprite3D.Vframes должны быть больше 1.

HframesСвойство

# Hframes

C#
public int Hframes { get; set; }

Количество столбцов в таблице спрайтов. При изменении этого свойства Sprite3D.Frame корректируется так, чтобы сохранялась та же визуальная рамка (та же строка и столбец). Если это невозможно, Sprite3D.Frame сбрасывается до 0.

RegionEnabledСвойство

# RegionEnabled

C#
public bool RegionEnabled { get; set; }

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

RegionRectСвойство

# RegionRect

C#
public Rect2 RegionRect { get; set; }

Область текстуры атласа для отображения. Sprite3D.RegionEnabled должен быть true.

TextureСвойство

# Texture

C#
public Texture2D Texture { get; set; }

Texture2D объект для рисования. Если используется GeometryInstance3D.MaterialOverride, это будет переопределено. Информация о размере по-прежнему используется.

VframesСвойство

# Vframes

C#
public int Vframes { get; set; }

Количество строк в таблице спрайтов. При изменении этого свойства Sprite3D.Frame корректируется так, чтобы сохранялась та же визуальная рамка (та же строка и столбец). Если это невозможно, Sprite3D.Frame сбрасывается до 0.

Методы14

GetFrameint

# GetFrame

C#
public int GetFrame();

Возвращает int

GetFrameCoordsVector2I

# GetFrameCoords

C#
public Vector2I GetFrameCoords();

Возвращает Vector2I

GetHframesint

# GetHframes

C#
public int GetHframes();

Возвращает int

GetRegionRectRect2

# GetRegionRect

C#
public Rect2 GetRegionRect();

Возвращает Rect2

GetTextureTexture2D

# GetTexture

C#
public Texture2D GetTexture();

Возвращает Texture2D

GetVframesint

# GetVframes

C#
public int GetVframes();

Возвращает int

IsRegionEnabledbool

# IsRegionEnabled

C#
public bool IsRegionEnabled();

Возвращает bool

SetFramevoid

# SetFrame

C#
public void SetFrame(int frame);

Параметры
Имя	Тип	По умолчанию
`frame`	`int`	—

SetFrameCoordsvoid

# SetFrameCoords

C#
public void SetFrameCoords(Vector2I coords);

Параметры
Имя	Тип	По умолчанию
`coords`	`Vector2I`	—

SetHframesvoid

# SetHframes

C#
public void SetHframes(int hframes);

Параметры
Имя	Тип	По умолчанию
`hframes`	`int`	—

SetRegionEnabledvoid

# SetRegionEnabled

C#
public void SetRegionEnabled(bool enabled);

Параметры
Имя	Тип	По умолчанию
`enabled`	`bool`	—

SetRegionRectvoid

# SetRegionRect

C#
public void SetRegionRect(Rect2 rect);

Параметры
Имя	Тип	По умолчанию
`rect`	`Rect2`	—

SetTexturevoid

# SetTexture

C#
public void SetTexture(Texture2D texture);

Параметры
Имя	Тип	По умолчанию
`texture`	`Texture2D`	—

SetVframesvoid

# SetVframes

C#
public void SetVframes(int vframes);

Параметры
Имя	Тип	По умолчанию
`vframes`	`int`	—

Сигналы и события2

FrameChangedСобытие

# FrameChanged

public event Action FrameChanged;

Выдается при изменении Sprite3D.Frame.

TextureChangedСобытие

# TextureChanged

public event Action TextureChanged;

Выдается при изменении Sprite3D.Texture.