Documentation
¶
Overview ¶
Retrieves the pose (or global pose) relative to the parent Skeleton's rest in model space and transfers it to the child Skeleton.
This modifier rewrites the pose of the child skeleton directly in the parent skeleton's update process. This means that it overwrites the mapped bone pose set in the normal process on the target skeleton. If you want to set the target skeleton bone pose after retargeting, you will need to add a SkeletonModifier3D child to the target skeleton and thereby modify the pose.
Note: When the UseGlobalPose is enabled, even if it is an unmapped bone, it can cause visual problems because the global pose is applied ignoring the parent bone's pose if it has mapped bone children. See also UseGlobalPose.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRetargetModifier3D() Instance
- func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
- func (self Instance) Enable() TransformFlag
- func (self Instance) ID() ID
- func (self Instance) IsPositionEnabled() bool
- func (self Instance) IsRotationEnabled() bool
- func (self Instance) IsScaleEnabled() bool
- func (self Instance) Profile() SkeletonProfile.Instance
- func (self Instance) SetEnable(value TransformFlag)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPositionEnabled(enabled bool)
- func (self Instance) SetProfile(value SkeletonProfile.Instance)
- func (self Instance) SetRotationEnabled(enabled bool)
- func (self Instance) SetScaleEnabled(enabled bool)
- func (self Instance) SetUseGlobalPose(value bool)
- func (self Instance) UseGlobalPose() bool
- func (self Instance) Virtual(name string) reflect.Value
- type TransformFlag
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]) AsRetargetModifier3D ¶
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.RetargetModifier3D
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) AsRetargetModifier3D ¶
func (Instance) AsSkeletonModifier3D ¶
func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
func (Instance) Enable ¶
func (self Instance) Enable() TransformFlag
func (Instance) IsPositionEnabled ¶
Returns true if Enable has TransformFlagPosition.
func (Instance) IsRotationEnabled ¶
Returns true if Enable has TransformFlagRotation.
func (Instance) IsScaleEnabled ¶
Returns true if Enable has TransformFlagScale.
func (Instance) Profile ¶
func (self Instance) Profile() SkeletonProfile.Instance
func (Instance) SetEnable ¶
func (self Instance) SetEnable(value TransformFlag)
func (Instance) SetPositionEnabled ¶
Sets TransformFlagPosition into Enable.
func (Instance) SetProfile ¶
func (self Instance) SetProfile(value SkeletonProfile.Instance)
func (Instance) SetRotationEnabled ¶
Sets TransformFlagRotation into Enable.
func (Instance) SetScaleEnabled ¶
Sets TransformFlagScale into Enable.
func (Instance) SetUseGlobalPose ¶
func (Instance) UseGlobalPose ¶
type TransformFlag ¶
type TransformFlag int //gd:RetargetModifier3D.TransformFlag
const ( // If set, allows to retarget the position. TransformFlagPosition TransformFlag = 1 // If set, allows to retarget the rotation. TransformFlagRotation TransformFlag = 2 // If set, allows to retarget the scale. TransformFlagScale TransformFlag = 4 // If set, allows to retarget the position/rotation/scale. TransformFlagAll TransformFlag = 7 )
Source Files