This is a description of the general structure of the MPFB code.
The code consists of a few different types of files:
- Data: these are not code files per se. Rather they are things such as JSON data files containing definitions of rigs or materials, or mesh objects.
- Service: this is either a stateless or singleton type of class with utility code. You will normally not manually instantiate these classes.
- Entity: this is a stateful class which is instantiated when performing an operation. Its instances might be long- or short lived.
- Operator: in this case this is something that happens as a reaction to a click in the UI. While there could in theory be other types of operators in Blender, this is currently the only type implemented.
- Panel: this is a visible area in the interface.
Outside of this there are some glue kind of files such as module descriptors and helper scripts.
All system data that is bundled with MPFB is located under src/mpfb/data.
If you want to find where a rig or a material is defined, or where a target is loaded from, this is where you would look.
The bulk of the logic is to be found here. This is where you should start looking if you need to find code logic.
As said above, the services are either completely stateless, or are implemented as singletons. You will normally get access to it by simply importing its global instance. For example the HumanService:
from mpfb.services.humanservice import HumanService
After which you can call methods defined on HumanService. From a coding point of view it should not make any difference if the service is a singleton or a stateless class.
The following services are available:
- AssetService contains logic for locating and listing assets
- ClothesService contains logic for loading MHCLO type assets and fitting them to the base mesh
- HumanService contains logic for constructing, serializing and deserializing humans. It also contains logic for equipping assets on the human by calling relevant methods in other services.
- LocationService contains logic for resolving path location the the MPFB system and user data directories.
- LogService contains logic for logging and profiling.
- MaterialService contains logic for loading and manipulating materials. This includes both procedural materials and materials loaded from MHMAT.
- NodeService contains logic for manipulating node trees, including serializing and deserializing them to/from json. It is closely related to the MaterialService.
- ObjectService contains logic for locating, selecting and activating objects.
- RigService contains logic for manipulating rigs and bones, including serializing and deserializing them to/from json. Note that there is a lot of related logic in other parts of the code, particularly in Rig and righelpers
- SocketService contains logic for online imports from MakeHuman via a local socket connection. Note the related logic in socketobject
- SystemService contains some platform-specific utility calls, such as a method for opening a web browser a specific location.
- TargetService contains logic loading targets and manipulating shape keys
- UiService contains logic for working with the user interface.
To be written
The user interface logic (Operators and panels)
The user interface is defined under src/mpfb/ui. The general principle is that each part of the user interface is placed in its own subfolder, although in some cases related panels are placed in the same subfolder.
The general structure of the ui folder is:
- There is an __init__.py file which imports all relevant parts (panels and operators) so that they become known to the system
- There is a file called *panel.py which contains the actual user interface definition
- The logic (what happens when you click a button etc) is placed in a subdirectory called “operators”. Each button will have its own code file in this subdirectory.
- Relevant scene- and object properties are defined in json files in a subdirectory called “properties”. These are, for example, text input boxes or checkboxes.
As an example of the last bullet, here is the checkbox for “Fit to body” which is in the asset loading panel:
"description": "Adjust the shape of the imported clothes to fit the selected human",
"label": "Fit to body",
To be written: describe how these are loaded via SceneConfigSet and BlenderConfigSet…