Improve consistency of mesh face naming #101689

New Issue

Hans Goudey · 2022-10-07T23:42:27+02:00

Hans Goudey commented

2022-10-07 23:42:27 +02:00

Currently mesh polygon naming is inconsistent and confusing.
The UI, BMesh, and most other software use the term "Face" rather than "Polygon".
Combined with the legacy "MFace" storage, it's easy to get things confused.

This task proposes to clearly name the legacy structures and use the "faces" term instead of "polygons"

Original	New	Comments
`fdata`	`fdata_legacy`
`MFace`	`MFaceLegacy`
`totface`	`totface_legacy`
`mface`	`mface_legacy`
`pdata`	`face_data`
`totpoly`	`faces_num`
`MPoly`	`MFace`
`poly`	`face`	Including all variable names
`polys`	`faces`	Including all span and pointer variable names

Currently mesh polygon naming is inconsistent and confusing. The UI, BMesh, and most other software use the term "Face" rather than "Polygon". Combined with the legacy "MFace" storage, it's easy to get things confused. This task proposes to clearly name the legacy structures and use the "faces" term instead of "polygons" | Original | New | Comments | | ---- | ---- | ---- | | `fdata` | `fdata_legacy` | | | `MFace` | `MFaceLegacy` | | | `totface` | `totface_legacy` | | | `mface` | `mface_legacy` | | | `pdata` | `face_data` | | | `totpoly` | `faces_num` | | | `MPoly` | `MFace` | | | `poly` | `face` | Including all variable names | | `polys` | `faces` | Including all span and pointer variable names |

Howard Trickey commented

2022-10-08 12:08:13 +02:00

I would be very happy if this were done. Feels like a rather enormous task - the "including all variable names' part.

Can someone answer: are MFace's used for anything besides backward compatibility these days? If they are used then putting legacy in their rename would be wrong.

I would be very happy if this were done. Feels like a rather enormous task - the "including all variable names' part. Can someone answer: are MFace's used for anything besides backward compatibility these days? If they are used then putting legacy in their rename would be wrong.

Hans Goudey commented

2022-10-10 17:26:57 +02:00

Feels like a rather enormous task - the "including all variable names' part.

Yeah, I guess that could happen in steps. But the final goal should be consistency I think.

are MFace's used for anything besides backward compatibility these days?

They are used for the particle system. The plan is to replace it soon (first step was the new hair system, then generic simulations). They're definitely not being used in new code. I guess it depends what "legacy" really means, but to me it's true enough in this case.

> Feels like a rather enormous task - the "including all variable names' part. Yeah, I guess that could happen in steps. But the final goal should be consistency I think. >are MFace's used for anything besides backward compatibility these days? They are used for the particle system. The plan is to replace it soon (first step was the new hair system, then generic simulations). They're definitely not being used in new code. I guess it depends what "legacy" really means, but to me it's true enough in this case.

Philipp Oeser removed the

Original	New
`vdata`	`vert_data`
`edata`	`edge_data`
`ldata`	`corner_data`
`totvert`	`verts_num`
`totedge`	`edges_num`
`totloop`	`corners_num`

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Improve consistency of mesh face naming #101689