manual_compatibility.py

import bpy
import math
from ..nodes import TREE_TYPES
from ..utils.node import find_nodes

# TODO:
#  * The ImagePipeline tonemapper default settings were changed: auto brightness is now disabled by default (was enabled),
#    gain is now 1.0 by default (was 0.5)

# TODO prevent user from pressing the button twice

def calc_power_correction_factor(spread_angle):
    return math.pi * (2 * math.pi * (1 - math.cos(spread_angle / 2)))


class LUXCORE_OT_convert_to_v23(bpy.types.Operator):
    bl_idname = "luxcore.convert_to_v23"
    bl_label = "Convert Scene From v2.2 or Earlier to v2.3"
    bl_description = ""
    bl_options = {"UNDO"}

    @classmethod
    def poll(cls, context):
        return True

    def execute(self, context):
        """
        When this operator is run, we can assume that the scene was saved with v2.2 or earlier, and is now open in v2.3.
        (which we can't assume in the utils/compatibility.py script)
        """

        for light in bpy.data.lights:
            if light.type == "SUN":
                if light.luxcore.light_type == "sun":
                    # Sun and sky now have a separate gain property with default 0.00002 to prevent overexposion
                    # with default tonemapper settings. In old scenes, copy the old gain value.
                    light.luxcore.sun_sky_gain = light.luxcore.gain
                elif light.luxcore.light_type == "distant":
                    # The distant light is now normalized by default. For scenes created in older versions,
                    # disable the normalize option to get the same result
                    light.luxcore.normalize_distant = False
            else:
                # LuxCore behaviour is to use only the gain if power or efficacy are 0, so in this case
                # it is ok to leave the new default "artistic" which uses only gain
                if light.luxcore.power != 0 and light.luxcore.efficacy != 0:
                    light.luxcore.light_unit = "power"
                    light.luxcore.power *= light.luxcore.gain

                    if light.type == "AREA" and not light.luxcore.is_laser:
                        light.luxcore.power *= calc_power_correction_factor(light.luxcore.spread_angle)

            light.update_tag()

        for world in bpy.data.worlds:
            if world.luxcore.light == "sky2":
                # Sun and sky now have a separate gain property with default 0.00002 to prevent overexposion
                # with default tonemapper settings. In old scenes, copy the old gain value.
                world.luxcore.sun_sky_gain = world.luxcore.gain
                world.update_tag()

        for node_tree in bpy.data.node_groups:
            if node_tree.bl_idname not in TREE_TYPES:
                continue

            # Note: for some reason we don't have to disable the new normalize option.

            for emission_node in find_nodes(node_tree, "LuxCoreNodeMatEmission", False):
                # LuxCore behaviour is to use only the gain if power or efficacy are 0, so in this case
                # it is ok to leave the new default "artistic" which uses only gain
                if emission_node.power != 0 and emission_node.efficacy != 0:
                    emission_node.emission_unit = "power"
                    emission_node.power *= emission_node.gain * calc_power_correction_factor(emission_node.spread_angle)

        return {"FINISHED"}