← Back to Docs
  • index.html
  • Clayground
  • Clayground.Character3D
  • Head
  • Clayground 2025.2
  • Head QML Type

    A complete head with facial features and expressions. More...

    Import Statement: import Clayground.Character3D
    Inherits:

    BodyPartsGroup

    Properties

    Detailed Description

    Head is a complex body part group containing upper head, lower head (jaw), hair, eyes, ears, nose, and mouth. It supports animated facial expressions including joy, anger, sadness, and talking.

    The head dimensions are derived from its component parts. The upper head contains eyes, ears, and hair, while the lower head contains the mouth and chin.

    Example usage:

    import Clayground.Character3D
    
    Head {
        skinColor: "#d38d5f"
        hairColor: "#734120"
        eyeColor: "#4a3728"
        hairVolume: 1.2
        activity: Head.Activity.ShowJoy
    }

    See also Character and BodyPartsGroup.

    Property Documentation

    activity : int

    Current facial expression activity.

    Use Head.Activity enum values.


    chinPointiness : real

    How pointed the chin is (0-1).

    Controls the bottom face scaling of the jaw.


    eyeColor : color

    Color of the irises.


    eyeSize : real

    Eye size multiplier (0.5 = small, 1.0 = normal, 1.5 = large).


    hairColor : color

    Color of the hair and eyebrows.


    hairVolume : real

    Hair volume multiplier (0 = bald, 1.0 = normal, 1.5 = voluminous).


    lowerHeadDepth : real

    Depth of the lower head (jaw).


    lowerHeadHeight : real

    Height of the lower head (jaw).


    lowerHeadWidth : real

    Width of the lower head (jaw).


    mouthSize : real

    Mouth size multiplier (0.5 = small, 1.0 = normal, 1.5 = large).


    noseSize : real

    Nose size multiplier (0.5 = small, 1.0 = normal, 1.5 = large).


    skinColor : color

    Color of the skin (face, ears, nose).


    talkDuration : int

    Duration of mouth open/close cycle when talking in milliseconds.


    toEmotionDuration : int

    Duration of emotion transition animations in milliseconds.


    upperHeadDepth : real

    Depth of the upper head (cranium).


    upperHeadHeight : real

    Height of the upper head (cranium).


    upperHeadWidth : real

    Width of the upper head (cranium).