Alembic loaders: Add `Always Add Cache Reader` loaded options by moonyuet · Pull Request #252 · ynput/ayon-blender

moonyuet · 2026-02-06T10:56:24Z

Changelog Description

This PR is to add the setting of Always Add Cache Render for the alembic loader options, it would also support to synchronize the related settings from AYON.

Resolve #251

Additional review information

n/a

Testing notes:

Build blender addon with this branch
Set the toggle from ayon+settings://blender/load/AbcCameraLoader/always_add_cache_reader or ayon+settings://blender/load/CacheModelLoader/always_add_cache_reader
Load Alembic objects
Should be working.

BigRoy

Nice! Looks good @moonyuet

Did you test run it as well? Or do we need more thorough testing from @LiborBatek ?

client/ayon_blender/plugins/load/load_cache.py

client/ayon_blender/plugins/load/load_camera_abc.py

server/settings/loaders.py

client/ayon_blender/plugins/load/load_cache.py

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

server/settings/loaders.py

LiborBatek

The Always Add Cache Reader works as expected...it also propagates from settings to the loader and options which is right.

All been working nicely.

There is only one flaw and that is when version managed and setting different version.

as the cache file is not properly connected to the Cache reader.

so the updated version is not animated anymore. However the Alembic cache file got swapped for correct version but unassigned to the cache reader

Not sure tho if connected to this PR or unrelated...leaving it to your decision.

BigRoy · 2026-02-06T14:37:39Z

I think that is a bug actually - probably even for animated transforms even before this PR (that did require a cache attached too)...

Seems like we're not processing TransformCache modifiers but only MeshSequenceCache ones @moonyuet ?
Or am I misreading this logic in this method?

@LiborBatek may be nice if you share with Kayla your test scene so she can reproduce easily and tweak it and confirm herself first it's stable when committing changes.

…ct_path during update

…ive children too with Cache Loader

client/ayon_blender/plugins/load/load_cache.py

moonyuet · 2026-02-11T03:25:10Z

@BigRoy Although the fixes appear to simplify the codebase, it doesn't seems to be working to setting correct filepath when setting version/upversioning.
The video shows how it doesn't work.
https://github.com/user-attachments/assets/9af2dd64-5185-4a92-87c1-98f6fd99b5e7

Similar things happened to the cache loader too (Mesh_Sequence_Modifier has disappeared), but I don't have generic example for testing the cache loader.

As this PR is more about adding Always Add Cache Reader as options, perhaps it would be helpful that we could revert the fix first, merge the relevant and then discuss the fixes in a separate issue? (Coming with this suggestion also contributes to the fact that it is sponsored PR).

LiborBatek · 2026-02-11T10:24:28Z

I have tested it again and even tho there are no issues with object_path within the cache modifier I have experienced weird version managing.

Please see vid below. Generally it can work for a first time when using e.g. Manage > Set Version but fails for a second time while using e.g. Manage > Update to Latest resulting into some duplication of linked cache files and suffix.

However it does set object path within the modifier in most occasions. Still not functional and reliable atm

blender-abc-manage.mp4

Note: I have tested it with both Alembic caches originating from the blender and also from outside (maya based ones) behaves very much the same in both occasions...

BigRoy · 2026-02-12T14:38:11Z

These breakings also happens for both MeshSequenceCache modifier used and also when using Transform Cache contraints...

Let's discuss these issues in a call where you can show what's happening please.

BigRoy · 2026-02-12T14:56:15Z

Let's discuss these issues in a call where you can show what's happening please.

So the case here is that inside the alembics you're updating between is that the object paths have changed. So I'll add some behavior that finds the best match.

…to (longest matching suffix)

…ng-Always-Add-Cache-Reader-argument' of https://github.com/ynput/ayon-blender into enhancement/YN-0479--Blender-Alembic-Loader-allow-setting-Always-Add-Cache-Reader-argument # Conflicts: # client/ayon_blender/plugins/load/load_cache.py

…en assigned to a single modifier or constraints

…n't create extra duplciate when the always_create_cache_loader is False

…9--Blender-Alembic-Loader-allow-setting-Always-Add-Cache-Reader-argument

BigRoy · 2026-02-13T08:19:56Z

client/ayon_blender/plugins/load/load_cache.py

+                cache for cache in bpy.data.cache_files
+                if cache in remove_caches and not lib.has_users(cache)
+            }
+


I don't see what this has to do with always_add_cache_reader. It also applies if it just happen to have applied cache to just a few.

Also, I may be misreading this, but this would essentially always result in the exact same remove_caches as just above. Because it will be in bpy.data.cache_files, it will be in remove_caches and the not lib.has_users check was also alreayd perform on the cache. As such, this logic can be removed.

Suggested change

I don't see what this has to do with always_add_cache_reader. It also applies if it just happen to have applied cache to just a few.

Not really, it would add up but not remove the target from bpy.data.cache_files. like I showed in #252 (comment) but this time is the cache loader.

I don't understand, sorry. Can you explain how this differs?

I don't understand, sorry. Can you explain how this differs?

Okay. My bad, let's clean this up(407fbd9). We can fix it later, the issue is still there when the always_add_cache_reader disabled with/without the cache

Recording.2026-02-13.164655.mp4

client/ayon_blender/plugins/load/load_camera_abc.py

LiborBatek

Im still getting errors while trying to version manage Animation in Abc which differs in object paths unfortunatelly...

getting this traceback in the console:

Running callback: <bound method CacheModelLoader.exec_update of []>
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh' not found in new cache file 'C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc'  ]
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh'  ]
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor' not found in new cache file 'C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc'  ]
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor'  ]
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh' not found in new cache file 'C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc'  ]
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh'  ]
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model' not found in new cache file 'C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc'  ]
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model'  ]
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor' not found in new cache file 'C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc'  ]
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor'  ]
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain' not found in new cache file 'C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc'  ]
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain'  ]
Done
Alembic: unknown how to handle objects of schema '', skipping object ''
Alembic: unknown how to handle objects of schema '02:15.813  object.modifier  | WARNING Object: "sh010_01_animationMain:vanguard_01_rigMain_vanguard_visor", Modifier: "MeshSequenceCache", Could not create cache reader for file C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc
', skipping object ''Alembic: unknown how to handle objects of schema '
', skipping object ''
Alembic: unknown how to handle objects of schema '', skipping object '02:15.813  object.modifier  | WARNING Object: "sh010_01_animationMain:vanguard_01_rigMain_vanguard_Mesh", Modifier: "MeshSequenceCache", Could not create cache reader for file C:/projects/Blender/Shots/sh010/publish/animation/animationMain/v003/Blnd_sh010_animationMain_v003.abc
'
Alembic: unknown how to handle objects of schema '', skipping object ''

BigRoy · 2026-02-13T09:21:30Z

client/ayon_blender/plugins/load/load_cache.py


-    def _process(self, libpath, asset_group, group_name, options=None):
+    def _process(self, libpath, asset_group, group_name,
+                 options: Optional[Dict] = None):


Just to be clear, the code in this method does not expect this to be None for the Alembic case - because None.get("always_add_cache_reader") would fail. So either we need

if options is None: options = {}

Or it should not have it as optional, and just require the dict.

BigRoy · 2026-02-13T09:23:12Z

No replacement found for object path '/vanguard_01_rigMain'

@moonyuet it may be worth logging the cache_file.object_paths if no replacement is found. Just to make it easier to ever debug why it couldn't be found. The only downside is - that cache_file.object_paths may be massive. :/ So we should perhaps log it only once?

Then with those logs - would be good to debug with Libor why his case fails.

… not None for the dictionary data

client/ayon_blender/plugins/load/load_cache.py

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

moonyuet · 2026-02-13T14:19:01Z

@BigRoy I got the files from Libor and find out that the empty lists from the new_cache.object_paths.

!!! ERR: 2026-02-13 22:17:29,670 >>> { ProductLoader }: [  Loader CacheModelLoader is doesn't specify `product_base_types` but product entity has `productBaseType` defined as `pointcache`.   ] 
[INFO]:   load_with_repre_context:  Running 'CacheModelLoader' on '/lib'
!!! ERR: 2026-02-13 22:17:30,502 >>> { ProductLoader }: [  Loader CacheModelLoader is doesn't specify `product_base_types` but product entity has `productBaseType` defined as `pointcache`.   ] 
!!! ERR: 2026-02-13 22:17:30,503 >>> { ProductLoader }: [  Loader AbcCameraLoader is doesn't specify `product_base_types` but product entity has `productBaseType` defined as `pointcache`.   ] 
!!! ERR: 2026-02-13 22:17:30,503 >>> { ProductLoader }: [  Loader LoadImageCompositor is doesn't specify `product_base_types` but product entity has `productBaseType` defined as `pointcache`.   ] 
!!! ERR: 2026-02-13 22:17:30,503 >>> { ProductLoader }: [  Loader LoadImageShaderEditor is doesn't specify `product_base_types` but product entity has `productBaseType` defined as `pointcache`.   ] 
>>> [  new_cache object paths '[]'  ] 
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model' not found in new cache file 'D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc'  ] 
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model'  ] 
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor' not found in new cache file 'D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc'  ] 
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor'  ] 
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain' not found in new cache file 'D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc'  ] 
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain'  ] 
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor' not found in new cache file 'D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc'  ] 
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_visor/vanguard_01_rigMain_vanguard_visor'  ] 
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh' not found in new cache file 'D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc'  ] 
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh'  ] 
*** WRN: >>> { ProductLoader }: [  Object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh' not found in new cache file 'D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc'  ] 
*** WRN: >>> { ProductLoader }: [  No replacement found for object path '/vanguard_01_rigMain/vanguard_01_rigMain_model/vanguard_01_rigMain_vanguard_Mesh/vanguard_01_rigMain_vanguard_Mesh'  ] 
Alembic import D:\sh_boss_proj\interior_lenny\lib\publish\pointcache\pointcacheObjectPath\v002\il_lib_pointcacheObjectPath_v002.abc took 9.24 ms
Alembic import took 9.35 ms
Alembic: unknown how to handle objects of schema '', skipping object ''Alembic: unknown how to handle objects of schema '', skipping object '
Alembic: unknown how to handle objects of schema '', skipping object '''

01:06.969  object.modifier  | WARNING Object: "lib_01_pointcacheObjectPath:vanguard_01_rigMain_vanguard_Mesh", Modifier: "MeshSequenceCache", Could not create cache reader for file D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc
Alembic: unknown how to handle objects of schema 'Alembic: unknown how to handle objects of schema '', skipping object '', skipping object '''

01:06.969  object.modifier  | WARNING Object: "lib_01_pointcacheObjectPath:vanguard_01_rigMain_vanguard_visor", Modifier: "MeshSequenceCache", Could not create cache reader for file D:/sh_boss_proj/interior_lenny/lib/publish/pointcache/pointcacheObjectPath/v001/il_lib_pointcacheObjectPath_v001.abc

BigRoy

Works for me.

moonyuet · 2026-02-14T06:04:01Z

I tested with blender 5.0.1, it works correctly as expected.

testing_video.mp4

add Always Add Cache Reader options for alembic loaders

14d12e4

moonyuet requested review from BigRoy and LiborBatek February 6, 2026 10:56

moonyuet self-assigned this Feb 6, 2026

moonyuet added type: enhancement Improvement of existing functionality or minor addition sponsored This is directly sponsored by a client or community member labels Feb 6, 2026

BigRoy reviewed Feb 6, 2026

View reviewed changes

moonyuet and others added 5 commits February 6, 2026 19:04

Update server/settings/loaders.py

d4f6e27

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

Update client/ayon_blender/plugins/load/load_cache.py

738932b

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

Update client/ayon_blender/plugins/load/load_cache.py

1940bba

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

Update server/settings/loaders.py

d0e6083

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

store the options as imprinted data

a1574a7

moonyuet requested a review from BigRoy February 6, 2026 11:15

BigRoy requested changes Feb 6, 2026

View reviewed changes

server/settings/loaders.py Show resolved Hide resolved

complete the loader plugiins

d602549

moonyuet requested a review from BigRoy February 6, 2026 13:24

complete the loader plugiins

0806951

LiborBatek reviewed Feb 6, 2026

View reviewed changes

add check on the asset_name of the object path to find the right obje…

e22a53f

…ct_path during update

moonyuet requested a review from LiborBatek February 9, 2026 13:21

BigRoy added 3 commits February 11, 2026 00:54

Simplify cache updating logic + update transform cache for all recurs…

0a38203

…ive children too with Cache Loader

Remove redundant get_cache_modifiers

5108d63

Tweak comment

e7473d9

BigRoy reviewed Feb 11, 2026

View reviewed changes

client/ayon_blender/plugins/load/load_cache.py Outdated Show resolved Hide resolved

BigRoy self-requested a review February 11, 2026 00:00

BigRoy and others added 2 commits February 11, 2026 02:25

Remove unused prev_filename

99d8916

remov unused import

ad3b84e

moonyuet and others added 8 commits February 12, 2026 23:02

roy's comment add some more condition check on removed cache file

756f4af

style ruff fix

5d982c9

add unnecessary import

7832f4b

Implement Object Path Matcher to find best matching object to update …

f235dc9

…to (longest matching suffix)

Try accessing CacheFile.object_paths later until it has at least be…

4b771aa

…en assigned to a single modifier or constraints

clean up the code for lib.get_user & make sure bpy.data.cache_file wo…

8dc03b5

…n't create extra duplciate when the always_create_cache_loader is False

Merge remote-tracking branch 'origin/develop' into enhancement/YN-047…

41afb71

…9--Blender-Alembic-Loader-allow-setting-Always-Add-Cache-Reader-argument

moonyuet requested a review from BigRoy February 13, 2026 07:22

BigRoy reviewed Feb 13, 2026

View reviewed changes

client/ayon_blender/plugins/load/load_camera_abc.py Show resolved Hide resolved

BigRoy reviewed Feb 13, 2026

View reviewed changes

client/ayon_blender/plugins/load/load_camera_abc.py Show resolved Hide resolved

remove the check on wehther always_add_cache_reader

407fbd9

moonyuet requested a review from BigRoy February 13, 2026 08:58

LiborBatek reviewed Feb 13, 2026

View reviewed changes

BigRoy reviewed Feb 13, 2026

View reviewed changes

add new log message for checking object paths and make sure option is…

b989a62

… not None for the dictionary data

BigRoy reviewed Feb 13, 2026

View reviewed changes

client/ayon_blender/plugins/load/load_cache.py Outdated Show resolved Hide resolved

Update client/ayon_blender/plugins/load/load_cache.py

d3deaf9

Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>

moonyuet and others added 3 commits February 13, 2026 23:47

use asset_group.children instead of asset_group.children_recursive

bd3c7bf

wip add debug message

e83df35

Fix updating of object paths

589c521

BigRoy approved these changes Feb 13, 2026

View reviewed changes

moonyuet merged commit 2ba7f16 into develop Feb 14, 2026
1 check passed

moonyuet deleted the enhancement/YN-0479--Blender-Alembic-Loader-allow-setting-Always-Add-Cache-Reader-argument branch February 14, 2026 06:04

Conversation

moonyuet commented Feb 6, 2026

Changelog Description

Additional review information

Testing notes:

Uh oh!

BigRoy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LiborBatek left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BigRoy commented Feb 6, 2026

Uh oh!

Uh oh!

moonyuet commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LiborBatek commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BigRoy commented Feb 12, 2026

Uh oh!

BigRoy commented Feb 12, 2026

Uh oh!

BigRoy Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

moonyuet Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BigRoy Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

moonyuet Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

LiborBatek left a comment

Choose a reason for hiding this comment

Uh oh!

BigRoy Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

BigRoy commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

moonyuet commented Feb 13, 2026

Uh oh!

BigRoy left a comment

Choose a reason for hiding this comment

Uh oh!

moonyuet commented Feb 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LiborBatek left a comment •

edited

Loading

moonyuet commented Feb 11, 2026 •

edited

Loading

LiborBatek commented Feb 11, 2026 •

edited

Loading

moonyuet Feb 13, 2026 •

edited

Loading

moonyuet Feb 13, 2026 •

edited

Loading

BigRoy commented Feb 13, 2026 •

edited

Loading