Model.morphmanagefacemark#

Model.morphmanagefacemark(mvol_entity, face_id, mlist, mode)#

Allows you to add a face, subtract a face, or clear all faces from a specified morph volume face user mark. Because morph volumes can share faces, the morph volume ID for the face must also be specified when adding or subtracting a face. When clearing a collection the morph volume ID field can hold any value. Since morph volume faces are not treated as independent entities, collections containing faces can only be managed through this external function. For functions that require face marks as input, this function must be used to place faces on the collection. The collection should be cleared before and after use to ensure clean operation.

Parameters:

  • mvol_entity (Entity) – The morph volume entity.

  • face_id (int) – The ID of the morph volume face.

  • mlist (int) – The ID of the user mark. Valid values are 0-3.

  • mode (int) –

    1 - Add face to mlist

    2 - Subtract face from mlist

    3 - Clear all faces from mlist

Example#

Add a face to the mark#
import hm
import hm.entities as ent

model = hm.Model()

model.morphmanagefacemark(
    mvol_entity=ent.Morphvolume(model, 2), face_id=4, mlist=0, mode=1
)
Clear the first user mark#
import hm
import hm.entities as ent

model = hm.Model()

model.morphmanagefacemark(
    mvol_entity=ent.Morphvolume(model, 0), face_id=0, mlist=0, mode=3
)