Skip to content
This repository has been archived by the owner on Jul 21, 2024. It is now read-only.

Commit

Permalink
Documentation Update
Browse files Browse the repository at this point in the history
- Updated docs and images
  • Loading branch information
animate1978 committed Nov 14, 2019
1 parent efeec52 commit 30c6810
Show file tree
Hide file tree
Showing 8 changed files with 114 additions and 24 deletions.
117 changes: 100 additions & 17 deletions docs/dev_modules.rst
Original file line number Diff line number Diff line change
@@ -1,58 +1,141 @@
MB-Lab Modules
==============

===========


============
Main Modules
============

The main modules are derived from the original code of ManuelBastioiLAB ver 1.6.1

Since the beginning of the fork this code has evolved and expanded over time.

-----------
_ init _.py
===========
-----------
This is the core of the addon.

* Function calls
* UI Elements

=============
-------------
algorithms.py
=============
-------------

Contains various functions for every engine.

* Example - https://github.com/animate1978/MB-Lab/blob/3994f37e33699bd0d082a4f9f076724e4f0d40ba/algorithms.py#L1332

==================
------------------
animationengine.py
==================
Handles the animation import and assigning to skeleton...
------------------

Handles the animation import and assigning to skeleton

* Retargeting
* Identifies Bones
* Similar functions (expand)
* Loads BVH files, saves and loads poses.

===========
-----------
humanoid.py
===========
-----------

Handles much of the character changing functions including Auto-Modelling.

=================
-----------------
materialengine.py
=================
-----------------

This is where the image textures get loaded and applied to nodes

==============
--------------
morphengine.py
==============
--------------

This is where the morphs of the character are loaded from JSON files


==============
--------------
proxyengine.py
==============
--------------

Handles the Proxy Fitting functions

=================
-----------------
skeletonengine.py
=================
-----------------

Loads and applies the skeleton (either FK or IK) to the character

===========
New Modules
===========

The new modules have been added over time to support the main code.


-------------
hairengine.py
-------------

This is the code that applies the hair to MB-Lab characters

-----------
file_ops.py
-----------

Contains code that handle file operations

---------------
material_ops.py
---------------

Contain functions that control some of the materials in MB-Lab

-------------
object_ops.py
-------------

Contain functions that help in object manipulation

----------
facerig.py
----------

This is the code that controls the face rig

--------------
preferences.py
--------------

Related to the Auto-updater

--------
utils.py
--------

Contain helper code for other engines

---------------------
humanoid_rotations.py
---------------------

Contains code for the human rotation limit feature

=====================
Addon Updater Modules
=====================

----------------
addon_updater.py
----------------

The main code for the auto-updater

--------------------
addon_updater_ops.py
--------------------

Contains functions and the settings for the auto-updater
2 changes: 1 addition & 1 deletion docs/getstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Pressing the "create character" button, Blender will create the selected model,

MB-Lab was redesigned for Blender 2.80 and now has shading networks for both Cycles and EEVEE. Choosing either option will also select the render engine required.

The option "Use portrait studio lights" is to create a set of lights in order to reproduce a professional studio setup.
The option "Use portrait studio lights" creates a set of lights.

.. image:: images/threepoint_arealights_01.png

Expand Down
8 changes: 7 additions & 1 deletion docs/hair_system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ Hair System

The new Hair Engine allows the ability to add particle hair to a MB-Lab character after finalization.

.. image:: images/hair_full_render_002.png

The particle hair can be accessed in ASSETS AND HAIR.

.. image:: images/GUI_hair_01.png

Features

- Add hair from selected polygons.
Expand Down Expand Up @@ -59,7 +65,7 @@ Add more Hair!
NOTES
=====

The Hair Engine is a brnad new feature and is evolving at a fast pace, expect the code to change
The Hair Engine is a brand new feature and is evolving at a fast pace, expect the code to change

Currently there is no shader assigned to the Hair system upon creation, this is actively being worked on and should appear soon.

Binary file added docs/images/hair_full_render_002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/hair_render_002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/new_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,16 @@ This version was improved mainly by contributors in the MB-Lab community!

* Hair Engine

.. image:: images/hair_render_002.png

The long awaited Hair Engine allows you to add particle hair to finalized MB-Lab characters.

* Human Rotation Limits

Adds rotation limits to MB-Lab armatures (need to be in POSE mode)

.. image:: images/GUI_hum_rotate_01.png

* Muscle System fixed

There were some serious bugs related to the Muscle system of MB-Lab that had gone unnoticed for some time
Expand Down
5 changes: 0 additions & 5 deletions file_ops.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,6 @@ def generate_items_list(folderpath, file_type="json"):
return items_list







# Append humanoid objects

def import_object_from_lib(lib_filepath, name, final_name=None, stop_import=True):
Expand Down
2 changes: 2 additions & 0 deletions material_ops.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ##### END GPL LICENSE BLOCK #####
#
# ManuelbastioniLAB - Copyright (C) 2015-2018 Manuel Bastioni

import logging
import bpy
Expand Down

0 comments on commit 30c6810

Please sign in to comment.