ConvertTransformModifier3D
A SkeletonModifier3D that apply transform to the bone which converted from reference.
A SkeletonModifier3D that apply transform to the bone which converted from reference.
Apply the copied transform of the bone set by BoneConstraint3D.SetReferenceBone to the bone set by BoneConstraint3D.SetApplyBone about the specific axis with remapping it with some options.
There are 4 ways to apply the transform, depending on the combination of ConvertTransformModifier3D.SetRelative and ConvertTransformModifier3D.SetAdditive.
Relative + Additive:
- Extract reference pose relative to the rest and add it to the apply bone's pose. Relative + Not Additive:
- Extract reference pose relative to the rest and add it to the apply bone's rest. Not Relative + Additive:
- Extract reference pose absolutely and add it to the apply bone's pose. Not Relative + Not Additive:
- Extract reference pose absolutely and the apply bone's pose is replaced with it.
Note: The relative and global options are only available when
BoneConstraint3D.GetReferenceTypeisBoneConstraint3D.ReferenceType.Bone. See alsoBoneConstraint3D.ReferenceType. Note: If there is a rotation greater than180degrees with constrained axes, flipping may occur.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
ConvertTransformModifier3DConstructor
public ConvertTransformModifier3D();Properties1
SettingCountProperty
public int SettingCount { get; set; }The number of settings in the modifier.
Methods22
GetApplyAxisVector3.Axis
public Vector3.Axis GetApplyAxis(int index);Returns the axis of the remapping destination transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
Vector3.AxisGetApplyRangeMaxfloat
public float GetApplyRangeMax(int index);Returns the maximum value of the remapping destination range.
| Name | Type | Default |
|---|---|---|
index | int | — |
floatGetApplyRangeMinfloat
public float GetApplyRangeMin(int index);Returns the minimum value of the remapping destination range.
| Name | Type | Default |
|---|---|---|
index | int | — |
floatGetApplyTransformModeConvertTransformModifier3D.TransformMode
public ConvertTransformModifier3D.TransformMode GetApplyTransformMode(int index);Returns the operation of the remapping destination transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
ConvertTransformModifier3D.TransformModeGetReferenceAxisVector3.Axis
public Vector3.Axis GetReferenceAxis(int index);Returns the axis of the remapping source transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
Vector3.AxisGetReferenceRangeMaxfloat
public float GetReferenceRangeMax(int index);Returns the maximum value of the remapping source range.
| Name | Type | Default |
|---|---|---|
index | int | — |
floatGetReferenceRangeMinfloat
public float GetReferenceRangeMin(int index);Returns the minimum value of the remapping source range.
| Name | Type | Default |
|---|---|---|
index | int | — |
floatGetReferenceTransformModeConvertTransformModifier3D.TransformMode
public ConvertTransformModifier3D.TransformMode GetReferenceTransformMode(int index);Returns the operation of the remapping source transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
ConvertTransformModifier3D.TransformModeIsAdditivebool
public bool IsAdditive(int index);Returns true if the additive option is enabled in the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
boolIsGlobalbool
public bool IsGlobal(int index);Returns true if the global option is enabled in the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
boolIsRelativebool
public bool IsRelative(int index);Returns true if the relative option is enabled in the setting at index.
| Name | Type | Default |
|---|---|---|
index | int | — |
boolSetAdditivevoid
public void SetAdditive(int index, bool enabled);Sets additive option in the setting at index to enabled. This mainly affects the process of applying transform to the BoneConstraint3D.SetApplyBone.
If enabled is true, the processed transform is added to the pose of the current apply bone.
If enabled is false, the pose of the current apply bone is replaced with the processed transform. However, if set ConvertTransformModifier3D.SetRelative to true, the transform is relative to rest.
| Name | Type | Default |
|---|---|---|
index | int | — |
enabled | bool | — |
SetApplyAxisvoid
public void SetApplyAxis(int index, Vector3.Axis axis);Sets the axis of the remapping destination transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
axis | Vector3.Axis | — |
SetApplyRangeMaxvoid
public void SetApplyRangeMax(int index, float rangeMax);Sets the maximum value of the remapping destination range.
| Name | Type | Default |
|---|---|---|
index | int | — |
rangeMax | float | — |
SetApplyRangeMinvoid
public void SetApplyRangeMin(int index, float rangeMin);Sets the minimum value of the remapping destination range.
| Name | Type | Default |
|---|---|---|
index | int | — |
rangeMin | float | — |
SetApplyTransformModevoid
public void SetApplyTransformMode(int index, ConvertTransformModifier3D.TransformMode transformMode);Sets the operation of the remapping destination transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
transformMode | ConvertTransformModifier3D.TransformMode | — |
SetGlobalvoid
public void SetGlobal(int index, bool enabled);Sets the global option in the setting at index to enabled.
If enabled is true, the global pose of the reference bone is used as the remapping source.
If enabled is false, the local pose of the reference bone is used as the remapping source.
Note: If the parent of the reference bone has a non-uniform scale, the reference bone is sheared as seen from global space. Since the local pose cannot bring in the shear, the scale may not be applied as intended.
| Name | Type | Default |
|---|---|---|
index | int | — |
enabled | bool | — |
SetReferenceAxisvoid
public void SetReferenceAxis(int index, Vector3.Axis axis);Sets the axis of the remapping source transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
axis | Vector3.Axis | — |
SetReferenceRangeMaxvoid
public void SetReferenceRangeMax(int index, float rangeMax);Sets the maximum value of the remapping source range.
| Name | Type | Default |
|---|---|---|
index | int | — |
rangeMax | float | — |
SetReferenceRangeMinvoid
public void SetReferenceRangeMin(int index, float rangeMin);Sets the minimum value of the remapping source range.
| Name | Type | Default |
|---|---|---|
index | int | — |
rangeMin | float | — |
SetReferenceTransformModevoid
public void SetReferenceTransformMode(int index, ConvertTransformModifier3D.TransformMode transformMode);Sets the operation of the remapping source transform.
| Name | Type | Default |
|---|---|---|
index | int | — |
transformMode | ConvertTransformModifier3D.TransformMode | — |
SetRelativevoid
public void SetRelative(int index, bool enabled);Sets relative option in the setting at index to enabled.
If enabled is true, the extracted and applying transform is relative to the rest.
If enabled is false, the extracted transform is absolute.
| Name | Type | Default |
|---|---|---|
index | int | — |
enabled | bool | — |
ConvertTransformModifier3D.TransformMode
| Value | Description |
|---|---|
Position = 0 | Convert with position. Transfer the difference. |
Rotation = 1 | Convert with rotation. The angle is the roll for the specified axis. |
Scale = 2 | Convert with scale. Transfers the ratio, not the difference. |