Documentation
¶
Overview ¶
This resource is used in EditorScenePostImport. Some parameters are referring to bones in Skeleton3D, Skin, Animation, and some other nodes are rewritten based on the parameters of SkeletonProfile.
Note: These parameters need to be set only when creating a custom profile. In SkeletonProfileHumanoid, they are defined internally as read-only values.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsSkeletonProfile() Instance
- func (self Instance) BoneSize() int
- func (self Instance) FindBone(bone_name string) int
- func (self Instance) GetBoneName(bone_idx int) string
- func (self Instance) GetBoneParent(bone_idx int) string
- func (self Instance) GetBoneTail(bone_idx int) string
- func (self Instance) GetGroup(bone_idx int) string
- func (self Instance) GetGroupName(group_idx int) string
- func (self Instance) GetHandleOffset(bone_idx int) Vector2.XY
- func (self Instance) GetReferencePose(bone_idx int) Transform3D.BasisOrigin
- func (self Instance) GetTailDirection(bone_idx int) TailDirection
- func (self Instance) GetTexture(group_idx int) Texture2D.Instance
- func (self Instance) GroupSize() int
- func (self Instance) ID() ID
- func (self Instance) IsRequired(bone_idx int) bool
- func (self Instance) OnProfileUpdated(cb func(), flags ...Signal.Flags)
- func (self Instance) RootBone() string
- func (self Instance) ScaleBaseBone() string
- func (self Instance) SetBoneName(bone_idx int, bone_name string)
- func (self Instance) SetBoneParent(bone_idx int, bone_parent string)
- func (self Instance) SetBoneSize(value int)
- func (self Instance) SetBoneTail(bone_idx int, bone_tail string)
- func (self Instance) SetGroup(bone_idx int, group string)
- func (self Instance) SetGroupName(group_idx int, group_name string)
- func (self Instance) SetGroupSize(value int)
- func (self Instance) SetHandleOffset(bone_idx int, handle_offset Vector2.XY)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetReferencePose(bone_idx int, bone_name Transform3D.BasisOrigin)
- func (self Instance) SetRequired(bone_idx int, required bool)
- func (self Instance) SetRootBone(value string)
- func (self Instance) SetScaleBaseBone(value string)
- func (self Instance) SetTailDirection(bone_idx int, tail_direction TailDirection)
- func (self Instance) SetTexture(group_idx int, texture Texture2D.Instance)
- func (self Instance) Virtual(name string) reflect.Value
- type TailDirection
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]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsSkeletonProfile ¶
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.SkeletonProfile
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) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsSkeletonProfile ¶
func (Instance) GetBoneName ¶
Returns the name of the bone at 'bone_idx' that will be the key name in the BoneMap.
In the retargeting process, the returned bone name is the bone name of the target skeleton.
func (Instance) GetBoneParent ¶
Returns the name of the bone which is the parent to the bone at 'bone_idx'. The result is empty if the bone has no parent.
func (Instance) GetBoneTail ¶
Returns the name of the bone which is the tail of the bone at 'bone_idx'.
func (Instance) GetGroupName ¶
Returns the name of the group at 'group_idx' that will be the drawing group in the BoneMap editor.
func (Instance) GetHandleOffset ¶
Returns the offset of the bone at 'bone_idx' that will be the button position in the BoneMap editor.
This is the offset with origin at the top left corner of the square.
func (Instance) GetReferencePose ¶
func (self Instance) GetReferencePose(bone_idx int) Transform3D.BasisOrigin
Returns the reference pose transform for bone 'bone_idx'.
func (Instance) GetTailDirection ¶
func (self Instance) GetTailDirection(bone_idx int) TailDirection
Returns the tail direction of the bone at 'bone_idx'.
func (Instance) GetTexture ¶
Returns the texture of the group at 'group_idx' that will be the drawing group background image in the BoneMap editor.
func (Instance) IsRequired ¶
Returns whether the bone at 'bone_idx' is required for retargeting.
This value is used by the bone map editor. If this method returns true, and no bone is assigned, the handle color will be red on the bone map editor.
func (Instance) OnProfileUpdated ¶
func (Instance) ScaleBaseBone ¶
func (Instance) SetBoneName ¶
Sets the name of the bone at 'bone_idx' that will be the key name in the BoneMap.
In the retargeting process, the setting bone name is the bone name of the target skeleton.
func (Instance) SetBoneParent ¶
Sets the bone with name 'bone_parent' as the parent of the bone at 'bone_idx'. If an empty string is passed, then the bone has no parent.
func (Instance) SetBoneSize ¶
func (Instance) SetBoneTail ¶
Sets the bone with name 'bone_tail' as the tail of the bone at 'bone_idx'.
func (Instance) SetGroupName ¶
Sets the name of the group at 'group_idx' that will be the drawing group in the BoneMap editor.
func (Instance) SetGroupSize ¶
func (Instance) SetHandleOffset ¶
Sets the offset of the bone at 'bone_idx' that will be the button position in the BoneMap editor.
This is the offset with origin at the top left corner of the square.
func (Instance) SetReferencePose ¶
func (self Instance) SetReferencePose(bone_idx int, bone_name Transform3D.BasisOrigin)
Sets the reference pose transform for bone 'bone_idx'.
func (Instance) SetRequired ¶
Sets the required status for bone 'bone_idx' to 'required'.
func (Instance) SetRootBone ¶
func (Instance) SetScaleBaseBone ¶
func (Instance) SetTailDirection ¶
func (self Instance) SetTailDirection(bone_idx int, tail_direction TailDirection)
Sets the tail direction of the bone at 'bone_idx'.
Note: This only specifies the method of calculation. The actual coordinates required should be stored in an external skeleton, so the calculation itself needs to be done externally.
func (Instance) SetTexture ¶
Sets the texture of the group at 'group_idx' that will be the drawing group background image in the BoneMap editor.
type TailDirection ¶
type TailDirection int //gd:SkeletonProfile.TailDirection
const ( // Direction to the average coordinates of bone children. TailDirectionAverageChildren TailDirection = 0 // Direction to the coordinates of specified bone child. TailDirectionSpecificChild TailDirection = 1 // Direction is not calculated. TailDirectionEnd TailDirection = 2 )
Source Files