Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
- Animation
- AnimationLibrary
- AnimationNode (6)
- AnimationNodeStateMachinePlayback
- AnimationNodeStateMachineTransition
- AudioBusLayout
- AudioEffect (17)
- AudioStream (10)
- BitMap
- BoneMap
- ButtonGroup
- CameraAttributes (2)
- ColorPalette
- Compositor
- CompositorEffect
- CryptoKey
- Curve
- Curve2D
- Curve3D
- EditorNode3DGizmoPlugin
- EditorSettings
- Environment
- Font (3)
- GDExtension
- GLTFAccessor
- GLTFAnimation
- GLTFBufferView
- GLTFCamera
- GLTFDocument (1)
- GLTFDocumentExtension (1)
- GLTFLight
- GLTFMesh
- GLTFNode
- GLTFPhysicsBody
- GLTFPhysicsShape
- GLTFSkeleton
- GLTFSkin
- GLTFSpecGloss
- GLTFState (1)
- GLTFTexture
- GLTFTextureSampler
- Gradient
- Image
- ImporterMesh
- InputEvent (6)
- JSON
- LabelSettings
- LightmapGIData
- Material (9)
- Mesh (4)
- MeshLibrary
- MissingResource
- MultiMesh
- NavigationMesh
- NavigationMeshSourceGeometryData2D
- NavigationMeshSourceGeometryData3D
- NavigationPolygon
- Noise (1)
- Occluder3D (5)
- OccluderPolygon2D
- OggPacketSequence
- OpenXRAction
- OpenXRActionMap
- OpenXRActionSet
- OpenXRBindingModifier (2)
- OpenXRHapticBase (1)
- OpenXRIPBinding
- OpenXRInteractionProfile
- PackedDataContainer
- PackedScene
- PhysicsMaterial
- PolygonPathFinder
- RDShaderFile
- RDShaderSPIRV
- RichTextEffect
- SceneReplicationConfig
- Script (3)
- Shader (1)
- ShaderInclude
- Shape2D (8)
- Shape3D (9)
- Shortcut
- SkeletonModification2D (7)
- SkeletonModificationStack2D
- SkeletonProfile (1)
- Skin
- Sky
- SpriteFrames
- StyleBox (4)
- SyntaxHighlighter (2)
- Texture (3)
- Theme
- TileMapPattern
- TileSet
- TileSetSource (2)
- Translation (1)
- VideoStream (1)
- VideoStreamPlayback
- VisualShaderNode (62)
- VoxelGIData
- World2D
- World3D
- X509Certificate
Table of contents
-
var bone_size: int = 0 -
var group_size: int = 0 -
var root_bone: StringName = &"" -
var scale_base_bone: StringName = &"" -
const func find_bone(bone_name: StringName) -> int -
const func get_bone_name(bone_idx: int) -> StringName -
const func get_bone_parent(bone_idx: int) -> StringName -
const func get_bone_tail(bone_idx: int) -> StringName -
const func get_group(bone_idx: int) -> StringName -
const func get_group_name(group_idx: int) -> StringName -
const func get_handle_offset(bone_idx: int) -> Vector2 -
const func get_reference_pose(bone_idx: int) -> Transform3D -
const func get_tail_direction(bone_idx: int) -> intSkeletonProfile.TailDirection -
const func get_texture(group_idx: int) -> Texture2D -
const func is_required(bone_idx: int) -> bool -
func set_bone_name(bone_name: StringName) -> void -
func set_bone_parent(bone_parent: StringName) -> void -
func set_bone_tail(bone_tail: StringName) -> void -
func set_group(group: StringName) -> void -
func set_group_name(group_name: StringName) -> void -
func set_handle_offset(handle_offset: Vector2) -> void -
func set_reference_pose(bone_name: Transform3D) -> void -
func set_required(required: bool) -> void -
func set_tail_direction(tail_direction: int enumSkeletonProfile.TailDirection) -> void -
func set_texture(texture: Texture2D) -> void -
const TAIL_DIRECTION_AVERAGE_CHILDREN = 0 enum TailDirection -
const TAIL_DIRECTION_SPECIFIC_CHILD = 1 enum TailDirection -
const TAIL_DIRECTION_END = 2 enum TailDirection -
enum TailDirection -
signal profile_updated()
SkeletonProfile #
is_refcounted, is_instantiable, resource, core, not_builtin_classes
Base class for a profile of a virtual skeleton used as a target for retargeting.
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.
Members #
var bone_size: int = 0#
The amount of bones in retargeting section's BoneMap editor. For example, SkeletonProfileHumanoid has 56 bones.
The size of elements in BoneMap updates when changing this property in it's assigned SkeletonProfile.
var group_size: int = 0#
The amount of groups of bones in retargeting section's BoneMap editor. For example, SkeletonProfileHumanoid has 4 groups.
This property exists to separate the bone list into several sections in the editor.
var root_bone: StringName = &""#
A bone name that will be used as the root bone in AnimationTree. This should be the bone of the parent of hips that exists at the world origin.
var scale_base_bone: StringName = &""#
A bone name which will use model's height as the coefficient for normalization. For example, SkeletonProfileHumanoid defines it as Hips.
Methods #
const func find_bone(bone_name: StringName) -> int#
Returns the bone index that matches bone_name as its name.
const func get_bone_name(bone_idx: int) -> StringName#
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.
const func get_bone_parent(bone_idx: int) -> StringName#
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.
const func get_bone_tail(bone_idx: int) -> StringName#
Returns the name of the bone which is the tail of the bone at bone_idx.
const func get_group(bone_idx: int) -> StringName#
Returns the group of the bone at bone_idx.
const func get_group_name(group_idx: int) -> StringName#
Returns the name of the group at group_idx that will be the drawing group in the BoneMap editor.
const func get_handle_offset(bone_idx: int) -> Vector2#
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.
const func get_reference_pose(bone_idx: int) -> Transform3D#
Returns the reference pose transform for bone bone_idx.
const func get_tail_direction(bone_idx: int) -> intSkeletonProfile.TailDirection#
Returns the tail direction of the bone at bone_idx.
const func get_texture(group_idx: int) -> Texture2D#
Returns the texture of the group at group_idx that will be the drawing group background image in the BoneMap editor.
const func is_required(bone_idx: int) -> bool#
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 set_bone_name(bone_name: StringName) -> void#
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 set_bone_parent(bone_parent: StringName) -> void#
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 set_bone_tail(bone_tail: StringName) -> void#
Sets the bone with name bone_tail as the tail of the bone at bone_idx.
func set_group(group: StringName) -> void#
Sets the group of the bone at bone_idx.
func set_group_name(group_name: StringName) -> void#
Sets the name of the group at group_idx that will be the drawing group in the BoneMap editor.
func set_handle_offset(handle_offset: Vector2) -> void#
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 set_reference_pose(bone_name: Transform3D) -> void#
Sets the reference pose transform for bone bone_idx.
func set_required(required: bool) -> void#
Sets the required status for bone bone_idx to required.
func set_tail_direction(tail_direction: int enumSkeletonProfile.TailDirection) -> void#
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 set_texture(texture: Texture2D) -> void#
Sets the texture of the group at group_idx that will be the drawing group background image in the BoneMap editor.
Annotations #
Constants #
const TAIL_DIRECTION_AVERAGE_CHILDREN = 0 enum TailDirection#
Direction to the average coordinates of bone children.
const TAIL_DIRECTION_SPECIFIC_CHILD = 1 enum TailDirection#
Direction to the coordinates of specified bone child.
const TAIL_DIRECTION_END = 2 enum TailDirection#
Direction is not calculated.
Constructors #
Enums #
TailDirection#
enum TailDirection {
TAIL_DIRECTION_AVERAGE_CHILDREN = 0,
TAIL_DIRECTION_SPECIFIC_CHILD = 1,
TAIL_DIRECTION_END = 2,
} Operators #
Signals #
signal profile_updated()#
This signal is emitted when change the value in profile. This is used to update key name in the BoneMap and to redraw the BoneMap editor.
Note: This signal is not connected directly to editor to simplify the reference, instead it is passed on to editor through the BoneMap.