ExportSettings
human/process/settings.pyInherits from Settings
Everything the process system needs to process a human.
| Attributes | ||
|---|---|---|
| version | int | — |
| recipe | str | — |
| output | OutputSettings | — |
| lods | List[QualitySettings] | — |
| meshes | MeshSettings | — |
| haircards | HaircardSettings | — |
| skeleton | SkeletonSettings | — |
| shape_keys | ShapeKeySettings | — |
| textures | TextureBakeSettings | — |
| animations | AnimationClipSettings | — |
| scripts | ScriptsSettings | — |
| Methods | ||
| from_dict() | ExportSettings | Settings from a dict, see `Settings.from_dict`. |
| from_recipe() | ExportSettings | Settings of a recipe, shipped or from the content folder. |
| save_recipe() | str | Writes the settings as recipe file for the user, in a group folder. |
| to_json() | str | The settings as JSON string, for storing on the result. |
| from_json() | ExportSettings | Settings from a JSON string made by `to_json`. |
| differs_from() | bool | Whether any setting other than the recipe name differs. |
| resolved_name() | str | The output name with the tokens filled in, see `OutputSettings.resolved_name`. |
| to_dict() | Dict[str, Any] | The settings as plain dict, nested settings included.from Settings |
| copy() | T | A deep copy.from Settings |
Attributes
No description yet.
No description yet.
human.process.settings.output: OutputSettings
sourceNo description yet.
human.process.settings.lods: List[QualitySettings]
sourceNo description yet.
human.process.settings.meshes: MeshSettings
sourceNo description yet.
human.process.settings.haircards: HaircardSettings
sourceNo description yet.
human.process.settings.skeleton: SkeletonSettings
sourceNo description yet.
human.process.settings.shape_keys: ShapeKeySettings
sourceNo description yet.
human.process.settings.textures: TextureBakeSettings
sourceNo description yet.
human.process.settings.animations: AnimationClipSettings
sourceNo description yet.
human.process.settings.scripts: ScriptsSettings
sourceNo description yet.
Methods
ExportSettings.from_dict(data: Dict[str, Any]) → ExportSettingsclass method
sourceSettings from a dict, see Settings.from_dict.
| Parameter | Type | Description |
|---|---|---|
| data | Dict[str, Any] | — |
Returns ExportSettings
ExportSettings.from_recipe(recipe: str) → ExportSettingsclass method
sourceSettings of a recipe, shipped or from the content folder.
| Parameter | Type | Description |
|---|---|---|
| recipe | str | Identifier from `recipe_items`, or a path of a recipe file. |
Returns ExportSettings — The settings of the recipe.
Raises FileNotFoundError — If there is no such recipe.
human.process.settings.save_recipe(folder: str, name: str) → str
sourceWrites the settings as recipe file for the user, in a group folder.
| Parameter | Type | Description |
|---|---|---|
| folder | str | Group folder inside the recipe folder of the content folder, created if needed. |
| name | str | Name of the recipe, becomes the file name. |
Returns str — Path of the written file.
The settings as JSON string, for storing on the result.
Returns str
ExportSettings.from_json(text: str) → ExportSettingsclass method
sourceSettings from a JSON string made by to_json.
| Parameter | Type | Description |
|---|---|---|
| text | str | — |
Returns ExportSettings
human.process.settings.differs_from(other: ExportSettings) → bool
sourceWhether any setting other than the recipe name differs.
| Parameter | Type | Description |
|---|---|---|
| other | ExportSettings | — |
Returns bool
human.process.settings.resolved_name(human_name: str) → str
sourceThe output name with the tokens filled in, see OutputSettings.resolved_name.
| Parameter | Type | Description |
|---|---|---|
| human_name | str | — |
Returns str
The settings as plain dict, nested settings included.
Returns Dict[str, Any]
A deep copy.
Returns T