Documentation
¶
Overview ¶
Apply the copied transform of the bone set by graphics.gd/classdb/BoneConstraint3D.Instance.SetReferenceBone to the bone set by graphics.gd/classdb/BoneConstraint3D.Instance.SetApplyBone about the specific axis with remapping it with some options.
There are 4 ways to apply the transform, depending on the combination of Instance.SetRelative and Instance.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.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsBoneConstraint3D() BoneConstraint3D.Instance
- func (self *Extension[T]) AsConvertTransformModifier3D() Instance
- func (self *Extension[T]) AsNode() Node.Instance
- func (self *Extension[T]) AsNode3D() Node3D.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsSkeletonModifier3D() SkeletonModifier3D.Instance
- type ID
- type Instance
- func (self Instance) AsBoneConstraint3D() BoneConstraint3D.Instance
- func (self Instance) AsConvertTransformModifier3D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
- func (self Instance) GetApplyAxis(index int) Vector3.Axis
- func (self Instance) GetApplyRangeMax(index int) Float.X
- func (self Instance) GetApplyRangeMin(index int) Float.X
- func (self Instance) GetApplyTransformMode(index int) TransformMode
- func (self Instance) GetReferenceAxis(index int) Vector3.Axis
- func (self Instance) GetReferenceRangeMax(index int) Float.X
- func (self Instance) GetReferenceRangeMin(index int) Float.X
- func (self Instance) GetReferenceTransformMode(index int) TransformMode
- func (self Instance) ID() ID
- func (self Instance) IsAdditive(index int) bool
- func (self Instance) IsRelative(index int) bool
- func (self Instance) SetAdditive(index int, enabled bool)
- func (self Instance) SetApplyAxis(index int, axis Vector3.Axis)
- func (self Instance) SetApplyRangeMax(index int, range_max Float.X)
- func (self Instance) SetApplyRangeMin(index int, range_min Float.X)
- func (self Instance) SetApplyTransformMode(index int, transform_mode TransformMode)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetReferenceAxis(index int, axis Vector3.Axis)
- func (self Instance) SetReferenceRangeMax(index int, range_max Float.X)
- func (self Instance) SetReferenceRangeMin(index int, range_min Float.X)
- func (self Instance) SetReferenceTransformMode(index int, transform_mode TransformMode)
- func (self Instance) SetRelative(index int, enabled bool)
- func (self Instance) Virtual(name string) reflect.Value
- type TransformMode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsBoneConstraint3D ¶
func (self *Extension[T]) AsBoneConstraint3D() BoneConstraint3D.Instance
func (*Extension[T]) AsConvertTransformModifier3D ¶
func (*Extension[T]) AsSkeletonModifier3D ¶
func (self *Extension[T]) AsSkeletonModifier3D() SkeletonModifier3D.Instance
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.ConvertTransformModifier3D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsBoneConstraint3D ¶
func (self Instance) AsBoneConstraint3D() BoneConstraint3D.Instance
func (Instance) AsConvertTransformModifier3D ¶
func (Instance) AsSkeletonModifier3D ¶
func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
func (Instance) GetApplyAxis ¶
Returns the axis of the remapping destination transform.
func (Instance) GetApplyRangeMax ¶
Returns the maximum value of the remapping destination range.
func (Instance) GetApplyRangeMin ¶
Returns the minimum value of the remapping destination range.
func (Instance) GetApplyTransformMode ¶
func (self Instance) GetApplyTransformMode(index int) TransformMode
Returns the operation of the remapping destination transform.
func (Instance) GetReferenceAxis ¶
Returns the axis of the remapping source transform.
func (Instance) GetReferenceRangeMax ¶
Returns the maximum value of the remapping source range.
func (Instance) GetReferenceRangeMin ¶
Returns the minimum value of the remapping source range.
func (Instance) GetReferenceTransformMode ¶
func (self Instance) GetReferenceTransformMode(index int) TransformMode
Returns the operation of the remapping source transform.
func (Instance) IsAdditive ¶
Returns true if the additive option is enabled in the setting at 'index'.
func (Instance) IsRelative ¶
Returns true if the relative option is enabled in the setting at 'index'.
func (Instance) SetAdditive ¶
Sets additive option in the setting at 'index' to 'enabled'. This mainly affects the process of applying transform to the graphics.gd/classdb/BoneConstraint3D.Instance.SetApplyBone.
If sets 'enabled' to true, the processed transform is added to the pose of the current apply bone.
If sets 'enabled' to false, the pose of the current apply bone is replaced with the processed transform. However, if set Instance.SetRelative to true, the transform is relative to rest.
func (Instance) SetApplyAxis ¶
Sets the axis of the remapping destination transform.
func (Instance) SetApplyRangeMax ¶
Sets the maximum value of the remapping destination range.
func (Instance) SetApplyRangeMin ¶
Sets the minimum value of the remapping destination range.
func (Instance) SetApplyTransformMode ¶
func (self Instance) SetApplyTransformMode(index int, transform_mode TransformMode)
Sets the operation of the remapping destination transform.
func (Instance) SetReferenceAxis ¶
Sets the axis of the remapping source transform.
func (Instance) SetReferenceRangeMax ¶
Sets the maximum value of the remapping source range.
func (Instance) SetReferenceRangeMin ¶
Sets the minimum value of the remapping source range.
func (Instance) SetReferenceTransformMode ¶
func (self Instance) SetReferenceTransformMode(index int, transform_mode TransformMode)
Sets the operation of the remapping source transform.
func (Instance) SetRelative ¶
Sets relative option in the setting at 'index' to 'enabled'.
If sets 'enabled' to true, the extracted and applying transform is relative to the rest.
If sets 'enabled' to false, the extracted transform is absolute.
type TransformMode ¶
type TransformMode int //gd:ConvertTransformModifier3D.TransformMode
const ( // Convert with position. Transfer the difference. TransformModePosition TransformMode = 0 // Convert with rotation. The angle is the roll for the specified axis. TransformModeRotation TransformMode = 1 // Convert with scale. Transfers the ratio, not the difference. TransformModeScale TransformMode = 2 )