Version: 2019.1

Canvas

class in UnityEngine

/

Inherits from:Behaviour

Switch to Manual

Description

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

Elements on a canvas are rendered AFTER Scene rendering, either from an attached camera or using overlay mode.

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); } }

Variables

additionalShaderChannelsGet or set the mask of additional shader channels to be used when creating the Canvas mesh.
cachedSortingLayerValueCached calculated value based upon SortingLayerID.
isRootCanvasЭто корень Canvas?
normalizedSortingGridSizeThe normalized grid size that the canvas will split the renderable area into.
overridePixelPerfectИспользуется с вложенными полотнами, позволяющими иметь разные настройки pixelPerfect в иерархии.
overrideSortingПереопределяет сортировку на полотне (canvas).
pixelPerfectЗаставляет элементы на полотне прийти в соответствие с пикселями. Применяется только с RenderMode в экранном пространстве.
pixelRectGet the render rect for the Canvas.
planeDistanceКак далеко от камеры полотно (Canvas) было сгенерировано.
referencePixelsPerUnitКоличество пикселей на единицу, которая считается по умолчанию.
renderModeЭтот Canvas в мировом режиме или режиме наложения?
renderOrderThe render order in which the canvas is being emitted to the Scene. (Read Only)
rootCanvasReturns the Canvas closest to root, by checking through each parent and returning the last canvas found. If no other canvas is found then the canvas will return itself.
scaleFactorИспользуется для масштабирования всего полотна, пока он располагается по размеру экрана. Применяется только с RenderMode в экранном пространстве.
sortingLayerIDИдентификатор слоя сортировки полотна (Canvas).
sortingLayerNameНазвание слоя сортировки полотна (Canvas).
sortingOrderПорядок полотна (Canvas) без слоя сортировки.
targetDisplayFor Overlay mode, display index on which the UI canvas will appear.
worldCamera Camera used for sizing the Canvas when in Screen Space - Camera. Also used as the Camera that events will be sent through for a World Space [[Canvas].

Static Functions

ForceUpdateCanvasesЗаставляет все полотна (canvases) обновить их содержание.
GetDefaultCanvasMaterialВозвращает материал по умолчанию, который может быть использован для рендеринга обычных элементов на полотне (Canvas).
GetETC1SupportedCanvasMaterialGets or generates the ETC1 Material.

Events

willRenderCanvasesСобытие, которое вызывается непосредственно перед тем как произойдет рендеринг Canvas.

Inherited members

Variables

enabledВключенное Поведение обновляется, выключенное Поведение не обновляется.
isActiveAndEnabledHas the Behaviour had active and enabled called?
gameObjectИгровой объект к которому прикреплён данный компонент. Компонент всегда прикреплён к игровому объекту.
tagТег данного игрового объекта.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Functions

BroadcastMessageВызывает метод названный methodName на каждом MonoBehaviour этого game object-а или любого из его потомков.
CompareTagПомечен ли данный игровой объект тегом tag?
GetComponentВозвращает компонент типа type, если он прикреплен к игровому объекту и null, если не прикреплен.
GetComponentInChildrenВозвращает компонент типа type в GameObject или некоторого его потомка через поиск в глубину.
GetComponentInParentВозвращает все компоненты типа type из GameObject'а или из любого его родителя.
GetComponentsВозвращает все компоненты типа type в GameObject.
GetComponentsInChildrenВозвращает все компоненты типа type в GameObject или любому из его потомков.
GetComponentsInParentВозвращает все компоненты типа type в GameObject или любому из его родителей.
SendMessageВызывает метод с названием methodName в каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName в каждом MonoBehaviour в этом игровом объекте и в каждом предке поведения.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Functions

DestroyУдаляет GameObject, Component или Asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.