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

# Conflicts:
#	io_xplane2blender/xplane_config.py
#	io_xplane2blender/xplane_constants.py
#	io_xplane2blender/xplane_props.py
#	io_xplane2blender/xplane_types/xplane_material.py
#	tests/features/lights.test.blend

Author: tngreene

io_xplane2blender/xplane_config.py

@@ -19,7 +19,7 @@
 # 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 = 100
+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

@@ -240,6 +240,7 @@ def _get_all_manipulators():
 LIGHT_CUSTOM = "custom"
 LIGHT_PARAM = "param"
 LIGHT_AUTOMATIC = "automatic"
+LIGHT_SPILL_CUSTOM = "light_spill_custom"
 LIGHT_NON_EXPORTING = "nonexporting"
 
 LIGHTS_OLD_TYPES = {

io_xplane2blender/xplane_props.py

@@ -1853,9 +1853,10 @@ class XPlaneLightSettings(bpy.types.PropertyGroup):
                 (LIGHT_STROBE,    "Strobe"   + " (deprecated)", "Strobe"   + " (deprecated)"),
                 (LIGHT_TRAFFIC,   "Traffic"  + " (deprecated)", "Traffic"  + " (deprecated)"),
                 (LIGHT_NAMED,     "Named"    + " (deprecated)", "Makes named and named only lights, use automatic"),
-                (LIGHT_CUSTOM,    "Custom",                     "Custom"),
+                (LIGHT_CUSTOM,    "Custom Billboard",           "Custom billboard light"),
                 (LIGHT_PARAM,     "Manual Param (deprecated)",  "Uses manual entry for parameters, not recommended"),
                 (LIGHT_AUTOMATIC, "Automatic",                  "Makes named and param lights with params taken from Blender light data"),
+                (LIGHT_SPILL_CUSTOM, "Custom Spill",            "Custom spill light, with automatic parameter detection"),
                 (LIGHT_NON_EXPORTING, "Non-Exporting", "Light will not be in the OBJ"),
         ]
     )
@@ -1880,7 +1881,7 @@ class XPlaneLightSettings(bpy.types.PropertyGroup):
 
     dataref: bpy.props.StringProperty(
         name = 'Dataref',
-        description = "A X-Plane Dataref",
+        description = "An X-Plane Dataref",
         default = ""
     )
 

io_xplane2blender/xplane_types/xplane_light.py

@@ -1,7 +1,8 @@
 import math
 import re
 from copy import deepcopy
-from itertools import takewhile, tee, zip_longest
+from dataclasses import dataclass, field
+from itertools import chain, takewhile, tee, zip_longest
 from typing import Dict, List, Optional, Tuple, Union
 
 import bpy
@@ -17,6 +18,45 @@
 from ..xplane_helpers import floatToStr, logger, vec_b_to_x, vec_x_to_b
 
 
+@dataclass
+class _LightSpillCustomParams:
+    r: float
+    g: float
+    b: float
+
+    @property
+    def a(self):
+        return 1
+
+    size: float
+    dx: float
+    dy: float
+    dz: float
+    width: float
+    dataref: str
+
+    def __str__(self):
+        return " ".join(
+            chain(
+                map(
+                    floatToStr,
+                    (
+                        self.r,
+                        self.g,
+                        self.b,
+                        self.a,
+                        self.size,
+                        self.dx,
+                        self.dy,
+                        self.dz,
+                        self.width,
+                    ),
+                ),
+                (self.dataref,),
+            )
+        )
+
+
 class XPlaneLight(xplane_object.XPlaneObject):
     def __init__(self, blenderObject: bpy.types.Object):
         super().__init__(blenderObject)
@@ -63,6 +103,8 @@ def __init__(self, blenderObject: bpy.types.Object):
             self.params = {}
         elif self.lightType == LIGHT_PARAM:
             self.params = blenderObject.data.xplane.params
+        elif self.lightType == LIGHT_SPILL_CUSTOM:
+            self.params = _LightSpillCustomParams(*([0] * 8), "")
         else:
             self.params = None
 
@@ -379,7 +421,50 @@ def convert_table(param: str) -> float:
             logger.warn(unknown_light_name_warning)
         # X-Plane Light Type | Light Type | parsed_light | light_param_defs | Result
         # -------------------|------------|--------------|------------------|-------
-        # LIGHT_ old         | *          | N/A          | N/A              | Write
+        # LIGHT_SPILL_CUSTOM |"POINT/SPOT"| N/A          | N/A              | Fillout params, write
+        # LIGHT_SPILL_CUSTOM | Any others | N/A          | N/A              | Error
+        elif self.lightType == LIGHT_SPILL_CUSTOM and light_data.type not in {
+            "POINT",
+            "SPOT",
+        }:
+            logger.error(
+                f"Custom Spill lights must be a Point or Spot light, change {self.blenderObject.name}'s type or change it's X-Plane Light Type"
+            )
+            return
+        elif self.lightType == LIGHT_SPILL_CUSTOM and light_data.type in {
+            "POINT",
+            "SPOT",
+        }:
+            p = self.params
+            p.r, self.params.g, self.params.b = self.color
+            p.size = self.size
+
+            def width_param_new_value() -> float:
+                if light_data.type == "POINT":
+                    return 1
+                elif light_data.type == "SPOT":
+                    # cos(half the cone angle)
+                    return XPlaneLight.WIDTH_for_spill(light_data.spot_size)
+
+            def new_dxyz_vec_x() -> Vector:
+                """
+                Returns (potentially scaled) light direction
+                or (0, 0, 0) for omni lights in X-Plane coords
+                """
+
+                if light_data.type == "POINT":
+                    return Vector((0, 0, 0))
+                elif light_data.type == "SPOT":
+                    return vec_b_to_x(self.get_light_direction_b())
+                else:
+                    assert False, f"What is this light_data.type {light_data.type}"
+
+            p.dx, p.dy, p.dz = new_dxyz_vec_x()
+            p.width = width_param_new_value()
+            p.dataref = self.dataref
+        # X-Plane Light Type | Light Type | parsed_light | light_param_defs | Result
+        # -------------------|------------|--------------|------------------|-------
+        # LIGHT_{OLD_TYPES}  | *          | N/A          | N/A              | Write
         elif self.lightType in LIGHTS_OLD_TYPES:
             pass
         else:
@@ -587,6 +672,8 @@ def should_autocorrect_automatic() -> bool:
                 f" {' '.join(map(floatToStr,self.uv))}"
                 f" {self.dataref}\n"
             )
+        elif self.lightType == LIGHT_SPILL_CUSTOM:
+            o += f"{indent}LIGHT_SPILL_CUSTOM {translation_xp_str} {self.params}\n"
         # do not render lights with no indices
         elif self.indices[1] > self.indices[0]:
             offset = self.indices[0]

io_xplane2blender/xplane_types/xplane_material.py

@@ -143,7 +143,9 @@ def collect(self) -> None:
                         elif xplane_blend_enum == BLEND_ON:
                             self.attributes["ATTR_blend"].setValue(True)
                         elif xplane_blend_enum == BLEND_SHADOW:
-                            self.attributes['ATTR_shadow_blend'].setValue(mat.xplane.blendRatio)
+                            self.attributes["ATTR_shadow_blend"].setValue(
+                                mat.xplane.blendRatio
+                            )
                     elif xplane_version < 1000:
                         if mat.xplane.blend:
                             self.attributes["ATTR_no_blend"].setValue(

io_xplane2blender/xplane_ui.py

@@ -669,6 +669,29 @@ def mesh_layout(layout: bpy.types.UILayout, obj: bpy.types.Object) -> None:
 
 def light_layout(layout: bpy.types.UILayout, obj: bpy.types.Object) -> None:
     light_data = obj.data
+
+    def draw_dataref_search_window(
+        dataref_row: bpy.types.UILayout, layout: bpy.types.UILayout
+    ):
+        scene = bpy.context.scene
+        expanded = (
+            scene.xplane.dataref_search_window_state.dataref_prop_dest
+            == "bpy.context.active_object.data.xplane.dataref"
+        )
+        if expanded:
+            our_icon = "ZOOM_OUT"
+        else:
+            our_icon = "ZOOM_IN"
+        dataref_search_toggle_op = row.operator(
+            "xplane.dataref_search_toggle", text="", emboss=False, icon=our_icon
+        )
+        dataref_search_toggle_op.paired_dataref_prop = (
+            "bpy.context.active_object.data.xplane.dataref"
+        )
+        # Finally, in the next row, if we are expanded, build the entire search list.
+        if expanded:
+            dataref_search_window_layout(layout)
+
     layout.row().prop(light_data.xplane, "type")
 
     if light_data.xplane.type == LIGHT_AUTOMATIC and light_data.type not in {
@@ -798,6 +821,30 @@ def draw_automatic_ui():
                 # try_param("param_phase", "PHASE", "Phase")
 
         draw_automatic_ui()
+    elif light_data.xplane.type == LIGHT_SPILL_CUSTOM and light_data.type not in {
+        "POINT",
+        "SPOT",
+    }:
+        layout.row().label(
+            text="Custom Spill lights must use Point or Spot Blender Lights"
+        )
+    elif light_data.xplane.type == LIGHT_SPILL_CUSTOM and light_data.type in {
+        "POINT",
+        "SPOT",
+    }:
+        layout.row().prop(light_data.xplane, "size")
+        row = layout.row()
+        row.prop(light_data.xplane, "dataref")
+        draw_dataref_search_window(row, layout)
+        debug_box = layout.box()
+        debug_box.label(text="Calculated Values")
+        if light_data.type == "POINT":
+            WIDTH_val = "Omni"
+        elif light_data.type == "SPOT":
+            WIDTH_val = round(
+                xplane_types.XPlaneLight.WIDTH_for_spill(light_data.spot_size), 5
+            )
+        debug_box.row().label(text=f"Width: {WIDTH_val}")
     elif light_data.xplane.type == LIGHT_NAMED:
         layout.row().prop(light_data.xplane, "name")
     elif light_data.xplane.type == LIGHT_PARAM:
@@ -809,24 +856,7 @@ def draw_automatic_ui():
         layout.row().prop(light_data.xplane, "uv", text="")
         row = layout.row()
         row.prop(light_data.xplane, "dataref", text="Dataref")
-        scene = bpy.context.scene
-        expanded = (
-            scene.xplane.dataref_search_window_state.dataref_prop_dest
-            == "bpy.context.active_object.data.xplane.dataref"
-        )
-        if expanded:
-            our_icon = "ZOOM_OUT"
-        else:
-            our_icon = "ZOOM_IN"
-        dataref_search_toggle_op = row.operator(
-            "xplane.dataref_search_toggle", text="", emboss=False, icon=our_icon
-        )
-        dataref_search_toggle_op.paired_dataref_prop = (
-            "bpy.context.active_object.data.xplane.dataref"
-        )
-        # Finally, in the next row, if we are expanded, build the entire search list.
-        if expanded:
-            dataref_search_window_layout(layout)
+        draw_dataref_search_window(row, layout)
 
         layout.row().prop(light_data.xplane, "enable_rgb_override")
         if light_data.xplane.enable_rgb_override:

pyproject.toml

@@ -2,14 +2,17 @@
 line-length = 88
 include = '\.pyi?$'
 exclude = '''
-/(
-    \.git
-  | \.mypy_cache
-  | \.vs
-  | \.venv
-  | _build
-  | build
-  | dist
-  | tests
-)/
+(
+  /(
+      \.git
+    | \.mypy_cache
+    | \.vs
+    | \.venv
+    | _build
+    | build
+    | dist
+    | tests
+  )/
+  | tests/template.py
+)
 '''

tests/features/lights.test.blend

@@ -0,0 +1,18 @@
+I
+800
+OBJ
+
+POINT_COUNTS	0	0	0	0
+
+# 0 ROOT
+	# 1 Light: Spot_blank
+	# LIGHT: Spot_blank	weight: 10000
+	LIGHT_SPILL_CUSTOM 0 1 -0 1 1 1 1 15 0 1 -0.00000015 0.92387953 
+	# 1 Light: Spot_none
+	# LIGHT: Spot_none	weight: 10000
+	LIGHT_SPILL_CUSTOM 10 1 -0 1 1 1 1 15 0 1 -0.00000015 0.92387953 none
+	# 1 Light: Spot_traffic_light
+	# LIGHT: Spot_traffic_light	weight: 10000
+	LIGHT_SPILL_CUSTOM 20 1 -0 1 1 1 1 15 0 1 -0.00000015 0.92387953 sim/graphics/animation/lights/traffic_light
+
+# Build with Blender 2.80 (sub 75) (build b'f6cb5f54494e'). Exported with XPlane2Blender 4.0.0-dev.0+90.NO_BUILD_NUMBR

tests/lights/fixtures/light_spill_custom/test_light_spill_custom_dref.obj

@@ -0,0 +1,21 @@
+I
+800
+OBJ
+
+POINT_COUNTS	0	0	0	0
+
+# 0 ROOT
+	# 1 Light: Spot_aa_backish_68.5_-.907_0,087_-.413_pink
+	# LIGHT: Spot_aa_backish_68.5_-.907_0,087_-.413_pink	weight: 10000
+	LIGHT_SPILL_CUSTOM 0 10 5 1 0 1 1 35 -0.54601967 0.35867152 0.75711119 0.92387953 
+	# 1 Light: Spot_down_0_0_0_red
+	# LIGHT: Spot_down_0_0_0_red	weight: 10000
+	LIGHT_SPILL_CUSTOM -20 10 -0 1 0 0 1 35 0 -1 -0 0.92387953 
+	# 1 Light: Spot_forward_90_0_0_blue
+	# LIGHT: Spot_forward_90_0_0_blue	weight: 10000
+	LIGHT_SPILL_CUSTOM -10 10 -0 0 0 1 1 35 0 0.00000004 -1 0.92387953 
+	# 1 Light: Spot_right_90_0_-90_green
+	# LIGHT: Spot_right_90_0_-90_green	weight: 10000
+	LIGHT_SPILL_CUSTOM 0 10 -0 0 1 0 1 35 1 0.00000004 0.00000004 0.92387953 
+
+# Build with Blender 2.80 (sub 75) (build b'f6cb5f54494e'). Exported with XPlane2Blender 4.0.0-dev.0+90.NO_BUILD_NUMBR