Cell.add_face

Cell.add_face(vertices, fkey=None, attr_dict=None, **kwattr)

Add a face to the mesh object.

Parameters

• vertices (list[int]) – A list of vertex keys.

• attr_dict (dict[str, Any], optional) – A dictionary of face attributes.

• **kwattr (dict[str, Any], optional) – A dictionary of additional attributes compiled of remaining named arguments.

Returns

int – The key of the face.

Raises

TypeError – If the provided face key is of an unhashable type.

Notes

If no key is provided for the face, one is generated automatically. An automatically generated key is an integer that increments the highest integer value of any key used so far by 1.

If a key with an integer value is provided that is higher than the current highest integer key value, then the highest integer value is updated accordingly.