properties.py

#  Copyright 2020-2021 Dragorn421, Rankaisija
#
#  This objex2 addon 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 3 of the License, or
#  (at your option) any later version.
#
#  This objex2 addon 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 objex2 addon.  If not, see <https://www.gnu.org/licenses/>.

from . import blender_version_compatibility

import bpy

from . import interface
from . import node_setup_helpers
from .logging_util import getLogger
from . import template

def hexify(segment: str):
    if len(segment) == 0:
        return ""

    if segment.startswith("0x"):
        if segment.startswith("0x0"):
            if segment.endswith("000000"):
                return segment
            segment = segment + "000000"
        else:
            if not segment.endswith("000000"):
                segment = segment + "000000"
            segment = segment[:2] + "0" + segment[2:]
    else:
        if len(segment) > 1:
            return ""
        segment = "0x0" + segment + "000000"
    
    slist = list(segment.upper())
    slist[1] = 'x'
    return ''.join(slist)

# scene
class SavedPoseBone(bpy.types.PropertyGroup):
    bone_name = bpy.props.StringProperty()
    location = bpy.props.FloatVectorProperty(size=3)
    rotation_quaternion = bpy.props.FloatVectorProperty(size=4)

class SavedPose(bpy.types.PropertyGroup):
    name = bpy.props.StringProperty()
    type = bpy.props.EnumProperty(
            items=[
                ('UNFOLDEDpose_foldedRest','','',1),
                ('foldedPose_UNFOLDEDrest','','',2),
            ],
            default='UNFOLDEDpose_foldedRest'
        )
    bones = bpy.props.CollectionProperty(type=SavedPoseBone)

class ObjexSceneProperties(bpy.types.PropertyGroup):
    is_objex_scene = bpy.props.BoolProperty()
    
    blend_scale = bpy.props.FloatProperty(
        name='Export Scale',
        soft_min=0.01, soft_max=1000.0,
        default=1.0,
    )

    colorspace_strategy = bpy.props.EnumProperty(
        # if modifying these items, also edit __init__.OBJEX_AddonPreferences.colorspace_default_strategy
        items=[
            ('QUIET','Do nothing + silence',
                'Do nothing and do not warn about using a non-linear color space.',1),
            ('WARN','Warn non-linear',
                'Warn on export about using a non-linear color space.',2),
        ],
        name='Color Space Strategy',
        description='How to handle color spaces in the scene',
    )

    sync_backface_culling = bpy.props.EnumProperty(
        items=[
            ('BLENDER_TO_OBJEX','Blender -> Objex',
                'Change backface culling property of an objex material when '
                'its Blender backface culling material property changes.',1 << 0),
            ('OBJEX_TO_BLENDER','Objex -> Blender',
                'Change Blender backface culling material property of a '
                'material when its objex backface culling property changes.',1 << 1),
        ],
        name='Sync Backface Culling',
        description='How to sync the two backface culling properties, the one in vanilla Blender and the objex one',
        options={'ENUM_FLAG'},
        default={'BLENDER_TO_OBJEX','OBJEX_TO_BLENDER'},
    )

    saved_poses = bpy.props.CollectionProperty(type=SavedPose)

    menu_tools = bpy.props.BoolProperty(name='Tools',default=False)
    menu_common = bpy.props.BoolProperty(name='Common',default=False)
    menu_material = bpy.props.BoolProperty( name='Material', default=True)
    menu_texel0 = bpy.props.BoolProperty(name='Texel0')
    menu_texel1 = bpy.props.BoolProperty(name='Texel1')
    menu_skelanime = bpy.props.BoolProperty(name='SkelAnime')
    menu_bone = bpy.props.BoolProperty(name='Bone')
    menu_joint = bpy.props.BoolProperty(name='Joint Sphere')
    menu_mesh = bpy.props.BoolProperty(name='Mesh')
    menu_global = bpy.props.BoolProperty(name='Export Settings')
    mode_menu = bpy.props.EnumProperty(
        items=[
            ('menu_mode_combiner',    'Combiner', '(A-B)*C+D',                'SHADING_RENDERED', 0),
            ('menu_mode_texture',     'Texture',  'Texture',                  'TEXTURE',          1),
            ('menu_mode_render',      'F3D',      'F3DZEX2 Flags',            'RENDERLAYERS',     2),
            ('menu_mode_settings',    'Settings', 'Objex2 Material Settings', 'TOOL_SETTINGS',    3),
        ],
        name='Menu Mode',
        default='menu_mode_texture',
    )

# mesh
def omp_object_name(self, context:bpy.types.Context):
    object:bpy.types.Object = context.object
    objex = object.data.objex_bonus

    if objex.type == 'COLLISION' and not object.name.startswith('collision.'):
        object.name = 'collision.' + object.name
    if objex.type == 'MESH' and object.name.startswith('collision.'):
        object.name = object.name[10:]

class ObjexMeshProperties(bpy.types.PropertyGroup):
    priority = bpy.props.IntProperty(
            name='Priority',
            description='Meshs with higher priority are written first',
            default=0
        )
    write_origin = bpy.props.EnumProperty(
            items=[
                ('YES','Yes','Write origin',1),
                ('NO','No','Do not write origin',2),
                ('AUTO','Auto','Write origin if mesh uses billboarding, do not otherwise',3)
            ],
            name='Origin',
            description='Export object location in world space.\n'
                        'Used by zzconvert to translate the mesh coordinates back, as if object had its location at world origin.',
            default='AUTO'
        )
    attrib_billboard = bpy.props.EnumProperty(
            items=[
                ('BBMTXS','Spherical','include spherical billboard matrix in Dlist',1),
                ('BBMTXC','Cylindrical','include cylindrical billboard matrix in Dlist',2),
                ('NONE','None','No billboarding',3)
            ],
            name='Billboard',
            description='Billboard type',
            default='NONE'
        )
    type = bpy.props.EnumProperty(
        items=[
            ('MESH', 'Mesh', ''),
            ('COLLISION', 'Collision', ''),
        ],
        default='MESH',
        update=omp_object_name
    )
    
# 421todo copied straight from specs, may want to improve wording / properties names
for attrib, desc in (
    ('LIMBMTX', 'include explicit limb matrix at start of Dlist'),
    ('POSMTX', 'include world positioning matrix at start of Dlist'),
    ('NOSPLIT', 'do not divide mesh by bones (and do not write skeleton)'),
    ('NOSKEL', 'do not write a skeleton to the generated zobj'),
    ('PROXY', 'write a proxy Dlist (will have _PROXY suffix)\n'
        'in the case of a divided mesh, a proxy is written for each Dlist, and a C array is generated\n'
        'if NOSKEL is not present (if a skeleton is written), that C array data is also written to zobj at PROXY_ offset and the skeleton points to that table\n'
        'in play-as data, display list pointers point to the proxy for each instead of the real display list'),
):
    setattr(ObjexMeshProperties, 'attrib_%s' % attrib,
        bpy.props.BoolProperty(
            name=attrib,
            description=desc,
            default=False
    ))

# armature
class ObjexArmatureExportActionsItem(bpy.types.PropertyGroup):
    action = bpy.props.PointerProperty(
            type=bpy.types.Action,
            name='Action',
            description='',
            update=interface.armature_export_actions_change
        )

def omp_armature_segment(self, context):
    armature:bpy.types.Image = self.id_data
    segment:str = armature.objex_bonus.segment
    
    armature.objex_bonus.segment = hexify(segment)

class ObjexArmatureProperties(bpy.types.PropertyGroup):
    export_all_actions = bpy.props.BoolProperty(
            name='Export all actions',
            description='',
            default=True,
            update=interface.armature_export_actions_change
        )
    export_actions_active = bpy.props.IntProperty()
    export_actions = bpy.props.CollectionProperty(
            type=ObjexArmatureExportActionsItem,
            name='Actions',
            description=''
        )
    
    type = bpy.props.EnumProperty(
            items=[
                ('z64npc','Flex','',2),
                ('z64player','Player','',1),
                ('z64dummy','Dummy','',3),
            ],
            name='Type',
            description='',
            default='z64npc'
        )
    
    pbody = bpy.props.BoolProperty(
            name='Physics Body',
            description='',
            default=False
        )
    pbody_parent_object = bpy.props.PointerProperty(
            type=bpy.types.Object,
            name='Parent Object',
            description='Optional'
        )
    pbody_parent_bone = bpy.props.StringProperty(
            name='Parent Bone',
            description=''
        )
    
    segment = bpy.props.StringProperty(
            name='Segment',
            description='Hexadecimal',
            update=omp_armature_segment
        )
    segment_local = bpy.props.BoolProperty(
            name='Local',
            description='',
            default=False
        )
    start_frame_clamp = bpy.props.BoolProperty(
            name='',
            description='',
            default=False
        )
    start_frame_clamp_value = bpy.props.IntProperty(
        name='Start Frame Minimum',
        description='',
        default=0
    )
    end_frame_minus = bpy.props.BoolProperty(
            name='',
            description='',
            default=False
        )
    end_frame_minus_value = bpy.props.IntProperty(
        name='End Frame Subtract',
        min=0,
        max=999,
        description='',
        default=0
    )

    fold_unfold_saved_pose_index = bpy.props.IntProperty()

    anim_filepath = bpy.props.StringProperty(
        name='Path',
        subtype="FILE_PATH"
    )

    src_bin_anim_filepath = bpy.props.StringProperty(
        name='Path',
        subtype="FILE_PATH"
    )

    uses_joint_spheres = bpy.props.BoolProperty(
        name='',
        default=False
    )

    joint_sphere_scale = bpy.props.FloatProperty(name='Scale', default=100, soft_min=1.0, max=100.0,
                                                 description="The scale at which the model the jntSph relies upon is exported\n"
                                                             "For example if 100 (default), the blender coordinates are multiplied by 100 before writing to the .h,"
                                                             "so that then when used by the game they are multiplied by 0.01 (default actor scale) as part of the transform.")

    joint_sphere_header_filepath = bpy.props.StringProperty(
        name='Path',
        subtype="FILE_PATH"
    )

def omp_updated_alpha(self, context:bpy.types.Context):
    material:bpy.types.Material = self.id_data
    data = material.objex_bonus
    alpha_value = material.node_tree.nodes["Principled BSDF"].inputs[21]

    alpha_value.default_value = data.collision.alpha

    if data.collision.alpha == 1 or data.collision.alpha == 0:
        material.blend_method = 'CLIP'
    else:
        material.blend_method = 'BLEND'

# material
class ObjexMaterialCollisionProperties(bpy.types.PropertyGroup):
    WATERBOX = bpy.props.BoolProperty()
    # 421todo WATERBOX properties
    ignore_camera = bpy.props.BoolProperty(
            name='Ignore Camera',
            description='Camera can pass through',
            default=False
        )
    ignore_entity = bpy.props.BoolProperty(
            name='Ignore Entities',
            description='Player, enemies... can pass through',
            default=False
        )
    ignore_ammo = bpy.props.BoolProperty(
            name='Ignore Ammos',
            description='Deku seeds, arrows, bombchus... can pass through',
            default=False
        )
    sound = bpy.props.EnumProperty(
            items=[
                ('UNSET',             '',                                         '',  0),
                ('SOUND_DIRT',        'Earth/Dirt',                               '',  1),
                ('SOUND_DIRT_LOOSE',  'Loose Earth/Dirt',                         '',  2),
                ('SOUND_GRASS',       'Underbrush/Grass',                         '',  3),
                ('SOUND_SAND',        'Sand',                                     '',  4),
                ('SOUND_WOOD',        'Wooden',                                   '',  5),
                ('SOUND_WOOD_STRUCK', 'Packed Earth/Wood (struck: wooden sound)', '',  6),
                ('SOUND_STONE',       'Stone',                                    '',  7),
                ('SOUND_STONE_WET',   'Stone (wet)',                              '',  8),
                ('SOUND_CERAMIC',     'Ceramic',                                  '',  9),
                ('SOUND_SPLASH',      'Shallow water',                            '', 10),
                ('SOUND_SPLASH_1',    'Shallow water (lower-pitched)',            '', 11),
                ('SOUND_LAVA',        'Lava/Goo',                                 '', 12),
                ('SOUND_DIRT_1',      'Earth/Dirt (duplicate 1)',                 '', 13),
                ('SOUND_DIRT_2',      'Earth/Dirt (duplicate 2)',                 '', 14),
                ('SOUND_DIRT_3',      'Earth/Dirt (duplicate 3)',                 '', 15),
                ('SOUND_DIRT_4',      'Earth/Dirt (duplicate 4)',                 '', 16),
            ],
            name='Sound',
            description='Sound used when walking on or hitting the collision.\n'
                        'Unless otherwise stated, the sound made when struck with a sword is the default metallic one',
            default='UNSET'
        )
    floor = bpy.props.EnumProperty(
            items=[
                ('UNSET',            '',              '',                                                             0),
                ('FLOOR_VOID_SCENE', 'Void to Scene', 'Void out to the last scene entered',                           1),
                ('FLOOR_VOID_ROOM',  'Void to Room',  'Void out to the last room entered',                            2),
                ('FLOOR_JUMP_VINE',  'Climb (vines)', 'Instead of jumping, climb down',                               3),
                ('FLOOR_JUMP_HANG',  'Grab ledge',    'Instead of jumping, hang from ledge',                          4),
                ('FLOOR_JUMP_FALL',  'Step off',      'Instead of jumping, step off the platform into falling state', 5),
                ('FLOOR_JUMP_DIVE',  'Dive',          'Instead of jumping, activate diving animation/state',          6),
            ],
            name='Floor',
            default='UNSET'
        )
    wall = bpy.props.EnumProperty(
            items=[
                ('UNSET',           '',            '',                                                       0),
                ('WALL_BARRIER',    'No Grab',     'Link will not jump over or attempt to climb the wall,\n'
                                                   'even if the wall is short enough for these actions',     1),
                ('WALL_LADDER',     'Ladder',      '',                                                       2),
                ('WALL_LADDER_TOP', 'Ladder Top',  'Makes Link climb down onto a ladder',                    3),
                ('WALL_VINES',      'Vines',       'Climbable vine wall',                                    4),
                ('WALL_CRAWL',      'Crawl',       'Wall used to activate/deactivate crawling',              5),
                ('WALL_CRAWL_1',    'Crawl 1',     'Difference from Crawl unknown',                          6),
                ('WALL_PUSHBLOCK',  'Pushblock',   '',                                                       7),
            ],
            name='Wall',
            default='UNSET'
        )
    special = bpy.props.EnumProperty(
            items=[
                ('UNSET', '', '', 0),
                # floor
                ('FLOOR_LAVA',       'Lava',                '',                                                    1),
                ('FLOOR_LAVA_1',     'Lava 1',              'Difference from Lava unknown',                        2),
                ('FLOOR_SAND',       'Sand',                '',                                                    3),
                ('FLOOR_ICE',        'Ice',                 '',                                                    4),
                ('FLOOR_NOFALLDMG',  'No Fall Damage',      '',                                                    5),
                ('FLOOR_QUICKHORSE', 'Quicksand (horse)',   'Quicksand, passable on horseback',                    6),
                ('FLOOR_QUICKSAND',  'Quicksand (no horse)','Quicksand, NOT passable on horseback',                7),
                ('SPECIAL_LOOKUP',   'Look Up',             'Makes the player look upwards when standing on it',   8),
                # wall
                ('SPECIAL_BLEEDWALL','Bleed Wall',          'Spawns "blood" particles when struck, special sound'
                                                            'when struck with sword (used in Jabu-Jabu\'s Belly)', 9),
                # other
                ('SPECIAL_INSTAVOID','Instavoid',           'Instantly void out on contact',                       10),
            ],
            name='Special',
            default='UNSET'
        )
    horse = bpy.props.BoolProperty(
            name='Horse',
            description='Epona can walk on the polygon',
            default=True
        )
    one_lower = bpy.props.BoolProperty(
            name='1 Lower',
            description='Sink 1 unit into the ground',
            default=False
        )
    wall_damage = bpy.props.BoolProperty(
            name='Wall Damage',
            default=False
        )
    hookshot = bpy.props.BoolProperty(
            name='Hookshot',
            default=False
        )
    steep = bpy.props.BoolProperty(
            name='Steep',
            description='Steep Surface (makes the player slide)',
            default=False
        )
    warp_enabled = bpy.props.BoolProperty(
            name='Exit',
            description='Scene exit to warp somewhere',
            default=False
        )
    warp_exit_index = bpy.props.IntProperty(
            name='Exit Index',
            description='0-indexes into the scene exit table',
            default=0
        )
    camera_enabled = bpy.props.BoolProperty(
            name='Camera',
            description='Use a specific camera',
            default=False
        )
    camera_index = bpy.props.IntProperty(
            name='Camera Index',
            default=False
        )
    echo_enabled = bpy.props.BoolProperty(
            name='Echo',
            default=False
        )
    echo_index = bpy.props.IntProperty(
            name='Echo Index',
            default=False
        )
    lighting_enabled = bpy.props.BoolProperty(
            name='Lighting',
            default=False
        )
    lighting_index = bpy.props.IntProperty(
            name='Lighting Index',
            default=False
        )
    conveyor_enabled = bpy.props.BoolProperty(
            name='Conveyor Surface',
            description='',
            default=False
        )
    # 421todo conveyor_outside_water
    conveyor_direction = bpy.props.IntProperty(
            name='Direction',
            description='Conveyor direction in degrees',
            min=0, max=360,
            default=0
        )
    conveyor_speed = bpy.props.EnumProperty(
            items=[
                ('NONE',    'None',     '', 0),
                ('SLOW',    'Slow',     '', 1),
                ('MEDIUM',  'Medium',   '', 2),
                ('FAST',    'Fast',     '', 3),
            ],
            name='Speed',
            default='NONE'
        )
    conveyor_inherit = bpy.props.BoolProperty(
            name='Inherit',
            description='Inherit speed from previously stepped-on conveyor surface',
            default=False
        )
    alpha = bpy.props.FloatProperty(default=1,min=0,max=1,update=omp_updated_alpha)

# ObjexMaterialProperties (omp)
def omp_change_alpha(self, context):
    material:bpy.types.Material = self.id_data
    objex:ObjexMaterialProperties = material.objex_bonus
    material.blend_method = objex.alpha_mode

    material.preview_render_type = 'FLAT'

    if objex.lock_material == False:
        template.material_apply_template(objex.alpha_mode, material)
    
    if material.blend_method == 'CLIP':
        material.alpha_threshold = 0.120

def omp_change_shade(self, context):
    material = self.id_data
    node_tree = material.node_tree
    material.preview_render_type = 'FLAT'

    combiner = {
        "LIGHTING": {
            'input_flags_A_A_1': ( 'OBJEX_AlphaCycle1', 'A', 'G_ACMUX_0' ),
            'input_flags_A_B_1': ( 'OBJEX_AlphaCycle1', 'B', 'G_ACMUX_0' ),
            'input_flags_A_C_1': ( 'OBJEX_AlphaCycle1', 'C', 'G_ACMUX_0' ),
            'input_flags_A_D_1': ( 'OBJEX_AlphaCycle1', 'D', 'G_ACMUX_COMBINED' ),
        },
        "VERTEX_COLOR": {
            'input_flags_A_A_1': ( 'OBJEX_AlphaCycle1', 'A', 'G_ACMUX_0' ),
            'input_flags_A_B_1': ( 'OBJEX_AlphaCycle1', 'B', 'G_ACMUX_0' ),
            'input_flags_A_C_1': ( 'OBJEX_AlphaCycle1', 'C', 'G_ACMUX_0' ),
            'input_flags_A_D_1': ( 'OBJEX_AlphaCycle1', 'D', 'G_ACMUX_COMBINED' ),
        },
        "VERTEX_ALL": {
            'input_flags_A_A_1': ( 'OBJEX_AlphaCycle1', 'A', 'G_ACMUX_COMBINED' ),
            'input_flags_A_B_1': ( 'OBJEX_AlphaCycle1', 'B', 'G_ACMUX_0' ),
            'input_flags_A_C_1': ( 'OBJEX_AlphaCycle1', 'C', 'G_ACMUX_SHADE' ),
            'input_flags_A_D_1': ( 'OBJEX_AlphaCycle1', 'D', 'G_ACMUX_0' ),
        },
    }

    for input_flag, (node_target, alpha, value) in combiner[material.objex_bonus.shading].items():
        node = node_tree.nodes[node_target]
        setattr(node.inputs[alpha], input_flag, value)

    if material.objex_bonus.shading == "LIGHTING":
        node_setup_helpers.set_shade_source_lighting(material)
    elif material.objex_bonus.shading == "VERTEX_COLOR":
        node_setup_helpers.set_shade_source_vertex_colors(material)
    else:
        node_setup_helpers.set_shade_source_vertex_colors_and_alpha(material)

    if material.objex_bonus.lock_material == False:
        template.material_apply_template(material.objex_bonus.alpha_mode, material)

def omp_change_texture_u_0(self, context):
    material:bpy.types.Material = self.id_data
    wrap   = material.node_tree.nodes["OBJEX_TransformUV0"].inputs[3]
    mirror = material.node_tree.nodes["OBJEX_TransformUV0"].inputs[5]

    material.preview_render_type = 'FLAT'

    setattr(wrap, 'default_value', False)
    setattr(mirror, 'default_value', False)

    if material.objex_bonus.texture_u_0 == 'WRAP' or material.objex_bonus.texture_u_0 == 'MIRROR':
        setattr(wrap, 'default_value', True)
    if material.objex_bonus.texture_u_0 == 'MIRROR':
        setattr(mirror, 'default_value', True)

    return

def omp_change_texture_u_1(self, context):
    material:bpy.types.Material = self.id_data
    wrap   = material.node_tree.nodes["OBJEX_TransformUV1"].inputs[3]
    mirror = material.node_tree.nodes["OBJEX_TransformUV1"].inputs[5]

    material.preview_render_type = 'FLAT'

    setattr(wrap, 'default_value', False)
    setattr(mirror, 'default_value', False)

    if material.objex_bonus.texture_u_1 == 'WRAP' or material.objex_bonus.texture_u_1 == 'MIRROR':
        setattr(wrap, 'default_value', True)
    if material.objex_bonus.texture_u_1 == 'MIRROR':
        setattr(mirror, 'default_value', True)

    return

def omp_change_texture_v_0(self, context):
    material:bpy.types.Material = self.id_data
    wrap   = material.node_tree.nodes["OBJEX_TransformUV0"].inputs[4]
    mirror = material.node_tree.nodes["OBJEX_TransformUV0"].inputs[6]

    setattr(wrap, 'default_value', False)
    setattr(mirror, 'default_value', False)

    if material.objex_bonus.texture_v_0 == 'WRAP' or material.objex_bonus.texture_v_0 == 'MIRROR':
        setattr(wrap, 'default_value', True)
    if material.objex_bonus.texture_v_0 == 'MIRROR':
        setattr(mirror, 'default_value', True)

    return

def omp_change_texture_v_1(self, context):
    material:bpy.types.Material = self.id_data
    wrap   = material.node_tree.nodes["OBJEX_TransformUV1"].inputs[4]
    mirror = material.node_tree.nodes["OBJEX_TransformUV1"].inputs[6]

    setattr(wrap, 'default_value', False)
    setattr(mirror, 'default_value', False)

    if material.objex_bonus.texture_v_1 == 'WRAP' or material.objex_bonus.texture_v_1 == 'MIRROR':
        setattr(wrap, 'default_value', True)
    if material.objex_bonus.texture_v_1 == 'MIRROR':
        setattr(mirror, 'default_value', True)

    return

def omp_change_texture_filter(self, context):
    material:bpy.types.Material = self.id_data

    if material.objex_bonus.texture_filter == 'G_TF_POINT':
        material.node_tree.nodes["OBJEX_Texel0Texture"].interpolation = 'Closest'
        material.node_tree.nodes["OBJEX_Texel1Texture"].interpolation = 'Closest'
    else:
        material.node_tree.nodes["OBJEX_Texel0Texture"].interpolation = 'Linear'
        material.node_tree.nodes["OBJEX_Texel1Texture"].interpolation = 'Linear'

def omp_change_external_segment(self, context):
    material:bpy.types.Material = self.id_data
    segment:str = material.objex_bonus.external_material_segment
    
    material.objex_bonus.external_material_segment = hexify(segment)

def omp_change_texel_alpha_source(self, context:bpy.types.Context):
    image:bpy.types.Image = self.id_data
    objex = image.objex_bonus

    for mtl in bpy.data.materials:
        if mtl.objex_bonus.is_objex_material == False:
            continue
        if mtl.objex_bonus.use_collision == True:
            continue
        
        node_tree:bpy.types.NodeTree = mtl.node_tree
        texel0 = node_tree.nodes["OBJEX_Texel0"]
        texel1 = node_tree.nodes["OBJEX_Texel1"]
        image0:bpy.types.ShaderNodeTexImage = node_tree.nodes["OBJEX_Texel0Texture"]
        image1:bpy.types.ShaderNodeTexImage = node_tree.nodes["OBJEX_Texel1Texture"]

        def clearLinks(tree, socket):
            while socket.links:
                tree.links.remove(socket.links[0])
        
        def relink(image:bpy.types.ShaderNodeTexImage, texel:bpy.types.ShaderNodeGroup):
            clearLinks(node_tree, texel.inputs['Alpha'])
            node_tree.links.new(texel.inputs['Alpha'], image.outputs[objex.alphasource])

        if image0.image == image:
            relink(image0, texel0)
        if image1.image == image:
            relink(image1, texel1)
            

def omp_change_texel_segment(self, context):
    image:bpy.types.Image = self.id_data
    segment:str = image.objex_bonus.pointer
    
    image.objex_bonus.pointer = hexify(segment)

def objex_backface_culling_update(self, context):
    material = self.id_data
    if material.objex_bonus.is_objex_material:
        material.use_backface_culling = material.objex_bonus.backface_culling

class ObjexMaterialProperties(bpy.types.PropertyGroup):
    is_objex_material = bpy.props.BoolProperty(default=False)
    objex_version = bpy.props.IntProperty(default=0) # see data_updater.py

    # Use this material as display properties
    use_display = bpy.props.BoolProperty(
            default=True
        )
    # Use this material as collision properties
    use_collision = bpy.props.BoolProperty(
            default=False
        )

    collision = bpy.props.PointerProperty(
            type=ObjexMaterialCollisionProperties
        )

    backface_culling = bpy.props.BoolProperty(
            name='Backface Culling',
            description='Culls the back face of geometry',
            update=objex_backface_culling_update,
            default=True
        )
    frontface_culling = bpy.props.BoolProperty(
            name='Cull frontfaces',
            description='Culls the front face of geometry',
            default=False
        )
    write_primitive_color = bpy.props.BoolProperty(
            name='Set prim color',
            description='Set the primitive color in the generated display list (macro gsDPSetPrimColor).\n'
                        'Disabling this can for example allow to set a dynamic primitive color from code or from another display list',
            default=True
        )
    write_environment_color = bpy.props.BoolProperty(
            name='Set env color',
            description='Same as "Set prim color" for the environment color (macro gsDPSetEnvColor)',
            default=False
        )

    rendermode_blender_flag_AA_EN = bpy.props.BoolProperty(
            name='AA_EN',
            description='AA_EN\n' 'Enable anti-aliasing?',
            default=True
        )
    rendermode_blender_flag_Z_CMP = bpy.props.BoolProperty(
            name='Z_CMP',
            description='Z_CMP\n' 'Use Z buffer',
            default=True
        )
    rendermode_blender_flag_Z_UPD = bpy.props.BoolProperty(
            name='Z_UPD',
            description='Z_UPD\n' 'Update Z buffer',
            default=True
        )
    rendermode_blender_flag_IM_RD = bpy.props.BoolProperty(
            name='IM_RD',
            description='IM_RD\n' '? see CloudModding wiki',
            default=True
        )
    rendermode_blender_flag_CLR_ON_CVG = bpy.props.BoolProperty(
            name='CLR_ON_CVG',
            description='CLR_ON_CVG\n' '? see CloudModding wiki',
            default=False
        )
    rendermode_blender_flag_CVG_DST_ = bpy.props.EnumProperty(
            items=[
                ('CVG_DST_CLAMP','CLAMP','CVG_DST_CLAMP',1),
                ('CVG_DST_WRAP','WRAP','CVG_DST_WRAP',2),
                ('CVG_DST_FULL','FULL','CVG_DST_FULL',3),
                ('CVG_DST_SAVE','SAVE','CVG_DST_SAVE',4),
            ],
            name='CVG_DST_',
            description='? see CloudModding wiki',
            default='CVG_DST_CLAMP'
        )
    rendermode_zmode = bpy.props.EnumProperty(
            items=[
                ('OPA',  'Opaque',            'Opaque surfaces (OPA)',1),
                ('INTER','Interpenetrating',  'Interpenetrating surfaces',2),
                ('XLU',  'Translucent',       'Translucent surfaces (XLU)',3),
                ('DEC',  'Decal',             'Decal surfaces (eg paths)',4),
            ],
            name='zmode',
            description='Not well understood, has to do with rendering order',
            default='OPA'
        )
    rendermode_blender_flag_CVG_X_ALPHA = bpy.props.BoolProperty(
            name='CVG_X_ALPHA',
            description='CVG_X_ALPHA\n' '? see CloudModding wiki',
            default=False
        )
    rendermode_blender_flag_ALPHA_CVG_SEL = bpy.props.BoolProperty(
            name='ALPHA_CVG_SEL',
            description='ALPHA_CVG_SEL\n' '? see CloudModding wiki',
            default=True # 421fixme does enabling this kill alpha?
        )
    rendermode_forceblending = bpy.props.BoolProperty(
            name='Force blending',
            description='Not well understood, related to transparency and rendering order',
            default=False
        )
    rendermode_blending_cycle0 = bpy.props.EnumProperty(
            items=[
                ('FOG_PRIM',  'FOG_PRIM', 'Blend with fog color and alpha (G_RM_FOG_PRIM_A)',1),  # G_BL_CLR_FOG   G_BL_A_FOG     G_BL_CLR_IN    G_BL_1MA
                ('FOG_SHADE', 'FOG_SHADE','Blend with fog color and shade alpha (shade from combiner cycles) (G_RM_FOG_SHADE_A)',2),  # G_BL_CLR_FOG   G_BL_A_SHADE   G_BL_CLR_IN    G_BL_1MA
                ('PASS',      'Pass',     'Let the input pixel color through unaltered (G_RM_PASS...)',3), # G_BL_CLR_IN    G_BL_0         G_BL_CLR_IN    G_BL_1
                ('OPA',       'OPA',      'Blend with the buffer\nCycle settings mainly used with OPA',4), # G_BL_CLR_IN    G_BL_A_IN      G_BL_CLR_MEM   G_BL_A_MEM
                ('XLU',       'XLU',      'Blend with the buffer\nCycle settings mainly used with XLU',5), # G_BL_CLR_IN    G_BL_A_IN      G_BL_CLR_MEM   G_BL_1MA
                ('VC_SHADE',  'VC_SHADE', '', 6),
                ('CUSTOM',    'Custom',   'Define a custom blending cycle',7),
            ],
            name='Blend1',
            description='First cycle\nHow to blend the pixels being rendered with the frame buffer\nResponsible for at least transparency effects and fog',
            default='FOG_SHADE'
        )
    rendermode_blending_cycle1 = bpy.props.EnumProperty(
            items=[
                ('OPA',    'OPA',    'Blend with the buffer\nCycle settings mainly used with OPA',1), # G_BL_CLR_IN    G_BL_A_IN      G_BL_CLR_MEM   G_BL_A_MEM
                ('XLU',    'XLU',    'Blend with the buffer\nCycle settings mainly used with XLU',2), # G_BL_CLR_IN    G_BL_A_IN      G_BL_CLR_MEM   G_BL_1MA
                ('CUSTOM', 'Custom', 'Define a custom blending cycle',4),
            ],
            name='Blend2',
            description='Second cycle\nHow to blend the pixels being rendered with the frame buffer\nResponsible for at least transparency effects and fog',
            default='OPA'
        )

    standalone = bpy.props.BoolProperty(
            name='Standalone',
            description='Write the display list for this material once, and use 0xDE G_DL commands to branch to it every use',
            default=False
        )
    empty = bpy.props.BoolProperty(
            name='Empty',
            description='Do not write any geometry using this material',
            default=False
        )
    branch_to_object = bpy.props.PointerProperty(
            type=bpy.types.Object,
            name='Branch to',
            description='Jump to the display list of another object',
            poll=lambda self, object: object.type == 'MESH'
        )
    branch_to_object_bone = bpy.props.StringProperty(
            name='Branch to bone',
            description='Jump to the display list for a bone'
        )
    vertex_shading = bpy.props.EnumProperty(
            items=[
                ('AUTO','Basic Shading','Colors only or normals only, depending on the selection for between "Lighting" / "Vertex Color" in Common tab',1),
                ('DYNAMIC','Dynamic Shading','Use normals where vertex colors are opaque white (1,1,1,1), and vertex colors otherwise',2),
            ],
            name='Dynamic Shading',
            description='What shade data should be written for each vertex',
            default='AUTO'
        )
    external_material_segment = bpy.props.StringProperty(
    		name='Segment',
    		description='Branch material to segment',
            update=omp_change_external_segment
    	)
    force_write = bpy.props.BoolProperty(
            name='Force write',
            description='Write this material even if it is not used',
            default=False
        )
    priority = bpy.props.IntProperty(
            name='Priority',
            description='Geometry using materials with higher priority is written first',
            default=0
        )
    geometrymode_G_FOG = bpy.props.BoolProperty(
            name='G_FOG',
            description='G_FOG\n' '? see CloudModding wiki, has to do with computing fog values\n' 'THIS DOES NOT DISABLE FOG, use the blending cycle settings for that purpose',
            default=True
        )
    geometrymode_G_ZBUFFER = bpy.props.BoolProperty(
            name='Z buffer',
            description='G_ZBUFFER\n' 'Enable Z buffer calculations',
            default=True
        )
    geometrymode_G_SHADING_SMOOTH = bpy.props.BoolProperty(
        name='Smooth Shading',
        description='G_SHADING_SMOOTH\n' 'Enable smooth shading (vertex colors, lighting)',
        default=True
    )
    geometrymode_G_LIGHTING_POSITIONAL = bpy.props.BoolProperty(
        name='Point Lighting'
    )

    texture_u_0 = bpy.props.EnumProperty(
        items=[
            ('WRAP',   'Wrap'   ,'', 'TEXTURE', 0),
            ('CLAMP',  'Clamp'  ,'', 'MOD_EDGESPLIT', 1),
            ('MIRROR', 'Mirror' ,'', 'MOD_MIRROR', 2),
        ],
        name='U',
        default='WRAP',
        update=omp_change_texture_u_0
    )
    texture_u_1 = bpy.props.EnumProperty(
        items=[
            ('WRAP',   'Wrap'   ,'', 'TEXTURE', 0),
            ('CLAMP',  'Clamp'  ,'', 'MOD_EDGESPLIT', 1),
            ('MIRROR', 'Mirror' ,'', 'MOD_MIRROR', 2),
        ],
        name='U',
        default='WRAP',
        update=omp_change_texture_u_1
    )
    
    texture_v_0 = bpy.props.EnumProperty(
        items=[
            ('WRAP',   'Wrap'   ,'', 'TEXTURE', 0),
            ('CLAMP',  'Clamp'  ,'', 'MOD_EDGESPLIT', 1),
            ('MIRROR', 'Mirror' ,'', 'MOD_MIRROR', 2),
        ],
        name='V',
        default='WRAP',
        update=omp_change_texture_v_0
    )    
    texture_v_1 = bpy.props.EnumProperty(
        items=[
            ('WRAP',   'Wrap'   ,'', 'TEXTURE', 0),
            ('CLAMP',  'Clamp'  ,'', 'MOD_EDGESPLIT', 1),
            ('MIRROR', 'Mirror' ,'', 'MOD_MIRROR', 2),
        ],
        name='V',
        default='WRAP',
        update=omp_change_texture_v_1
    )

    shading = bpy.props.EnumProperty(
        items=[
            ('LIGHTING',         'Lighting',      'OoT Lighting'),
            ('VERTEX_COLOR',     'Vertex Color',  'Vertex Color'),
            ('VERTEX_ALL',       'Vertex Full',   'Vertex Full'),
        ],
        name='Shading',
        default='LIGHTING',
        update=omp_change_shade
    )
    alpha_mode = bpy.props.EnumProperty(
        items=[
            ('OPAQUE', 'Opaque', ''),
            ('CLIP',   'Clip',   ''),
            ('BLEND',  'Blend',  ''),
        ],
        name='Alpha Mode',
        default='OPAQUE',
        update=omp_change_alpha
    )

    texture_filter = bpy.props.EnumProperty(
        items=[
            ('G_TF_POINT',   'Closest',      'Nearest Neighbor'),
            ('G_TF_BILERP',  'N64-Bilinear', '3-point filtering'),
            ('G_TF_AVERAGE', 'Bilinear',     '4-point filtering, maybe?'),
        ],
        name='Texture Filter',
        default='G_TF_BILERP',
        update=omp_change_texture_filter
    )

    lock_material = bpy.props.BoolProperty(
        name='Lock',
        description='Do not let alpha switching affect these settings'
    )

# add rendermode_blending_cycle%d_custom_%s properties to ObjexMaterialProperties for each cycle 0,1 and each variable P,A,M,B
for c in (0,1):
    for v,choices,d in (
    # variable   choices                                                     default
        ('P', ('G_BL_CLR_IN','G_BL_CLR_MEM','G_BL_CLR_BL','G_BL_CLR_FOG'), 'G_BL_CLR_IN'),
        ('A', ('G_BL_A_IN','G_BL_A_FOG','G_BL_A_SHADE','G_BL_0'),          'G_BL_A_IN'),
        ('M', ('G_BL_CLR_IN','G_BL_CLR_MEM','G_BL_CLR_BL','G_BL_CLR_FOG'), 'G_BL_CLR_MEM'),
        ('B', ('G_BL_1MA','G_BL_A_MEM','G_BL_1','G_BL_0'),                 'G_BL_1MA')
    ):
        setattr(ObjexMaterialProperties, 'rendermode_blending_cycle%d_custom_%s' % (c,v), bpy.props.EnumProperty(
            items=[(choices[i],choices[i],'',i+1) for i in range(4)],
            name='%s' % v,
            default=d
        ))

# images
class ObjexImageProperties(bpy.types.PropertyGroup):
    format = bpy.props.EnumProperty(
            items=[
                # number identifiers are 0xFS with F~G_IM_FMT_ and S~G_IM_SIZ_
                ('I4','I4','Greyscale shared with alpha, 16 values (AAAA)',0x40),
                ('I8','I8','Greyscale shared with alpha, 256 values (AAAA AAAA)',0x41),
                ('IA4','IA4','Greyscale 8 values and alpha on/off (CCCA)',0x30),
                ('IA8','IA8','Distinct greyscale and alpha, 16 values each (CCCC AAAA)',0x31),
                ('IA16','IA16','Distinct greyscale and alpha, 256 values each (CCCC CCCC AAAA AAAA)',0x32),
                ('RGBA16','RGBA16','32 values per color red/green/blue, and alpha on/off (RRRR RGGG GGBB BBBA)',0x02),
                ('RGBA32','RGBA32','256 values per color red/green/blue and alpha (RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA)',0x03),
                ('CI4','CI4','Paletted in 16 colors',0x20),
                ('CI8','CI8','Paletted in 256 colors',0x21),
                ('AUTO','Auto','Do not specify a format',0xFF),
            ],
            name='Format',
            description='What format to use when writing the texture',
            default='AUTO'
        )
    palette = bpy.props.IntProperty(
            name='Palette',
            description='Palette slot to use (0 for automatic)\nSeveral paletted textures (CI format) may use the same palette slot to save space',
            min=0,
            soft_max=255, # todo ?
            default=0
        )
    alphamode = bpy.props.EnumProperty(
            items=[
                ('AUTO','Auto','Defaults to edge if format is not I (greyscale shared with alpha)',0),
                ('edge','Edge','Color is taken from visible edges',1),
                ('average','Average','Use average of all visible colors',2),
                ('white','White','Use white',3),
                ('black','Black','Use black',4),
                ('image','Image','Use colors as they are in the input image.\n'
                                '(falls back to Edge on CI formats (paletted) if there are more than four unique invisible colors)',5),
            ],
            name='Alpha',
            description='What color to write for fully transparent pixels.\n'
                        '(color of such pixels can indeed still show due to not-nearest-neighbour texture filtering)',
            default='AUTO'
        )
    alphasource = bpy.props.EnumProperty(
        items=[
            ("Alpha","Alpha",""),
            ("Color","Color",""),
        ],
        name="Source",
        default="Alpha",
        update=omp_change_texel_alpha_source
    )
    pointer = bpy.props.StringProperty(
            name='Segment',
            description='The address that should be used when referencing this texture',
            default='',
            update=omp_change_texel_segment
        )
    priority = bpy.props.IntProperty(
            name='Priority',
            description='Textures with higher priority are written first',
            default=0
        )
    force_write = bpy.props.EnumProperty(
            items=[
                ('FORCE_WRITE','Always','Force the texture to be written',1),
                ('DO_NOT_WRITE','Never','Force the texture to NOT be written',2),
                ('UNSPECIFIED','If used','Texture will be written if it is used',3),
            ],
            name='Write',
            description='Explicitly state to write or to not write the image',
            default='UNSPECIFIED'
        )
    texture_bank = bpy.props.PointerProperty(
            type=bpy.types.Image,
            name='Bank',
            description='Image data to write instead of this texture, useful for dynamic textures (eyes, windows)'
        )

classes = (
    SavedPoseBone,
    SavedPose,

    ObjexSceneProperties,

    ObjexMeshProperties,

    ObjexArmatureExportActionsItem,
    ObjexArmatureProperties,

    ObjexMaterialCollisionProperties,
    ObjexMaterialProperties,

    ObjexImageProperties,
)

def register_properties():
    log = getLogger('properties')
    for clazz in classes:
        try:
            blender_version_compatibility.adapt_ID_PointerProperty(clazz)
            blender_version_compatibility.make_annotations(clazz)
            bpy.utils.register_class(clazz)
        except:
            log.exception('Failed to register {!r}', clazz)
            raise
    bpy.types.Scene.objex_bonus = bpy.props.PointerProperty(type=ObjexSceneProperties)
    bpy.types.Mesh.objex_bonus = bpy.props.PointerProperty(type=ObjexMeshProperties)
    bpy.types.Armature.objex_bonus = bpy.props.PointerProperty(type=ObjexArmatureProperties)
    bpy.types.Material.objex_bonus = bpy.props.PointerProperty(type=ObjexMaterialProperties)
    bpy.types.Image.objex_bonus = bpy.props.PointerProperty(type=ObjexImageProperties)

def unregister_properties():
    del bpy.types.Scene.objex_bonus
    del bpy.types.Mesh.objex_bonus
    del bpy.types.Armature.objex_bonus
    del bpy.types.Material.objex_bonus
    del bpy.types.Image.objex_bonus
    for clazz in reversed(classes):
        try:
            bpy.utils.unregister_class(clazz)
        except:
            log.exception('Failed to unregister {!r}', clazz)