Pular para o conteúdo
AstraDOCS

Astra.Components.ChainIk

Astra 0.3.2-preview.20261016Referência de assinaturas

IK de cadeia: CCD ou FABRIK em N ossos, com iterações e tolerância. Família Lógica · IK.

Namespace: Astra.Components · Assembly: Astra.Scripting · Tipo: Struct

readonly struct Astra.Components.ChainIk

IK de cadeia: CCD ou FABRIK em N ossos, com iterações e tolerância. Família Lógica · IK.

Referência estudada: https://docs.unity3d.com/Packages/com.unity.animation.rigging@1.2/manual/constraints/ChainIKConstraint.html

Interfaces: Astra.Components.IComponentFacade<Astra.Components.ChainIk>.

Hierarquia → selecione o objeto → Inspector → Adicionar componente → Lógica / IK → IK de cadeia.

No Behavior em Play, obtenha a fachada com Object.GetComponent<ChainIk>(); trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar new ChainIk(component) envolve um componente existente; não adiciona um componente à cena.

Objetos, Behaviors e composição: 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 IK de cadeia para propriedades, valores iniciais, requisitos e edição em Play.

Membro Categoria
.ctor Method
Remove Method
Wrap Method
ChainLength Property
Component Property
Enabled Property
InstanceId Property
IsAlive Property
Iterations Property
MatchTargetRotation Property
Object Property
PlaneAngle Property
PlaneZeroX Property
PlaneZeroY Property
PlaneZeroZ Property
Pole Property
PoleRotation Property
Priority Property
Reference Property
Solver Property
Target Property
TargetOffsetX Property
TargetOffsetY Property
TargetOffsetZ Property
Tolerance Property
TypeId Property
Weight Property

.ctor

public ChainIk(Astra.Component component)

Caminho: Inspector → IK de cadeia; 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
component Astra.Component

Remove

public void Remove()

Remove a instância pelo ciclo nativo; dependências e ownership podem recusar.

Caminho: Inspector → IK de cadeia; ou fachada C# em um Behavior.

Uso: Solicita remoção pelo lifecycle nativo; dependências e regras de Play podem recusar.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Wrap

public static Astra.Components.ChainIk Wrap(Astra.Component component)

Caminho: Inspector → IK de cadeia; ou fachada C# em um Behavior.

Uso: Envolve um Component existente após conferir TypeId; não cria componente.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
component Astra.Component

ChainLength

public float ChainLength { get; set; }

Ossos na cadeia (ossos)

Faixa válida: 2 a 32.

Caminho: Inspector → IK de cadeia → Cadeia; ou fachada C# em um Behavior.

Uso: Ossos na cadeia: Quantos ossos acima deste participam.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Component

public Astra.Component Component { get; }

Caminho: Inspector → IK de cadeia; 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Enabled

public bool Enabled { get; set; }

Ativo

Caminho: Inspector → IK de cadeia → Influência; ou fachada C# em um Behavior.

Uso: Ativo: Desligado, o componente fica na cena sem agir.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

InstanceId

public ulong InstanceId { get; }

Caminho: Inspector → IK de cadeia; ou fachada C# em um Behavior.

Uso: Distingue a instância no mesmo objeto; importante para componentes múltiplos.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

IsAlive

public bool IsAlive { get; }

Caminho: Inspector → IK de cadeia; 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Iterations

public float Iterations { get; set; }

Iterações máximas

Faixa válida: 1 a 128.

Caminho: Inspector → IK de cadeia → Solver; ou fachada C# em um Behavior.

Uso: Iterações máximas: Mais iterações, mais precisão e mais custo por quadro.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

MatchTargetRotation

public bool MatchTargetRotation { get; set; }

Ponta segue rotação do alvo

Caminho: Inspector → IK de cadeia → Alvo; ou fachada C# em um Behavior.

Uso: Ponta segue rotação do alvo: A ponta copia a rotação do alvo, com o desvio em graus abaixo.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Object

public Astra.GameObject Object { get; }

Caminho: Inspector → IK de cadeia; ou fachada C# em um Behavior.

Uso: Objeto dono deste componente; use para resolver composição.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

PlaneAngle

public float PlaneAngle { get; set; }

Ângulo do plano (°). Gira o plano da dobra em torno do eixo raiz→ponta.

Faixa válida: -360 a 360.

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Ângulo do plano: Gira o plano da dobra em graus, sem um objeto de direção.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

PlaneZeroX

public float PlaneZeroX { get; set; }

Zero do plano X. Direção do zero do ângulo no espaço do osso raiz; zerado usa a perpendicular do osso do meio.

Faixa válida: -1 a 1.

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Zero do plano X: Componente da direção que define o zero do plano da dobra.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

PlaneZeroY

public float PlaneZeroY { get; set; }

Zero do plano Y. Direção do zero do ângulo no espaço do osso raiz; zerado usa a perpendicular do osso do meio.

Faixa válida: -1 a 1.

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Zero do plano Y: Componente da direção que define o zero do plano da dobra.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

PlaneZeroZ

public float PlaneZeroZ { get; set; }

Zero do plano Z. Direção do zero do ângulo no espaço do osso raiz; zerado usa a perpendicular do osso do meio.

Faixa válida: -1 a 1.

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Zero do plano Z: Componente da direção que define o zero do plano da dobra.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Pole

public Astra.ObjectReference Pole { get; set; }

Direção da dobra

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Direção da dobra: Objeto para onde a dobra aponta; vazio usa o plano configurado.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

PoleRotation

public float PoleRotation { get; set; }

Rotação do polo (°). Gira a cadeia resolvida em torno do eixo raiz→alvo.

Faixa válida: -360 a 360.

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Rotação do polo: Gira o polo em torno do eixo raiz-ponta.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Priority

public float Priority { get; set; }

Prioridade

Faixa válida: -100 a 100.

Caminho: Inspector → IK de cadeia → Influência; ou fachada C# em um Behavior.

Uso: Prioridade: Ordem entre solvers do mesmo osso: o maior roda por último e vence.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Reference

public Astra.Components.ChainIk.ReferenceOption Reference { get; set; }

Referência. De onde a cadeia parte antes de resolver.

Caminho: Inspector → IK de cadeia → Plano; ou fachada C# em um Behavior.

Uso: Referência: De onde vem o plano da dobra: do alvo ou do próprio objeto.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Solver

public Astra.Components.ChainIk.SolverOption Solver { get; set; }

Solver

Caminho: Inspector → IK de cadeia → Solver; ou fachada C# em um Behavior.

Uso: Solver: Trigonométrico resolve em um passo; Limb respeita limites do rig; CCD e FABRIK valem para cadeias.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Target

public Astra.ObjectReference Target { get; set; }

Alvo

Caminho: Inspector → IK de cadeia → Alvo; ou fachada C# em um Behavior.

Uso: Alvo: Objeto da cena que o solver alcança; as receitas criam um alvo nomeado ao lado do personagem.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TargetOffsetX

public float TargetOffsetX { get; set; }

Desvio da rotação do alvo X (°). Rotação somada à do alvo quando a ponta segue a rotação do alvo (eixos do alvo).

Faixa válida: -360 a 360.

Caminho: Inspector → IK de cadeia → Alvo; ou fachada C# em um Behavior.

Uso: Desvio da rotação do alvo X: Desvio em graus somado à rotação do alvo quando a ponta a segue.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TargetOffsetY

public float TargetOffsetY { get; set; }

Desvio da rotação do alvo Y (°). Rotação somada à do alvo quando a ponta segue a rotação do alvo (eixos do alvo).

Faixa válida: -360 a 360.

Caminho: Inspector → IK de cadeia → Alvo; ou fachada C# em um Behavior.

Uso: Desvio da rotação do alvo Y: Desvio em graus somado à rotação do alvo quando a ponta a segue.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TargetOffsetZ

public float TargetOffsetZ { get; set; }

Desvio da rotação do alvo Z (°). Rotação somada à do alvo quando a ponta segue a rotação do alvo (eixos do alvo).

Faixa válida: -360 a 360.

Caminho: Inspector → IK de cadeia → Alvo; ou fachada C# em um Behavior.

Uso: Desvio da rotação do alvo Z: Desvio em graus somado à rotação do alvo quando a ponta a segue.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Tolerance

public float Tolerance { get; set; }

Tolerância (m)

Faixa válida: 0.00001 a 1.

Caminho: Inspector → IK de cadeia → Solver; ou fachada C# em um Behavior.

Uso: Tolerância: Distância da ponta ao alvo considerada resolvida, em metros.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TypeId

public static string TypeId { get; }

Caminho: Inspector → IK de cadeia; ou fachada C# em um Behavior.

Uso: Identificador nativo usado em AddComponent/GetComponent.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Weight

public float Weight { get; set; }

Peso

Faixa válida: 0 a 1.

Caminho: Inspector → IK de cadeia → Influência; ou fachada C# em um Behavior.

Uso: Peso: 0 desliga, 1 aplica por inteiro; anime para ligar e desligar o efeito com suavidade.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.