TwoBoneIK3D — C# API

Решатель обратной кинематики на основе вращения при пересечении двух окружностей.

class TwoBoneIK3DReckfellSharpНаследует IKModifier3D

Решатель обратной кинематики на основе вращения при пересечении двух окружностей.

Этот IKModifier3D требует наличия целевого полюса. Он обеспечивает детерминированные результаты, строя плоскость из каждого сустава и целевого полюса и находя пересечение двух окружностей (дисков в 3D). Этот IK может обрабатывать скручивание, задавая направление полюса. Если между каждой заданной костью находится более одной кости, их вращения игнорируются, а прямая линия, соединяющая корневой, средний и средний конечный суставы, рассматривается как виртуальная кость. Примечание: Все методы в этом классе принимают параметр index. Этот параметр указывает, какую запись списка настроек возвращать, если IK имеет несколько записей (например, settings/<index>/root_bone_name).

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

TwoBoneIK3DКонструктор

# TwoBoneIK3D

C#
public TwoBoneIK3D();

Свойства1

SettingCountСвойство

# SettingCount

C#
public int SettingCount { get; set; }

Количество настроек.

Методы28

GetEndBoneint

# GetEndBone

C#
public int GetEndBone(int index);

Возвращает индекс конечной кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает int

GetEndBoneDirectionSkeletonModifier3D.BoneDirection

# GetEndBoneDirection

C#
public SkeletonModifier3D.BoneDirection GetEndBoneDirection(int index);

Возвращает направление хвоста конечной кости, когда TwoBoneIK3D.IsEndBoneExtended имеет значение true.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает SkeletonModifier3D.BoneDirection

GetEndBoneLengthfloat

# GetEndBoneLength

C#
public float GetEndBoneLength(int index);

Возвращает длину хвостовой части конечной кости цепочки костей, когда TwoBoneIK3D.IsEndBoneExtended имеет значение true.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает float

GetEndBoneNamestring

# GetEndBoneName

C#
public string GetEndBoneName(int index);

Возвращает название конечной кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает string

GetMiddleBoneint

# GetMiddleBone

C#
public int GetMiddleBone(int index);

Возвращает индекс средней кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает int

GetMiddleBoneNamestring

# GetMiddleBoneName

C#
public string GetMiddleBoneName(int index);

Возвращает название средней кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает string

GetPoleDirectionSkeletonModifier3D.SecondaryDirection

# GetPoleDirection

C#
public SkeletonModifier3D.SecondaryDirection GetPoleDirection(int index);

Возвращает направление полюса.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает SkeletonModifier3D.SecondaryDirection

GetPoleDirectionVectorVector3

# GetPoleDirectionVector

C#
public Vector3 GetPoleDirectionVector(int index);

Возвращает вектор направления полюса. Если TwoBoneIK3D.GetPoleDirection равен SkeletonModifier3D.SecondaryDirection.None, этот метод возвращает Vector3(0, 0, 0).

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает Vector3

GetPoleEntityEntityPath

# GetPoleEntity

C#
public EntityPath GetPoleEntity(int index);

Возвращает целевой узел столба, который строит плоскость, на которой находятся все шарниры и которую столб пытается направить.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает EntityPath

GetRootBoneint

# GetRootBone

C#
public int GetRootBone(int index);

Возвращает индекс корневой кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает int

GetRootBoneNamestring

# GetRootBoneName

C#
public string GetRootBoneName(int index);

Возвращает имя корневой кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает string

GetTargetEntityEntityPath

# GetTargetEntity

C#
public EntityPath GetTargetEntity(int index);

Возвращает целевой узел, до которого пытается добраться конечная кость.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает EntityPath

IsEndBoneExtendedbool

# IsEndBoneExtended

C#
public bool IsEndBoneExtended(int index);

Возвращает true, если конечная кость удлинена и имеет хвост.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает bool

IsUsingVirtualEndbool

# IsUsingVirtualEnd

C#
public bool IsUsingVirtualEnd(int index);

Возвращает true, если конечная кость является продолжением средней кости в качестве виртуальной кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—

Возвращает bool

SetEndBonevoid

# SetEndBone

C#
public void SetEndBone(int index, int bone);

Устанавливает индекс конечной кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`bone`	`int`	—

SetEndBoneDirectionvoid

# SetEndBoneDirection

C#
public void SetEndBoneDirection(int index, SkeletonModifier3D.BoneDirection boneDirection);

Задает направление хвостовой части конечной кости, когда TwoBoneIK3D.IsEndBoneExtended имеет значение true.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`boneDirection`	`SkeletonModifier3D.BoneDirection`	—

SetEndBoneLengthvoid

# SetEndBoneLength

C#
public void SetEndBoneLength(int index, float length);

Устанавливает длину хвостовой части конечной кости, когда TwoBoneIK3D.IsEndBoneExtended имеет значение true.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`length`	`float`	—

SetEndBoneNamevoid

# SetEndBoneName

C#
public void SetEndBoneName(int index, string boneName);

Задает имя конечной кости. Примечание: Конечная кость должна быть дочерней по отношению к средней кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`boneName`	`string`	—

SetExtendEndBonevoid

# SetExtendEndBone

C#
public void SetExtendEndBone(int index, bool enabled);

Если enabled равно true, конечная кость удлиняется, образуя хвост.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`enabled`	`bool`	—

SetMiddleBonevoid

# SetMiddleBone

C#
public void SetMiddleBone(int index, int bone);

Устанавливает средний индекс кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`bone`	`int`	—

SetMiddleBoneNamevoid

# SetMiddleBoneName

C#
public void SetMiddleBoneName(int index, string boneName);

Задает имя средней кости. Примечание: Средняя кость должна быть дочерней по отношению к корневой кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`boneName`	`string`	—

SetPoleDirectionvoid

# SetPoleDirection

C#
public void SetPoleDirection(int index, SkeletonModifier3D.SecondaryDirection direction);

Задает направление полюса. Полюс расположен на средней кости и будет направлен к целевой точке. Ось вращения — это вектор, ортогональный этому вектору и вектору прямого вращения. Примечание: Направление полюса и вектор прямого вращения не должны быть коллинеарными, чтобы избежать непреднамеренного вращения.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`direction`	`SkeletonModifier3D.SecondaryDirection`	—

SetPoleDirectionVectorvoid

# SetPoleDirectionVector

C#
public void SetPoleDirectionVector(int index, Vector3 vector);

Задает вектор направления полюса. Этот вектор нормализуется внутренним процессом. Если длина вектора равна 0, он считается синонимом SkeletonModifier3D.SecondaryDirection.None.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`vector`	`Vector3`	—

SetPoleEntityvoid

# SetPoleEntity

C#
public void SetPoleEntity(int index, EntityPath poleNode);

Задает целевой узел столба, который строит плоскость, на которой находятся все соединения и которую столб пытается направить.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`poleNode`	`EntityPath`	—

SetRootBonevoid

# SetRootBone

C#
public void SetRootBone(int index, int bone);

Устанавливает индекс корневой кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`bone`	`int`	—

SetRootBoneNamevoid

# SetRootBoneName

C#
public void SetRootBoneName(int index, string boneName);

Задает имя корневой кости.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`boneName`	`string`	—

SetTargetEntityvoid

# SetTargetEntity

C#
public void SetTargetEntity(int index, EntityPath targetEntity);

Задает целевой узел, до которого пытается добраться конечная кость.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`targetEntity`	`EntityPath`	—

SetUseVirtualEndvoid

# SetUseVirtualEnd

C#
public void SetUseVirtualEnd(int index, bool enabled);

Если enabled равно true, конечная кость отходит от средней кости как виртуальная кость.

Параметры
Имя	Тип	По умолчанию
`index`	`int`	—
`enabled`	`bool`	—