Unity 6.3
0 онлайн 66 гостей 3 в системе
Вход

Canvas

класс в UnityEngine

Наследуется от:Behaviour

Выполнено в:UnityEngine.UIModule

Описание

Элемент, который может быть использован для экранного отображения.

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

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using UnityEngine.UI;

// Create a Canvas that holds a Text GameObject.

public class ExampleClass : MonoBehaviour { void Start() { GameObject myGO; GameObject myText; Canvas myCanvas; Text text; RectTransform rectTransform;

// Canvas myGO = new GameObject(); myGO.name = "TestCanvas"; myGO.AddComponent<Canvas>();

myCanvas = myGO.GetComponent<Canvas>(); myCanvas.renderMode = RenderMode.ScreenSpaceOverlay; myGO.AddComponent<CanvasScaler>(); myGO.AddComponent<GraphicRaycaster>();

// Text myText = new GameObject(); myText.transform.parent = myGO.transform; myText.name = "wibble";

text = myText.AddComponent<Text>(); text.font = (Font)Resources.Load("MyFont"); text.text = "wobble"; text.fontSize = 100;

// Text position rectTransform = text.GetComponent<RectTransform>(); rectTransform.localPosition = new Vector3(0, 0, 0); rectTransform.sizeDelta = new Vector2(400, 200); } }

Свойства

Свойство Описание
additionalShaderChannelsПолучить или установить маску дополнительных каналов шейдера для использования при создании сетки Canvas.
cachedSortingLayerValueКэшированное значение, рассчитанное на основе SortingLayerID.
isRootCanvasЭто корень Canvas?
normalizedSortingGridSizeНормализованный размер сетки, на которую будет разделена рендируемая область.
overridePixelPerfectПозволяет вложенным холстам переопределять настройку pixelPerfect, унаследованную от родительских холстов.
overrideSortingПозволяет вложенным холстам переопределять Canvas.sortingOrder, унаследованный от родительских холстов.
pixelPerfectПринуждает элементы на холсте к выравниванию пикселей. Применяется только тогда, когда Canvas.renderMode установлено на Screen Space.
pixelRectПолучить рендеринг rect для Canvas.
planeDistanceНа каком расстоянии от камеры генерируется Canvas? Он применяется только тогда, когда Canvas.renderMode установлен на RenderMode.ScreenSpaceCamera.
referencePixelsPerUnitКоличество пикселей на единицу, которое считается по умолчанию.
renderingDisplaySizeПредоставляет пиксельные размеры области отображения, в которой отображается полотно UI.
renderModeРаботает ли Canvas в режиме Мира или Оверлей?
renderOrderПорядок отображения, в котором изображение выводится на Scene. (только для чтения)
rootCanvasВозвращает Canvas, ближайший к корню, проверяя каждый родитель и возвращая последний найденный canvas. Если не найдено другого canvas, то canvas возвращается самостоятельно.
scaleFactorМасштабирует всю картинку, обеспечивая ее соответствие размерам экрана. Применяется только тогда, когда Canvas.renderMode установлено на Screen Space.
sortingLayerIDУникальный ID слоя сортировки Canvas'.
sortingLayerNameИмя слоя сортировки Canvas'.
sortingOrderCanvas' порядок в слое сортировки.
targetDisplayДля режима Overlay, индекс отображения, на котором будет отображаться UI.
updateRectTransformForStandaloneДолжен ли размер Canvas обновляться на основе цели отображения при выполнении ручного вызова Camera.Render.
vertexColorAlwaysGammaSpaceДолжен ли цвет вершины Canvas всегда находиться в гамма-пространстве перед переходом к шейдерам UI в линейном рабочем потоке цветового пространства.
worldCameraCamera используется для определения размера Canvas, когда он находится в Экранном Пространстве — Camera. Также используется как Camera, через который будут отправляться события для Мирового Пространства Canvas.

Статические методы

Метод Описание
ForceUpdateCanvasesПринудительное обновление содержимого всех полотен.
GetDefaultCanvasMaterialВозвращает материал по умолчанию, который может быть использован для отображения обычных элементов на Canvas.
GetETC1SupportedCanvasMaterialПолучает или генерирует ETC1 Материал.

Мероприятия

Мероприятие Описание
preWillRenderCanvasesСобытие, вызванное непосредственно перед отображением Canvas.
willRenderCanvasesСобытие, вызванное до рендеринга Canvas.
Унаследованные члены 4

Свойства

СвойствоОписание
enabledTrue, если это Поведение включено, в противном случае false.
isActiveAndEnabledПроверяет, включён ли компонент, прикреплен ли он к GameObject, который активен в иерархии, и вызван ли OnEnable компонента.
gameObjectGameObject, к которому прикреплен данный компонент. Компонент всегда прикрепляется к игровому объекту.
tagТег этого игрового объекта.
transformTransform прикреплен к этому GameObject.
transformHandleTransformHandle этого GameObject.
hideFlagsДолжен ли объект быть скрытым, сохраняться с Scene или изменяться пользователем?
nameИмя объекта.

Открытые методы

МетодОписание
BroadcastMessageВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте или любом из его дочерей.
CompareTagПроверяет тег GameObject на соответствие определенному тегу.
GetComponentПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент.
GetComponentInChildrenПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любого ребенка GameObject.
GetComponentIndexПолучает индекс компонента на его родительском GameObject.
GetComponentInParentПолучает ссылку на компонент типа T на том же GameObject, что и указанный компонент, или на любой родитель GameObject.
GetComponentsПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент.
GetComponentsInChildrenПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и на любого ребенка GameObject.
GetComponentsInParentПолучает ссылки на все компоненты типа T на том же GameObject, что и указанный компонент, и любой родитель GameObject.
SendMessageВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName на каждом MonoBehaviour в этом игровом объекте и на каждом предшественнике поведения.
TryGetComponentПолучает компонент указанного типа, если он существует.
GetInstanceIDПолучает экземпляр ID объекта.
ToStringВозвращает имя объекта.

Статические методы

МетодОписание
DestroyУдаляет GameObject, компонент или ресурс.
DestroyImmediateНемедленно уничтожает указанный объект. Используйте с осторожностью и только в режиме редактирования.
DontDestroyOnLoadНе уничтожать целевой Объект при загрузке нового Scene.
FindAnyObjectByTypeПолучает любой активный загруженный объект типа Type.
FindFirstObjectByTypeПолучает первый активный загруженный объект типа Type.
FindObjectsByTypeПолучает список всех загруженных объектов типа Type.
InstantiateКлонирует исходный объект и возвращает клон.
InstantiateAsyncЗахватывает моментальный снимок первоначального объекта (который должен быть связан с каким-либо GameObject) и возвращает AsyncInstantiateOperation.

Операторы

ОператорОписание
boolСуществует ли объект?
оператор!=Сравнивает, если два объекта ссылаются на разные объекты.
оператор ==Сравнение двух ссылок на объекты для определения того, относятся ли они к одному и тому же объекту.