FaceBuilder

This script contains obsolete FaceBuilder nodes. Unfortunately, they are not supported anymore. You can create new nodes, or load this script with KeenTools v2022.1 or older. If you’re creating nodes from Python, please use ‘FaceBuilder2’.

Inputs

Knobs

Toolbar

Name Label Description
center_geo center geo Place the object in 3D space so it will be visible in the frame
align_face align face Detect a face in the viewer and pin the model to the detected face
focal_length_view Current focal length
reset_to_neutral reset shape Reset the shape to the default state. The facial expressions, position and all pins on all keyframes will be left intact.
reset_to_neutral_1 reset expression Reset the facial expressions to neutral in the current keyframe
remove_pins remove pins Removes selected pins if there are any, or all pins if nothing is selected
toggle_pins toggle pins Activate or deactivate selected pins, applied to all pins if nothing is selected
estimate_focal_length estimate focal length Focal length estimation happens when you drag pins. Estimation starts once you have at least 4 pins. It’s automatically turned off after switching frames. It’s also not available if you chose to get the focal length from a connected Camera node.
meta_keyframes Keyframes toolbar

FaceBuilder Tab

Model

Name Label Description
allow_facial_expressions allow facial expressions When on, you can pin faces with expressions like open mouth, closed eyes, etc. Later you can export all keyframes from FaceBuilder into FaceTracker on the Results tab.
blinking_locked eye blinking When off, the output geometry will attempt to fit eylash movement (i.e. eye blinking). When on the eyes of the model will remain still. This value is used when you’re pinning the model and when tracking is happening.
neck_movement_locked neck movement When off, the output geometry will attempt to fit neck movement. When on the neck of the model will remain still. This value is used when you’re pinning the model and when tracking is happening.
copy_expression copy Copy current facial expressions to clipboard
paste_expression paste Paste facial expressions from clipboard to current frame. If there’s no keyframe, it’ll be created.
selected_uv_set uv The UV used for the model
topology topology Choose a desired topology
shape_model_rigidity shape High values make the shape more rigid. For example if you need the shape to be softer try to lower the value a bit.
expressions_model_rigidity expression With high values the expression tends to stay neutral, with low values it’s easier to change it. This value is used when you’re pinning the model and when tracking is happening.
blinking_model_rigidity eye blinking With high values the eye blinking tends to stay neutral, with low values it’s easier to change it. This value is used when you’re pinning the model and when tracking is happening.
neck_movement_model_rigidity neck movement With high values the neck movement tends to stay neutral, with low values it’s easier to change it. This value is used when you’re pinning the model and when tracking is happening.

Camera

Name Label Description
focal_length_mode

Focal length settings

  • focal length from Camera node: use the focal length set in the Camera node connected to the ‘cam’ input. Don’t forget to setup the proper film back dimensions in the Camera node. Focal length estimation can’t be used in this mode.
  • fixed focal length: use fixed focal length specified in the field (below or on the Results tab). One focal length is used for all keyframes. The film back dimensions will be taken from a default Camera node, if you want to override them — connect a Camera node with the desired film back dimensions, the focal length will not be taken from that node. Focal length estimation can be used with this mode.
  • varying focal length (zoom): use varying focal length specified in the field below. Focal length is stored within keyframes, it can be different for each keyframe. The film back dimensions will be taken from a default Camera node, if you want to override them — connect a Camera node with the desired film back dimensions, the focal length will not be taken from that node. Focal length estimation can be used with this mode.
focal_length focal length Current focal length

Render

Name Label Description
lit_wireframe lit wireframe The shape of the lit wireframe will be more apparent due to darkening of the furthest regions.
adaptive_opacity adaptive opacity Opacity will be reduced for dense regions of the wireframe in 2D viewer, so the footage visibility will suffer less.
wireframe_opacity opacity Opacity of the wireframe drawn in 2D viewer over the footage
back_face_culling back-face culling Don’t render back-faced polygons in 2D viewer
textured_wireframe use texture A texture will be used to color the wireframe. The default texture highlights the facial parts. You can connect your own texture to the ‘tex’ input.
face_box_color face box Color of detected face bounding box
pins_color normal pins Normal pin color
residuals_color residuals Color of pin residual lines
unpinned_pins_color deactivated pins Color of deactivated pins
selected_pins_color selected pins Color of selected pins
wireframe_color wireframe Base colour of the wireframe drawn in 2D viewer over the footage
wireframe_secondary wireframe secondary The color used for distinct parts of the wireframe like ears, eyes and lips
wireframe_midline wireframe midline The color used for the vertical middle line of the wireframe

Results Tab

Name Label Description
translate Geometry translation
rotate Geometry rotation
global_fixed_rx x Lock X-axis rotation
global_fixed_ry y Lock Y-axis rotation
global_fixed_rz z Lock Z-axis rotation
global_fixed_tx x Lock X-axis translation
global_fixed_ty y Lock Y-axis translation
global_fixed_tz z Lock Z-axis translation
unbreak_rotation unbreak rotation Fix rotation making it continious and removing 360 degrees jumps
scale scale Geometry input scale. All operations are performed with the scaled geometry. The scale is not restored on the output.
copy_expression copy Copy current facial expressions to clipboard
paste_expression paste Paste facial expressions from clipboard to current frame. If there’s no keyframe, it’ll be created.
output_transformed_geo output transformed geometry When on, the output geometry will be translated and rotated in accordance with the 2D position of the model in keyframes relative to the camera. You may need it if you want to project the texture with Project3D or TextureBuilder.

Export

Name Label Description
export_mode

Results export mode

  • TransformGeo: create a TransformGeo node containing the positions of the head in 3D relative to the input camera. If you are using the default camera or the custom focal length mode the new Camera node will also be created.
  • FaceTracker: create a FaceTracker node containing the positions of the head in 3D relative to the input camera. If you are using non- neutral expressions, they’re also copied (but not linked).
  • Axis: create an Axis node containing the positions of the head in 3D relative to the input camera. If you are using the default camera or the custom focal length mode the new Camera node will also be created.
  • Camera: create a Camera node. Only makes sense if you’re using the default camera or the focal length estimation. Doesn’t contain any movement data.
  • Translated Camera: create a Camera node containing the positions of the camera as if the head was static and the camera moved
  • FacialExpressions: create a FacialExpressions node that allows extracting facial expressions from FaceBuilder and FaceTracker.
export export Create a node of the selected type
link_output link output The exported node will be linked to GeoTracker, so when you change someting in GeoTracker the exported node will be updated. Switch it off if you need to embed all data into the exported node, to use in another script for example.
cam_rotate Inverted rotation. When coupled with inverted translation can be used as the rotation of a geometry-tracked camera.
cam_translate Inverted translation. When coupled with inverted rotation can be used as the translation of a geometry-tracked camera.

Last update: Wed Dec 18 17:21:07 2024