BoneMap
Describes a mapping of bone names for retargeting Skeleton3D
into common names defined by a SkeletonProfile
.
class BoneMap
This class contains a dictionary that uses a list of bone names in SkeletonProfile
as key names.
By assigning the actual Skeleton3D
bone name as the key value, it maps the Skeleton3D
to the SkeletonProfile
.
This object emits the following signals:
Superclasses
class Resource
Base class for serializable objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
var boneMapUpdated: SimpleSignal
This signal is emitted when change the key value in the
BoneMap
. This is used to validate mapping and to updateBoneMap
editor.var profile: SkeletonProfile?
A
SkeletonProfile
of the mapping target. Key names in theBoneMap
are synchronized with it.var profileUpdated: SimpleSignal
This signal is emitted when change the value in profile or change the reference of profile. This is used to update key names in the
BoneMap
and to redraw theBoneMap
editor.func findProfileBoneName(skeletonBoneName: StringName
) -> StringName Returns a profile bone name having
skeletonBoneName
. If not found, an emptyStringName
will be returned.func getSkeletonBoneName(profileBoneName: StringName
) -> StringName Returns a skeleton bone name is mapped to
profileBoneName
.func setSkeletonBoneName(profileBoneName: StringName, skeletonBoneName: StringName
) Maps a skeleton bone name to
profileBoneName
.