Node naming conventions
The following naming conventions are meant to be used as useful guidelines. They are not enforced by Bifrost.
- Use snake_case when naming your node.
- Do not nest your operators more than three namespaces deep.
- Only capitalize proper names and acronyms in your node name. For example
read_OpenVDB
andread_PDC
. - Capitalize your namespace names.
- Use singular form in your node name if it operates on one element, and use the plural form if it operates on more than one element. For example,
merge_meshes
merges two meshes and uses the plural form, whileerase_property
erases one property and uses the singular form. - Name your nodes as descriptively as possible while keeping the name as short as possible.
- If your node is a generic node that can operate on multiple types, keep its name simple. However, if your node does a specific operation, or operates on a specific type of element, you should include that in its name. For example,
multiply
is a generic multiplier, butmultiply_matrix
specifically does matrix multiplication. - Avoid giving nodes the same name even if they exist in different namespaces.