dnacalib_api.md

API overview

DNA modification is done through available commands. Each command implements the run(DNACalibDNAReader* output) method that modifies the DNA specified through its argument. To configure the modification that occurs in run(), parameters can be passed through constructor or specific setter methods. The following documentation is for C++. Currently, there is no Python documentation.

List of all available commands:

Commands that remove certain parts of DNA:

• RemoveJointAnimationCommand Removes animation of joint with given index from the DNA.

• RemoveJointCommand Removes joint with given index from the DNA.

• RemoveMeshCommand Removes mesh with given index from the DNA.

• ClearBlendShapesCommand Clears all blend shape data from the DNA.

Commands that rename certain parts of DNA:

• RenameAnimatedMapCommand Renames animated map with given index or previous name.

• RenameBlendShapeCommand Renames blendshape with given index or previous name.

• RenameJointCommand Renames joint with given index or previous name.

• RenameMeshCommand Renames mesh with given index or previous name.

Commands that transform DNA:

• RotateCommand Rotates neutral joints and vertex positions around given origin.

• ScaleCommand Scales neutral joints, vertex positions, and joint and blendshape deltas by a factor. For neutral joints and joint deltas, only translation attributes are scaled.

• TranslateCommand Translates neutral joints and vertex positions.

Commands that modify blendshapes:

• SetBlendShapeTargetDeltasCommand Changes blendshape target deltas.

• PruneBlendShapeTargetsCommand Prunes blendshape target deltas which are lower than or equal to the specified threshold.

Commands that change bind pose:

• SetNeutralJointRotationsCommand Sets new rotation values to neutral joints.

• SetNeutralJointTranslationsCommand Sets new translation values to neutral joints.

• SetVertexPositionsCommand Changes vertex positions values.

Commands that perform useful calculations or provide additional functionality:

• SetLODsCommand Filters DNA so that it only contains data for specified LODs.

• CalculateMeshLowerLODsCommand Recalculates vertex positions for lower LOD meshes of the specified mesh.

• CommandSequence Runs a sequence of commands on the specified DNA.

A more detailed description of each available command and its methods can be found in DNACalib/include/dnacalib/commands.