BoneSpaceAdjuster3D
Inputs a scale and converts it to the position of a child bone.
Inputs a scale and converts it to the position of a child bone.
Inputs a scale and converts it to the position of a child bone. Intended for use in combination with Skeleton3D.SetBoneSkinScale.
This modifier repositions child bones to follow the skin transformation by Skeleton3D.SetBoneSkinScale in cases when you want to adjust bone length using Skeleton3D.SetBoneSkinScale or when the bone has multiple child bones.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
BoneSpaceAdjuster3DConstructor
public BoneSpaceAdjuster3D();Properties2
SettingSizeProperty
public int SettingSize { get; set; }The number of settings in the modifier.
UseBoneSkinScaleForAllBonesProperty
public bool UseBoneSkinScaleForAllBones { get; set; }If true, this modifier processes all bones for which Skeleton3D.GetBoneSkinScale is not Vector3(1, 1, 1).
If false, this modifier allows you to configure whether to process bone skin scaling individually in the settings.
Methods13
AreAllBonesUsingBoneSkinScalebool
public bool AreAllBonesUsingBoneSkinScale();boolClearSettingvoid
public void ClearSetting();Clears all settings.
GetBoneint
public int GetBone(int index);Returns the scaled bone of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
intGetBoneNameStringName
public StringName GetBoneName(int index);Returns the scaled bone name of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
StringNameGetBoneScaleVector3
public Vector3 GetBoneScale(int index);Returns the scale of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
Vector3GetSettingSizeint
public int GetSettingSize();intIsUsingBoneSkinScalebool
public bool IsUsingBoneSkinScale(int index);Returns whether to use the skin_scale property of a Skeleton3D's bone of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
boolSetBonevoid
public void SetBone(int index, int bone);Sets the scaled bone of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
bone | int | — |
SetBoneNamevoid
public void SetBoneName(int index, StringName boneName);Sets the scaled bone name of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
boneName | StringName | — |
SetBoneScalevoid
public void SetBoneScale(int index, Vector3 scale);When BoneSpaceAdjuster3D.IsUsingBoneSkinScale returns false, sets the scale of the setting at index.
Note: The scale value is recommended to be non-zero.
| Name | Type | Default |
|---|---|---|
index | int | — |
scale | Vector3 | — |
SetSettingSizevoid
public void SetSettingSize(int size);| Name | Type | Default |
|---|---|---|
size | int | — |
SetUseBoneSkinScalevoid
public void SetUseBoneSkinScale(int index, bool enabled);Sets whether to use the skin_scale property of a Skeleton3D's bone of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
enabled | bool | — |
SetUseBoneSkinScaleForAllBonesvoid
public void SetUseBoneSkinScaleForAllBones(bool enabled);| Name | Type | Default |
|---|---|---|
enabled | bool | — |