CanvasLayer — C# API

Узел, используемый для независимой визуализации объектов в 2D-сцене.

class CanvasLayerReckfellSharpНаследует Entity

Узел, используемый для независимой визуализации объектов в 2D-сцене.

Узлы, производные от CanvasItem, которые являются прямыми или косвенными потомками CanvasLayer, будут отрисованы в этом слое. Слой — это числовой индекс, который определяет порядок отрисовки. 2D-сцена по умолчанию визуализируется с индексом 0, поэтому CanvasLayer с индексом -1 будет отрисован ниже, а CanvasLayer с индексом 1 будет отрисован выше. Этот порядок будет сохраняться независимо от CanvasItem.ZIndex узлов в каждом слое. CanvasLayer могут быть скрыты, и они также могут опционально следовать за областью просмотра. Это делает их полезными для HUD, таких как наложения полос здоровья (на слоях 1 и выше) или фонов (на слоях -1 и ниже). Примечание: Встроенные Window размещаются на слое 1024. CanvasItem на слоях 1025 и выше отображаются поверх встроенных окон. Примечание: Каждый CanvasLayer рисуется на одном определенном Viewport и не может совместно использоваться несколькими Viewport, см. CanvasLayer.CustomViewport. При использовании нескольких Viewport, например, в игре с разделенным экраном, вам необходимо создать отдельный CanvasLayer для каждого Viewport, на котором вы хотите его нарисовать.

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

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

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

# CanvasLayer

C#
public CanvasLayer();

Свойства9

CustomViewportСвойство

# CustomViewport

C#
public Entity CustomViewport { get; set; }

Пользовательский узел Viewport, назначенный CanvasLayer. Если null, вместо этого используется viewport по умолчанию.

FollowViewportEnabledСвойство

# FollowViewportEnabled

C#
public bool FollowViewportEnabled { get; set; }

Если включено, CanvasLayer сохраняет свое положение в мировом пространстве. Если отключено, CanvasLayer остается в фиксированном положении на экране. Вместе с CanvasLayer.FollowViewportScale это можно использовать для псевдо-3D-эффекта.

FollowViewportScaleСвойство

# FollowViewportScale

C#
public float FollowViewportScale { get; set; }

Масштабирует слой при использовании CanvasLayer.FollowViewportEnabled. Слои, перемещающиеся на передний план, должны иметь увеличивающиеся масштабы, а слои, перемещающиеся на задний план, должны иметь уменьшающиеся масштабы.

LayerСвойство

# Layer

C#
public int Layer { get; set; }

Индекс слоя для порядка отрисовки. Меньшие значения рисуются позади больших значений. Примечание: Если несколько CanvasLayers имеют одинаковый индекс слоя, то дочерние элементы CanvasItem одного CanvasLayer рисуются позади дочерних элементов CanvasItem другого CanvasLayer. Какой CanvasLayer рисуется впереди, не определено. Примечание: Индекс слоя должен быть между RenderingServer.CanvasLayerMin и RenderingServer.CanvasLayerMax (включительно). Любое другое значение будет переноситься.

OffsetСвойство

# Offset

C#
public Vector2 Offset { get; set; }

Смещение базы слоя.

RotationСвойство

# Rotation

C#
public float Rotation { get; set; }

Вращение слоя в радианах.

ScaleСвойство

# Scale

C#
public Vector2 Scale { get; set; }

Масштаб слоя.

TransformСвойство

# Transform

C#
public Transform2D Transform { get; set; }

Трансформация слоя.

VisibleСвойство

# Visible

C#
public bool Visible { get; set; }

Если false, любой CanvasItem под этим CanvasLayer будет скрыт. В отличие от CanvasItem.Visible, видимость CanvasLayer не распространяется на нижележащие слои.

Методы22

GetCanvasRid

# GetCanvas

C#
public Rid GetCanvas();

Возвращает RID холста, используемого этим слоем.

Возвращает Rid

GetCustomViewportEntity

# GetCustomViewport

C#
public Entity GetCustomViewport();

Возвращает Entity

GetFinalTransformTransform2D

# GetFinalTransform

C#
public Transform2D GetFinalTransform();

Возвращает трансформацию из CanvasLayer:: система координат Viewport- система координат.

Спрячься.

Возвращает Transform2D

GetFollowViewportScalefloat

# GetFollowViewportScale

C#
public float GetFollowViewportScale();

Возвращает float

GetLayerint

# GetLayer

C#
public int GetLayer();

Возвращает int

GetOffsetVector2

# GetOffset

C#
public Vector2 GetOffset();

Возвращает Vector2

GetRotationfloat

# GetRotation

C#
public float GetRotation();

Возвращает float

GetScaleVector2

# GetScale

C#
public Vector2 GetScale();

Возвращает Vector2

GetTransformTransform2D

# GetTransform

C#
public Transform2D GetTransform();

Возвращает Transform2D

Hidevoid

# Hide

C#
public void Hide();

Скрывает любой CanvasItem под этим CanvasLayer. Это эквивалентно установке CanvasLayer.Visible на false.

IsFollowingViewportbool

# IsFollowingViewport

C#
public bool IsFollowingViewport();

Возвращает bool

IsVisiblebool

# IsVisible

C#
public bool IsVisible();

Возвращает bool

SetCustomViewportvoid

# SetCustomViewport

C#
public void SetCustomViewport(Entity viewport);

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

SetFollowViewportvoid

# SetFollowViewport

C#
public void SetFollowViewport(bool enable);

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

SetFollowViewportScalevoid

# SetFollowViewportScale

C#
public void SetFollowViewportScale(float scale);

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

SetLayervoid

# SetLayer

C#
public void SetLayer(int layer);

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

SetOffsetvoid

# SetOffset

C#
public void SetOffset(Vector2 offset);

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

SetRotationvoid

# SetRotation

C#
public void SetRotation(float radians);

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

SetScalevoid

# SetScale

C#
public void SetScale(Vector2 scale);

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

SetTransformvoid

# SetTransform

C#
public void SetTransform(Transform2D transform);

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

SetVisiblevoid

# SetVisible

C#
public void SetVisible(bool visible);

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

Showvoid

# Show

C#
public void Show();

Показывает любой CanvasItem под этим CanvasLayer. Это эквивалентно установке CanvasLayer.Visible на true.

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

VisibilityChangedСобытие

# VisibilityChanged

public event Action VisibilityChanged;

Выдается при изменении видимости слоя. См. CanvasLayer.Visible.