temporary workaround for issue with 4.4.3 visibility channel import (#272)

* temporary workaround for issue with 4.4.3 visibility channel import

* print a warning if visibility channel is available in animation import on 4.4.3

Author: Tarcontar

.github/workflows/ci.yml

@@ -29,6 +29,9 @@ jobs:
           - blender-version: '4.2'
             blender-version-suffix: '0'
             python-version: '3.11.7'
+          - blender-version: '4.4'
+            blender-version-suffix: '3'
+            python-version: '3.11.7'
 
     steps:
     - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,30 +1,36 @@
 # Version History
 
 ## v0.7.2 (28.09.24)
+
 * adapt to API changes in Blender 4.2+
 
 ## v0.7.1 (29.01.24)
-* adapt to API changes in Blender 4.0+
 
+* adapt to API changes in Blender 4.0+
 
 ## v0.7.0 (09.09.23)
+
 * delete base sphere object and mesh after hierarchy import
 * fix face distance calculation to match 3DS max exporter
 * multi-texture / multi-material support by @nkx111 thx!
 
 ## v0.6.9 (06.04.23)
+
 * fixed export of materials with normal maps
 
 ## v0.6.8 (29.12.21)
+
 * fixed issues with api changes in blender 3.0
 * export texture names always with '.tga' extension
 
 ## v0.6.7 (22.10.21)
+
 * added auto updater
 * adaptions for python 3.9 used in blender 2.93 and later
 * Bugfix: pivot and vertex groups are compared all lowercase
 
 ## v0.6.6 (24.7.21)
+
 * display valid vertex color layer names if layer name is invalid
 * display actual bone weights if they do not add up to 100%
 * inform user on animation import that armature might have been hidden due to visibility channels
@@ -34,13 +40,15 @@
 * Bugfix: do not crash if mesh has more shader structs than vertex materials
 
 ## v0.6.5 (26.3.21)
+
 * cancel export if a mesh and a bone share the same name and mesh is not configured properly
 * inform user if both vertex bone weights do not add up to 100%
 * Bugfix: handling of specular and emission color
 * Bugfix: use proper file extension for loaded textures
 * Bugfix: split vertices with n uv-coords into n vertices
 
 ## v0.6.4 (23.2.21)
+
 * support mesh property 'two sided'
 * cancel export if vertices are not rigged to any bone
 * cancel export if vertices are rigged to more than 2 bones
@@ -51,13 +59,16 @@
 * Bugfix: normalize quaternions on animation export
 
 ## v0.6.3 (17.1.20)
+
 * geometry data can now be exported to xml and ini
 
 ## v0.6.2 (01.12.20)
+
 * support for floats in xml files with ',' and '.'
 * support more collision box properties (type, collision_type)
 
 ## v0.6.0 (28.7.20)
+
 * export dummy shade indices (they are needed for the mod SDK (at least for W3X))
 * support for mesh sorting levels
 * only display appropriate custom object properties
@@ -72,6 +83,7 @@
 * Bugfix: set hierarchy name always uppercase
 
 ## v0.5.0 (10.06.20)
+
 * use proper enums for vertex material shader properties
 * create pivots for meshes on export if they have no parent bone
 * create a bone for each hierarchy pivot on import (otherwise pivot order can not be maintained on roundtrip)
@@ -84,9 +96,11 @@
 * Bugfix: use proper hierarchy name for animation and hlod on export
 
 ## v0.4.7 (26.04.20)
+
 * Bugfix: fixed installation issue
 
 ## v0.4.6 (24.04.20)
+
 * apply modifiers to meshes on export
 * handle export of 'multi-user' meshes
 * default material type is now 'VERTEX_MATERIAL'
@@ -95,6 +109,7 @@
 * Bugfix: check for referenced armature case insensitive
 
 ## v0.4.5 (11.03.20)
+
 * split vertices with multiple uv coordinates on export
 * use actual mesh normals on import
 * export tangents and bitangents
@@ -105,34 +120,41 @@
 * Bugfix: proper bool string export
 
 ## v0.4.4 (19.02.20)
+
 * limit decimal digits in w3x files to 6
 * Bugfix: use armature name as hierarchy ID
 * Bugfix: create includes on export
 
 ## v0.4.3 (13.02.20)
+
 * create only required keyframes on animation import
 * support more texture file formats
 * Bugfix: bone visibility channels
 * Bugfix: do not crash on missing float vector entries
 
 ## v0.4.2 (04.02.20)
+
 * switched to ElementTree for xml stuff
 * Bugfix: write boolean values as lower in w3x
 * Bugfix: loading of animations without include for corresponding hierarchy
 
 ## v0.4.1 (01.02.20)
+
 * support splitted w3x files
 * support w3x single mesh imports
 * Bugfix: do not crash on missing attributes
 
 ## v0.4.0 (31.01.20)
+
 * support for w3x files
 
 ## v0.3.0 (05.01.20)
+
 * support multiple levels of detail in HLod chunks
 * Bugfix: fix rigging issues with C&C Generals and C&C Renegade models
 
 ## v0.2.1 (13.11.19)
+
 * support for basic uncompressd and timecoded animation export
 * added multiple custom properties in order to reduce data loss on roundtrips
 * Bugfix: exported files now work in W3DViewer 6.0 and the recent revora version

README.md

@@ -8,7 +8,7 @@
 ![Sample](/art/AotR_Umbar_Buildings.jpg)
 
 **OpenSAGE.BlenderPlugin**: a free, open source blender plugin for the [Westwood](https://de.wikipedia.org/wiki/Westwood_Studios) 3D
-format used in Command & Conquer™: Generals and other RTS titles from Westwood Studios and EA Pacific. 
+format used in Command & Conquer™: Generals and other RTS titles from Westwood Studios and EA Pacific.
 
 ## Installing and activating
 

io_mesh_w3d/common/utils/animation_import.py

@@ -56,51 +56,54 @@ def set_rotation(bone, frame, value):
     bone.keyframe_insert(data_path='rotation_quaternion', frame=frame)
 
 
-def set_visibility(bone, frame, value):
+def set_visibility(context, bone, frame, value):
     if isinstance(bone, bpy.types.Bone):
-        bone.visibility = value
-        bone.keyframe_insert(data_path='visibility', frame=frame, options=creation_options)
+        if bpy.app.version != (4, 4, 3): #TODO fix 4.4.3
+            bone.visibility = value
+            bone.keyframe_insert(data_path='visibility', frame=frame, options=creation_options)
+        else:
+            context.warning(f'bone visibility channels are currently not supported for blender 4.4.3!')
     else:
         bone.hide_viewport = bool(value)
         bone.keyframe_insert(data_path='hide_viewport', frame=frame, options=creation_options)
 
 
-def set_keyframe(bone, channel, frame, value):
+def set_keyframe(context, bone, channel, frame, value):
     if is_visibility(channel):
-        set_visibility(bone, frame, value)
+        set_visibility(context, bone, frame, value)
     elif is_translation(channel):
         set_translation(bone, channel.type, frame, value)
     else:
         set_rotation(bone, frame, value)
 
 
-def apply_timecoded(bone, channel):
+def apply_timecoded(context, bone, channel):
     for key in channel.time_codes:
-        set_keyframe(bone, channel, key.time_code, key.value)
+        set_keyframe(context, bone, channel, key.time_code, key.value)
 
 
-def apply_motion_channel_time_coded(bone, channel):
+def apply_motion_channel_time_coded(context, bone, channel):
     for datum in channel.data:
-        set_keyframe(bone, channel, datum.time_code, datum.value)
+        set_keyframe(context, bone, channel, datum.time_code, datum.value)
 
 
-def apply_motion_channel_adaptive_delta(bone, channel):
+def apply_motion_channel_adaptive_delta(context, bone, channel):
     data = decode(channel.type, channel.vector_len, channel.num_time_codes, channel.data.scale, channel.data.data)
     for i in range(channel.num_time_codes):
-        set_keyframe(bone, channel, i, data[i])
+        set_keyframe(context, bone, channel, i, data[i])
 
 
-def apply_adaptive_delta(bone, channel):
+def apply_adaptive_delta(context, bone, channel):
     data = decode(channel.type, channel.vector_len, channel.num_time_codes, channel.scale, channel.data)
     for i in range(channel.num_time_codes):
-        set_keyframe(bone, channel, i, data[i])
+        set_keyframe(context, bone, channel, i, data[i])
 
 
-def apply_uncompressed(bone, channel):
+def apply_uncompressed(context, bone, channel):
     for index in range(channel.last_frame - channel.first_frame + 1):
         data = channel.data[index]
         frame = index + channel.first_frame
-        set_keyframe(bone, channel, frame, data)
+        set_keyframe(context, bone, channel, frame, data)
 
 
 def process_channels(context, hierarchy, channels, rig, apply_func):
@@ -109,7 +112,7 @@ def process_channels(context, hierarchy, channels, rig, apply_func):
         if obj is None:
             continue
 
-        apply_func(obj, channel)
+        apply_func(context, obj, channel)
 
 
 def process_motion_channels(context, hierarchy, channels, rig):
@@ -119,9 +122,9 @@ def process_motion_channels(context, hierarchy, channels, rig):
             continue
 
         if channel.delta_type == 0:
-            apply_motion_channel_time_coded(obj, channel)
+            apply_motion_channel_time_coded(context, obj, channel)
         else:
-            apply_motion_channel_adaptive_delta(obj, channel)
+            apply_motion_channel_adaptive_delta(context, obj, channel)
 
 
 def create_animation(context, rig, animation, hierarchy):

tests/common/cases/structs/test_animation.py

@@ -1,7 +1,7 @@
 # <pep8 compliant>
 # Written by Stephan Vedder and Michael Schnabel
 
-import io
+import io, bpy
 from tests.common.helpers.animation import *
 from tests.utils import TestCase
 from unittest.mock import patch, call
@@ -12,8 +12,12 @@ def test_write_read(self):
         expected = get_animation()
 
         self.assertEqual(52, expected.header.size())
-        self.assertEqual(683, expected.size(False))
-        self.assertEqual(691, expected.size())
+        if bpy.app.version == (4, 4, 3):
+            self.assertEqual(645, expected.size(False))
+            self.assertEqual(653, expected.size())
+        else:
+            self.assertEqual(683, expected.size(False))
+            self.assertEqual(691, expected.size())
 
         self.write_read_test(expected, W3D_CHUNK_ANIMATION, Animation.read, compare_animations, self, True)
 

tests/common/helpers/animation.py

@@ -1,6 +1,6 @@
 # <pep8 compliant>
 # Written by Stephan Vedder and Michael Schnabel
-
+import bpy
 from io_mesh_w3d.common.structs.animation import *
 from tests.mathutils import *
 from tests.w3d.helpers.version import *
@@ -99,9 +99,8 @@ def compare_animation_bit_channels(self, expected, actual):
 
 
 def get_animation(hierarchy_name='TestHierarchy', xml=False):
-    return Animation(
-        header=get_animation_header(hierarchy_name),
-        channels=[get_animation_channel(type=0, pivot=0),
+    channels = [
+                  get_animation_channel(type=0, pivot=0),
                   get_animation_channel(type=1, pivot=1),
                   get_animation_channel(type=2, pivot=1),
 
@@ -114,9 +113,15 @@ def get_animation(hierarchy_name='TestHierarchy', xml=False):
                   get_animation_channel(type=1, pivot=3),
                   get_animation_channel(type=2, pivot=3),
                   get_animation_channel(type=6, pivot=3),
-
-                  get_animation_bit_channel(pivot=6, xml=xml),
-                  get_animation_bit_channel(pivot=7)])
+                ]
+    
+    if bpy.app.version != (4, 4, 3): #TODO fix 4.4.3
+        channels.append(get_animation_bit_channel(pivot=6, xml=xml))
+        channels.append(get_animation_bit_channel(pivot=7))
+    
+    return Animation(
+        header=get_animation_header(hierarchy_name),
+        channels=channels)
 
 
 def get_animation_minimal():