Files
godot-docs/classes/class_skeletonprofilehumanoid.rst
2024-04-13 03:17:16 +00:00

116 lines
6.1 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonProfileHumanoid.xml.
.. _class_SkeletonProfileHumanoid:
SkeletonProfileHumanoid
=======================
**Inherits:** :ref:`SkeletonProfile<class_SkeletonProfile>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A humanoid :ref:`SkeletonProfile<class_SkeletonProfile>` preset.
.. rst-class:: classref-introduction-group
Description
-----------
A :ref:`SkeletonProfile<class_SkeletonProfile>` as a preset that is optimized for the human form. This exists for standardization, so all parameters are read-only.
A humanoid skeleton profile contains 54 bones divided in 4 groups: ``"Body"``, ``"Face"``, ``"LeftHand"``, and ``"RightHand"``. It is structured as follows:
.. code:: text
Root
└─ Hips
├─ LeftUpperLeg
│ └─ LeftLowerLeg
│ └─ LeftFoot
│ └─ LeftToes
├─ RightUpperLeg
│ └─ RightLowerLeg
│ └─ RightFoot
│ └─ RightToes
└─ Spine
└─ Chest
└─ UpperChest
├─ Neck
│ └─ Head
│ ├─ Jaw
│ ├─ LeftEye
│ └─ RightEye
├─ LeftShoulder
│ └─ LeftUpperArm
│ └─ LeftLowerArm
│ └─ LeftHand
│ ├─ LeftThumbMetacarpal
│ │ └─ LeftThumbProximal
│ ├─ LeftIndexProximal
│ │ └─ LeftIndexIntermediate
│ │ └─ LeftIndexDistal
│ ├─ LeftMiddleProximal
│ │ └─ LeftMiddleIntermediate
│ │ └─ LeftMiddleDistal
│ ├─ LeftRingProximal
│ │ └─ LeftRingIntermediate
│ │ └─ LeftRingDistal
│ └─ LeftLittleProximal
│ └─ LeftLittleIntermediate
│ └─ LeftLittleDistal
└─ RightShoulder
└─ RightUpperArm
└─ RightLowerArm
└─ RightHand
├─ RightThumbMetacarpal
│ └─ RightThumbProximal
├─ RightIndexProximal
│ └─ RightIndexIntermediate
│ └─ RightIndexDistal
├─ RightMiddleProximal
│ └─ RightMiddleIntermediate
│ └─ RightMiddleDistal
├─ RightRingProximal
│ └─ RightRingIntermediate
│ └─ RightRingDistal
└─ RightLittleProximal
└─ RightLittleIntermediate
└─ RightLittleDistal
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Retargeting 3D Skeletons <../tutorials/assets_pipeline/retargeting_3d_skeletons>`
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | bone_size | ``56`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_bone_size>`) |
+-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | group_size | ``4`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_group_size>`) |
+-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | root_bone | ``&"Root"`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_root_bone>`) |
+-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | scale_base_bone | ``&"Hips"`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_scale_base_bone>`) |
+-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`