preferences.py

# ##### BEGIN GPL LICENSE BLOCK #####
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ##### END GPL LICENSE BLOCK #####


"""Addon preferences"""

import os
import platform

import bpy
from bpy.props import BoolProperty, EnumProperty, FloatProperty, StringProperty
from bpy.types import AddonPreferences

from . import paths, ui

preferences_tabs = [
    ("OPTIONS", "Options", ""),
    ("IMPORT", "Import", ""),
    ("EXPORT", "Export", ""),
    ("DEBUG", "Debug", ""),
    ("HELP", "Troubleshooting", ""),
]


class GoB_Preferences(AddonPreferences):
    bl_idname = __package__
    tabs: EnumProperty(name="Tabs", items=preferences_tabs, default="OPTIONS")

    def on_x_axis_remap_change(self, context):
        x_axis = self.remap_x_axis
        if x_axis == self.remap_y_axis:
            if x_axis != "X":
                self.remap_y_axis = "X"
            else:
                self.remap_y_axis = "Y"
        if x_axis == self.remap_z_axis:
            if x_axis != "X":
                self.remap_z_axis = "X"
            else:
                self.remap_z_axis = "Z"
        else:
            pass

    def on_y_axis_remap_change(self, context):
        y_axis = self.remap_y_axis
        if y_axis == self.remap_x_axis:
            if y_axis != "Y":
                self.remap_x_axis = "Y"
            else:
                self.remap_x_axis = "X"
        if y_axis == self.remap_z_axis:
            if y_axis != "Y":
                self.remap_z_axis = "Y"
            else:
                self.remap_z_axis = "Z"
        else:
            pass

    def on_z_axis_remap_change(self, context):
        z_axis = self.remap_z_axis
        if z_axis == self.remap_x_axis:
            if z_axis != "Z":
                self.remap_x_axis = "Z"
            else:
                self.remap_x_axis = "X"
        if z_axis == self.remap_y_axis:
            if z_axis != "Z":
                self.remap_y_axis = "Z"
            else:
                self.remap_y_axis = "Y"
        else:
            pass

    # GLOBAL
    zbrush_exec: StringProperty(
        name="ZBrush Path",
        description="Select Zbrush executable (C:\Program Files\Pixologic\ZBrush\ZBrush.exe). "
        "\nIf not specified the system default for Zscript (.zsc) files will be used",
        subtype="FILE_PATH",
        default="",
    )  # Default: ""

    use_pixologic_path: BoolProperty(
        name="Find Pixologic Version",
        description="When enabled the addon will search for the Pixologic ZBrush executable over the Maxon executable, "
        "\nthis is useful if you have a Pixologic installation of ZBrush and want to use it with GoB. "
        "\nIf you have a Maxon installation of ZBrush, please disable this option",
        default=False,
    )  # Default: False

    custom_pixologoc_path: BoolProperty(
        name="Custom Pixologic Public Path",
        description="This will allow you to set a custom Public Pixologic Path, this is where ZBrush stores GoZ configurations",
        default=False,
    )  # Default: False

    if platform.system() == "Windows":
        PATH_GOZ = os.path.join(os.environ["PUBLIC"], "Pixologic")
    elif platform.system() == "Darwin":  # osx
        PATH_GOZ = os.path.join("/", "Users", "Shared", "Pixologic")
    else:
        PATH_GOZ = False

    pixologoc_path: StringProperty(
        name="Pixologic Public Path",
        description="Set public pixologic path, this needs to be a valid folder which zbrush accesses."
        "By default this folder is on the windows system drive under C:\\Users\\Public\\Pixologic",
        subtype="DIR_PATH",
        default=PATH_GOZ,
    )  # Default: PATH_GOZ

    project_path: StringProperty(
        name="Project Path",
        description="Folder where Zbrush and Blender will store the exported content",
        subtype="DIR_PATH",
        default=os.path.join(paths.PATH_GOZ, "GoZProjects", "Default/").replace(
            "\\", "/"
        ),
    )

    clean_project_path: BoolProperty(
        name="Clean Project Files",
        description="Removes files in the project path to keep your GoZ bridge clean and your SSD happy",
        default=False,
    )  # Default: False

    use_scale: EnumProperty(
        name="Scale",
        description="Create Material",
        items=[
            ("MANUAL", "Manual", "Use Manual Factor for Scaling"),
            (
                "BUNITS",
                "Blender Units",
                "Changes Scale depending on Blenders Unit Scale ",
            ),
            ("ZUNITS", "ZBrush Units", "Scale single Object to ZBrush Units"),
        ],
        default="BUNITS",
    )  # Default: BUNITS
    zbrush_scale: FloatProperty(
        name="ZBrush Scale",
        description="Target ZBrush Scale",
        default=2.0,
        soft_min=0.01,
        min=0,
        soft_max=10,
        step=0.01,
        precision=2,
        subtype="FACTOR",
    )
    manual_scale: FloatProperty(
        name="Scale Factor",
        description="Change Scale in Zbrush",
        default=1.0,
        soft_min=0.01,
        min=0,
        soft_max=10,
        step=0.01,
        precision=2,
        subtype="FACTOR",
    )
    flip_x_axis: BoolProperty(
        name="Flip X axis",
        description="Flip the X axis (before remapping)",
        default=False,
    )  # Default: False
    flip_y_axis: BoolProperty(
        name="Flip Y axis",
        description="Flip the Y axis (before remapping)",
        default=False,
    )  # Default: False
    flip_z_axis: BoolProperty(
        name="Flip Z axis",
        description="Flip the Z axis (before remapping)",
        default=False,
    )  # Default: False

    # Axis Remapping
    remap_x_axis: EnumProperty(
        name="Remap X Axis",
        description="Remap the X axis to another axis",
        items=[
            ("X", "X", "Keep X as X"),
            ("Y", "Y", "Map X to Y"),
            ("Z", "Z", "Map X to Z"),
        ],
        default="X",
        update=on_x_axis_remap_change
    )  # Default: X

    remap_y_axis: EnumProperty(
        name="Remap Y Axis",
        description="Remap the Y axis to another axis",
        items=[
            ("X", "X", "Map Y to X"),
            ("Y", "Y", "Keep Y as Y"),
            ("Z", "Z", "Map Y to Z"),
        ],
        default="Y",
        update=on_y_axis_remap_change
    )  # Default: Y

    remap_z_axis: EnumProperty(
        name="Remap Z Axis",
        description="Remap the Z axis to another axis",
        items=[
            ("X", "X", "Map Z to X"),
            ("Y", "Y", "Map Z to Y"),
            ("Z", "Z", "Keep Z as Z"),
        ],
        default="Z",
        update=on_z_axis_remap_change
    )  # Default: Z
    show_button_text: BoolProperty(
        name="Show Buttons Text",
        description="Show Text on the Import/Export Buttons",
        default=True,
    )  # Default: True
    flat_icons: BoolProperty(
        name="Use flat icons", description="Use flat icons without color", default=True
    )  # Default: True

    export_uv_flip_x: BoolProperty(
        name="UV Map Flip X", default=False
    )  # Default: False
    export_uv_flip_y: BoolProperty(name="UV Map Flip Y", default=True)  # Default: True

    """
    texture_format: EnumProperty(
        name="Image Format",
        description=" Output image format",
        items=[ ('TIFF', '.tif', ' Output image in TIFF format'),
                ('BMP', '.bmp', ' Output image in BMP format'),
                ('JPEG', '.jpg', ' Output image in JPEG format'),
                ('PNG', '.png', ' Output image in PNG format'),
               ],
        default='BMP')  # Default: BMP           """

    # EXPORT
    export_modifiers: EnumProperty(
        name="Modifiers",
        description="Modifiers Mode",
        items=[
            (
                "APPLY_EXPORT",
                "Export and Apply",
                "Apply Modifiers in Blender and Export them to ZBrush",
            ),
            (
                "ONLY_EXPORT",
                "Only Export",
                "Export Modifiers to ZBrush but do not apply them in Blender",
            ),
            ("IGNORE", "Ignore", "Do not export modifiers"),
        ],
        default="ONLY_EXPORT",
    )  # Default: ONLY_EXPORT

    export_polygroups: EnumProperty(
        name="Polygroups",
        description="Create Polygroups",
        items=[
            ("FACE_SETS", "from Face Sets", "Create Polygroups from Face Sets"),
            ("MATERIALS", "from Materials", "Create Polygroups from Materials"),
            (
                "VERTEX_GROUPS",
                "from Vertex Groups",
                "Create Polygroups from Vertex Groups",
            ),
            ("NONE", "None", "Do not Create Polygroups"),
        ],
        default="FACE_SETS",
    )  # Default: FACE_SETS

    export_weight_threshold: FloatProperty(
        name="Weight Threshold",
        description="Only vertex weight higher than the threshold are converted to polygroups",
        default=0.1,
        soft_min=0.01,
        min=0,
        max=1.0,
        step=0.01,
        precision=2,
        subtype="FACTOR",
    )

    export_mask: EnumProperty(
        name="Mask",
        description="Mask export options",
        items=[
            (
                "SCULPT_MASK",
                "from Sculpt Mode Mask",
                "Create Mask from Sculpt Mode Mask",
            ),
            ("VERTEX_GROUP_MASK", "from Vertex Group", "Create Mask from Vertex Group"),
            ("NONE", "None", "Do not export a Mask"),
        ],
        default="SCULPT_MASK",
    )

    export_remove_internal_faces: BoolProperty(
        name="Delete internal faces",
        description="Delete internal faces where all edges have more than 2 face users",
        default=True,
    )  # Default: True

    export_merge: BoolProperty(
        name="Merge Vertices of Curves, Surfaces, Fonts and Meta Objects",
        description="Merges vertices of mesh type 'SURFACE', 'CURVE', 'FONT', 'META' that are in a given distance to each other",
        default=False,
    )  # Default: False

    export_merge_distance: FloatProperty(
        name="Vertex Merge Threshold",
        description="Vertex Merge Threshold",
        default=0.0001,
        min=0,
        soft_min=0.0001,
        soft_max=0.01,
        step=0.0001,
        precision=4,
        subtype="DISTANCE",
    )

    export_run_zbrush: BoolProperty(
        name="Run Zbrush",
        description="Launch Zbrush after exporting from blender",
        default=True,
    )  # Default:True

    # IMPORT
    import_timer: FloatProperty(
        name="Update interval",
        description="Interval (in seconds) to look for changes in GoZ_ObjectList.txt",
        default=0.5,
        min=0.1,
        soft_max=2.0,
        step=0.1,
        precision=2,
        subtype="FACTOR",
    )

    import_material: EnumProperty(
        name="Material",
        description="Create Material",
        items=[
            ("TEXTURES", "from Textures", "Create Material inputs from Textures"),
            ("POLYPAINT", "from Polypaint", "Create Material from Polypaint"),
            ("POLYGROUPS", "from Polygroups", "Create Materials from Polygroups"),
            ("NONE", "None", "No additional material inputs are created"),
        ],
        default="POLYPAINT",
    )  # Default: POLYPAINT

    import_method: EnumProperty(
        name="Import Button Method",
        description="Manual Mode requires to press the import every time you send a model from zbrush to import it.",
        items=[
            (
                "MANUAL",
                "Manual",
                "Manual Mode requires to press the import every time you send a model from zbrush to import it.",
            ),
            ("AUTOMATIC", "Automatic", "Automatic Mode"),
        ],
        default="AUTOMATIC",
    )  # Default: AUTOMATIC

    import_mask: BoolProperty(
        name="Mask", description="Import Mask to Vertex Group", default=True
    )  # Default: True

    import_uv: BoolProperty(
        name="UV Map", description="Import Uv Map from ZBrush", default=True
    )  # Default: True
    import_uv_name: StringProperty(
        name="UV Map", description="Set name for the UV Map", default="UVMap"
    )  # Default: UVMap

    import_uv_flip_x: BoolProperty(
        name="UV Map Flip X", default=False
    )  # Default: False
    import_uv_flip_y: BoolProperty(name="UV Map Flip Y", default=True)  # Default: True

    import_subdiv: BoolProperty(
        name="Subdiv", description="Import Subdivision Levels", default=True
    )  # Default: True

    import_polypaint: BoolProperty(
        name="Polypaint", description="Import Polypaint as Vertex Color", default=True
    )  # Default: True
    import_polypaint_name: StringProperty(
        name="Vertex Color",
        description="Set name for Vertex Color Layer",
        default="Col",
    )  # Default: Col

    import_polygroups: BoolProperty(
        name="Polygroups", description="Import Polygroup data", default=True
    )  # Default: True
    import_polygroups_to_vertexgroups: BoolProperty(
        name="Polygroups to Vertex Groups",
        description="Import Polygroups as Vertex Groups",
        default=False,
    )  # Default: False
    import_polygroups_to_facesets: BoolProperty(
        name="Polygroups to Face Sets",
        description="Import Polygroups as Face Sets",
        default=True,
    )  # Default: True

    import_diffuse_suffix: StringProperty(
        name="Base Color", description="Set Suffix for Base Color Map", default="_diff"
    )  # Default: _diff
    import_diffuse_colorspace: EnumProperty(
        name="",
        description="diffuse_colorspace",
        items=[
            (item.identifier, item.name, item.description)
            for item in bpy.types.ColorManagedInputColorspaceSettings.bl_rna.properties[
                "name"
            ].enum_items
        ],
        default="sRGB",
    )  # Default: sRGB

    import_displace_suffix: StringProperty(
        name="Displacement Map",
        description="Set Suffix for Displacement Map",
        default="_disp",
    )  # Default: _disp

    import_displace_colorspace: EnumProperty(
        name="",
        description="displace_colorspace",
        items=[
            (item.identifier, item.name, item.description)
            for item in bpy.types.ColorManagedInputColorspaceSettings.bl_rna.properties[
                "name"
            ].enum_items
        ],
        default="Linear Rec.709",
    )  # Default: Linear

    import_normal_suffix: StringProperty(
        name="Normal Map", description="Set Suffix for Normal Map", default="_norm"
    )  # Default: _norm

    import_normal_colorspace: EnumProperty(
        name="",
        description="normal_colorspace",
        items=[
            (item.identifier, item.name, item.description)
            for item in bpy.types.ColorManagedInputColorspaceSettings.bl_rna.properties[
                "name"
            ].enum_items
        ],
        default="Non-Color",
    )  # Default: Non-Color

    # DEBUG
    performance_profiling: BoolProperty(
        name="Debug: Performance profiling",
        description="Show timing output in console, note this will slow down the GoZ transfer if enabled!",
        default=False,
    )  # Default:False
    debug_output: BoolProperty(
        name="Debug: Output",
        description="Show debug output in console, note this will slow down the GoZ transfer if enabled!",
        default=False,
    )  # Default:False

    def draw_options(self, box):
        # GoB General Options
        box.use_property_split = True
        box.label(text="GoB General Options", icon="PREFERENCES")
        col = box.column(align=False)
        col.prop(self, "use_pixologic_path")
        col.prop(self, "zbrush_exec")
        col.prop(self, "project_path")

        col.prop(self, "custom_pixologoc_path")
        if self.custom_pixologoc_path:
            col.prop(self, "pixologoc_path")

        col.prop(self, "clean_project_path")
        col.prop(self, "remap_x_axis")
        col.prop(self, "flip_x_axis")
        col.prop(self, "remap_y_axis")
        col.prop(self, "flip_y_axis")
        col.prop(self, "remap_z_axis")
        col.prop(self, "flip_z_axis")
        col.prop(self, "use_scale")
        if self.use_scale == "MANUAL":
            col.prop(self, "manual_scale")
        if self.use_scale == "ZUNITS":
            col.prop(self, "zbrush_scale")
        col.prop(self, "show_button_text")
        col.prop(self, "flat_icons")
        # col.prop(self, 'texture_format')

    def draw_import(self, box):
        # GoB Import Options
        box.use_property_split = True
        # box = layout.box()
        box.label(text="GoB Import Options", icon="IMPORT")
        col = box.column(align=False)
        # box.prop(self, 'import_method') #TODO: disabled: some bugs when switching import method
        col.prop(self, "import_timer")
        col.prop(self, "import_material")
        col.prop(self, "import_mask")

        uv_row = col.row()
        uv_row.prop(self, "import_uv")
        if self.import_uv:
            uv_row.prop(self, "import_uv_name", text="")
            col.prop(self, "import_uv_flip_x")
            col.prop(self, "import_uv_flip_y")

        pp_row = col.row()
        pp_row.prop(self, "import_polypaint")
        if self.import_polypaint:
            pp_row.prop(self, "import_polypaint_name", text="")

        pg_col = col.column()
        pg_col.prop(self, "import_polygroups_to_vertexgroups")
        pg_col.prop(self, "import_polygroups_to_facesets")

        if self.import_material == "TEXTURES":
            row = box.row(align=True)
            row.prop(self, "import_diffuse_suffix")
            row.prop(self, "import_diffuse_colorspace")
            row = box.row(align=True)
            row.prop(self, "import_normal_suffix")
            row.prop(self, "import_normal_colorspace")
            row = box.row(align=True)
            row.prop(self, "import_displace_suffix")
            row.prop(self, "import_displace_colorspace")

    def draw_export(self, box):
        # GoB Export Options
        box.use_property_split = True
        box.label(text="GoB Export Options", icon="EXPORT")
        col = box.column(align=False)
        col.prop(self, "export_modifiers")
        col.prop(self, "export_polygroups")
        if self.export_polygroups == "VERTEX_GROUPS":
            col.prop(self, "export_weight_threshold")
        col.prop(self, "export_mask")
        col.prop(self, "export_uv_flip_x")
        col.prop(self, "export_uv_flip_y")

        col.prop(self, "export_merge")
        if self.export_merge:
            col.prop(self, "export_merge_distance")
        col.prop(self, "export_remove_internal_faces")
        col.prop(self, "export_run_zbrush")

    def draw_debug(self, box):
        box.use_property_split = True
        col = box.column(align=True)
        col.prop(self, "performance_profiling")
        col.prop(self, "debug_output")

    def draw_help(self, box):
        # GoB Troubleshooting
        box.use_property_split = True
        # box = layout.box()
        box.label(text="GoB Troubleshooting", icon="QUESTION")

        if platform.system() == "Windows":
            icons = ui.preview_collections["main"]
            box.operator(
                "gob.install_goz",
                text="Install GoZ",
                icon_value=icons["GOZ_SEND"].icon_id,
            )

    def draw(self, context):

        layout = self.layout
        # TAB BAR
        layout.use_property_split = False
        column = layout.column(align=True)
        row = column.row()
        row.prop(self, "tabs", expand=True)
        box = column.box()
        if self.tabs == "OPTIONS":
            self.draw_options(box)
        elif self.tabs == "EXPORT":
            self.draw_export(box)
        elif self.tabs == "IMPORT":
            self.draw_import(box)
        elif self.tabs == "HELP":
            self.draw_help(box)
        elif self.tabs == "DEBUG":
            self.draw_debug(box)