Skip to content

Working With Shapekeys

Mad Hatter edited this page Oct 13, 2024 · 2 revisions

Shape keys are a method of warping the mesh to make unique characters. These shape keys are lumped into 2 groups: macro shapekeys, basic shapekeys. Macro shape keys will change several of the basic shape keys together to achieve a uniform effect across the model. An example of a macro shape key is "age", this will change the shape of the face, the size of the character and muscle structure on all parts of the body when the user selects a value between 0-1. Shape keys generally accept a value between 0 and 1.

Getting All usable shapekeys

When working with shapekeys it is often useful to know all of the shape key options that are loaded in the current version of Humanizer. The following line of code will return a categorized dictionary of all possible shape keys.

var dict_of_shapekeys = HumanizerTargetService.get_shapekey_categories()

Categories include:

Category Description
Macro A set of shape keys that define other shape keys to achieve a full character effect
Race A set of Macros that specifically refer to racial features for the full character
Body A set of shape keys that target the torso as a whole
Head A set of shape keys that target the head shape and size
Eyes A set of shape keys that target the eyes and area around the eyes(l denotes left, r denotes right)
Mouth A set of shape keys that target the mouth and area around the mouth
Nose A set of shape keys that target the noise size and shape
Ears A set of shape keys that target the ears (l denotes left, r denotes right)
Face A set of shape keys that target the areas around the face
Neck A set of shape keys that target the neck size length, and shape
Chest A set of shape keys that target the upper body
Breasts A set of shape keys that target the Pectoral areas of both male and female characters
Hips A set of shape keys that target the area from the upper legs to the ribs including stomach a buttock
Legs A set of shape key that targets from the buttock to the bottom of the feet
Legs A set of shape key that targets from the Shoulder to the fingers.
Misc A set of shape keys that complete tasks that do not fit an above category (typically blank)
Custom A set of project defined shape keys (typically blank)

Changing a shape key with in class HumanizerEditorTool

This section assumed you have a reference to a node with type HumanizerEditorTool in a script named het.

To set the shape key value use the following line of code:

het.set_shapekeys({"SHAPEKEY_NAME":NUMBER_0_to_1})

Where SHAPEKEY_NAME is a name of a shape key found in previous section. and NUMBER_0_to_1 is a float between 0 and 1

Clone this wiki locally