Astra.Components.UiCanvas
Canvas UI: Instância independente de documento de UI, na tela ou no objeto. Família Renderização · Interface.
Namespace: Astra.Components · Assembly: Astra.Scripting · Tipo: Struct
Declaração
Seção intitulada “Declaração”readonly struct Astra.Components.UiCanvasCanvas UI: Instância independente de documento de UI, na tela ou no objeto. Família Renderização · Interface.
Referência estudada: https://docs.unity3d.com/Packages/com.unity.ugui@2.0/manual/class-Canvas.html
Interfaces: Astra.Components.IComponentFacade<Astra.Components.UiCanvas>.
Onde acessar este tipo
Seção intitulada “Onde acessar este tipo”Hierarquia → selecione o objeto → Inspector → Adicionar componente → Renderização / Interface → Canvas UI.
No Behavior em Play, obtenha a fachada com Object.GetComponent<UiCanvas>(); trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar new UiCanvas(component) envolve um componente existente; não adiciona um componente à cena.
Roadmap e uso
Seção intitulada “Roadmap e uso”Canvas e UI de jogo: o membro presente nesta referência pertence ao contrato atual. O roadmap registra a família; não há promessa/data individual de evolução para cada membro. Membros ainda sem explicação especializada são indicados como revisão editorial pendente.
Para ler os campos e recursos pelo caminho do editor, use mapa de acesso.
Consulte também Canvas UI para propriedades, valores iniciais, requisitos e edição em Play.
Membros
Seção intitulada “Membros”| Membro | Categoria |
|---|---|
| .ctor | Method |
| GetDocument | Method |
| Remove | Method |
| SetDocument | Method |
| Wrap | Method |
| Component | Property |
| Enabled | Property |
| InputCamera | Property |
| InputReceiver | Property |
| InstanceId | Property |
| IsAlive | Property |
| Mode | Property |
| MovementSpace | Property |
| Object | Property |
| Occlusion | Property |
| Offset | Property |
| Order | Property |
| Resolution | Property |
| Rotation | Property |
| TypeId | Property |
| UnitsPerPixel | Property |
.ctor
public UiCanvas(Astra.Component component)Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Constrói o tipo pela assinatura declarada. Um construtor de fachada envolve um componente existente; um record de configuração só tem efeito quando atribuído ao consumidor.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
component |
Astra.Component |
GetDocument
public Astra.AssetGuid GetDocument(uint slot = 0)Documento UI. Recurso do projeto por slot
Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Documento UI. Recurso do projeto por slot
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
slot |
uint |
· Opcional: 0 |
Remove
public void Remove()Remove a instância pelo ciclo nativo; dependências e ownership podem recusar.
Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Solicita remoção pelo lifecycle nativo; dependências e regras de Play podem recusar.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
SetDocument
public void SetDocument(Astra.AssetGuid value, uint slot = 0)Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
value |
Astra.AssetGuid |
|
slot |
uint |
· Opcional: 0 |
Wrap
public static Astra.Components.UiCanvas Wrap(Astra.Component component)Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Envolve um Component existente após conferir TypeId; não cria componente.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
component |
Astra.Component |
Component
public Astra.Component Component { get; }Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Handle genérico da instância, usado para operações de reflexão e recursos.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Enabled
public bool Enabled { get; set; }Habilitado
Caminho: Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.
Uso: Habilitado: Ativa/desativa a participação do componente no sistema consumidor; não remove seus dados.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
InputCamera
public Astra.ObjectReference InputCamera { get; set; }Camera de entrada
Caminho: Inspector → Canvas UI → Entrada; ou fachada C# em um Behavior.
Uso: Camera de entrada: Câmera usada para o espaço de movimento/olhar dos controles do Canvas.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
InputReceiver
public Astra.ObjectReference InputReceiver { get; set; }Jogador / receptor. Character ou motor de corpo dinâmico ativo.
Caminho: Inspector → Canvas UI → Entrada; ou fachada C# em um Behavior.
Uso: Jogador / receptor: Character ou motor de corpo dinâmico ativo.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
InstanceId
public ulong InstanceId { get; }Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Distingue a instância no mesmo objeto; importante para componentes múltiplos.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
IsAlive
public bool IsAlive { get; }Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Validade do handle no mundo/geração atuais. Remoção e novo Play invalidam a referência.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Mode
public Astra.Components.UiCanvas.ModeOption Mode { get; set; }Apresentação
Caminho: Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.
Uso: Apresentação: Seleciona o modo do componente no domínio indicado; revise os campos que aparecem após trocar.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
MovementSpace
public Astra.Components.UiCanvas.MovementSpaceOption MovementSpace { get; set; }Espaço do movimento
Caminho: Inspector → Canvas UI → Entrada; ou fachada C# em um Behavior.
Uso: Espaço do movimento: Escolhe espaço do vetor de movimento: mundo, jogador ou câmera de entrada.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Object
public Astra.GameObject Object { get; }Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Objeto dono deste componente; use para resolver composição.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Occlusion
public bool Occlusion { get; set; }Oclusão no mundo. Depth e hit de Canvas no mundo.
Caminho: Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.
Uso: Oclusão no mundo: Depth e hit de Canvas no mundo.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Offset
public System.Numerics.Vector3 Offset { get; set; }Deslocamento local
Caminho: Inspector → Canvas UI → Apresentação; ou fachada C# em um Behavior.
Uso: Posição X: Aplica-se ao Canvas no mundo; Tela usa o viewport. Posição Y: Aplica-se ao Canvas no mundo; Tela usa o viewport. Posição Z: Aplica-se ao Canvas no mundo; Tela usa o viewport.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Order
public float Order { get; set; }Ordem
Faixa válida: -10000 a 10000.
Caminho: Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.
Uso: Ordem: Ordena apresentação dos Canvas; compare sobreposição e entrada com o modo efetivo.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Resolution
public System.Numerics.Vector2 Resolution { get; set; }Resolução
Caminho: Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.
Uso: Largura: Abertura estéreo da cauda. Não muda a posição 3D da fonte. Altura: Aplica-se ao Canvas no mundo; Tela usa o viewport.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Rotation
public System.Numerics.Vector3 Rotation { get; set; }Rotação local
Caminho: Inspector → Canvas UI → Apresentação; ou fachada C# em um Behavior.
Uso: Rotação X: Aplica-se ao Canvas no mundo; Tela usa o viewport. Rotação Y: Aplica-se ao Canvas no mundo; Tela usa o viewport. Rotação Z: Aplica-se ao Canvas no mundo; Tela usa o viewport.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
TypeId
public static string TypeId { get; }Caminho: Inspector → Canvas UI; ou fachada C# em um Behavior.
Uso: Identificador nativo usado em AddComponent/GetComponent.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
UnitsPerPixel
public float UnitsPerPixel { get; set; }Unidades por pixel (m/px). Aplica-se ao Canvas no mundo; Tela usa o viewport.
Faixa válida: 0.00001 a 10.
Caminho: Inspector → Canvas UI → Canvas; ou fachada C# em um Behavior.
Uso: Unidades por pixel: Aplica-se ao Canvas no mundo; Tela usa o viewport.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.