Merge branch 'develop' into 312-light-spill-custom

# Conflicts:
#	io_xplane2blender/xplane_config.py
#	io_xplane2blender/xplane_constants.py
#	io_xplane2blender/xplane_props.py
#	io_xplane2blender/xplane_ui.py

Author: tngreene

io_xplane2blender/__init__.py

@@ -25,7 +25,7 @@
     "name": "Export: X-Plane (.obj)",
     "description": "Export X-Plane objects/planes (.obj format)",
     "author": "Ted Greene, Ben Supnik",
-    "version": (4, 0, 0),
+    "version": (4, 1, 0),
     "blender": (2, 80, 0),
     "location": "File > Import/Export > X-Plane",
     "warning": "",

io_xplane2blender/tests/__init__.py

@@ -14,12 +14,16 @@
 from io_xplane2blender.tests import animation_file_mappings, test_creation_helpers
 from io_xplane2blender.xplane_config import getDebug, setDebug
 from io_xplane2blender.xplane_helpers import XPlaneLogger, logger
-from io_xplane2blender.xplane_types import xplane_bone, xplane_file, xplane_primitive
+from io_xplane2blender.xplane_types import (
+    xplane_attribute,
+    xplane_bone,
+    xplane_file,
+    xplane_primitive,
+)
 
 FLOAT_TOLERANCE = 0.0001
 
 __dirname__ = os.path.dirname(__file__)
-TMP_DIR = os.path.realpath(os.path.join(__dirname__, "../../tests/tmp"))
 
 FilterLinesCallback = Callable[[List[Union[float, str]]], bool]
 
@@ -189,10 +193,10 @@ def assertFloatVectorsEqual(
         for a_comp, b_comp in zip(a, b):
             self.assertFloatsEqual(a_comp, b_comp, tolerance)
 
-    def parseFileToLines(self, data: str) -> List[Union[float, str]]:
+    def parseFileToLines(self, data: str) -> List[Tuple[Union[float, str]]]:
         """
-        Turns a string of \n seperated lines into a List[Union[float,str]]
-        without comments or 0 length strings. All numeric parts are converted
+        Turns a string of \n seperated lines into a list of lines
+        without comments or 0 length strings with all numeric parts are converted
         """
         lines = []  # type: List[Union[float,str]]
 
@@ -208,7 +212,7 @@ def tryToFloat(part: str) -> Union[float, str]:
             line = line.strip()
             if line:
                 if line.startswith("800"):
-                    lines.append(line.split())
+                    lines.append(tuple(line.split()))
                 else:
                     lines.append(tuple(map(tryToFloat, line.split())))
 
@@ -414,7 +418,7 @@ def assertLayerExportEqualsFixture(
         - layer_number starts at 0, as it used to access the scene.layers collection
         """
         # if not ('-q' in sys.argv or '--quiet' in sys.argv):
-        # print("Comparing: '%s', '%s'" % (tmpFilename, fixturePath))
+        #     print("Comparing: '%s', '%s'" % (tmpFilename, fixturePath))
 
         out = self.exportExportableRoot(
             bpy.data.collections[f"Layer {layer_number + 1}"], tmpFilename
@@ -446,34 +450,35 @@ def assertExportableRootExportEqualsFixture(
     # asserts that an attributes object equals a dict
     def assertAttributesEqualDict(
         self,
-        attrs: List[str],
+        attrs: List[Union[str, xplane_attribute.XPlaneAttribute]],
         d: Dict[str, Any],
         floatTolerance: float = FLOAT_TOLERANCE,
     ):
-        self.assertEquals(len(d), len(attrs), "Attribute lists have different length")
+        self.assertEquals(
+            len(d),
+            len(attrs),
+            f"Attribute lists {list(d.keys())}, {list(attrs.keys())} have different length",
+        )
 
         for name in attrs:
             attr = attrs[name]
             value = attr.getValue()
             expectedValue = d[name]
 
-            if isinstance(expectedValue, list) or isinstance(expectedValue, tuple):
-                self.assertTrue(
-                    isinstance(value, list) or isinstance(value, tuple),
-                    'Attribute value for "%s" is no list or tuple but: %s'
-                    % (name, str(value)),
+            if isinstance(expectedValue, (list, tuple)):
+                self.assertIsInstance(
+                    value,
+                    (list, tuple),
+                    msg='Attribute value for "%s" is no list or tuple but: %s',
                 )
                 self.assertEquals(
                     len(expectedValue),
                     len(value),
                     'Attribute values for "%s" have different length' % name,
                 )
 
-                for i in range(0, len(expectedValue)):
-                    v = value[i]
-                    expectedV = expectedValue[i]
-
-                    if isinstance(expectedV, float) or isinstance(expectedV, int):
+                for i, (v, expectedV) in enumerate(zip(value, expectedValue)):
+                    if isinstance(expectedV, (float, int)):
                         self.assertFloatsEqual(expectedV, v, floatTolerance)
                     else:
                         self.assertEquals(
@@ -564,7 +569,7 @@ def exportExportableRoot(
         xplane_file._all_keyframe_infos.clear()
 
         if dest:
-            with open(os.path.join(TMP_DIR, dest + ".obj"), "w") as tmp_file:
+            with open(os.path.join(get_tmp_folder(), dest + ".obj"), "w") as tmp_file:
                 tmp_file.write(out)
 
         return out
@@ -640,18 +645,22 @@ def filterLine(line):
 
 def get_source_folder() -> pathlib.Path:
     """Returns the full path to the addon folder"""
-    return os.path.dirname(pathlib.Path("..", __file__))
+    return pathlib.Path(__file__).parent
 
 
 def get_project_folder() -> pathlib.Path:
     """Returns the full path to the project folder"""
-    return os.path.dirname(pathlib.Path("..", "..", __file__))
+    return pathlib.Path(__file__).parent.parent.parent
 
 
 def get_tests_folder() -> pathlib.Path:
     return pathlib.Path(get_project_folder(), "tests")
 
 
+def get_tmp_folder() -> pathlib.Path:
+    return os.path.realpath(os.path.join(__dirname__, "../../tests/tmp"))
+
+
 def make_fixture_path(dirname, filename, sub_dir=""):
     return os.path.join(dirname, "fixtures", sub_dir, filename + ".obj")
 

io_xplane2blender/xplane_config.py

@@ -10,16 +10,16 @@
 CURRENT_ADDON_VERSION: Tuple[int, int, int] = bl_info["version"]
 
 # The current build type, must be a member of XPlane2BlenderVersion.BUILD_TYPE
-CURRENT_BUILD_TYPE = xplane_constants.BUILD_TYPE_DEV
+CURRENT_BUILD_TYPE = xplane_constants.BUILD_TYPE_BETA
 
 # The current build type version, must be > 0
 # if not BUILD_TYPE_DEV or BULD_TYPE_LEGACY
-CURRENT_BUILD_TYPE_VERSION = 0
+CURRENT_BUILD_TYPE_VERSION = 1
 
 # The current data model version, incrementing every time xplane_constants, xplane_props, or xplane_updater
 # changes. Builds earlier than 3.4.0-beta.5 have and a version of 0.
 # When merging, take the higher data model version of the two branches and add one
-CURRENT_DATA_MODEL_VERSION = 90
+CURRENT_DATA_MODEL_VERSION = 101
 
 # The build number, hardcoded by the build script when there is one, otherwise it is xplane_constants.BUILD_NUMBER_NONE
 CURRENT_BUILD_NUMBER = xplane_constants.BUILD_NUMBER_NONE

io_xplane2blender/xplane_constants.py

@@ -91,6 +91,21 @@ def _get_resources_folder() -> str:
 CONDITION_GLOBAL_SHADOWS = "GLOBAL_SHADOWS"
 CONDITION_VERSION10 = "VERSION10"
 
+COCKPIT_FEATURE_NONE = "none"
+# See panel modes as well
+COCKPIT_FEATURE_PANEL = "panel"
+COCKPIT_FEATURE_DEVICE = "device"
+
+DEVICE_GNS430_1 = "GNS430_1"
+DEVICE_GNS430_2 = "GNS430_2"
+DEVICE_GNS530_1 = "GNS530_1"
+DEVICE_GNS530_2 = "GNS530_2"
+DEVICE_CDU739_1 = "CDU739_1"
+DEVICE_CDU739_2 = "CDU739_2"
+DEVICE_G1000_PFD1 = "G1000_PFD1"
+DEVICE_G1000_MFD = "G1000_MFD"
+DEVICE_G1000_PFD2 = "G1000_PFD2"
+
 MANIP_DRAG_XY = "drag_xy"
 MANIP_DRAG_AXIS = "drag_axis"
 MANIP_COMMAND = "command"
@@ -226,6 +241,7 @@ def _get_all_manipulators():
 LIGHT_PARAM = "param"
 LIGHT_AUTOMATIC = "automatic"
 LIGHT_SPILL_CUSTOM = "light_spill_custom"
+LIGHT_NON_EXPORTING = "nonexporting"
 
 LIGHTS_OLD_TYPES = {
     LIGHT_DEFAULT,
@@ -248,3 +264,7 @@ def _get_all_manipulators():
     LOGGER_LEVEL_SUCCESS,
     LOGGER_LEVEL_WARN,
 )
+
+PANEL_COCKPIT = "cockpit"
+PANEL_COCKPIT_LIT_ONLY = "cockpit_lit_only"
+PANEL_COCKPIT_REGION = "cockpit_region"

io_xplane2blender/xplane_helpers.py

@@ -9,7 +9,7 @@
 import mathutils
 
 import io_xplane2blender
-from io_xplane2blender import xplane_config, xplane_constants
+from io_xplane2blender import xplane_config, xplane_constants, xplane_props
 from io_xplane2blender.xplane_constants import PRECISION_OBJ_FLOAT
 
 """
@@ -63,6 +63,20 @@ def resolveBlenderPath(path: str) -> str:
         return path
 
 
+def effective_normal_metalness(xp_file: "xplane_file.XPlaneFile") -> bool:
+    return (
+        int(bpy.context.scene.xplane.version) >= 1100
+        and xp_file.options.normal_metalness
+    )
+
+
+def effective_normal_metalness_draped(xp_file: "xplane_file.XPlaneFile") -> bool:
+    return (
+        int(bpy.context.scene.xplane.version) >= 1100
+        and xp_file.options.normal_metalness_draped
+    )
+
+
 def get_plugin_resources_folder() -> str:
     return os.path.join(os.path.dirname(__file__), "resources")
 
@@ -195,11 +209,11 @@ def vec_x_to_b(v) -> mathutils.Vector:
 class VerStruct:
     def __init__(
         self,
-        addon_version: Tuple[int, int, int] = None,
-        build_type: str = None,
-        build_type_version: int = None,
-        data_model_version: int = None,
-        build_number=None,
+        addon_version: Optional[Tuple[int, int, int]] = None,
+        build_type: Optional[str] = None,
+        build_type_version: Optional[int] = None,
+        data_model_version: Optional[int] = None,
+        build_number: Optional[str] = None,
     ):
         # fmt: off
         self.addon_version      = tuple(addon_version) if addon_version      is not None else (0,0,0)
@@ -279,7 +293,7 @@ def __str__(self):
     # according to our spec
     #
     # Returns True or False
-    def is_valid(self):
+    def is_valid(self) -> bool:
         types_correct = (
             isinstance(self.addon_version, tuple)
             and len(self.addon_version) == 3
@@ -354,13 +368,17 @@ def is_valid(self):
                         return True
             else:
                 print("build_type %s was not found in BUILD_TYPES" % self.build_type)
+                return False
         else:
             print("addon_version %s is invalid" % str(self.addon_version))
             return False
 
     @staticmethod
-    def add_to_version_history(version_to_add):
-        history = bpy.context.scene.xplane.xplane2blender_ver_history
+    def add_to_version_history(
+        scene: bpy.types.Scene,
+        version_to_add: Union["VerStruct", "xplane_props.XPlane2BlenderVersion"],
+    ):
+        history = scene.xplane.xplane2blender_ver_history
 
         if len(history) == 0 or history[-1].name != repr(version_to_add):
             new_hist_entry = history.add()
@@ -396,6 +414,18 @@ def current():
             xplane_config.CURRENT_BUILD_NUMBER,
         )
 
+    @staticmethod
+    def from_version_entry(
+        version_entry: "xplane_props.XPlane2BlenderVersion",
+    ) -> "VerStruct":
+        return VerStruct(
+            version_entry.addon_version,
+            version_entry.build_type,
+            version_entry.build_type_version,
+            version_entry.data_model_version,
+            version_entry.build_number,
+        )
+
     @staticmethod
     def make_new_build_number():
         # Use the UNIX Timestamp in UTC