Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

BoneTwistDisperser3D

Eredita: SkeletonModifier3D < Node3D < Node < Object

Un nodo che propaga e disperde la torsione dell'osso figlio alle ossa genitori.

Descrizione

Questo BoneTwistDisperser3D consente un'interpolazione fluida della torsione tra più ossa, distribuendo la torsione dell'osso finale agli ossi genitori. Così viene modificata solo la torsione, senza alterare la posizione globale di ciascuna articolazione.

È utile per torcere le ossa fluidamente in combinazione con CopyTransformModifier3D e IK.

Nota: Se la torsione estratta è superiore a 180 gradi, avviene un ribaltamento. Questo comportamento è simile a quello di ConvertTransformModifier3D.

Nota: La maggior parte dei metodi di questa classe accetta un parametro index. Questo parametro specifica quale voce nell'elenco delle impostazioni restituire, se l'IK ha più voci (ad esempio, settings/<index>/root_bone_name).

Proprietà

bool

mutable_bone_axes

true

int

setting_count

0

Metodi

void

clear_settings()

Curve

get_damping_curve(index: int) const

DisperseMode

get_disperse_mode(index: int) const

int

get_end_bone(index: int) const

BoneDirection

get_end_bone_direction(index: int) const

String

get_end_bone_name(index: int) const

int

get_joint_bone(index: int, joint: int) const

String

get_joint_bone_name(index: int, joint: int) const

int

get_joint_count(index: int) const

float

get_joint_twist_amount(index: int, joint: int) const

int

get_reference_bone(index: int) const

String

get_reference_bone_name(index: int) const

int

get_root_bone(index: int) const

String

get_root_bone_name(index: int) const

Quaternion

get_twist_from(index: int) const

float

get_weight_position(index: int) const

bool

is_end_bone_extended(index: int) const

bool

is_twist_from_rest(index: int) const

void

set_damping_curve(index: int, curve: Curve)

void

set_disperse_mode(index: int, disperse_mode: DisperseMode)

void

set_end_bone(index: int, bone: int)

void

set_end_bone_direction(index: int, bone_direction: BoneDirection)

void

set_end_bone_name(index: int, bone_name: String)

void

set_extend_end_bone(index: int, enabled: bool)

void

set_joint_twist_amount(index: int, joint: int, twist_amount: float)

void

set_root_bone(index: int, bone: int)

void

set_root_bone_name(index: int, bone_name: String)

void

set_twist_from(index: int, from: Quaternion)

void

set_twist_from_rest(index: int, enabled: bool)

void

set_weight_position(index: int, weight_position: float)


Enumerazioni

enum DisperseMode: 🔗

DisperseMode DISPERSE_MODE_EVEN = 0

Assegna quantità in modo che aumentino monotonicamente da 0.0 a 1.0, assicurando che tutti i pesi siano uguali. Ad esempio, con cinque articolazioni, i valori sarebbero 0.2, 0.4, 0.6, 0.8 e 1.0 a partire dall'osso radice.

DisperseMode DISPERSE_MODE_WEIGHTED = 1

Assegna quantità in modo che aumentino monotonicamente da 0.0 a 1.0, in base alla lunghezza delle ossa tra i segmenti delle articolazioni. Vedi anche set_weight_position().

DisperseMode DISPERSE_MODE_CUSTOM = 2

Diventa possibile assegnare valori arbitrari all'elenco delle articolazioni. Vedi anche set_joint_twist_amount().

Quando is_end_bone_extended() è false, un figlio dell'osso di riferimento esiste unicamente per determinare l'asse di torsione, quindi la sua quantità personalizzata non ha alcun effetto.


Descrizioni delle proprietà

bool mutable_bone_axes = true 🔗

  • void set_mutable_bone_axes(value: bool)

  • bool are_bone_axes_mutable()

Se true, il risolutore recupera l'asse dell'osso dalla posa dell'osso a ogni frame.

Se false, il risolutore recupera l'asse dell'osso dal riposo dell'osso e lo memorizza nella cache.


int setting_count = 0 🔗

  • void set_setting_count(value: int)

  • int get_setting_count()

Il numero di impostazioni.


Descrizioni dei metodi

void clear_settings() 🔗

Cancella tutte le impostazioni.


Curve get_damping_curve(index: int) const 🔗

Restituisce la curva di smorzamento quando get_disperse_mode() è DISPERSE_MODE_CUSTOM.


DisperseMode get_disperse_mode(index: int) const 🔗

Restituisce se utilizzare l'assegnazione automatica della quantità o consentire l'assegnazione manuale.


int get_end_bone(index: int) const 🔗

Restituisce l'indice dell'osso finale della catena d'ossa.


BoneDirection get_end_bone_direction(index: int) const 🔗

Restituisce la direzione della coda dell'osso finale della catena d'ossa quando is_end_bone_extended() è true.


String get_end_bone_name(index: int) const 🔗

Restituisce il nome dell'osso finale della coda d'ossa.


int get_joint_bone(index: int, joint: int) const 🔗

Restituisce l'indice dell'osso in joint nella lista delle articolazioni della catena d'ossa.


String get_joint_bone_name(index: int, joint: int) const 🔗

Restituisce il nome dell'osso in joint nella lista delle articolazioni della catena d'ossa.


int get_joint_count(index: int) const 🔗

Restituisce il numero di articolazioni nella lista delle articolazioni della catena d'ossa.


float get_joint_twist_amount(index: int, joint: int) const 🔗

Restituisce la quantità di torsione in joint nella lista delle articolazioni della catena d'ossa quando get_disperse_mode() è DISPERSE_MODE_CUSTOM.


int get_reference_bone(index: int) const 🔗

Restituisce l'osso di riferimento da cui estrarre la torsione dell'impostazione all'indice index.

Questo osso è la fine della catena o il suo genitore, a seconda di is_end_bone_extended().


String get_reference_bone_name(index: int) const 🔗

Restituisce il nome dell'osso di riferimento da cui estrarre la torsione dell'impostazione all'indice index.

Questo osso è la fine della catena o il suo genitore, a seconda di is_end_bone_extended().


int get_root_bone(index: int) const 🔗

Restituisce l'indice dell'osso radice della catena d'ossa.


String get_root_bone_name(index: int) const 🔗

Restituisce il nome dell'osso radice della catena d'ossa.


Quaternion get_twist_from(index: int) const 🔗

Restituisce la rotazione a uno stato arbitrario prima della torsione per la posa attuale dell'osso al fine di estrarre la torsione quando is_twist_from_rest() è true.


float get_weight_position(index: int) const 🔗

Restituisce la posizione in cui dividere il segmento tra le articolazioni per l'assegnazione dei pesi quando get_disperse_mode() è DISPERSE_MODE_WEIGHTED.


bool is_end_bone_extended(index: int) const 🔗

Restituisce true se l'osso finale è prolungato per avere una coda.


bool is_twist_from_rest(index: int) const 🔗

Restituisce true se si sta estraendo la quantità di torsione dalla differenza tra la posa di riposo dell'osso e la posa attuale dell'osso.


void set_damping_curve(index: int, curve: Curve) 🔗

Imposta la curva di smorzamento quando get_disperse_mode() è DISPERSE_MODE_CUSTOM.


void set_disperse_mode(index: int, disperse_mode: DisperseMode) 🔗

Imposta se utilizzare l'assegnazione automatica della quantità o l'assegnazione manuale.


void set_end_bone(index: int, bone: int) 🔗

Imposta l'indice dell'osso finale della catena d'ossa.


void set_end_bone_direction(index: int, bone_direction: BoneDirection) 🔗

Imposta la direzione della coda dell'osso finale della catena d'ossa quando is_end_bone_extended() è true.


void set_end_bone_name(index: int, bone_name: String) 🔗

Imposta il nome dell'osso finale della coda d'ossa.

Nota: L'osso finale deve essere un figlio dell'osso radice.


void set_extend_end_bone(index: int, enabled: bool) 🔗

Se enabled è true, l'osso finale è allungato per avere una coda.

Se enabled è false, get_reference_bone() diventa un genitore dell'osso finale e utilizza il vettore dell'osso finale come asse di torsione.


void set_joint_twist_amount(index: int, joint: int, twist_amount: float) 🔗

Imposta la quantità di torsione in joint nella lista delle articolazioni della catena d'ossa quando get_disperse_mode() è DISPERSE_MODE_CUSTOM.


void set_root_bone(index: int, bone: int) 🔗

Imposta l'indice dell'osso radice della catena d'ossa.


void set_root_bone_name(index: int, bone_name: String) 🔗

Imposta il nome dell'osso radice della catena d'ossa.


void set_twist_from(index: int, from: Quaternion) 🔗

Imposta la rotazione a uno stato arbitrario prima della torsione per la posa attuale dell'osso, al fine di estrarre la torsione quando is_twist_from_rest() è false.

In altre parole, chiamando set_twist_from() tramite SkeletonModifier3D.modification_processed di uno specifico SkeletonModifier3D, è possibile estrarre solo le torsioni generate dai modificatori elaborati dopo tale modificatore ma prima di questo BoneTwistDisperser3D.


void set_twist_from_rest(index: int, enabled: bool) 🔗

Se enabled è true, estrae la quantità di torsione dalla differenza tra la posa di riposo dell'osso e la posa attuale dell'osso.

Se enabled è false, estrae la quantità di torsione dalla differenza tra get_twist_from() e la posa attuale dell'osso. Vedi anche set_twist_from().


void set_weight_position(index: int, weight_position: float) 🔗

Imposta la posizione in cui dividere il segmento tra le articolazioni per l'assegnazione dei pesi quando get_disperse_mode() è DISPERSE_MODE_WEIGHTED.

Ad esempio, quando weight_position è 0.5, se esistono due segmenti d'ossa di lunghezza pari a 1.0 tra tre articolazioni, i pesi sono assegnati a ciascuna articolazione dalla radice alla fine con rapporti di 0.5, 1.0 e 0.5. Pertanto i valori diventano rispettivamente 0.25, 0.75 e 1.0.