BoneConstraint3D
A node that may modify Skeleton3D's bone with associating the two bones.
A node that may modify Skeleton3D's bone with associating the two bones.
Base class of SkeletonModifier3D that modifies the bone set in BoneConstraint3D.SetApplyBone based on the transform of the bone retrieved by BoneConstraint3D.GetReferenceBone.
Note: Most methods in this class take an index parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. settings/<index>/amount).
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
BoneConstraint3DConstructor
public BoneConstraint3D();Methods17
ClearSettingvoid
public void ClearSetting();Clear all settings.
GetAmountfloat
public float GetAmount(int index);Returns the apply amount of the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
floatGetApplyBoneint
public int GetApplyBone(int index);Returns the apply bone of the setting at index. This bone will be modified.
| Name | Type | Default |
|---|---|---|
index | int | — |
intGetApplyBoneNamestring
public string GetApplyBoneName(int index);Returns the apply bone name of the setting at index. This bone will be modified.
| Name | Type | Default |
|---|---|---|
index | int | — |
stringGetReferenceBoneint
public int GetReferenceBone(int index);Returns the reference bone of the setting at index.
This bone will be only referenced and not modified by this modifier.
| Name | Type | Default |
|---|---|---|
index | int | — |
intGetReferenceBoneNamestring
public string GetReferenceBoneName(int index);Returns the reference bone name of the setting at index.
This bone will be only referenced and not modified by this modifier.
| Name | Type | Default |
|---|---|---|
index | int | — |
stringGetReferenceEntityEntityPath
public EntityPath GetReferenceEntity(int index);Returns the reference node path of the setting at index.
This node will only be referenced and not modified by this modifier.
| Name | Type | Default |
|---|---|---|
index | int | — |
EntityPathGetReferenceTypeBoneConstraint3D.ReferenceType
public BoneConstraint3D.ReferenceType GetReferenceType(int index);Returns the reference target type of the setting at index. See also BoneConstraint3D.ReferenceType.
| Name | Type | Default |
|---|---|---|
index | int | — |
BoneConstraint3D.ReferenceTypeGetSettingCountint
public int GetSettingCount();Returns the number of settings in the modifier.
intSetAmountvoid
public void SetAmount(int index, float amount);Sets the apply amount of the setting at index to amount.
| Name | Type | Default |
|---|---|---|
index | int | — |
amount | float | — |
SetApplyBonevoid
public void SetApplyBone(int index, int bone);Sets the apply bone of the setting at index to bone. This bone will be modified.
| Name | Type | Default |
|---|---|---|
index | int | — |
bone | int | — |
SetApplyBoneNamevoid
public void SetApplyBoneName(int index, string boneName);Sets the apply bone of the setting at index to bone_name. This bone will be modified.
| Name | Type | Default |
|---|---|---|
index | int | — |
boneName | string | — |
SetReferenceBonevoid
public void SetReferenceBone(int index, int bone);Sets the reference bone of the setting at index to bone.
This bone will only be referenced and not modified by this modifier.
| Name | Type | Default |
|---|---|---|
index | int | — |
bone | int | — |
SetReferenceBoneNamevoid
public void SetReferenceBoneName(int index, string boneName);Sets the reference bone of the setting at index to bone_name.
This bone will only be referenced and not modified by this modifier.
| Name | Type | Default |
|---|---|---|
index | int | — |
boneName | string | — |
SetReferenceEntityvoid
public void SetReferenceEntity(int index, EntityPath node);Sets the reference node path of the setting at index to node.
This node will only be referenced and not modified by this modifier.
| Name | Type | Default |
|---|---|---|
index | int | — |
node | EntityPath | — |
SetReferenceTypevoid
public void SetReferenceType(int index, BoneConstraint3D.ReferenceType type);Sets the reference target type of the setting at index to type. See also BoneConstraint3D.ReferenceType.
| Name | Type | Default |
|---|---|---|
index | int | — |
type | BoneConstraint3D.ReferenceType | — |
SetSettingCountvoid
public void SetSettingCount(int count);Sets the number of settings in the modifier.
| Name | Type | Default |
|---|---|---|
count | int | — |
BoneConstraint3D.ReferenceType
| Value | Description |
|---|---|
Bone = 0 | The reference target is a bone. In this case, the reference target space is local space. |
Node = 1 | The reference target is a |