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

    A complete arm with upper arm, lower arm, and hand. More...

    Import Statement: import Clayground.Character3D
    Inherits:

    BodyPartsGroup

    Properties

    Detailed Description

    Arm is a hierarchical body part group containing an upper arm, lower arm, and hand connected by animatable joints (shoulder, elbow, wrist).

    The arm uses a joint-based hierarchy for natural animation: - Shoulder joint controls the entire arm - Elbow joint controls lower arm and hand - Wrist joint controls hand rotation

    Example usage:

    import Clayground.Character3D
    
    Arm {
        width: 1.0
        height: 4.0
        upperRatio: 0.45
        color: "#4169e1"
        handColor: "#d38d5f"
    }

    See also Leg, Hand, and Character.

    Property Documentation

    color : color

    Color of the arm (upper and lower segments).


    hand : Node [read-only]

    Reference to the wrist joint for animation.


    handColor : color

    Color of the hand (skin color).


    handDepth : real

    Depth of the hand.


    handHeight : real

    Height of the hand.


    handWidth : real

    Width of the hand.


    lowerArm : Node [read-only]

    Reference to the elbow joint for animation.


    lowerTaper : real

    Taper factor for lower arm width/depth (0-1).

    Controls how much the forearm narrows compared to the upper arm.


    upperArm : Node [read-only]

    Reference to the shoulder joint for animation.


    upperRatio : real

    Proportion of total arm length for upper arm (0.4-0.6).

    A value of 0.5 means upper and lower arm are equal length.