Canvas

class in UnityEngine

/

Hereda de:Behaviour

Cambiar al Manual

Descripción

Elemento que se puede utilizar para renderizar en la pantalla.

Los elementos en un canvas son renderizados DESPUÉS del renderizado de escena, ya sea desde una cámara adjunta o utilizando un modo de superposición.

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.
cachedSortingLayerValueValor almacenado en caché calculado básandose en SortingLayerID.
isRootCanvasEs este el Canvas raíz?
normalizedSortingGridSizeEl tamaño de la cuadrilla normalizada que el canvas dividirá el área renderizable.
overridePixelPerfectLe permite a los canvases anidados anular los ajustes de pixelPerfect heredados de los canvases de los padres.
overrideSortingAnular el ordenamiento del canvas.
pixelPerfectForza a los elementos en el canvas para que se alineen con píxeles. Sólo se aplica con renderMode en el Screen Space.
pixelRectObtiene el render rect para el Canvas.
planeDistanceQué tan lejos de la cámara está el Canvas generado.
referencePixelsPerUnitLa cantidad de pixeles por unidad que son consideradas por defecto.
renderModeEstá el Canvasen el modo World o Overlay?
renderOrderThe render order in which the canvas is being emitted to the scene. (Read Only)
rootCanvasRetorna el Canvas más cerca a la raíz, al revisar a través de cada padre y devolver el último canvas encontrado. Si ningún otro canvas es encontrado, entonces el canvas se retornará a si mismo.
scaleFactorSe utiliza para escalar el canvas entero, mientras que todavía lo hace caber en la pantalla. Sólo se aplica con renderMode en el Screen Space. (espacio de pantalla).
sortingLayerIDID único del sorting layer del Canvas'.
sortingLayerNameNombre del sorting layer del Canvas.
sortingOrderOrden del Canvas dentro de una sorting layer.
targetDisplayPara el modo Overlay, muestra el indice donde el canvas UI aparecerá.
worldCamera Camera utilizada para dimensionar el Canvas cuando está en Screen Space - Camera. También se utiliza como la Camera que los eventos envían a través de un World Space [[Canvas].

Funciones Estáticas

ForceUpdateCanvasesForzar actualizar el contenido a todos los canvas.
GetDefaultCanvasMaterialDevuelve el material predeterminado que se puede utilizar para representar elementos normales en el Canvas.
GetETC1SupportedCanvasMaterialGets or generates the ETC1 Material.

Events

willRenderCanvasesEvento que es llamado justo antes de que el rendering del Canvas suceda.

Miembros heredados

Variables

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had enabled called.
gameObjectEl game object que tiene este componente adjunto. Un componente siempre está adjunto a un game object.
tagEl tag de este game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameEl nombre del objeto.

Funciones Públicas

BroadcastMessageLlama al método denominado methodName de todos los MonoBehaviour en este game objecto en cualquiera de sus hijos.
CompareTag¿Este game object está etiquetado con tag?
GetComponentDevuelve un componente de tipo type si el game object tiene a alguno adjuntado, o null si no lo tiene.
GetComponentInChildrenRetorna el componente de tipo type en el GameObject o cualquiera de sus hijos utilizando depth first search (busqueda de profundidad).
GetComponentInParentRetorna el componente de tipo type en el GameObject o cualquiera de sus padres.
GetComponentsRetorna todos los componentes de tipo type en el GameObject.
GetComponentsInChildrenRetorna todos los componentes de tipo type en el GameObject o cualquiera de sus hijo.
GetComponentsInParentRetorna todos los componentes de tipo type en el GameObject o cualquiera de sus padres.
SendMessageLlama al método denominado methodName en cada MonoBehaviour de este game object.
SendMessageUpwardsLlama al método denominado methodName en todos los MonoBehaviour de este juego y en todos los ancestros del behaviour.
GetInstanceIDDevuelve el id de la instancia del objeto.
ToStringReturns the name of the GameObject.

Funciones Estáticas

DestroyElimina un gameobject, componente o 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.
FindObjectOfTypeDevuelve el primer objeto activo cargado de tipo type.
FindObjectsOfTypeDevuelve una lista de todos los objetos activos cargados de tipo type.
InstantiateClona el objeto original y devuelve el clon.

Operadores

bool¿Existe el objeto?
operator !=Compare si dos objetos se refieren a un objeto diferente.
operator ==Compara dos referencias de objeto para ver si se refieren al mismo objeto.