FaceGen SDK Manual - Commands

Overview

There are 4 command-line interface (CLI) executables, based on function-level distribution.

They are all available on Windows, MacOS and Linux, however only the Windows versions include GUI functionality required by some commands (eg. 'view mesh').

For all commands, documentation is available by typing the command without any arguments, and follows typical unix CLI description conventions.

Many of the commands have sub-commands, whose documentation can be obtained similarity.

fgbl

The FaceGen base library CLI has all the functionality not directly related to our core face technology. It is free, open-source, and available on github

$> fgbl

3dmm - 3D morphable model commands
cons - Construct makefiles / solution file / project files
d3d - Compile Direct3D shaders (Windows only)
graph - Create simple bar graphs from text data
image - Image operations
mesh - 3D Mesh IO and manipulation tools
morph - List, apply or create animation morphs for 3D meshes
rename - rename files according to a pattern
render - Render meshes with color & specular maps to an image file
sys - Show system info
test - Automated tests
testm - Manual tests
view - Interactive GUI view of images and meshes (Windows only)

fg3

The FaceGen Main SDK CLI has all our face creation and editing functionality except for the face-from-photo function. It is a paid license that includes full source code.

$> fg3

apply - Apply a face (.fg) to SAMs to create meshes and color maps
basis - Import / export SAM basis modes
controls - Parametric controls on face coordinates (.fg)
coord - list / set face coordinates (.fg)
create - Create random or average faces (.fg)
detail - Extract/insert a detail texure from/to an .FG file
interactive - Apply interactive deformations to an SSM and face coordinate
random - Batch create random face images
test - Automated tests
util - Utility functions
view - interactive GUI view of SAMs, FG files, FIM files (Windows only)

fg3pf

The FaceGen PhotoFit SDK CLI has the face-from-photo function. It is a paid license that includes full source code.

$> fg3pf

batch - Batch process photofits.
lms - automatically detect and place landmarks for frontal face photos
photofit - Create FG data from an image.
test - Automated photofit tests

fg3t

The FaceGen Integration Tools CLI contains tools for integrating FaceGen statistics with your meshes, along with some other tools. It is a closed-source binary-only tool.

$> fg3t

morphx - Spatially extrapolate morphs to an aligned mesh with different topology
nrr - Non-rigid registration of custom mesh to FaceGen internal shape
rebasex - Spatially extrapolate a base mesh morph to related assets
scan - Extract FaceGen shape coordinates from a 3D scan mesh
scm - Create an SCM (.jpg .egt [.fim] ) for a skin color map (head or body)
ssm - Create SSMs (.egm file) for base meshes (head or accessory)
ssmEyeC - Create shape-preserving SSMs (.egm files) for separate spherical eye meshes
ssmEyeI - Inject shape-preserving SSM data for spherical eyes into a body SSM (.egm)