Compare commits

..

54 Commits
8.1.1 ... 9.0.1

Author SHA1 Message Date
Colin Basnett
fd3e54eb10 Incremented version to 9.0.1 2025-12-08 19:46:09 -08:00
Colin Basnett
cc730b6ce3 Implement #136: Added support for exporting group properties for sequences 2025-12-03 17:44:05 -08:00
Colin Basnett
94c940b970 Added psk_psa_py package to replace basic data IO
Fixed PSK and PSA export
2025-12-02 17:44:40 -08:00
Colin Basnett
c5bb526843 Added support for podman when running tests
I use Bazzite, and it uses `podman` for it's container CLI system.
2025-11-27 14:43:11 -08:00
Colin Basnett
384f017bdd Fixed shape key value test asserts 2025-11-27 13:55:25 -08:00
Colin Basnett
485d46e075 Added typing casts to PSK import tests 2025-11-27 13:45:32 -08:00
Colin Basnett
d7bc8fd080 Fix #137: Shape keys start with 1.0 value on PSK import
There was an undocumented change in 5.0 where the shape keys now start with a weight of 1.0 instead of 0.0 when created.

I have added an assert in the shape key test to make sure that the values are set to `0.0`.

This also fixes the assertion in the poll function (asserts should never be in poll functions).
2025-11-27 13:44:51 -08:00
Colin Basnett
c370bc902b Now using fcurves.ensure when assembling import bone fcurve list 2025-11-27 13:17:00 -08:00
Colin Basnett
fe97b229d9 Channel bags now being created using the anim_utils convenience function 2025-11-27 13:10:56 -08:00
Colin Basnett
622aa46a82 Removed soon-to-be-deprecated Material.use_nodes assignment 2025-11-27 13:03:11 -08:00
Colin Basnett
66881d5ac1 Changed Blender 4.4 references to 5.0 2025-11-27 12:59:35 -08:00
Colin Basnett
1bac8b2b30 Fix #139: PSA import does not work on Blender 5.0 2025-11-27 12:52:40 -08:00
Colin Basnett
3153be3cdf Fix for error when exporting from Blender 5.0
`Action.fcurves` was removed. We now use `layers` to determine if there is data or not.
2025-11-24 15:17:42 -08:00
Colin Basnett
9b98909c8b Fixed embarrassing typo that stopped PSK collection exporter from working 2025-11-22 21:09:11 -08:00
Colin Basnett
37f7cc4d9f Increment version to 8.2.4 2025-11-08 18:28:21 -08:00
Colin Basnett
93083f09f8 Fix #135: Extra UV maps have incorrect data
This was caused by a regression caused by 29831d7f09.

The test for importing extra UVs has been updated to check that the data is different between the different UV layers.
2025-11-08 18:27:40 -08:00
Colin Basnett
75660f9dc1 Incremented version to 8.2.3 2025-10-31 12:43:09 -07:00
Colin Basnett
5421ac5151 Removed debugging code 2025-10-31 12:42:14 -07:00
Colin Basnett
9dcbb74058 Fix for missing transform source and broken scale controls on PSK export dialog 2025-10-31 12:41:14 -07:00
Colin Basnett
8ed985263c Fix for bad class inclusion 2025-10-06 17:57:55 -07:00
Colin Basnett
d91408ecab Incremented version to 8.2.2 2025-10-06 17:52:59 -07:00
Colin Basnett
dd1ea683bb Added bone mapping option to ignore trailing whitespace
Some very old PSKs and PSAs have trailing spaces in the bone names instead of padding the buffer with null bytes.

Trailing whitespace will now be ignored by default to maximize compatibility.
2025-10-06 17:48:51 -07:00
Colin Basnett
240b79d374 Fixed a number of PEP warnings
Most of these are just assert statements to silence the warnings for accessing optionals
2025-09-20 12:34:35 -07:00
Colin Basnett
33e7862288 Converted __init__ module initialisation to new pattern
Thanks to Dr. Sybren for the BCON25 presentation that tipped me off to the existence of `register_classes_factory`.
2025-09-18 23:29:14 -07:00
Colin Basnett
b4eefaba6f Increased the minimum Blender version to 4.4 2025-08-17 17:20:07 -07:00
Colin Basnett
ca869731e7 Incremented version to 8.2.1 2025-08-17 13:20:16 -07:00
Colin Basnett
20c8a39f23 Fixed is_action_for_object failing when action had multiple slots 2025-08-17 13:19:47 -07:00
Colin Basnett
8d2f46c2b1 Split axis selection functionality from TransformMixin 2025-08-10 22:12:46 -07:00
Colin Basnett
84863d9de4 Fixed same invalid faces bug, but for the Extra UVs channel 2025-08-09 17:48:55 -07:00
Colin Basnett
ef38b896a6 Added unit test for import PSKs with invalid faces 2025-08-03 01:50:31 -07:00
Colin Basnett
3e54378a57 Incremented version to 8.2.0 2025-08-03 01:43:47 -07:00
Colin Basnett
75cee40604 Merge branch '8.2.0' 2025-08-03 01:43:15 -07:00
Colin Basnett
7cc36d427e Minor formatting fix 2025-08-03 01:42:54 -07:00
Colin Basnett
5c50e76771 Moved get_collection_*from_context functions to helpers.py 2025-08-03 01:42:44 -07:00
Colin Basnett
bd3ea76109 Fixed a bug where meshes with invalid faces could not be imported 2025-08-03 01:41:29 -07:00
Colin Basnett
f4b20e4e0f Reverted to old "is action for armature" functionality
The current Blender 4.4 functionality is still very wishy washy (not able to inspect channel bags), and the solution that was created was broken.

In addition, newly created actions will be given an appropriately named slot instead of it being a "Legacy Slot".
2025-08-03 01:40:38 -07:00
Colin Basnett
921efe97aa Minor fixes 2025-07-23 10:26:56 -07:00
Colin Basnett
4767081bc4 Update README.md 2025-06-19 18:41:24 +00:00
Colin Basnett
ff4cbc8871 Update README.md 2025-06-19 18:40:07 +00:00
Colin Basnett
7d0c520019 Update README.md 2025-06-19 18:39:33 +00:00
Colin Basnett
e7ce934383 Improve empty material slot error message 2025-06-07 19:29:59 -07:00
Colin Basnett
a48fcbd6e3 Ignore empty armature modifiers on PSK export 2025-06-07 19:20:29 -07:00
Colin Basnett
253566576e Fix PSK export with no armatures while using ARMATURE export space 2025-06-07 19:19:54 -07:00
Colin Basnett
660a196002 Fix "Advanced" panel being open by default in PSA export 2025-06-07 19:18:02 -07:00
Colin Basnett
98968a8623 Fix error when attempting to export mesh with no UV layers
The fallback behaviour is now to just output zeroes for the UVs if a mesh has no UV layers.
2025-06-07 19:17:39 -07:00
Colin Basnett
29831d7f09 Improved performance of PSK importer by ~40% for large meshes 2025-05-18 01:16:20 -07:00
Colin Basnett
00d9e3996c Fixed an issue where ACTIVE_ACTION sequence source was not working
Also added a scene-level transform source.
2025-05-18 00:46:50 -07:00
Colin Basnett
ff2fe35846 Incremented version to 8.1.2 2025-05-06 19:09:32 -07:00
Colin Basnett
f6fa646a63 Minor formatting fixes for sort_and_normalize_weights 2025-05-06 19:08:41 -07:00
Colin Basnett
16471344f0 Fix #129: PSK can be imported into UT2 with incorrect weighting
Weights within the PSK are now sorted by point_index and have their weights normalized.
2025-05-06 18:48:44 -07:00
Colin Basnett
172249dfff Improved error reporting for multiple armature exports
When exporting multiple armatures, the Export Space must be set to World Space. The user may not intended to be doing a multi-armature export, so the error message has been updated to list the armatures attempting to be exported.
2025-04-16 16:53:25 -07:00
Colin Basnett
0b30161cd7 Fixed an error that could occur on export if material name lookup failed 2025-04-16 16:49:55 -07:00
Colin Basnett
e66f7f98e2 Reorganized the README 2025-04-15 17:50:00 -07:00
Colin Basnett
879c3cbaf6 Added script to run tests from the host machine 2025-04-15 16:28:41 -07:00
39 changed files with 937 additions and 1060 deletions

View File

@@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy: strategy:
matrix: matrix:
blender-version: [ 4.4 ] blender-version: [ 5.0 ]
env: env:
ADDON_NAME: io_scene_psk_psa ADDON_NAME: io_scene_psk_psa
steps: steps:

View File

@@ -1,7 +1,5 @@
FROM ubuntu:22.04 FROM ubuntu:22.04
ARG BLENDER_VERSION=4.4
RUN apt-get update -y && \ RUN apt-get update -y && \
apt-get install -y libxxf86vm-dev libxfixes3 libxi-dev libxkbcommon-x11-0 libgl1 libglx-mesa0 python3 python3-pip \ apt-get install -y libxxf86vm-dev libxfixes3 libxi-dev libxkbcommon-x11-0 libgl1 libglx-mesa0 python3 python3-pip \
libxrender1 libsm6 libxrender1 libsm6
@@ -10,6 +8,8 @@ RUN pip install --upgrade pip
RUN pip install pytest-blender RUN pip install pytest-blender
RUN pip install blender-downloader RUN pip install blender-downloader
ARG BLENDER_VERSION=5.0
# Set BLENDER_EXECUTABLE and BLENDER_PYTHON as environment variables # Set BLENDER_EXECUTABLE and BLENDER_PYTHON as environment variables
RUN BLENDER_EXECUTABLE=$(blender-downloader $BLENDER_VERSION --extract --remove-compressed --print-blender-executable) && \ RUN BLENDER_EXECUTABLE=$(blender-downloader $BLENDER_VERSION --extract --remove-compressed --print-blender-executable) && \
BLENDER_PYTHON=$(pytest-blender --blender-executable "${BLENDER_EXECUTABLE}") && \ BLENDER_PYTHON=$(pytest-blender --blender-executable "${BLENDER_EXECUTABLE}") && \
@@ -22,7 +22,7 @@ RUN pip install pytest-cov
# Source the environment variables and install Python dependencies # Source the environment variables and install Python dependencies
RUN . /etc/environment && \ RUN . /etc/environment && \
$BLENDER_PYTHON -m ensurepip && \ $BLENDER_PYTHON -m ensurepip && \
$BLENDER_PYTHON -m pip install pytest pytest-cov $BLENDER_PYTHON -m pip install pytest pytest-cov psk-psa-py
# Persist BLENDER_EXECUTABLE as an environment variable # Persist BLENDER_EXECUTABLE as an environment variable
RUN echo $(cat /blender_executable_path) > /tmp/blender_executable_path_env && \ RUN echo $(cat /blender_executable_path) > /tmp/blender_executable_path_env && \

View File

@@ -7,6 +7,11 @@ This Blender addon allows you to import and export meshes and animations to and
This software is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) license. This software is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) license.
# Installation
For Blender 4.2 and higher, download the latest version from the [Blender Extensions](https://extensions.blender.org/add-ons/io-scene-psk-psa/) platform.
For Blender 4.1 and lower, see [Legacy Compatibility](#legacy-compatibility).
# Features # Features
* Full PSK/PSA import and export capabilities. * Full PSK/PSA import and export capabilities.
* Non-standard file section data (.pskx) is supported for import only (vertex normals, extra UV channels, vertex colors, shape keys). * Non-standard file section data (.pskx) is supported for import only (vertex normals, extra UV channels, vertex colors, shape keys).
@@ -18,23 +23,6 @@ This software is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0
* Multiple armature objects can be exported to a single PSK or PSA file, allowing seamless use of [action slots](https://docs.blender.org/manual/en/latest/animation/actions.html#action-slots). * Multiple armature objects can be exported to a single PSK or PSA file, allowing seamless use of [action slots](https://docs.blender.org/manual/en/latest/animation/actions.html#action-slots).
* Support for exporting instance collections. * Support for exporting instance collections.
# Installation
For Blender 4.2 and higher, download the latest version from the [Blender Extensions](https://extensions.blender.org/add-ons/io-scene-psk-psa/) platform.
For Blender 4.1 and lower, see [Legacy Compatibility](#legacy-compatibility).
# Legacy Compatibility
Below is a table of the latest addon versions that are compatible with older versions of Blender. These versions are no longer maintained and may contain bugs that have been fixed in newer versions. It is recommended to use the latest version of the addon for the best experience.
Critical bug fixes may be issued for legacy addon versions that are under [Blender's LTS maintenance period](https://www.blender.org/download/lts/). Once the LTS period has ended, legacy addon versions will no longer be supported by the maintainers of this repository, although the releases will still be available for download.
| Blender Version| Addon Version | Long Term Support |
|-|--------------------------------------------------------------------------------|-----------------|
| [4.1](https://www.blender.org/download/releases/4-1/) | [7.0.0](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/7.0.0) | No |
| [4.0](https://www.blender.org/download/releases/4-0/) | [6.2.1](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/6.2.1) | No |
| [3.4 - 3.6](https://www.blender.org/download/lts/3-6/) | [5.0.6](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/5.0.6) | June 2025 |
| [2.93 - 3.3](https://www.blender.org/download/releases/3-3/) | [4.3.0](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/4.3.0) | ~~September 2024~~ |
# Usage # Usage
## Exporting a PSK ## Exporting a PSK
1. Select the mesh objects you wish to export. 1. Select the mesh objects you wish to export.
@@ -68,7 +56,7 @@ The PSA importer creates [Actions](https://docs.blender.org/manual/en/latest/ani
## Why are imported PSKs too big/too small? ## Why are imported PSKs too big/too small?
The PSK format, unlike other more modern formats, has no explicit or implicit unit system. Each game has its own convention as to what the base distance unit will represent. As such, this addon makes no assumptions as to the unit scale of the imported PSKs. If you think that your models are being imported into Blender either too big or too small, there are a couple ways to remedy this. The PSK format, unlike other more modern formats, has no explicit or implicit unit system. Each game has its own convention as to what the base distance unit will represent. As such, this addon makes no assumptions as to the unit scale of the imported PSKs. If you think that your models are being imported into Blender either too big or too small, there are a couple ways to remedy this.
The method I prefer is to simply change the Blender [scene properties](https://docs.blender.org/manual/en/4.4/scene_layout/scene/properties.html#units) to match the unit system and scale for the game you're using. This is non-destructive and ensures that the unit scaling of any PSK or PSA exports from Blender will match the source file from which it was derived. The method I prefer is to simply change the Blender [scene properties](https://docs.blender.org/manual/en/5.0/scene_layout/scene/properties.html#units) to match the unit system and scale for the game you're using. This is non-destructive and ensures that the unit scaling of any PSK or PSA exports from Blender will match the source file from which it was derived.
The second option is to simply change the `Scale` value on the PSK import dialog. This will scale the armature by the factor provided. Note that this is more destructive, but may be preferable if you don't intend on exporting PSKs or PSAs to a game engine. The second option is to simply change the `Scale` value on the PSK import dialog. This will scale the armature by the factor provided. Note that this is more destructive, but may be preferable if you don't intend on exporting PSKs or PSAs to a game engine.
@@ -78,4 +66,25 @@ The PSK format does not support vertex normals and instead uses [smoothing group
## Why are the mesh normals not accurate when importing a PSK extracted from [UE Viewer](https://www.gildor.org/en/projects/umodel)? ## Why are the mesh normals not accurate when importing a PSK extracted from [UE Viewer](https://www.gildor.org/en/projects/umodel)?
If preserving the mesh normals of models is important for your workflow, it is *not recommended* to export PSK files from UE Viewer. This is because UE Viewer makes no attempt to reconstruct the original [smoothing groups](https://en.wikipedia.org/wiki/Smoothing_group). As a result, the normals of imported PSK files will be incorrect when imported into Blender and will need to be manually fixed. If preserving the mesh normals of models is important for your workflow, it is *not recommended* to export PSK files from UE Viewer. This is because UE Viewer makes no attempt to reconstruct the original [smoothing groups](https://en.wikipedia.org/wiki/Smoothing_group). As a result, the normals of imported PSK files will be incorrect when imported into Blender and will need to be manually fixed.
There is a [pull request](https://github.com/gildor2/UEViewer/pull/277) to add support for exporting explicit normals from UE Viewer in the future, although UEViewer's maintainer has seemingly abandoned the project. There is a [pull request](https://github.com/gildor2/UEViewer/pull/277) to add support for exporting explicit normals from UE Viewer, although UEViewer's maintainer has seemingly abandoned the project.
# Legacy Compatibility
Below is a table of the latest addon versions that are compatible with older versions of Blender. These versions are no longer maintained and may contain bugs that have been fixed in newer versions. It is recommended to use the latest version of the addon for the best experience.
| Blender Version| Addon Version |
|-|-|
| [4.1](https://www.blender.org/download/releases/4-1/) | [7.0.0](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/7.0.0) |
| [4.0](https://www.blender.org/download/releases/4-0/) | [6.2.1](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/6.2.1) |
| [3.4 - 3.6](https://www.blender.org/download/lts/3-6/) | [5.0.6](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/5.0.6) |
| [2.93 - 3.3](https://www.blender.org/download/releases/3-3/) | [4.3.0](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/4.3.0) |
# Testing
To execute the automated tests, run:
```
./test.sh
````
This will create a [Docker](https://www.docker.com/) container with and run the tests inside it. The tests are executed using [pytest](https://docs.pytest.org/en/stable/) and the results will be displayed in the terminal.
For now, the tests are not exhaustive and primarily focus on sanity checking the most common use cases (PSK & PSA import). New tests will likely be made to cover new features and prevent further regressions of reported issues.

View File

@@ -1,17 +1,43 @@
from bpy.app.handlers import persistent from bpy.app.handlers import persistent
if 'bpy' in locals(): from .shared import types as shared_types, helpers as shared_helpers
from .shared import dfs as shared_dfs, ui as shared_ui
from .psk import (
builder as psk_builder,
importer as psk_importer,
properties as psk_properties,
)
from .psk import ui as psk_ui
from .psk.export import (
operators as psk_export_operators,
properties as psk_export_properties,
ui as psk_export_ui,
)
from .psk.import_ import operators as psk_import_operators
from .psa import (
config as psa_config,
builder as psa_builder,
importer as psa_importer,
)
from .psa.export import (
properties as psa_export_properties,
ui as psa_export_ui,
operators as psa_export_operators,
)
from .psa.import_ import operators as psa_import_operators
from .psa.import_ import ui as psa_import_ui, properties as psa_import_properties
_needs_reload = 'bpy' in locals()
if _needs_reload:
import importlib import importlib
importlib.reload(shared_data)
importlib.reload(shared_helpers) importlib.reload(shared_helpers)
importlib.reload(shared_types) importlib.reload(shared_types)
importlib.reload(shared_dfs) importlib.reload(shared_dfs)
importlib.reload(shared_ui) importlib.reload(shared_ui)
importlib.reload(psk_data)
importlib.reload(psk_reader)
importlib.reload(psk_writer)
importlib.reload(psk_builder) importlib.reload(psk_builder)
importlib.reload(psk_importer) importlib.reload(psk_importer)
importlib.reload(psk_properties) importlib.reload(psk_properties)
@@ -21,10 +47,7 @@ if 'bpy' in locals():
importlib.reload(psk_export_ui) importlib.reload(psk_export_ui)
importlib.reload(psk_import_operators) importlib.reload(psk_import_operators)
importlib.reload(psa_data)
importlib.reload(psa_config) importlib.reload(psa_config)
importlib.reload(psa_reader)
importlib.reload(psa_writer)
importlib.reload(psa_builder) importlib.reload(psa_builder)
importlib.reload(psa_importer) importlib.reload(psa_importer)
importlib.reload(psa_export_properties) importlib.reload(psa_export_properties)
@@ -33,57 +56,10 @@ if 'bpy' in locals():
importlib.reload(psa_import_properties) importlib.reload(psa_import_properties)
importlib.reload(psa_import_operators) importlib.reload(psa_import_operators)
importlib.reload(psa_import_ui) importlib.reload(psa_import_ui)
else:
from .shared import data as shared_data, types as shared_types, helpers as shared_helpers
from .shared import dfs as shared_dfs, ui as shared_ui
from .psk import (
builder as psk_builder,
data as psk_data,
importer as psk_importer,
properties as psk_properties,
writer as psk_writer,
)
from .psk import reader as psk_reader, ui as psk_ui
from .psk.export import (
operators as psk_export_operators,
properties as psk_export_properties,
ui as psk_export_ui,
)
from .psk.import_ import operators as psk_import_operators
from .psa import (
config as psa_config,
data as psa_data,
writer as psa_writer,
reader as psa_reader,
builder as psa_builder,
importer as psa_importer,
)
from .psa.export import (
properties as psa_export_properties,
ui as psa_export_ui,
operators as psa_export_operators,
)
from .psa.import_ import operators as psa_import_operators
from .psa.import_ import ui as psa_import_ui, properties as psa_import_properties
import bpy import bpy
from bpy.props import PointerProperty from bpy.props import PointerProperty
classes = shared_types.classes + \
psk_properties.classes + \
psk_ui.classes + \
psk_import_operators.classes + \
psk_export_properties.classes + \
psk_export_operators.classes + \
psk_export_ui.classes + \
psa_export_properties.classes + \
psa_export_operators.classes + \
psa_export_ui.classes + \
psa_import_properties.classes + \
psa_import_operators.classes + \
psa_import_ui.classes
def psk_export_menu_func(self, context): def psk_export_menu_func(self, context):
self.layout.operator(psk_export_operators.PSK_OT_export.bl_idname, text='Unreal PSK (.psk)') self.layout.operator(psk_export_operators.PSK_OT_export.bl_idname, text='Unreal PSK (.psk)')
@@ -101,22 +77,41 @@ def psa_import_menu_func(self, context):
self.layout.operator(psa_import_operators.PSA_OT_import.bl_idname, text='Unreal PSA (.psa)') self.layout.operator(psa_import_operators.PSA_OT_import.bl_idname, text='Unreal PSA (.psa)')
_modules = (
shared_types,
shared_ui,
psk_properties,
psk_ui,
psk_import_operators,
psk_export_properties,
psk_export_operators,
psk_export_ui,
psa_export_properties,
psa_export_operators,
psa_export_ui,
psa_import_properties,
psa_import_operators,
psa_import_ui
)
def register(): def register():
for cls in classes: for module in _modules:
bpy.utils.register_class(cls) module.register()
bpy.types.TOPBAR_MT_file_export.append(psk_export_menu_func) bpy.types.TOPBAR_MT_file_export.append(psk_export_menu_func)
bpy.types.TOPBAR_MT_file_import.append(psk_import_menu_func) bpy.types.TOPBAR_MT_file_import.append(psk_import_menu_func)
bpy.types.TOPBAR_MT_file_export.append(psa_export_menu_func) bpy.types.TOPBAR_MT_file_export.append(psa_export_menu_func)
bpy.types.TOPBAR_MT_file_import.append(psa_import_menu_func) bpy.types.TOPBAR_MT_file_import.append(psa_import_menu_func)
bpy.types.Material.psk = PointerProperty(type=psk_properties.PSX_PG_material) bpy.types.Material.psk = PointerProperty(type=psk_properties.PSX_PG_material, options={'HIDDEN'})
bpy.types.Scene.psa_import = PointerProperty(type=psa_import_properties.PSA_PG_import) bpy.types.Scene.psx_export = PointerProperty(type=shared_types.PSX_PG_scene_export, options={'HIDDEN'})
bpy.types.Scene.psa_export = PointerProperty(type=psa_export_properties.PSA_PG_export) bpy.types.Scene.psa_import = PointerProperty(type=psa_import_properties.PSA_PG_import, options={'HIDDEN'})
bpy.types.Scene.psk_export = PointerProperty(type=psk_export_properties.PSK_PG_export) bpy.types.Scene.psa_export = PointerProperty(type=psa_export_properties.PSA_PG_export, options={'HIDDEN'})
bpy.types.Action.psa_export = PointerProperty(type=shared_types.PSX_PG_action_export) bpy.types.Scene.psk_export = PointerProperty(type=psk_export_properties.PSK_PG_export, options={'HIDDEN'})
bpy.types.Action.psa_export = PointerProperty(type=shared_types.PSX_PG_action_export, options={'HIDDEN'})
def unregister(): def unregister():
del bpy.types.Material.psk del bpy.types.Material.psk
del bpy.types.Scene.psx_export
del bpy.types.Scene.psa_import del bpy.types.Scene.psa_import
del bpy.types.Scene.psa_export del bpy.types.Scene.psa_export
del bpy.types.Scene.psk_export del bpy.types.Scene.psk_export
@@ -125,8 +120,8 @@ def unregister():
bpy.types.TOPBAR_MT_file_import.remove(psk_import_menu_func) bpy.types.TOPBAR_MT_file_import.remove(psk_import_menu_func)
bpy.types.TOPBAR_MT_file_export.remove(psa_export_menu_func) bpy.types.TOPBAR_MT_file_export.remove(psa_export_menu_func)
bpy.types.TOPBAR_MT_file_import.remove(psa_import_menu_func) bpy.types.TOPBAR_MT_file_import.remove(psa_import_menu_func)
for cls in reversed(classes): for module in reversed(_modules):
bpy.utils.unregister_class(cls) module.unregister()
if __name__ == '__main__': if __name__ == '__main__':

View File

@@ -1,18 +1,21 @@
schema_version = "1.0.0" schema_version = "1.0.0"
id = "io_scene_psk_psa" id = "io_scene_psk_psa"
version = "8.1.1" version = "9.0.1"
name = "Unreal PSK/PSA (.psk/.psa)" name = "Unreal PSK/PSA (.psk/.psa)"
tagline = "Import and export PSK and PSA files used in Unreal Engine" tagline = "Import and export PSK and PSA files used in Unreal Engine"
maintainer = "Colin Basnett <cmbasnett@gmail.com>" maintainer = "Colin Basnett <cmbasnett@gmail.com>"
type = "add-on" type = "add-on"
website = "https://github.com/DarklightGames/io_scene_psk_psa/" website = "https://github.com/DarklightGames/io_scene_psk_psa/"
tags = ["Game Engine", "Import-Export"] tags = ["Game Engine", "Import-Export"]
blender_version_min = "4.2.0" blender_version_min = "5.0.0"
# Optional: maximum supported Blender version # Optional: maximum supported Blender version
# blender_version_max = "5.1.0" # blender_version_max = "5.1.0"
license = [ license = [
"SPDX:GPL-3.0-or-later", "SPDX:GPL-3.0-or-later",
] ]
wheels = [
'./wheels/psk_psa_py-0.0.1-py3-none-any.whl'
]
[build] [build]
paths_exclude_pattern = [ paths_exclude_pattern = [

View File

@@ -1,10 +1,10 @@
from bpy.types import Action, AnimData, Context, Object, PoseBone from bpy.types import Action, AnimData, Context, Object, PoseBone
from .data import Psa from psk_psa_py.psa.data import Psa
from typing import Dict, List, Optional, Tuple from typing import Dict, List, Optional, Tuple
from mathutils import Matrix, Quaternion, Vector from mathutils import Matrix, Quaternion, Vector
from ..shared.helpers import create_psx_bones, get_coordinate_system_transform from ..shared.helpers import PsxBoneCollection, create_psx_bones, get_coordinate_system_transform
class PsaBuildSequence: class PsaBuildSequence:
@@ -22,6 +22,7 @@ class PsaBuildSequence:
self.compression_ratio: float = 1.0 self.compression_ratio: float = 1.0
self.key_quota: int = 0 self.key_quota: int = 0
self.fps: float = 30.0 self.fps: float = 30.0
self.group: Optional[str] = None
class PsaBuildOptions: class PsaBuildOptions:
@@ -30,7 +31,7 @@ class PsaBuildOptions:
self.animation_data: Optional[AnimData] = None self.animation_data: Optional[AnimData] = None
self.sequences: List[PsaBuildSequence] = [] self.sequences: List[PsaBuildSequence] = []
self.bone_filter_mode: str = 'ALL' self.bone_filter_mode: str = 'ALL'
self.bone_collection_indices: List[Tuple[str, int]] = [] self.bone_collection_indices: List[PsxBoneCollection] = []
self.sequence_name_prefix: str = '' self.sequence_name_prefix: str = ''
self.sequence_name_suffix: str = '' self.sequence_name_suffix: str = ''
self.scale = 1.0 self.scale = 1.0
@@ -39,6 +40,11 @@ class PsaBuildOptions:
self.forward_axis = 'X' self.forward_axis = 'X'
self.up_axis = 'Z' self.up_axis = 'Z'
self.root_bone_name = 'ROOT' self.root_bone_name = 'ROOT'
self.sequence_source = 'ACTIONS' # One of ('ACTIONS', 'TIMELINE_MARKERS', 'NLA_STRIPS')
@property
def bone_collection_primary_key(self) -> str:
return 'DATA' if self.sequence_source == 'ACTIVE_ACTION' else 'OBJECT'
def _get_pose_bone_location_and_rotation( def _get_pose_bone_location_and_rotation(
@@ -98,10 +104,21 @@ def _get_pose_bone_location_and_rotation(
def build_psa(context: Context, options: PsaBuildOptions) -> Psa: def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
assert context.scene
assert context.window_manager
psa = Psa() psa = Psa()
armature_objects_for_bones = options.armature_objects
if options.sequence_source == 'ACTIVE_ACTION' and len(options.armature_objects) >= 2:
# Make sure that the data-block for all the selected armature objects is the same.
if any(map(lambda o: o.data != options.armature_objects[0].data, options.armature_objects[1:])):
raise RuntimeError('All armature objects must share the same data-block when exporting from the active action')
armature_objects_for_bones = [options.armature_objects[0]]
psx_bone_create_result = create_psx_bones( psx_bone_create_result = create_psx_bones(
armature_objects=options.armature_objects, armature_objects=armature_objects_for_bones,
export_space=options.export_space, export_space=options.export_space,
root_bone_name=options.root_bone_name, root_bone_name=options.root_bone_name,
forward_axis=options.forward_axis, forward_axis=options.forward_axis,
@@ -109,6 +126,7 @@ def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
scale=options.scale, scale=options.scale,
bone_filter_mode=options.bone_filter_mode, bone_filter_mode=options.bone_filter_mode,
bone_collection_indices=options.bone_collection_indices, bone_collection_indices=options.bone_collection_indices,
bone_collection_primary_key=options.bone_collection_primary_key,
) )
# Build list of PSA bones. # Build list of PSA bones.
@@ -145,11 +163,7 @@ def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
frame_extents = abs(frame_end - frame_start) frame_extents = abs(frame_end - frame_start)
frame_count_raw = frame_extents + 1 frame_count_raw = frame_extents + 1
frame_count = max(1, max(export_sequence.key_quota, int(frame_count_raw * export_sequence.compression_ratio))) frame_count = max(1, max(export_sequence.key_quota, int(frame_count_raw * export_sequence.compression_ratio)))
frame_step = frame_extents / (frame_count - 1) if frame_count > 1 else 0.0
try:
frame_step = frame_extents / (frame_count - 1)
except ZeroDivisionError:
frame_step = 0.0
# If this is a reverse sequence, we need to reverse the frame step. # If this is a reverse sequence, we need to reverse the frame step.
if frame_start > frame_end: if frame_start > frame_end:
@@ -158,11 +172,20 @@ def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
sequence_duration = frame_count_raw / export_sequence.fps sequence_duration = frame_count_raw / export_sequence.fps
psa_sequence = Psa.Sequence() psa_sequence = Psa.Sequence()
try: try:
psa_sequence.name = bytes(export_sequence.name, encoding='windows-1252') psa_sequence.name = bytes(export_sequence.name, encoding='windows-1252')
except UnicodeEncodeError: except UnicodeEncodeError:
raise RuntimeError( raise RuntimeError(
f'Sequence name "{export_sequence.name}" contains characters that cannot be encoded in the Windows-1252 codepage') f'Sequence name "{export_sequence.name}" contains characters that cannot be encoded in the Windows-1252 codepage')
try:
if export_sequence.group is not None:
psa_sequence.group = bytes(export_sequence.group, encoding='windows-1252')
except UnicodeDecodeError:
raise RuntimeError(
f'Group name "{export_sequence.group} contains characters that cannot be encoded in the Windows-1252 codepage')
psa_sequence.frame_count = frame_count psa_sequence.frame_count = frame_count
psa_sequence.frame_start_index = frame_start_index psa_sequence.frame_start_index = frame_start_index
psa_sequence.fps = frame_count / sequence_duration psa_sequence.fps = frame_count / sequence_duration
@@ -215,13 +238,11 @@ def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
export_bones.append(PsaExportBone(None, None, Vector((1.0, 1.0, 1.0)))) export_bones.append(PsaExportBone(None, None, Vector((1.0, 1.0, 1.0))))
continue continue
assert armature_object.pose
pose_bone = armature_object.pose.bones[psx_bone.name.decode('windows-1252')] pose_bone = armature_object.pose.bones[psx_bone.name.decode('windows-1252')]
export_bones.append(PsaExportBone(pose_bone, armature_object, armature_scales[armature_object])) export_bones.append(PsaExportBone(pose_bone, armature_object, armature_scales[armature_object]))
for export_bone in export_bones:
print(export_bone.pose_bone, export_bone.armature_object, export_bone.scale)
match options.sampling_mode: match options.sampling_mode:
case 'INTERPOLATED': case 'INTERPOLATED':
# Used as a store for the last frame's pose bone locations and rotations. # Used as a store for the last frame's pose bone locations and rotations.
@@ -315,6 +336,7 @@ def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
# Restore the previous actions & frame. # Restore the previous actions & frame.
for armature_object, action in saved_armature_object_actions.items(): for armature_object, action in saved_armature_object_actions.items():
assert armature_object.animation_data
armature_object.animation_data.action = action armature_object.animation_data.action = action
context.scene.frame_set(saved_frame_current) context.scene.frame_set(saved_frame_current)

View File

@@ -55,7 +55,9 @@ def read_psa_config(psa_sequence_names: List[str], file_path: str) -> PsaConfig:
if config.has_section('RemoveTracks'): if config.has_section('RemoveTracks'):
for key, value in config.items('RemoveTracks'): for key, value in config.items('RemoveTracks'):
match = re.match(f'^(.+)\.(\d+)$', key) match = re.match(rf'^(.+)\.(\d+)$', key)
if not match:
continue
sequence_name = match.group(1) sequence_name = match.group(1)
# Map the sequence name onto the actual sequence name in the PSA file. # Map the sequence name onto the actual sequence name in the PSA file.

View File

@@ -1,53 +0,0 @@
from collections import OrderedDict
from typing import List, OrderedDict as OrderedDictType
from ctypes import Structure, c_char, c_int32, c_float
from ..shared.data import PsxBone, Quaternion, Vector3
class Psa:
"""
Note that keys are not stored within the Psa object.
Use the `PsaReader.get_sequence_keys` to get the keys for a sequence.
"""
class Sequence(Structure):
_fields_ = [
('name', c_char * 64),
('group', c_char * 64),
('bone_count', c_int32),
('root_include', c_int32),
('compression_style', c_int32),
('key_quotum', c_int32),
('key_reduction', c_float),
('track_time', c_float),
('fps', c_float),
('start_bone', c_int32),
('frame_start_index', c_int32),
('frame_count', c_int32)
]
class Key(Structure):
_fields_ = [
('location', Vector3),
('rotation', Quaternion),
('time', c_float)
]
@property
def data(self):
yield self.rotation.w
yield self.rotation.x
yield self.rotation.y
yield self.rotation.z
yield self.location.x
yield self.location.y
yield self.location.z
def __repr__(self) -> str:
return repr((self.location, self.rotation, self.time))
def __init__(self):
self.bones: List[PsxBone] = []
self.sequences: OrderedDictType[str, Psa.Sequence] = OrderedDict()
self.keys: List[Psa.Key] = []

View File

@@ -1,9 +1,10 @@
from collections import Counter from collections import Counter
from typing import List, Iterable, Dict, Tuple, Optional from typing import List, Iterable, Dict, Tuple, cast as typing_cast
import bpy import bpy
import re
from bpy.props import StringProperty from bpy.props import StringProperty
from bpy.types import Context, Action, Object, AnimData, TimelineMarker, Operator from bpy.types import Context, Action, Object, AnimData, TimelineMarker, Operator, Armature
from bpy_extras.io_utils import ExportHelper from bpy_extras.io_utils import ExportHelper
from .properties import ( from .properties import (
@@ -12,14 +13,14 @@ from .properties import (
filter_sequences, filter_sequences,
get_sequences_from_name_and_frame_range, get_sequences_from_name_and_frame_range,
) )
from .ui import PSA_UL_export_sequences
from ..builder import build_psa, PsaBuildSequence, PsaBuildOptions from ..builder import build_psa, PsaBuildSequence, PsaBuildOptions
from ..writer import write_psa from psk_psa_py.psa.writer import write_psa_to_file
from ...shared.helpers import populate_bone_collection_list, get_nla_strips_in_frame_range from ...shared.helpers import populate_bone_collection_list, get_nla_strips_in_frame_range, PsxBoneCollection
from ...shared.semver import SemanticVersion
from ...shared.ui import draw_bone_filter_mode from ...shared.ui import draw_bone_filter_mode
def get_sequences_propnames_from_source(sequence_source: str) -> Optional[Tuple[str, str]]: def get_sequences_propnames_from_source(sequence_source: str) -> Tuple[str, str]:
match sequence_source: match sequence_source:
case 'ACTIONS': case 'ACTIONS':
return 'action_list', 'action_list_index' return 'action_list', 'action_list_index'
@@ -34,35 +35,28 @@ def get_sequences_propnames_from_source(sequence_source: str) -> Optional[Tuple[
def is_action_for_object(obj: Object, action: Action): def is_action_for_object(obj: Object, action: Action):
if action is None or len(action.fcurves) == 0: if len(action.layers) == 0:
return False return False
if obj is None or obj.animation_data is None or obj.type != 'ARMATURE': if obj is None or obj.animation_data is None or obj.type != 'ARMATURE':
return False return False
version = SemanticVersion(bpy.app.version) armature_data = typing_cast(Armature, obj.data)
bone_names = set([x.name for x in armature_data.bones])
def is_action_for_object_legacy(action: Action, obj: Object): # The nesting here is absolutely bonkers.
""" for layer in action.layers:
This is the legacy behavior before slotted actions were introduced in Blender 4.4. for strip in layer.strips:
It would simply check if it had any f-curves that corresponded to any bones in the armature. for channelbag in strip.channelbags:
""" for fcurve in channelbag.fcurves:
import re match = re.match(r'pose\.bones\[\"([^\"]+)\"](\[\"([^\"]+)\"])?', fcurve.data_path)
armature_data = obj.data if not match:
bone_names = set([x.name for x in armature_data.bones]) continue
for fcurve in action.fcurves: bone_name = match.group(1)
match = re.match(r'pose\.bones\[\"([^\"]+)\"](\[\"([^\"]+)\"])?', fcurve.data_path) if bone_name in bone_names:
if not match: return True
continue
bone_name = match.group(1) return False
if bone_name in bone_names:
return True
if version < SemanticVersion((4, 4, 0)):
return is_action_for_object_legacy(action, obj)
# If the object is a part of the slot's user list, then it is a valid action for the object.
return any(obj in slot.users() for slot in action.slots)
def update_actions_and_timeline_markers(context: Context, armature_objects: Iterable[Object]): def update_actions_and_timeline_markers(context: Context, armature_objects: Iterable[Object]):
@@ -178,7 +172,7 @@ def get_animation_data_object(context: Context) -> Object:
active_object = context.view_layer.objects.active active_object = context.view_layer.objects.active
if active_object.type != 'ARMATURE': if active_object is None or active_object.type != 'ARMATURE':
raise RuntimeError('Active object must be an Armature') raise RuntimeError('Active object must be an Armature')
if pg.sequence_source != 'ACTIONS' and pg.should_override_animation_data: if pg.sequence_source != 'ACTIONS' and pg.should_override_animation_data:
@@ -306,6 +300,7 @@ class PSA_OT_export(Operator, ExportHelper):
def draw(self, context): def draw(self, context):
layout = self.layout layout = self.layout
assert layout
pg = getattr(context.scene, 'psa_export') pg = getattr(context.scene, 'psa_export')
sequences_header, sequences_panel = layout.panel('Sequences', default_closed=False) sequences_header, sequences_panel = layout.panel('Sequences', default_closed=False)
@@ -335,13 +330,11 @@ class PSA_OT_export(Operator, ExportHelper):
row.operator(PSA_OT_export_actions_select_all.bl_idname, text='All', icon='CHECKBOX_HLT') row.operator(PSA_OT_export_actions_select_all.bl_idname, text='All', icon='CHECKBOX_HLT')
row.operator(PSA_OT_export_actions_deselect_all.bl_idname, text='None', icon='CHECKBOX_DEHLT') row.operator(PSA_OT_export_actions_deselect_all.bl_idname, text='None', icon='CHECKBOX_DEHLT')
from .ui import PSA_UL_export_sequences
propname, active_propname = get_sequences_propnames_from_source(pg.sequence_source) propname, active_propname = get_sequences_propnames_from_source(pg.sequence_source)
sequences_panel.template_list(PSA_UL_export_sequences.bl_idname, '', pg, propname, pg, active_propname, sequences_panel.template_list(PSA_UL_export_sequences.bl_idname, '', pg, propname, pg, active_propname,
rows=max(3, min(len(getattr(pg, propname)), 10))) rows=max(3, min(len(getattr(pg, propname)), 10)))
name_header, name_panel = layout.panel('Name', default_closed=False) name_header, name_panel = sequences_panel.panel('Name', default_closed=False)
name_header.label(text='Name') name_header.label(text='Name')
if name_panel: if name_panel:
flow = name_panel.grid_flow() flow = name_panel.grid_flow()
@@ -358,8 +351,20 @@ class PSA_OT_export(Operator, ExportHelper):
if count > 1: if count > 1:
layout.label(text=f'Duplicate action: {action_name}', icon='ERROR') layout.label(text=f'Duplicate action: {action_name}', icon='ERROR')
break break
# Group
group_header, group_panel = sequences_panel.panel('Group', default_closed=True)
group_header.label(text='Group')
if group_panel is not None:
group_flow = group_panel.grid_flow()
group_flow.use_property_split = True
group_flow.use_property_decorate = False
group_flow.prop(pg, 'group_source')
if pg.group_source == 'CUSTOM':
group_flow.prop(pg, 'group_custom', placeholder='Group')
sampling_header, sampling_panel = layout.panel('Data Source', default_closed=False) # Sampling
sampling_header, sampling_panel = sequences_panel.panel('Data Source', default_closed=False)
sampling_header.label(text='Sampling') sampling_header.label(text='Sampling')
if sampling_panel: if sampling_panel:
flow = sampling_panel.grid_flow() flow = sampling_panel.grid_flow()
@@ -400,7 +405,7 @@ class PSA_OT_export(Operator, ExportHelper):
rows=rows rows=rows
) )
bones_advanced_header, bones_advanced_panel = layout.panel('Advanced', default_closed=False) bones_advanced_header, bones_advanced_panel = layout.panel('Bones Advanced', default_closed=True)
bones_advanced_header.label(text='Advanced') bones_advanced_header.label(text='Advanced')
if bones_advanced_panel: if bones_advanced_panel:
flow = bones_advanced_panel.grid_flow() flow = bones_advanced_panel.grid_flow()
@@ -438,6 +443,7 @@ class PSA_OT_export(Operator, ExportHelper):
self._check_context(context) self._check_context(context)
except RuntimeError as e: except RuntimeError as e:
self.report({'ERROR_INVALID_CONTEXT'}, str(e)) self.report({'ERROR_INVALID_CONTEXT'}, str(e))
return {'CANCELLED'}
pg: PSA_PG_export = getattr(context.scene, 'psa_export') pg: PSA_PG_export = getattr(context.scene, 'psa_export')
@@ -450,24 +456,18 @@ class PSA_OT_export(Operator, ExportHelper):
armature_object.animation_data_create() armature_object.animation_data_create()
update_actions_and_timeline_markers(context, self.armature_objects) update_actions_and_timeline_markers(context, self.armature_objects)
populate_bone_collection_list(self.armature_objects, pg.bone_collection_list) populate_bone_collection_list(
pg.bone_collection_list,
self.armature_objects,
primary_key='DATA' if pg.sequence_source == 'ACTIVE_ACTION' else 'OBJECT',
)
context.window_manager.fileselect_add(self) context.window_manager.fileselect_add(self)
return {'RUNNING_MODAL'} return {'RUNNING_MODAL'}
def execute(self, context): def execute(self, context):
pg = getattr(context.scene, 'psa_export') pg = typing_cast(PSA_PG_export, getattr(context.scene, 'psa_export'))
# Ensure that we actually have items that we are going to be exporting.
if pg.sequence_source == 'ACTIONS' and len(pg.action_list) == 0:
raise RuntimeError('No actions were selected for export')
if pg.sequence_source == 'TIMELINE_MARKERS' and len(pg.marker_list) == 0:
raise RuntimeError('No timeline markers were selected for export')
if pg.sequence_source == 'NLA_TRACK_STRIPS' and len(pg.nla_strip_list) == 0:
raise RuntimeError('No NLA track strips were selected for export')
# Populate the export sequence list. # Populate the export sequence list.
animation_data_object = get_animation_data_object(context) animation_data_object = get_animation_data_object(context)
@@ -475,16 +475,29 @@ class PSA_OT_export(Operator, ExportHelper):
if animation_data is None: if animation_data is None:
raise RuntimeError(f'No animation data for object \'{animation_data_object.name}\'') raise RuntimeError(f'No animation data for object \'{animation_data_object.name}\'')
if context.active_object is None:
raise RuntimeError('No active object')
export_sequences: List[PsaBuildSequence] = [] export_sequences: List[PsaBuildSequence] = []
def get_export_sequence_group(group_source: str, group_custom: str | None, action: Action | None) -> str | None:
match group_source:
case 'ACTIONS':
return action.psa_export.group if action else None
case 'CUSTOM':
return group_custom
case _:
return None
match pg.sequence_source: match pg.sequence_source:
case 'ACTIONS': case 'ACTIONS':
for action_item in filter(lambda x: x.is_selected, pg.action_list): for action_item in filter(lambda x: x.is_selected, pg.action_list):
if len(action_item.action.fcurves) == 0: if len(action_item.action.layers) == 0:
continue continue
export_sequence = PsaBuildSequence(context.active_object, animation_data) export_sequence = PsaBuildSequence(context.active_object, animation_data)
export_sequence.name = action_item.name export_sequence.name = action_item.name
export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, action_item.action)
export_sequence.nla_state.action = action_item.action export_sequence.nla_state.action = action_item.action
export_sequence.nla_state.frame_start = action_item.frame_start export_sequence.nla_state.frame_start = action_item.frame_start
export_sequence.nla_state.frame_end = action_item.frame_end export_sequence.nla_state.frame_end = action_item.frame_end
@@ -494,12 +507,15 @@ class PSA_OT_export(Operator, ExportHelper):
export_sequences.append(export_sequence) export_sequences.append(export_sequence)
case 'TIMELINE_MARKERS': case 'TIMELINE_MARKERS':
for marker_item in filter(lambda x: x.is_selected, pg.marker_list): for marker_item in filter(lambda x: x.is_selected, pg.marker_list):
nla_strips_actions: List[Action] = []
for nla_strip in get_nla_strips_in_frame_range(animation_data, marker_item.frame_start, marker_item.frame_end):
if nla_strip.action:
nla_strips_actions.append(nla_strip.action)
export_sequence = PsaBuildSequence(context.active_object, animation_data) export_sequence = PsaBuildSequence(context.active_object, animation_data)
export_sequence.name = marker_item.name export_sequence.name = marker_item.name
export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, next(iter(nla_strips_actions), None))
export_sequence.nla_state.frame_start = marker_item.frame_start export_sequence.nla_state.frame_start = marker_item.frame_start
export_sequence.nla_state.frame_end = marker_item.frame_end export_sequence.nla_state.frame_end = marker_item.frame_end
nla_strips_actions = set(
map(lambda x: x.action, get_nla_strips_in_frame_range(animation_data, marker_item.frame_start, marker_item.frame_end)))
export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, nla_strips_actions) export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, nla_strips_actions)
export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, nla_strips_actions) export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, nla_strips_actions)
export_sequences.append(export_sequence) export_sequences.append(export_sequence)
@@ -507,6 +523,7 @@ class PSA_OT_export(Operator, ExportHelper):
for nla_strip_item in filter(lambda x: x.is_selected, pg.nla_strip_list): for nla_strip_item in filter(lambda x: x.is_selected, pg.nla_strip_list):
export_sequence = PsaBuildSequence(context.active_object, animation_data) export_sequence = PsaBuildSequence(context.active_object, animation_data)
export_sequence.name = nla_strip_item.name export_sequence.name = nla_strip_item.name
export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, nla_strip_item.action)
export_sequence.nla_state.frame_start = nla_strip_item.frame_start export_sequence.nla_state.frame_start = nla_strip_item.frame_start
export_sequence.nla_state.frame_end = nla_strip_item.frame_end export_sequence.nla_state.frame_end = nla_strip_item.frame_end
export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, [nla_strip_item.action]) export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, [nla_strip_item.action])
@@ -518,6 +535,7 @@ class PSA_OT_export(Operator, ExportHelper):
export_sequence = PsaBuildSequence(active_action_item.armature_object, active_action_item.armature_object.animation_data) export_sequence = PsaBuildSequence(active_action_item.armature_object, active_action_item.armature_object.animation_data)
action = active_action_item.action action = active_action_item.action
export_sequence.name = action.name export_sequence.name = action.name
export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, action)
export_sequence.nla_state.action = action export_sequence.nla_state.action = action
export_sequence.nla_state.frame_start = int(action.frame_range[0]) export_sequence.nla_state.frame_start = int(action.frame_range[0])
export_sequence.nla_state.frame_end = int(action.frame_range[1]) export_sequence.nla_state.frame_end = int(action.frame_range[1])
@@ -537,15 +555,16 @@ class PSA_OT_export(Operator, ExportHelper):
options.animation_data = animation_data options.animation_data = animation_data
options.sequences = export_sequences options.sequences = export_sequences
options.bone_filter_mode = pg.bone_filter_mode options.bone_filter_mode = pg.bone_filter_mode
options.bone_collection_indices = [(x.armature_object_name, x.index) for x in pg.bone_collection_list if x.is_selected] options.bone_collection_indices = [PsxBoneCollection(x.armature_object_name, x.armature_data_name, x.index) for x in pg.bone_collection_list if x.is_selected]
options.sequence_name_prefix = pg.sequence_name_prefix options.sequence_name_prefix = pg.sequence_name_prefix
options.sequence_name_suffix = pg.sequence_name_suffix options.sequence_name_suffix = pg.sequence_name_suffix
options.scale = pg.scale
options.sampling_mode = pg.sampling_mode options.sampling_mode = pg.sampling_mode
options.export_space = pg.export_space options.export_space = pg.export_space
options.scale = pg.scale
options.forward_axis = pg.forward_axis options.forward_axis = pg.forward_axis
options.up_axis = pg.up_axis options.up_axis = pg.up_axis
options.root_bone_name = pg.root_bone_name options.root_bone_name = pg.root_bone_name
options.sequence_source = pg.sequence_source
try: try:
psa = build_psa(context, options) psa = build_psa(context, options)
@@ -554,7 +573,7 @@ class PSA_OT_export(Operator, ExportHelper):
self.report({'ERROR_INVALID_CONTEXT'}, str(e)) self.report({'ERROR_INVALID_CONTEXT'}, str(e))
return {'CANCELLED'} return {'CANCELLED'}
write_psa(psa, self.filepath) write_psa_to_file(psa, self.filepath)
return {'FINISHED'} return {'FINISHED'}
@@ -671,10 +690,14 @@ class PSA_OT_export_bone_collections_deselect_all(Operator):
return {'FINISHED'} return {'FINISHED'}
classes = ( _classes = (
PSA_OT_export, PSA_OT_export,
PSA_OT_export_actions_select_all, PSA_OT_export_actions_select_all,
PSA_OT_export_actions_deselect_all, PSA_OT_export_actions_deselect_all,
PSA_OT_export_bone_collections_select_all, PSA_OT_export_bone_collections_select_all,
PSA_OT_export_bone_collections_deselect_all, PSA_OT_export_bone_collections_deselect_all,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -12,7 +12,10 @@ from bpy.props import (
StringProperty, StringProperty,
) )
from bpy.types import PropertyGroup, Object, Action, AnimData, Context from bpy.types import PropertyGroup, Object, Action, AnimData, Context
from ...shared.types import ForwardUpAxisMixin, ExportSpaceMixin, PsxBoneExportMixin
from ...shared.dfs import dfs_view_layer_objects
from ...shared.helpers import populate_bone_collection_list
from ...shared.types import TransformMixin, ExportSpaceMixin, PsxBoneExportMixin
def psa_export_property_group_animation_data_override_poll(_context, obj): def psa_export_property_group_animation_data_override_poll(_context, obj):
@@ -26,6 +29,7 @@ class PSA_PG_export_action_list_item(PropertyGroup):
frame_start: IntProperty(options={'HIDDEN'}) frame_start: IntProperty(options={'HIDDEN'})
frame_end: IntProperty(options={'HIDDEN'}) frame_end: IntProperty(options={'HIDDEN'})
is_pose_marker: BoolProperty(options={'HIDDEN'}) is_pose_marker: BoolProperty(options={'HIDDEN'})
group: StringProperty()
class PSA_PG_export_active_action_list_item(PropertyGroup): class PSA_PG_export_active_action_list_item(PropertyGroup):
@@ -35,6 +39,7 @@ class PSA_PG_export_active_action_list_item(PropertyGroup):
is_selected: BoolProperty(default=True) is_selected: BoolProperty(default=True)
frame_start: IntProperty(options={'HIDDEN'}) frame_start: IntProperty(options={'HIDDEN'})
frame_end: IntProperty(options={'HIDDEN'}) frame_end: IntProperty(options={'HIDDEN'})
group: StringProperty()
class PSA_PG_export_timeline_markers(PropertyGroup): # TODO: rename this to singular class PSA_PG_export_timeline_markers(PropertyGroup): # TODO: rename this to singular
@@ -43,6 +48,7 @@ class PSA_PG_export_timeline_markers(PropertyGroup): # TODO: rename this to sin
is_selected: BoolProperty(default=True) is_selected: BoolProperty(default=True)
frame_start: IntProperty(options={'HIDDEN'}) frame_start: IntProperty(options={'HIDDEN'})
frame_end: IntProperty(options={'HIDDEN'}) frame_end: IntProperty(options={'HIDDEN'})
group: StringProperty()
class PSA_PG_export_nla_strip_list_item(PropertyGroup): class PSA_PG_export_nla_strip_list_item(PropertyGroup):
@@ -51,6 +57,7 @@ class PSA_PG_export_nla_strip_list_item(PropertyGroup):
frame_start: FloatProperty() frame_start: FloatProperty()
frame_end: FloatProperty() frame_end: FloatProperty()
is_selected: BoolProperty(default=True) is_selected: BoolProperty(default=True)
group: StringProperty()
def get_sequences_from_name_and_frame_range(name: str, frame_start: int, frame_end: int): def get_sequences_from_name_and_frame_range(name: str, frame_start: int, frame_end: int):
@@ -103,7 +110,49 @@ def animation_data_override_update_cb(self: 'PSA_PG_export', context: Context):
self.nla_track = '' self.nla_track = ''
class PSA_PG_export(PropertyGroup, ForwardUpAxisMixin, ExportSpaceMixin, PsxBoneExportMixin): sequence_source_items = (
('ACTIONS', 'Actions', 'Sequences will be exported using actions', 'ACTION', 0),
('TIMELINE_MARKERS', 'Timeline Markers', 'Sequences are delineated by scene timeline markers', 'MARKER_HLT', 1),
('NLA_TRACK_STRIPS', 'NLA Track Strips', 'Sequences are delineated by the start & end times of strips on the selected NLA track', 'NLA', 2),
('ACTIVE_ACTION', 'Active Action', 'The active action will be exported for each selected armature', 'ACTION', 3),
)
fps_source_items = (
('SCENE', 'Scene', '', 'SCENE_DATA', 0),
('ACTION_METADATA', 'Action Metadata', 'The frame rate will be determined by action\'s FPS property found in the PSA Export panel.\n\nIf the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used', 'ACTION', 1),
('CUSTOM', 'Custom', '', 2)
)
compression_ratio_source_items = (
('ACTION_METADATA', 'Action Metadata', 'The compression ratio will be determined by action\'s Compression Ratio property found in the PSA Export panel.\n\nIf the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used', 'ACTION', 1),
('CUSTOM', 'Custom', '', 2)
)
sampling_mode_items = (
('INTERPOLATED', 'Interpolated', 'Sampling is performed by interpolating the evaluated bone poses from the adjacent whole frames.', 'INTERPOLATED', 0),
('SUBFRAME', 'Subframe', 'Sampling is performed by evaluating the bone poses at the subframe time.\n\nNot recommended unless you are also animating with subframes enabled.', 'SUBFRAME', 1),
)
group_source_items = (
('ACTIONS', 'Actions', '', 0),
('CUSTOM', 'Custom', '', 1),
)
def sequence_source_update_cb(self: 'PSA_PG_export', context: Context) -> None:
armature_objects = []
assert context.view_layer
for dfs_object in dfs_view_layer_objects(context.view_layer):
if dfs_object.obj.type == 'ARMATURE' and dfs_object.is_selected:
armature_objects.append(dfs_object.obj)
populate_bone_collection_list(
self.bone_collection_list,
armature_objects,
primary_key='DATA' if self.sequence_source == 'ACTIVE_ACTION' else 'OBJECT')
class PSA_PG_export(PropertyGroup, TransformMixin, ExportSpaceMixin, PsxBoneExportMixin):
should_override_animation_data: BoolProperty( should_override_animation_data: BoolProperty(
name='Override Animation Data', name='Override Animation Data',
options=set(), options=set(),
@@ -120,12 +169,8 @@ class PSA_PG_export(PropertyGroup, ForwardUpAxisMixin, ExportSpaceMixin, PsxBone
name='Source', name='Source',
options=set(), options=set(),
description='', description='',
items=( items=sequence_source_items,
('ACTIONS', 'Actions', 'Sequences will be exported using actions', 'ACTION', 0), update=sequence_source_update_cb,
('TIMELINE_MARKERS', 'Timeline Markers', 'Sequences are delineated by scene timeline markers', 'MARKER_HLT', 1),
('NLA_TRACK_STRIPS', 'NLA Track Strips', 'Sequences are delineated by the start & end times of strips on the selected NLA track', 'NLA', 2),
('ACTIVE_ACTION', 'Active Action', 'The active action will be exported for each selected armature', 'ACTION', 3),
)
) )
nla_track: StringProperty( nla_track: StringProperty(
name='NLA Track', name='NLA Track',
@@ -139,22 +184,14 @@ class PSA_PG_export(PropertyGroup, ForwardUpAxisMixin, ExportSpaceMixin, PsxBone
name='FPS Source', name='FPS Source',
options=set(), options=set(),
description='', description='',
items=( items=fps_source_items,
('SCENE', 'Scene', '', 'SCENE_DATA', 0),
('ACTION_METADATA', 'Action Metadata', 'The frame rate will be determined by action\'s FPS property found in the PSA Export panel.\n\nIf the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used', 'ACTION', 1),
('CUSTOM', 'Custom', '', 2)
)
) )
fps_custom: FloatProperty(default=30.0, min=sys.float_info.epsilon, soft_min=1.0, options=set(), step=100, fps_custom: FloatProperty(default=30.0, min=sys.float_info.epsilon, soft_min=1.0, options=set(), step=100, soft_max=60.0)
soft_max=60.0)
compression_ratio_source: EnumProperty( compression_ratio_source: EnumProperty(
name='Compression Ratio Source', name='Compression Ratio Source',
options=set(), options=set(),
description='', description='',
items=( items=compression_ratio_source_items,
('ACTION_METADATA', 'Action Metadata', 'The compression ratio will be determined by action\'s Compression Ratio property found in the PSA Export panel.\n\nIf the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used', 'ACTION', 1),
('CUSTOM', 'Custom', '', 2)
)
) )
compression_ratio_custom: FloatProperty(default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames') compression_ratio_custom: FloatProperty(default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames')
action_list: CollectionProperty(type=PSA_PG_export_action_list_item) action_list: CollectionProperty(type=PSA_PG_export_action_list_item)
@@ -193,23 +230,25 @@ class PSA_PG_export(PropertyGroup, ForwardUpAxisMixin, ExportSpaceMixin, PsxBone
name='Show Reversed', name='Show Reversed',
description='Show reversed sequences' description='Show reversed sequences'
) )
scale: FloatProperty(
name='Scale',
default=1.0,
description='Scale factor to apply to the bone translations. Use this if you are exporting animations for a scaled PSK mesh',
min=0.0,
soft_max=100.0
)
sampling_mode: EnumProperty( sampling_mode: EnumProperty(
name='Sampling Mode', name='Sampling Mode',
options=set(), options=set(),
description='The method by which frames are sampled', description='The method by which frames are sampled',
items=( items=sampling_mode_items,
('INTERPOLATED', 'Interpolated', 'Sampling is performed by interpolating the evaluated bone poses from the adjacent whole frames.', 'INTERPOLATED', 0),
('SUBFRAME', 'Subframe', 'Sampling is performed by evaluating the bone poses at the subframe time.\n\nNot recommended unless you are also animating with subframes enabled.', 'SUBFRAME', 1),
),
default='INTERPOLATED' default='INTERPOLATED'
) )
group_source: EnumProperty(
name='Group Source',
options=set(),
description='The source of the exported sequence\'s group property',
items=group_source_items,
default='ACTIONS'
)
group_custom: StringProperty(
name='Group',
options=set(),
description='The group to apply to all exported sequences. Only applicable when Group Source is Custom.'
)
def filter_sequences(pg: PSA_PG_export, sequences) -> List[int]: def filter_sequences(pg: PSA_PG_export, sequences) -> List[int]:
@@ -245,10 +284,14 @@ def filter_sequences(pg: PSA_PG_export, sequences) -> List[int]:
return flt_flags return flt_flags
classes = ( _classes = (
PSA_PG_export_action_list_item, PSA_PG_export_action_list_item,
PSA_PG_export_timeline_markers, PSA_PG_export_timeline_markers,
PSA_PG_export_nla_strip_list_item, PSA_PG_export_nla_strip_list_item,
PSA_PG_export_active_action_list_item, PSA_PG_export_active_action_list_item,
PSA_PG_export, PSA_PG_export,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -52,6 +52,10 @@ class PSA_UL_export_sequences(UIList):
return flt_flags, flt_neworder return flt_flags, flt_neworder
classes = ( _classes = (
PSA_UL_export_sequences, PSA_UL_export_sequences,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -8,11 +8,13 @@ from bpy_extras.io_utils import ImportHelper
from .properties import PsaImportMixin, get_visible_sequences from .properties import PsaImportMixin, get_visible_sequences
from ..config import read_psa_config from ..config import read_psa_config
from ..importer import PsaImportOptions, import_psa from ..importer import BoneMapping, PsaImportOptions, import_psa
from ..reader import PsaReader from psk_psa_py.psa.reader import PsaReader
def psa_import_poll(cls, context: Context): def psa_import_poll(cls, context: Context):
if context.view_layer is None or context.view_layer.objects.active is None:
return False
active_object = context.view_layer.objects.active active_object = context.view_layer.objects.active
if active_object is None or active_object.type != 'ARMATURE': if active_object is None or active_object.type != 'ARMATURE':
cls.poll_message_set('The active object must be an armature') cls.poll_message_set('The active object must be an armature')
@@ -32,10 +34,12 @@ class PSA_OT_import_sequences_select_from_text(Operator):
return len(pg.sequence_list) > 0 return len(pg.sequence_list) > 0
def invoke(self, context, event): def invoke(self, context, event):
assert context.window_manager
return context.window_manager.invoke_props_dialog(self, width=256) return context.window_manager.invoke_props_dialog(self, width=256)
def draw(self, context): def draw(self, context):
layout = self.layout layout = self.layout
assert layout
pg = getattr(context.scene, 'psa_import') pg = getattr(context.scene, 'psa_import')
layout.label(icon='INFO', text='Each sequence name should be on a new line.') layout.label(icon='INFO', text='Each sequence name should be on a new line.')
layout.prop(pg, 'select_text', text='') layout.prop(pg, 'select_text', text='')
@@ -134,6 +138,8 @@ class PSA_OT_import_drag_and_drop(Operator, PsaImportMixin):
warnings = [] warnings = []
sequences_count = 0 sequences_count = 0
assert context.view_layer and context.view_layer.objects.active
for file in self.files: for file in self.files:
psa_path = str(os.path.join(self.directory, file.name)) psa_path = str(os.path.join(self.directory, file.name))
psa_reader = PsaReader(psa_path) psa_reader = PsaReader(psa_path)
@@ -157,12 +163,14 @@ class PSA_OT_import_drag_and_drop(Operator, PsaImportMixin):
def invoke(self, context: Context, event): def invoke(self, context: Context, event):
# Make sure the selected object is an obj. # Make sure the selected object is an obj.
assert context.view_layer and context.view_layer.objects.active
active_object = context.view_layer.objects.active active_object = context.view_layer.objects.active
if active_object is None or active_object.type != 'ARMATURE': if active_object is None or active_object.type != 'ARMATURE':
self.report({'ERROR_INVALID_CONTEXT'}, 'The active object must be an armature') self.report({'ERROR_INVALID_CONTEXT'}, 'The active object must be an armature')
return {'CANCELLED'} return {'CANCELLED'}
# Show the import operator properties in a pop-up dialog (do not use the file selector). # Show the import operator properties in a pop-up dialog (do not use the file selector).
assert context.window_manager
context.window_manager.invoke_props_dialog(self) context.window_manager.invoke_props_dialog(self)
return {'RUNNING_MODAL'} return {'RUNNING_MODAL'}
@@ -181,7 +189,10 @@ def psa_import_options_from_property_group(pg: PsaImportMixin, sequence_names: I
options.should_write_metadata = pg.should_write_metadata options.should_write_metadata = pg.should_write_metadata
options.should_write_keyframes = pg.should_write_keyframes options.should_write_keyframes = pg.should_write_keyframes
options.should_convert_to_samples = pg.should_convert_to_samples options.should_convert_to_samples = pg.should_convert_to_samples
options.bone_mapping_mode = pg.bone_mapping_mode options.bone_mapping = BoneMapping(
is_case_sensitive=pg.bone_mapping_is_case_sensitive,
should_ignore_trailing_whitespace=pg.bone_mapping_should_ignore_trailing_whitespace
)
options.fps_source = pg.fps_source options.fps_source = pg.fps_source
options.fps_custom = pg.fps_custom options.fps_custom = pg.fps_custom
options.translation_scale = pg.translation_scale options.translation_scale = pg.translation_scale
@@ -236,7 +247,10 @@ class PSA_OT_import_all(Operator, PsaImportMixin):
options = PsaImportOptions( options = PsaImportOptions(
action_name_prefix=self.action_name_prefix, action_name_prefix=self.action_name_prefix,
bone_mapping_mode=self.bone_mapping_mode, bone_mapping=BoneMapping(
is_case_sensitive=self.bone_mapping_is_case_sensitive,
should_ignore_trailing_whitespace=self.bone_mapping_should_ignore_trailing_whitespace
),
fps_custom=self.fps_custom, fps_custom=self.fps_custom,
fps_source=self.fps_source, fps_source=self.fps_source,
sequence_names=sequence_names, sequence_names=sequence_names,
@@ -250,6 +264,8 @@ class PSA_OT_import_all(Operator, PsaImportMixin):
translation_scale=self.translation_scale translation_scale=self.translation_scale
) )
assert context.view_layer
assert context.view_layer.objects.active
result = _import_psa(context, options, self.filepath, context.view_layer.objects.active) result = _import_psa(context, options, self.filepath, context.view_layer.objects.active)
if len(result.warnings) > 0: if len(result.warnings) > 0:
@@ -308,12 +324,13 @@ class PSA_OT_import(Operator, ImportHelper, PsaImportMixin):
def invoke(self, context: Context, event: Event): def invoke(self, context: Context, event: Event):
# Attempt to load the PSA file for the pre-selected file. # Attempt to load the PSA file for the pre-selected file.
load_psa_file(context, self.filepath) load_psa_file(context, self.filepath)
assert context.window_manager
context.window_manager.fileselect_add(self) context.window_manager.fileselect_add(self)
return {'RUNNING_MODAL'} return {'RUNNING_MODAL'}
def draw(self, context: Context): def draw(self, context: Context):
layout = self.layout layout = self.layout
assert layout
pg = getattr(context.scene, 'psa_import') pg = getattr(context.scene, 'psa_import')
sequences_header, sequences_panel = layout.panel('sequences_panel_id', default_closed=False) sequences_header, sequences_panel = layout.panel('sequences_panel_id', default_closed=False)
@@ -370,10 +387,14 @@ class PSA_OT_import(Operator, ImportHelper, PsaImportMixin):
advanced_header.label(text='Advanced') advanced_header.label(text='Advanced')
if advanced_panel: if advanced_panel:
col = advanced_panel.column() bone_mapping_header, bone_mapping_panel = layout.panel('bone_mapping_id', default_closed=False)
col.use_property_split = True bone_mapping_header.label(text='Bone Mapping')
col.use_property_decorate = False if bone_mapping_panel:
col.prop(self, 'bone_mapping_mode') col = bone_mapping_panel.column()
col.use_property_split = True
col.use_property_decorate = False
col.prop(self, 'bone_mapping_is_case_sensitive')
col.prop(self, 'bone_mapping_should_ignore_trailing_whitespace')
col = advanced_panel.column() col = advanced_panel.column()
col.use_property_split = True col.use_property_split = True
@@ -412,10 +433,15 @@ def draw_psa_import_options_no_panels(layout, pg: PsaImportMixin):
col.use_property_decorate = False col.use_property_decorate = False
col.prop(pg, 'should_convert_to_samples') col.prop(pg, 'should_convert_to_samples')
col = layout.column(heading='Bone Mapping')
col.use_property_split = True
col.use_property_decorate = False
col.prop(pg, 'bone_mapping_is_case_sensitive')
col.prop(pg, 'bone_mapping_should_ignore_trailing_whitespace')
col = layout.column() col = layout.column()
col.use_property_split = True col.use_property_split = True
col.use_property_decorate = False col.use_property_decorate = False
col.prop(pg, 'bone_mapping_mode')
col.prop(pg, 'translation_scale') col.prop(pg, 'translation_scale')
col = layout.column(heading='Options') col = layout.column(heading='Options')
@@ -434,11 +460,11 @@ class PSA_FH_import(FileHandler): # TODO: rename and add handling for PSA expor
bl_file_extensions = '.psa' bl_file_extensions = '.psa'
@classmethod @classmethod
def poll_drop(cls, context: Context): def poll_drop(cls, context: Context) -> bool:
return context.area and context.area.type == 'VIEW_3D' return context.area is not None and context.area.type == 'VIEW_3D'
classes = ( _classes = (
PSA_OT_import_sequences_select_all, PSA_OT_import_sequences_select_all,
PSA_OT_import_sequences_deselect_all, PSA_OT_import_sequences_deselect_all,
PSA_OT_import_sequences_select_from_text, PSA_OT_import_sequences_select_from_text,
@@ -447,3 +473,6 @@ classes = (
PSA_OT_import_drag_and_drop, PSA_OT_import_drag_and_drop,
PSA_FH_import, PSA_FH_import,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -80,12 +80,13 @@ class PsaImportMixin:
description='Convert keyframes to read-only samples. ' description='Convert keyframes to read-only samples. '
'Recommended if you do not plan on editing the actions directly' 'Recommended if you do not plan on editing the actions directly'
) )
bone_mapping_mode: EnumProperty( bone_mapping_is_case_sensitive: BoolProperty(
name='Bone Mapping', default=False,
options=set(), name='Case Sensitive'
description='The method by which bones from the incoming PSA file are mapped to the armature', )
items=bone_mapping_items, bone_mapping_should_ignore_trailing_whitespace: BoolProperty(
default='CASE_INSENSITIVE' default=True,
name='Ignore Trailing Whitespace'
) )
fps_source: EnumProperty(name='FPS Source', items=fps_source_items) fps_source: EnumProperty(name='FPS Source', items=fps_source_items)
fps_custom: FloatProperty( fps_custom: FloatProperty(
@@ -175,9 +176,12 @@ def get_visible_sequences(pg: PSA_PG_import, sequences) -> List[PSA_PG_import_ac
return visible_sequences return visible_sequences
classes = ( _classes = (
PSA_PG_import_action_list_item, PSA_PG_import_action_list_item,
PSA_PG_bone, PSA_PG_bone,
PSA_PG_data, PSA_PG_data,
PSA_PG_import, PSA_PG_import,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -42,8 +42,11 @@ class PSA_UL_import_actions(PSA_UL_sequences_mixin):
pass pass
classes = ( _classes = (
PSA_UL_sequences, PSA_UL_sequences,
PSA_UL_import_sequences, PSA_UL_import_sequences,
PSA_UL_import_actions, PSA_UL_import_actions,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -1,24 +1,36 @@
import typing from typing import Sequence, Iterable, List, Optional, cast as typing_cast
from typing import Iterable, List, Optional, cast as typing_cast
import bpy import bpy
import numpy as np import numpy as np
from bpy.types import Armature, Context, FCurve, Object import re
from bpy.types import Armature, Context, FCurve, Object, Bone, PoseBone
from mathutils import Vector, Quaternion from mathutils import Vector, Quaternion
from bpy_extras import anim_utils
from .config import PsaConfig, REMOVE_TRACK_LOCATION, REMOVE_TRACK_ROTATION from .config import PsaConfig, REMOVE_TRACK_LOCATION, REMOVE_TRACK_ROTATION
from .reader import PsaReader from psk_psa_py.psa.reader import PsaReader
from ..shared.data import PsxBone from psk_psa_py.shared.data import PsxBone
class BoneMapping:
def __init__(self,
is_case_sensitive: bool = False,
should_ignore_trailing_whitespace: bool = True
):
self.is_case_sensitive = is_case_sensitive
# Ancient PSK and PSA exporters would, for some reason, pad the bone names with spaces
# instead of just writing null bytes, probably because the programmers were lazy.
# By default, we will ignore trailing whitespace when doing comparisons.
self.should_ignore_trailing_whitespace = should_ignore_trailing_whitespace
class PsaImportOptions(object): class PsaImportOptions(object):
def __init__(self, def __init__(self,
action_name_prefix: str = '', action_name_prefix: str = '',
bone_mapping_mode: str = 'CASE_INSENSITIVE', bone_mapping: BoneMapping = BoneMapping(),
fps_custom: float = 30.0, fps_custom: float = 30.0,
fps_source: str = 'SEQUENCE', fps_source: str = 'SEQUENCE',
psa_config: PsaConfig = PsaConfig(), psa_config: PsaConfig = PsaConfig(),
sequence_names: List[str] = None, sequence_names: Optional[List[str]] = None,
should_convert_to_samples: bool = False, should_convert_to_samples: bool = False,
should_overwrite: bool = False, should_overwrite: bool = False,
should_stash: bool = False, should_stash: bool = False,
@@ -29,7 +41,7 @@ class PsaImportOptions(object):
translation_scale: float = 1.0 translation_scale: float = 1.0
): ):
self.action_name_prefix = action_name_prefix self.action_name_prefix = action_name_prefix
self.bone_mapping_mode = bone_mapping_mode self.bone_mapping = bone_mapping
self.fps_custom = fps_custom self.fps_custom = fps_custom
self.fps_source = fps_source self.fps_source = fps_source
self.psa_config = psa_config self.psa_config = psa_config
@@ -48,15 +60,15 @@ class ImportBone(object):
def __init__(self, psa_bone: PsxBone): def __init__(self, psa_bone: PsxBone):
self.psa_bone: PsxBone = psa_bone self.psa_bone: PsxBone = psa_bone
self.parent: Optional[ImportBone] = None self.parent: Optional[ImportBone] = None
self.armature_bone = None self.armature_bone: Optional[Bone] = None
self.pose_bone = None self.pose_bone: Optional[PoseBone] = None
self.original_location: Vector = Vector() self.original_location: Vector = Vector()
self.original_rotation: Quaternion = Quaternion() self.original_rotation: Quaternion = Quaternion()
self.post_rotation: Quaternion = Quaternion() self.post_rotation: Quaternion = Quaternion()
self.fcurves: List[FCurve] = [] self.fcurves: List[FCurve] = []
def _calculate_fcurve_data(import_bone: ImportBone, key_data: Iterable[float]): def _calculate_fcurve_data(import_bone: ImportBone, key_data: Sequence[float]):
# Convert world-space transforms to local-space transforms. # Convert world-space transforms to local-space transforms.
key_rotation = Quaternion(key_data[0:4]) key_rotation = Quaternion(key_data[0:4])
key_location = Vector(key_data[4:]) key_location = Vector(key_data[4:])
@@ -79,20 +91,30 @@ class PsaImportResult:
self.warnings: List[str] = [] self.warnings: List[str] = []
def _get_armature_bone_index_for_psa_bone(psa_bone_name: str, armature_bone_names: List[str], bone_mapping_mode: str = 'EXACT') -> Optional[int]: def _get_armature_bone_index_for_psa_bone(psa_bone_name: str, armature_bone_names: List[str], bone_mapping: BoneMapping) -> Optional[int]:
""" """
@param psa_bone_name: The name of the PSA bone. @param psa_bone_name: The name of the PSA bone.
@param armature_bone_names: The names of the bones in the armature. @param armature_bone_names: The names of the bones in the armature.
@param bone_mapping_mode: One of `['EXACT', 'CASE_INSENSITIVE']`. @param bone_mapping: Bone mapping information.
@return: The index of the armature bone that corresponds to the given PSA bone, or None if no such bone exists. @return: The index of the armature bone that corresponds to the given PSA bone, or None if no such bone exists.
""" """
# Use regular expressions for bone name matching.
pattern = psa_bone_name
flags = 0
if bone_mapping.should_ignore_trailing_whitespace:
psa_bone_name = psa_bone_name.rstrip()
pattern += r'\s*'
if not bone_mapping.is_case_sensitive:
flags = re.IGNORECASE
pattern = re.compile(pattern, flags)
for armature_bone_index, armature_bone_name in enumerate(armature_bone_names): for armature_bone_index, armature_bone_name in enumerate(armature_bone_names):
if bone_mapping_mode == 'CASE_INSENSITIVE': if re.fullmatch(pattern, armature_bone_name):
if armature_bone_name.lower() == psa_bone_name.lower(): return armature_bone_index
return armature_bone_index
else:
if armature_bone_name == psa_bone_name:
return armature_bone_index
return None return None
@@ -146,6 +168,9 @@ def _resample_sequence_data_matrix(sequence_data_matrix: np.ndarray, frame_step:
def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object, options: PsaImportOptions) -> PsaImportResult: def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object, options: PsaImportOptions) -> PsaImportResult:
assert context.window_manager
result = PsaImportResult() result = PsaImportResult()
sequences = [psa_reader.sequences[x] for x in options.sequence_names] sequences = [psa_reader.sequences[x] for x in options.sequence_names]
armature_data = typing_cast(Armature, armature_object.data) armature_data = typing_cast(Armature, armature_object.data)
@@ -159,7 +184,7 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
for psa_bone_index, psa_bone in enumerate(psa_reader.bones): for psa_bone_index, psa_bone in enumerate(psa_reader.bones):
psa_bone_name: str = psa_bone.name.decode('windows-1252') psa_bone_name: str = psa_bone.name.decode('windows-1252')
armature_bone_index = _get_armature_bone_index_for_psa_bone(psa_bone_name, armature_bone_names, options.bone_mapping_mode) armature_bone_index = _get_armature_bone_index_for_psa_bone(psa_bone_name, armature_bone_names, options.bone_mapping)
if armature_bone_index is not None: if armature_bone_index is not None:
# Ensure that no other PSA bone has been mapped to this armature bone yet. # Ensure that no other PSA bone has been mapped to this armature bone yet.
if armature_bone_index not in armature_to_psa_bone_indices: if armature_bone_index not in armature_to_psa_bone_indices:
@@ -190,6 +215,8 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
) )
del armature_bone_names del armature_bone_names
assert armature_object.pose
# Create intermediate bone data for import operations. # Create intermediate bone data for import operations.
import_bones = [] import_bones = []
psa_bone_names_to_import_bones = dict() psa_bone_names_to_import_bones = dict()
@@ -253,21 +280,27 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
action = bpy.data.actions[action_name] action = bpy.data.actions[action_name]
else: else:
action = bpy.data.actions.new(name=action_name) action = bpy.data.actions.new(name=action_name)
action_slot = action.slots.new('OBJECT', armature_object.name)
# TODO: Wish there was a better way to do this.
action_slot = action.slots[f'OB{armature_object.name}']
assert action_slot
# Calculate the target FPS. # Calculate the target FPS.
match options.fps_source: match options.fps_source:
case 'CUSTOM': case 'CUSTOM':
target_fps = options.fps_custom target_fps = options.fps_custom
case 'SCENE': case 'SCENE':
assert context.scene
target_fps = context.scene.render.fps target_fps = context.scene.render.fps
case 'SEQUENCE': case 'SEQUENCE':
target_fps = sequence.fps target_fps = sequence.fps
case _: case _:
assert False, f'Invalid FPS source: {options.fps_source}' assert False, f'Invalid FPS source: {options.fps_source}'
if options.should_write_keyframes: if options.should_write_keyframes:
# Remove existing f-curves. channelbag = anim_utils.action_ensure_channelbag_for_slot(action, action_slot)
action.fcurves.clear()
# Create f-curves for the rotation and location of each bone. # Create f-curves for the rotation and location of each bone.
for psa_bone_index, armature_bone_index in psa_to_armature_bone_indices.items(): for psa_bone_index, armature_bone_index in psa_to_armature_bone_indices.items():
@@ -279,13 +312,13 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
add_rotation_fcurves = (bone_track_flags & REMOVE_TRACK_ROTATION) == 0 add_rotation_fcurves = (bone_track_flags & REMOVE_TRACK_ROTATION) == 0
add_location_fcurves = (bone_track_flags & REMOVE_TRACK_LOCATION) == 0 add_location_fcurves = (bone_track_flags & REMOVE_TRACK_LOCATION) == 0
import_bone.fcurves = [ import_bone.fcurves = [
action.fcurves.new(rotation_data_path, index=0, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qw channelbag.fcurves.ensure(rotation_data_path, index=0, group_name=pose_bone.name) if add_rotation_fcurves else None, # Qw
action.fcurves.new(rotation_data_path, index=1, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qx channelbag.fcurves.ensure(rotation_data_path, index=1, group_name=pose_bone.name) if add_rotation_fcurves else None, # Qx
action.fcurves.new(rotation_data_path, index=2, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qy channelbag.fcurves.ensure(rotation_data_path, index=2, group_name=pose_bone.name) if add_rotation_fcurves else None, # Qy
action.fcurves.new(rotation_data_path, index=3, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qz channelbag.fcurves.ensure(rotation_data_path, index=3, group_name=pose_bone.name) if add_rotation_fcurves else None, # Qz
action.fcurves.new(location_data_path, index=0, action_group=pose_bone.name) if add_location_fcurves else None, # Lx channelbag.fcurves.ensure(location_data_path, index=0, group_name=pose_bone.name) if add_location_fcurves else None, # Lx
action.fcurves.new(location_data_path, index=1, action_group=pose_bone.name) if add_location_fcurves else None, # Ly channelbag.fcurves.ensure(location_data_path, index=1, group_name=pose_bone.name) if add_location_fcurves else None, # Ly
action.fcurves.new(location_data_path, index=2, action_group=pose_bone.name) if add_location_fcurves else None, # Lz channelbag.fcurves.ensure(location_data_path, index=2, group_name=pose_bone.name) if add_location_fcurves else None, # Lz
] ]
# Read the sequence data matrix from the PSA. # Read the sequence data matrix from the PSA.
@@ -322,6 +355,7 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
for fcurve_index, fcurve in enumerate(import_bone.fcurves): for fcurve_index, fcurve in enumerate(import_bone.fcurves):
if fcurve is None: if fcurve is None:
continue continue
fcurve.keyframe_points.clear()
fcurve_data[1::2] = resampled_sequence_data_matrix[:, bone_index, fcurve_index] fcurve_data[1::2] = resampled_sequence_data_matrix[:, bone_index, fcurve_index]
fcurve.keyframe_points.add(target_frame_count) fcurve.keyframe_points.add(target_frame_count)
fcurve.keyframe_points.foreach_set('co', fcurve_data) fcurve.keyframe_points.foreach_set('co', fcurve_data)
@@ -345,10 +379,11 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
# If the user specifies, store the new animations as strips on a non-contributing NLA track. # If the user specifies, store the new animations as strips on a non-contributing NLA track.
if options.should_stash: if options.should_stash:
if armature_object.animation_data is None: animation_data = armature_object.animation_data
armature_object.animation_data_create() if animation_data is None:
animation_data = armature_object.animation_data_create()
for action in actions: for action in actions:
nla_track = armature_object.animation_data.nla_tracks.new() nla_track = animation_data.nla_tracks.new()
nla_track.name = action.name nla_track.name = action.name
nla_track.mute = True nla_track.mute = True
nla_track.strips.new(name=action.name, start=0, action=action) nla_track.strips.new(name=action.name, start=0, action=action)

View File

@@ -1,126 +0,0 @@
from ctypes import sizeof
from typing import List
import numpy as np
from .data import Psa, PsxBone
from ..shared.data import Section
def _try_fix_cue4parse_issue_103(sequences) -> bool:
# Detect if the file was exported from CUE4Parse prior to the fix for issue #103.
# https://github.com/FabianFG/CUE4Parse/issues/103
# The issue was that the frame_start_index was not being set correctly, and was always being set to the same value
# as the frame_count.
# This fix will eventually be deprecated as it is only necessary for files exported prior to the fix.
if len(sequences) > 0 and sequences[0].frame_start_index == sequences[0].frame_count:
# Manually set the frame_start_index for each sequence. This assumes that the sequences are in order with
# no shared frames between sequences (all exporters that I know of do this, so it's a safe assumption).
frame_start_index = 0
for i, sequence in enumerate(sequences):
sequence.frame_start_index = frame_start_index
frame_start_index += sequence.frame_count
return True
return False
class PsaReader(object):
"""
This class reads the sequences and bone information immediately upon instantiation and holds onto a file handle.
The keyframe data is not read into memory upon instantiation due to its potentially very large size.
To read the key data for a particular sequence, call :read_sequence_keys.
"""
def __init__(self, path):
self.keys_data_offset: int = 0
self.fp = open(path, 'rb')
self.psa: Psa = self._read(self.fp)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.fp.close()
@property
def bones(self):
return self.psa.bones
@property
def sequences(self):
return self.psa.sequences
def read_sequence_data_matrix(self, sequence_name: str) -> np.ndarray:
"""
Reads and returns the data matrix for the given sequence.
@param sequence_name: The name of the sequence.
@return: An FxBx7 matrix where F is the number of frames, B is the number of bones.
"""
sequence = self.psa.sequences[sequence_name]
keys = self.read_sequence_keys(sequence_name)
bone_count = len(self.bones)
matrix_size = sequence.frame_count, bone_count, 7
matrix = np.zeros(matrix_size)
keys_iter = iter(keys)
for frame_index in range(sequence.frame_count):
for bone_index in range(bone_count):
matrix[frame_index, bone_index, :] = list(next(keys_iter).data)
return matrix
def read_sequence_keys(self, sequence_name: str) -> List[Psa.Key]:
"""
Reads and returns the key data for a sequence.
@param sequence_name: The name of the sequence.
@return: A list of Psa.Keys.
"""
# Set the file reader to the beginning of the keys data
sequence = self.psa.sequences[sequence_name]
data_size = sizeof(Psa.Key)
bone_count = len(self.psa.bones)
buffer_length = data_size * bone_count * sequence.frame_count
sequence_keys_offset = self.keys_data_offset + (sequence.frame_start_index * bone_count * data_size)
self.fp.seek(sequence_keys_offset, 0)
buffer = self.fp.read(buffer_length)
offset = 0
keys = []
for _ in range(sequence.frame_count * bone_count):
key = Psa.Key.from_buffer_copy(buffer, offset)
keys.append(key)
offset += data_size
return keys
@staticmethod
def _read_types(fp, data_class, section: Section, data):
buffer_length = section.data_size * section.data_count
buffer = fp.read(buffer_length)
offset = 0
for _ in range(section.data_count):
data.append(data_class.from_buffer_copy(buffer, offset))
offset += section.data_size
def _read(self, fp) -> Psa:
psa = Psa()
while fp.read(1):
fp.seek(-1, 1)
section = Section.from_buffer_copy(fp.read(sizeof(Section)))
if section.name == b'ANIMHEAD':
pass
elif section.name == b'BONENAMES':
PsaReader._read_types(fp, PsxBone, section, psa.bones)
elif section.name == b'ANIMINFO':
sequences = []
PsaReader._read_types(fp, Psa.Sequence, section, sequences)
# Try to fix CUE4Parse bug, if necessary.
_try_fix_cue4parse_issue_103(sequences)
for sequence in sequences:
psa.sequences[sequence.name.decode()] = sequence
elif section.name == b'ANIMKEYS':
# Skip keys on this pass. We will keep this file open and read from it as needed.
self.keys_data_offset = fp.tell()
fp.seek(section.data_size * section.data_count, 1)
else:
fp.seek(section.data_size * section.data_count, 1)
print(f'Unrecognized section in PSA: "{section.name}"')
return psa

View File

@@ -1,25 +0,0 @@
from ctypes import Structure, sizeof
from typing import Type
from .data import Psa
from ..shared.data import PsxBone, Section
def write_section(fp, name: bytes, data_type: Type[Structure] = None, data: list = None):
section = Section()
section.name = name
if data_type is not None and data is not None:
section.data_size = sizeof(data_type)
section.data_count = len(data)
fp.write(section)
if data is not None:
for datum in data:
fp.write(datum)
def write_psa(psa: Psa, path: str):
with open(path, 'wb') as fp:
write_section(fp, b'ANIMHEAD')
write_section(fp, b'BONENAMES', PsxBone, psa.bones)
write_section(fp, b'ANIMINFO', Psa.Sequence, list(psa.sequences.values()))
write_section(fp, b'ANIMKEYS', Psa.Key, psa.keys)

View File

@@ -1,16 +1,18 @@
import bmesh import bmesh
import bpy import bpy
import numpy as np import numpy as np
from bpy.types import Armature, Collection, Context, Depsgraph, Object from bpy.types import Armature, Collection, Context, Depsgraph, Object, ArmatureModifier, Mesh
from mathutils import Matrix from mathutils import Matrix
from typing import Dict, Generator, Iterable, List, Optional, Set, Tuple, cast as typing_cast from typing import Dict, Iterable, List, Optional, Set, cast as typing_cast
from .data import Psk from psk_psa_py.shared.data import Vector3
from psk_psa_py.psk.data import Psk
from .properties import triangle_type_and_bit_flags_to_poly_flags from .properties import triangle_type_and_bit_flags_to_poly_flags
from ..shared.data import Vector3
from ..shared.dfs import DfsObject, dfs_collection_objects, dfs_view_layer_objects from ..shared.dfs import DfsObject, dfs_collection_objects, dfs_view_layer_objects
from ..shared.helpers import ( from ..shared.helpers import (
PsxBoneCollection,
convert_string_to_cp1252_bytes, convert_string_to_cp1252_bytes,
create_psx_bones, create_psx_bones,
get_armatures_for_mesh_objects,
get_coordinate_system_transform, get_coordinate_system_transform,
) )
@@ -24,7 +26,7 @@ class PskInputObjects(object):
class PskBuildOptions(object): class PskBuildOptions(object):
def __init__(self): def __init__(self):
self.bone_filter_mode = 'ALL' self.bone_filter_mode = 'ALL'
self.bone_collection_indices: List[Tuple[str, int]] = [] self.bone_collection_indices: List[PsxBoneCollection] = []
self.object_eval_state = 'EVALUATED' self.object_eval_state = 'EVALUATED'
self.material_order_mode = 'AUTOMATIC' self.material_order_mode = 'AUTOMATIC'
self.material_name_list: List[str] = [] self.material_name_list: List[str] = []
@@ -42,7 +44,7 @@ def get_materials_for_mesh_objects(depsgraph: Depsgraph, mesh_objects: Iterable[
for i, material_slot in enumerate(evaluated_mesh_object.material_slots): for i, material_slot in enumerate(evaluated_mesh_object.material_slots):
material = material_slot.material material = material_slot.material
if material is None: if material is None:
raise RuntimeError('Material slot cannot be empty (index ' + str(i) + ')') raise RuntimeError(f'Material slots cannot be empty. ({mesh_object.name}, index {i})')
if material not in yielded_materials: if material not in yielded_materials:
yielded_materials.add(material) yielded_materials.add(material)
yield material yield material
@@ -53,40 +55,31 @@ def get_mesh_objects_for_collection(collection: Collection) -> Iterable[DfsObjec
def get_mesh_objects_for_context(context: Context) -> Iterable[DfsObject]: def get_mesh_objects_for_context(context: Context) -> Iterable[DfsObject]:
if context.view_layer is None:
return
for dfs_object in dfs_view_layer_objects(context.view_layer): for dfs_object in dfs_view_layer_objects(context.view_layer):
if dfs_object.obj.type == 'MESH' and dfs_object.is_selected: if dfs_object.obj.type == 'MESH' and dfs_object.is_selected:
yield dfs_object yield dfs_object
def get_armature_for_mesh_object(mesh_object: Object) -> Optional[Object]: def get_armature_for_mesh_object(mesh_object: Object) -> Optional[Object]:
for modifier in mesh_object.modifiers: if mesh_object.type != 'MESH':
if modifier.type == 'ARMATURE': return None
return modifier.object # Get the first armature modifier with a non-empty armature object.
for modifier in filter(lambda x: x.type == 'ARMATURE', mesh_object.modifiers):
armature_modifier = typing_cast(ArmatureModifier, modifier)
if armature_modifier.object is not None:
return armature_modifier.object
return None return None
def get_armatures_for_mesh_objects(mesh_objects: Iterable[Object]) -> Generator[Object, None, None]:
# Ensure that there are either no armature modifiers (static mesh) or that there is exactly one armature modifier
# object shared between all meshes.
armature_objects = set()
for mesh_object in mesh_objects:
modifiers = [x for x in mesh_object.modifiers if x.type == 'ARMATURE']
if len(modifiers) == 0:
continue
if modifiers[0].object in armature_objects:
continue
yield modifiers[0].object
def _get_psk_input_objects(mesh_dfs_objects: Iterable[DfsObject]) -> PskInputObjects: def _get_psk_input_objects(mesh_dfs_objects: Iterable[DfsObject]) -> PskInputObjects:
mesh_dfs_objects = list(mesh_dfs_objects) mesh_dfs_objects = list(mesh_dfs_objects)
if len(mesh_dfs_objects) == 0: if len(mesh_dfs_objects) == 0:
raise RuntimeError('At least one mesh must be selected') raise RuntimeError('At least one mesh must be selected')
input_objects = PskInputObjects() input_objects = PskInputObjects()
input_objects.mesh_dfs_objects = mesh_dfs_objects input_objects.mesh_dfs_objects = mesh_dfs_objects
input_objects.armature_objects |= set(get_armatures_for_mesh_objects(map(lambda x: x.obj, mesh_dfs_objects))) input_objects.armature_objects |= set(get_armatures_for_mesh_objects(map(lambda x: x.obj, mesh_dfs_objects)))
return input_objects return input_objects
@@ -95,17 +88,15 @@ def get_psk_input_objects_for_context(context: Context) -> PskInputObjects:
return _get_psk_input_objects(mesh_objects) return _get_psk_input_objects(mesh_objects)
def get_psk_input_objects_for_collection(collection: Collection, should_exclude_hidden_meshes: bool = True) -> PskInputObjects: def get_psk_input_objects_for_collection(collection: Collection) -> PskInputObjects:
mesh_objects = get_mesh_objects_for_collection(collection) mesh_objects = get_mesh_objects_for_collection(collection)
if should_exclude_hidden_meshes:
mesh_objects = filter(lambda x: x.is_visible, mesh_objects)
return _get_psk_input_objects(mesh_objects) return _get_psk_input_objects(mesh_objects)
class PskBuildResult(object): class PskBuildResult(object):
def __init__(self): def __init__(self, psk: Psk, warnings: list[str]):
self.psk = None self.psk: Psk = psk
self.warnings: List[str] = [] self.warnings: List[str] = warnings
def _get_mesh_export_space_matrix(armature_object: Optional[Object], export_space: str) -> Matrix: def _get_mesh_export_space_matrix(armature_object: Optional[Object], export_space: str) -> Matrix:
@@ -146,9 +137,12 @@ def _get_material_name_indices(obj: Object, material_names: List[str]) -> Iterab
def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuildOptions) -> PskBuildResult: def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuildOptions) -> PskBuildResult:
assert context.window_manager
armature_objects = list(input_objects.armature_objects) armature_objects = list(input_objects.armature_objects)
result = PskBuildResult() warnings: list[str] = []
psk = Psk() psk = Psk()
psx_bone_create_result = create_psx_bones( psx_bone_create_result = create_psx_bones(
@@ -173,16 +167,17 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
# The material name list may contain materials that are not on the mesh objects. # The material name list may contain materials that are not on the mesh objects.
# Therefore, we can take the material_name_list as gospel and simply use it as a lookup table. # Therefore, we can take the material_name_list as gospel and simply use it as a lookup table.
# If a look-up fails, replace it with an empty material. # If a look-up fails, replace it with an empty material.
materials = [bpy.data.materials.get(x.material_name, None) for x in options.material_name_list] materials = [bpy.data.materials.get(x, None) for x in options.material_name_list]
case _: case _:
assert False, f'Invalid material order mode: {options.material_order_mode}' assert False, f'Invalid material order mode: {options.material_order_mode}'
for material in materials: for material in materials:
psk_material = Psk.Material() psk_material = Psk.Material()
psk_material.name = convert_string_to_cp1252_bytes(material.name) psk_material.name = convert_string_to_cp1252_bytes(material.name if material else 'None')
psk_material.texture_index = len(psk.materials) psk_material.texture_index = len(psk.materials)
psk_material.poly_flags = triangle_type_and_bit_flags_to_poly_flags(material.psk.mesh_triangle_type, if material is not None:
material.psk.mesh_triangle_bit_flags) psk_material.poly_flags = triangle_type_and_bit_flags_to_poly_flags(material.psk.mesh_triangle_type,
material.psk.mesh_triangle_bit_flags)
psk.materials.append(psk_material) psk.materials.append(psk_material)
# TODO: This wasn't left in a good state. We should detect if we need to add a "default" material. # TODO: This wasn't left in a good state. We should detect if we need to add a "default" material.
@@ -203,6 +198,9 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
# Calculate the export spaces for the armature objects. # Calculate the export spaces for the armature objects.
# This is used later to transform the mesh object geometry into the export space. # This is used later to transform the mesh object geometry into the export space.
armature_mesh_export_space_matrices: Dict[Optional[Object], Matrix] = {None: Matrix.Identity(4)} armature_mesh_export_space_matrices: Dict[Optional[Object], Matrix] = {None: Matrix.Identity(4)}
if options.export_space == 'ARMATURE':
# For meshes without an armature modifier, we need to set the export space to the armature object.
armature_mesh_export_space_matrices[None] = _get_mesh_export_space_matrix(next(iter(input_objects.armature_objects), None), options.export_space)
for armature_object in armature_objects: for armature_object in armature_objects:
armature_mesh_export_space_matrices[armature_object] = _get_mesh_export_space_matrix(armature_object, options.export_space) armature_mesh_export_space_matrices[armature_object] = _get_mesh_export_space_matrix(armature_object, options.export_space)
@@ -213,15 +211,14 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
# Temporarily force the armature into the rest position. # Temporarily force the armature into the rest position.
# We will undo this later. # We will undo this later.
for armature_object in armature_objects: for armature_object in armature_objects:
armature_object.data.pose_position = 'REST' armature_data = typing_cast(Armature, armature_object.data)
armature_data.pose_position = 'REST'
material_names = [m.name for m in materials] material_names = [m.name if m is not None else 'None' for m in materials]
for object_index, input_mesh_object in enumerate(input_objects.mesh_dfs_objects): for object_index, input_mesh_object in enumerate(input_objects.mesh_dfs_objects):
obj, matrix_world = input_mesh_object.obj, input_mesh_object.matrix_world obj, matrix_world = input_mesh_object.obj, input_mesh_object.matrix_world
armature_object = get_armature_for_mesh_object(obj) armature_object = get_armature_for_mesh_object(obj)
should_flip_normals = False should_flip_normals = False
# Material indices # Material indices
@@ -239,7 +236,7 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
match options.object_eval_state: match options.object_eval_state:
case 'ORIGINAL': case 'ORIGINAL':
mesh_object = obj mesh_object = obj
mesh_data = obj.data mesh_data = typing_cast(Mesh, obj.data)
case 'EVALUATED': case 'EVALUATED':
# Create a copy of the mesh object after non-armature modifiers are applied. # Create a copy of the mesh object after non-armature modifiers are applied.
depsgraph = context.evaluated_depsgraph_get() depsgraph = context.evaluated_depsgraph_get()
@@ -281,7 +278,14 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
case _: case _:
assert False, f'Invalid object evaluation state: {options.object_eval_state}' assert False, f'Invalid object evaluation state: {options.object_eval_state}'
mesh_export_space_matrix = armature_mesh_export_space_matrices[armature_object] match options.export_space:
case 'ARMATURE' | 'ROOT':
mesh_export_space_matrix = armature_mesh_export_space_matrices[armature_object]
case 'WORLD':
mesh_export_space_matrix = armature_mesh_export_space_matrices[armature_object]
case _:
assert False, f'Invalid export space: {options.export_space}'
vertex_transform_matrix = scale_matrix @ coordinate_system_matrix @ mesh_export_space_matrix vertex_transform_matrix = scale_matrix @ coordinate_system_matrix @ mesh_export_space_matrix
point_transform_matrix = vertex_transform_matrix @ mesh_object.matrix_world point_transform_matrix = vertex_transform_matrix @ mesh_object.matrix_world
@@ -295,19 +299,25 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
point.z = v.z point.z = v.z
psk.points.append(point) psk.points.append(point)
uv_layer = mesh_data.uv_layers.active.data
# Wedges # Wedges
mesh_data.calc_loop_triangles() mesh_data.calc_loop_triangles()
if mesh_data.uv_layers.active is None:
warnings.append(f'"{mesh_object.name}" has no active UV Map')
# Build a list of non-unique wedges. # Build a list of non-unique wedges.
wedges = [] wedges = []
for loop_index, loop in enumerate(mesh_data.loops): if mesh_data.uv_layers.active:
wedges.append(Psk.Wedge( uv_layer = mesh_data.uv_layers.active.data
point_index=loop.vertex_index + vertex_offset, for loop_index, loop in enumerate(mesh_data.loops):
u=uv_layer[loop_index].uv[0], wedges.append(Psk.Wedge(
v=1.0 - uv_layer[loop_index].uv[1] point_index=loop.vertex_index + vertex_offset,
)) u=uv_layer[loop_index].uv[0],
v=1.0 - uv_layer[loop_index].uv[1]
))
else:
for loop_index, loop in enumerate(mesh_data.loops):
wedges.append(Psk.Wedge(point_index=loop.vertex_index + vertex_offset, u=0.0, v=0.0))
# Assign material indices to the wedges. # Assign material indices to the wedges.
for triangle in mesh_data.loop_triangles: for triangle in mesh_data.loop_triangles:
@@ -417,10 +427,12 @@ def build_psk(context: Context, input_objects: PskInputObjects, options: PskBuil
# Restore the original pose position of the armature objects. # Restore the original pose position of the armature objects.
for armature_object, pose_position in original_armature_object_pose_positions.items(): for armature_object, pose_position in original_armature_object_pose_positions.items():
armature_object.data.pose_position = pose_position armature_data = typing_cast(Armature, armature_object.data)
armature_data.pose_position = pose_position
# https://github.com/DarklightGames/io_scene_psk_psa/issues/129.
psk.sort_and_normalize_weights()
context.window_manager.progress_end() context.window_manager.progress_end()
result.psk = psk return PskBuildResult(psk, warnings)
return result

View File

@@ -1,128 +0,0 @@
from ctypes import Structure, c_uint32, c_float, c_int32, c_uint8, c_int8, c_int16, c_char, c_uint16
from typing import List
from ..shared.data import Vector3, Quaternion, Color, Vector2, PsxBone
class Psk(object):
class Wedge(object):
def __init__(self, point_index: int, u: float, v: float, material_index: int = 0):
self.point_index: int = point_index
self.u: float = u
self.v: float = v
self.material_index = material_index
def __hash__(self):
return hash(f'{self.point_index}-{self.u}-{self.v}-{self.material_index}')
class Wedge16(Structure):
_fields_ = [
('point_index', c_uint32),
('u', c_float),
('v', c_float),
('material_index', c_uint8),
('reserved', c_int8),
('padding2', c_int16)
]
class Wedge32(Structure):
_fields_ = [
('point_index', c_uint32),
('u', c_float),
('v', c_float),
('material_index', c_uint32)
]
class Face(Structure):
_fields_ = [
('wedge_indices', c_uint16 * 3),
('material_index', c_uint8),
('aux_material_index', c_uint8),
('smoothing_groups', c_int32)
]
class Face32(Structure):
_pack_ = 1
_fields_ = [
('wedge_indices', c_uint32 * 3),
('material_index', c_uint8),
('aux_material_index', c_uint8),
('smoothing_groups', c_int32)
]
class Material(Structure):
_fields_ = [
('name', c_char * 64),
('texture_index', c_int32),
('poly_flags', c_int32),
('aux_material', c_int32),
('aux_flags', c_int32),
('lod_bias', c_int32),
('lod_style', c_int32)
]
class Bone(Structure):
_fields_ = [
('name', c_char * 64),
('flags', c_int32),
('children_count', c_int32),
('parent_index', c_int32),
('rotation', Quaternion),
('location', Vector3),
('length', c_float),
('size', Vector3)
]
class Weight(Structure):
_fields_ = [
('weight', c_float),
('point_index', c_int32),
('bone_index', c_int32),
]
class MorphInfo(Structure):
_fields_ = [
('name', c_char * 64),
('vertex_count', c_int32)
]
class MorphData(Structure):
_fields_ = [
('position_delta', Vector3),
('tangent_z_delta', Vector3),
('point_index', c_int32)
]
@property
def has_extra_uvs(self):
return len(self.extra_uvs) > 0
@property
def has_vertex_colors(self):
return len(self.vertex_colors) > 0
@property
def has_vertex_normals(self):
return len(self.vertex_normals) > 0
@property
def has_material_references(self):
return len(self.material_references) > 0
@property
def has_morph_data(self):
return len(self.morph_infos) > 0
def __init__(self):
self.points: List[Vector3] = []
self.wedges: List[Psk.Wedge] = []
self.faces: List[Psk.Face] = []
self.materials: List[Psk.Material] = []
self.weights: List[Psk.Weight] = []
self.bones: List[PsxBone] = []
self.extra_uvs: List[Vector2] = []
self.vertex_colors: List[Color] = []
self.vertex_normals: List[Vector3] = []
self.morph_infos: List[Psk.MorphInfo] = []
self.morph_data: List[Psk.MorphData] = []
self.material_references: List[str] = []

View File

@@ -1,9 +1,9 @@
from pathlib import Path from pathlib import Path
from typing import Iterable, List, Optional, cast as typing_cast from typing import Iterable, List
import bpy import bpy
from bpy.props import BoolProperty, StringProperty from bpy.props import BoolProperty, StringProperty
from bpy.types import Collection, Context, Depsgraph, Material, Object, Operator, SpaceProperties from bpy.types import Context, Depsgraph, Material, Object, Operator, Scene
from bpy_extras.io_utils import ExportHelper from bpy_extras.io_utils import ExportHelper
from .properties import PskExportMixin from .properties import PskExportMixin
@@ -14,8 +14,8 @@ from ..builder import (
get_psk_input_objects_for_collection, get_psk_input_objects_for_collection,
get_psk_input_objects_for_context, get_psk_input_objects_for_context,
) )
from ..writer import write_psk from psk_psa_py.psk.writer import write_psk_to_path
from ...shared.helpers import populate_bone_collection_list from ...shared.helpers import PsxBoneCollection, get_collection_export_operator_from_context, populate_bone_collection_list
from ...shared.ui import draw_bone_filter_mode from ...shared.ui import draw_bone_filter_mode
@@ -35,29 +35,6 @@ def populate_material_name_list(depsgraph: Depsgraph, mesh_objects: Iterable[Obj
def get_collection_from_context(context: Context) -> Optional[Collection]:
if context.space_data.type != 'PROPERTIES':
return None
space_data = typing_cast(SpaceProperties, context.space_data)
if space_data.use_pin_id:
return typing_cast(Collection, space_data.pin_id)
else:
return context.collection
def get_collection_export_operator_from_context(context: Context) -> Optional[object]:
collection = get_collection_from_context(context)
if collection is None:
return None
if 0 > collection.active_exporter_index >= len(collection.exporters):
return None
exporter = collection.exporters[collection.active_exporter_index]
# TODO: make sure this is actually an ASE exporter.
return exporter.export_properties
class PSK_OT_bone_collection_list_populate(Operator): class PSK_OT_bone_collection_list_populate(Operator):
bl_idname = 'psk.bone_collection_list_populate' bl_idname = 'psk.bone_collection_list_populate'
bl_label = 'Populate Bone Collection List' bl_label = 'Populate Bone Collection List'
@@ -69,6 +46,9 @@ class PSK_OT_bone_collection_list_populate(Operator):
if export_operator is None: if export_operator is None:
self.report({'ERROR_INVALID_CONTEXT'}, 'No valid export operator found in context') self.report({'ERROR_INVALID_CONTEXT'}, 'No valid export operator found in context')
return {'CANCELLED'} return {'CANCELLED'}
if context.collection is None:
self.report({'ERROR_INVALID_CONTEXT'}, 'No active collection')
return {'CANCELLED'}
try: try:
input_objects = get_psk_input_objects_for_collection(context.collection) input_objects = get_psk_input_objects_for_collection(context.collection)
except RuntimeError as e: except RuntimeError as e:
@@ -77,7 +57,7 @@ class PSK_OT_bone_collection_list_populate(Operator):
if not input_objects.armature_objects: if not input_objects.armature_objects:
self.report({'ERROR_INVALID_CONTEXT'}, 'No armature modifiers found on mesh objects') self.report({'ERROR_INVALID_CONTEXT'}, 'No armature modifiers found on mesh objects')
return {'CANCELLED'} return {'CANCELLED'}
populate_bone_collection_list(input_objects.armature_objects, export_operator.bone_collection_list) populate_bone_collection_list(export_operator.bone_collection_list, input_objects.armature_objects)
return {'FINISHED'} return {'FINISHED'}
@@ -111,6 +91,7 @@ class PSK_OT_populate_material_name_list(Operator):
self.report({'ERROR_INVALID_CONTEXT'}, 'No valid export operator found in context') self.report({'ERROR_INVALID_CONTEXT'}, 'No valid export operator found in context')
return {'CANCELLED'} return {'CANCELLED'}
depsgraph = context.evaluated_depsgraph_get() depsgraph = context.evaluated_depsgraph_get()
assert context.collection
input_objects = get_psk_input_objects_for_collection(context.collection) input_objects = get_psk_input_objects_for_collection(context.collection)
try: try:
populate_material_name_list(depsgraph, [x.obj for x in input_objects.mesh_dfs_objects], export_operator.material_name_list) populate_material_name_list(depsgraph, [x.obj for x in input_objects.mesh_dfs_objects], export_operator.material_name_list)
@@ -135,6 +116,7 @@ class PSK_OT_material_list_name_add(Operator):
name: StringProperty(search=material_list_names_search_cb, name='Material Name', default='None') name: StringProperty(search=material_list_names_search_cb, name='Material Name', default='None')
def invoke(self, context, event): def invoke(self, context, event):
assert context.window_manager
return context.window_manager.invoke_props_dialog(self) return context.window_manager.invoke_props_dialog(self)
def execute(self, context): def execute(self, context):
@@ -246,18 +228,28 @@ def get_sorted_materials_by_names(materials: Iterable[Material], material_names:
return materials_in_collection + materials_not_in_collection return materials_in_collection + materials_not_in_collection
def get_psk_build_options_from_property_group(pg: PskExportMixin) -> PskBuildOptions: def get_psk_build_options_from_property_group(scene: Scene, pg: PskExportMixin) -> PskBuildOptions:
options = PskBuildOptions() options = PskBuildOptions()
options.object_eval_state = pg.object_eval_state options.object_eval_state = pg.object_eval_state
options.export_space = pg.export_space options.export_space = pg.export_space
options.bone_filter_mode = pg.bone_filter_mode options.bone_filter_mode = pg.bone_filter_mode
options.bone_collection_indices = [(x.armature_object_name, x.index) for x in pg.bone_collection_list if x.is_selected] options.bone_collection_indices = [PsxBoneCollection(x.armature_object_name, x.armature_data_name, x.index) for x in pg.bone_collection_list if x.is_selected]
options.scale = pg.scale
options.forward_axis = pg.forward_axis
options.up_axis = pg.up_axis
options.root_bone_name = pg.root_bone_name options.root_bone_name = pg.root_bone_name
options.material_order_mode = pg.material_order_mode options.material_order_mode = pg.material_order_mode
options.material_name_list = pg.material_name_list options.material_name_list = [x.material_name for x in pg.material_name_list]
match pg.transform_source:
case 'SCENE':
transform_source = getattr(scene, 'psx_export')
case 'CUSTOM':
transform_source = pg
case _:
assert False, f'Invalid transform source: {pg.transform_source}'
options.scale = transform_source.scale
options.forward_axis = transform_source.forward_axis
options.up_axis = transform_source.up_axis
return options return options
@@ -276,22 +268,25 @@ class PSK_OT_export_collection(Operator, ExportHelper, PskExportMixin):
collection: StringProperty(options={'HIDDEN'}) collection: StringProperty(options={'HIDDEN'})
def execute(self, context): def execute(self, context):
collection = bpy.data.collections.get(self.collection) collection = bpy.data.collections.get(self.collection, None)
assert collection is not None
assert context.scene is not None
try: try:
input_objects = get_psk_input_objects_for_collection(collection, self.should_exclude_hidden_meshes) input_objects = get_psk_input_objects_for_collection(collection)
except RuntimeError as e: except RuntimeError as e:
self.report({'ERROR_INVALID_CONTEXT'}, str(e)) self.report({'ERROR_INVALID_CONTEXT'}, str(e))
return {'CANCELLED'} return {'CANCELLED'}
options = get_psk_build_options_from_property_group(self) options = get_psk_build_options_from_property_group(context.scene, self)
filepath = str(Path(self.filepath).resolve()) filepath = str(Path(self.filepath).resolve())
try: try:
result = build_psk(context, input_objects, options) result = build_psk(context, input_objects, options)
for warning in result.warnings: for warning in result.warnings:
self.report({'WARNING'}, warning) self.report({'WARNING'}, warning)
write_psk(result.psk, filepath) write_psk_to_path(result.psk, filepath)
if len(result.warnings) > 0: if len(result.warnings) > 0:
self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings') self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings')
else: else:
@@ -305,6 +300,8 @@ class PSK_OT_export_collection(Operator, ExportHelper, PskExportMixin):
def draw(self, context: Context): def draw(self, context: Context):
layout = self.layout layout = self.layout
assert layout is not None
flow = layout.grid_flow(row_major=True) flow = layout.grid_flow(row_major=True)
flow.use_property_split = True flow.use_property_split = True
flow.use_property_decorate = False flow.use_property_decorate = False
@@ -317,7 +314,6 @@ class PSK_OT_export_collection(Operator, ExportHelper, PskExportMixin):
flow.use_property_split = True flow.use_property_split = True
flow.use_property_decorate = False flow.use_property_decorate = False
flow.prop(self, 'object_eval_state', text='Data') flow.prop(self, 'object_eval_state', text='Data')
flow.prop(self, 'should_exclude_hidden_meshes')
# Bones # Bones
bones_header, bones_panel = layout.panel('Bones', default_closed=False) bones_header, bones_panel = layout.panel('Bones', default_closed=False)
@@ -375,10 +371,24 @@ class PSK_OT_export_collection(Operator, ExportHelper, PskExportMixin):
flow.use_property_split = True flow.use_property_split = True
flow.use_property_decorate = False flow.use_property_decorate = False
flow.prop(self, 'export_space') flow.prop(self, 'export_space')
flow.prop(self, 'scale') flow.prop(self, 'transform_source')
flow.prop(self, 'forward_axis')
flow.prop(self, 'up_axis')
flow = transform_panel.grid_flow(row_major=True)
flow.use_property_split = True
flow.use_property_decorate = False
match self.transform_source:
case 'SCENE':
transform_source = getattr(context.scene, 'psx_export')
flow.enabled = False
case 'CUSTOM':
transform_source = self
case _:
assert False, f'Invalid transform source: {self.transform_source}'
flow.prop(transform_source, 'scale')
flow.prop(transform_source, 'forward_axis')
flow.prop(transform_source, 'up_axis')
class PSK_OT_export(Operator, ExportHelper): class PSK_OT_export(Operator, ExportHelper):
@@ -403,7 +413,7 @@ class PSK_OT_export(Operator, ExportHelper):
pg = getattr(context.scene, 'psk_export') pg = getattr(context.scene, 'psk_export')
populate_bone_collection_list(input_objects.armature_objects, pg.bone_collection_list) populate_bone_collection_list(pg.bone_collection_list, input_objects.armature_objects)
depsgraph = context.evaluated_depsgraph_get() depsgraph = context.evaluated_depsgraph_get()
@@ -413,6 +423,7 @@ class PSK_OT_export(Operator, ExportHelper):
self.report({'ERROR_INVALID_CONTEXT'}, str(e)) self.report({'ERROR_INVALID_CONTEXT'}, str(e))
return {'CANCELLED'} return {'CANCELLED'}
assert context.window_manager
context.window_manager.fileselect_add(self) context.window_manager.fileselect_add(self)
return {'RUNNING_MODAL'} return {'RUNNING_MODAL'}
@@ -420,6 +431,8 @@ class PSK_OT_export(Operator, ExportHelper):
def draw(self, context): def draw(self, context):
layout = self.layout layout = self.layout
assert layout
pg = getattr(context.scene, 'psk_export') pg = getattr(context.scene, 'psk_export')
# Mesh # Mesh
@@ -473,21 +486,47 @@ class PSK_OT_export(Operator, ExportHelper):
flow.use_property_split = True flow.use_property_split = True
flow.use_property_decorate = False flow.use_property_decorate = False
flow.prop(pg, 'export_space') flow.prop(pg, 'export_space')
flow.prop(pg, 'scale') flow.prop(pg, 'transform_source')
flow.prop(pg, 'forward_axis')
flow.prop(pg, 'up_axis') flow = transform_panel.grid_flow(row_major=True)
flow.use_property_split = True
flow.use_property_decorate = False
match pg.transform_source:
case 'SCENE':
transform_source = getattr(context.scene, 'psx_export')
flow.enabled = False
case 'CUSTOM':
transform_source = pg
case _:
assert False, f'Invalid transform source: {pg.transform_source}'
flow.prop(transform_source, 'scale')
flow.prop(transform_source, 'forward_axis')
flow.prop(transform_source, 'up_axis')
# Extended Format
extended_format_header, extended_format_panel = layout.panel('Extended Format', default_closed=False)
extended_format_header.label(text='Extended Format')
if extended_format_panel:
flow = extended_format_panel.grid_flow(row_major=True)
flow.use_property_split = True
flow.use_property_decorate = False
flow.prop(pg, 'should_export_vertex_normals', text='Vertex Normals')
def execute(self, context): def execute(self, context):
pg = getattr(context.scene, 'psk_export') pg = getattr(context.scene, 'psk_export')
assert context.scene
input_objects = get_psk_input_objects_for_context(context) input_objects = get_psk_input_objects_for_context(context)
options = get_psk_build_options_from_property_group(pg) options = get_psk_build_options_from_property_group(context.scene, pg)
try: try:
result = build_psk(context, input_objects, options) result = build_psk(context, input_objects, options)
for warning in result.warnings: for warning in result.warnings:
self.report({'WARNING'}, warning) self.report({'WARNING'}, warning)
write_psk(result.psk, self.filepath) write_psk_to_path(result.psk, self.filepath)
if len(result.warnings) > 0: if len(result.warnings) > 0:
self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings') self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings')
else: else:
@@ -499,7 +538,7 @@ class PSK_OT_export(Operator, ExportHelper):
return {'FINISHED'} return {'FINISHED'}
classes = ( _classes = (
PSK_OT_material_list_move_up, PSK_OT_material_list_move_up,
PSK_OT_material_list_move_down, PSK_OT_material_list_move_down,
PSK_OT_export, PSK_OT_export,
@@ -511,3 +550,6 @@ classes = (
PSK_OT_material_list_name_move_down, PSK_OT_material_list_name_move_down,
PSK_OT_material_list_name_add, PSK_OT_material_list_name_add,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -2,13 +2,13 @@ from bpy.props import (
BoolProperty, BoolProperty,
CollectionProperty, CollectionProperty,
EnumProperty, EnumProperty,
FloatProperty,
IntProperty, IntProperty,
PointerProperty, PointerProperty,
StringProperty, StringProperty,
) )
from bpy.types import Material, PropertyGroup from bpy.types import Material, PropertyGroup
from ...shared.types import ExportSpaceMixin, ForwardUpAxisMixin, PsxBoneExportMixin
from ...shared.types import ExportSpaceMixin, TransformMixin, PsxBoneExportMixin
object_eval_state_items = ( object_eval_state_items = (
('EVALUATED', 'Evaluated', 'Use data from fully evaluated object'), ('EVALUATED', 'Evaluated', 'Use data from fully evaluated object'),
@@ -20,33 +20,27 @@ material_order_mode_items = (
('MANUAL', 'Manual', 'Manually arrange the materials'), ('MANUAL', 'Manual', 'Manually arrange the materials'),
) )
transform_source_items = (
('SCENE', 'Scene', 'Use the scene transform settings'),
('CUSTOM', 'Custom', 'Use custom transform settings'),
)
class PSK_PG_material_list_item(PropertyGroup): class PSK_PG_material_list_item(PropertyGroup):
material: PointerProperty(type=Material) material: PointerProperty(type=Material)
index: IntProperty() index: IntProperty()
class PSK_PG_material_name_list_item(PropertyGroup): class PSK_PG_material_name_list_item(PropertyGroup):
material_name: StringProperty() material_name: StringProperty()
index: IntProperty() index: IntProperty()
class PskExportMixin(ExportSpaceMixin, ForwardUpAxisMixin, PsxBoneExportMixin): class PskExportMixin(ExportSpaceMixin, TransformMixin, PsxBoneExportMixin):
object_eval_state: EnumProperty( object_eval_state: EnumProperty(
items=object_eval_state_items, items=object_eval_state_items,
name='Object Evaluation State', name='Object Evaluation State',
default='EVALUATED' default='EVALUATED'
) )
should_exclude_hidden_meshes: BoolProperty(
default=False,
name='Visible Only',
description='Export only visible meshes'
)
scale: FloatProperty(
name='Scale',
default=1.0,
description='Scale factor to apply to the exported mesh and armature',
min=0.0001,
soft_max=100.0
)
material_order_mode: EnumProperty( material_order_mode: EnumProperty(
name='Material Order', name='Material Order',
description='The order in which to export the materials', description='The order in which to export the materials',
@@ -55,14 +49,28 @@ class PskExportMixin(ExportSpaceMixin, ForwardUpAxisMixin, PsxBoneExportMixin):
) )
material_name_list: CollectionProperty(type=PSK_PG_material_name_list_item) material_name_list: CollectionProperty(type=PSK_PG_material_name_list_item)
material_name_list_index: IntProperty(default=0) material_name_list_index: IntProperty(default=0)
should_export_vertex_normals: BoolProperty(
name='Export Vertex Normals',
default=False,
description='Export VTXNORMS section.'
)
transform_source: EnumProperty(
items=transform_source_items,
name='Transform Source',
default='SCENE'
)
class PSK_PG_export(PropertyGroup, PskExportMixin): class PSK_PG_export(PropertyGroup, PskExportMixin):
pass pass
classes = ( _classes = (
PSK_PG_material_list_item, PSK_PG_material_list_item,
PSK_PG_material_name_list_item, PSK_PG_material_name_list_item,
PSK_PG_export, PSK_PG_export,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -10,6 +10,9 @@ class PSK_UL_material_names(UIList):
row.prop(item, 'material_name', text='', emboss=False, icon_value=icon_value, icon='BLANK1' if icon_value == 0 else 'NONE') row.prop(item, 'material_name', text='', emboss=False, icon_value=icon_value, icon='BLANK1' if icon_value == 0 else 'NONE')
classes = ( _classes = (
PSK_UL_material_names, PSK_UL_material_names,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -7,7 +7,8 @@ from bpy_extras.io_utils import ImportHelper
from ..importer import PskImportOptions, import_psk from ..importer import PskImportOptions, import_psk
from ..properties import PskImportMixin from ..properties import PskImportMixin
from ..reader import read_psk from psk_psa_py.psk.reader import read_psk_from_file
def get_psk_import_options_from_properties(property_group: PskImportMixin): def get_psk_import_options_from_properties(property_group: PskImportMixin):
options = PskImportOptions() options = PskImportOptions()
@@ -90,7 +91,7 @@ class PSK_OT_import(Operator, ImportHelper, PskImportMixin):
def execute(self, context): def execute(self, context):
try: try:
psk = read_psk(self.filepath) psk = read_psk_from_file(self.filepath)
except OSError as e: except OSError as e:
self.report({'ERROR'}, f'Failed to read "{self.filepath}". The file may be corrupted or not a valid PSK file: {e}') self.report({'ERROR'}, f'Failed to read "{self.filepath}". The file may be corrupted or not a valid PSK file: {e}')
return {'CANCELLED'} return {'CANCELLED'}
@@ -109,6 +110,7 @@ class PSK_OT_import(Operator, ImportHelper, PskImportMixin):
return {'FINISHED'} return {'FINISHED'}
def draw(self, context): def draw(self, context):
assert self.layout
psk_import_draw(self.layout, self) psk_import_draw(self.layout, self)
@@ -122,13 +124,15 @@ class PSK_OT_import_drag_and_drop(Operator, PskImportMixin):
files: CollectionProperty(type=OperatorFileListElement, options={'SKIP_SAVE', 'HIDDEN'}) files: CollectionProperty(type=OperatorFileListElement, options={'SKIP_SAVE', 'HIDDEN'})
@classmethod @classmethod
def poll(cls, context): def poll(cls, context) -> bool:
return context.area and context.area.type == 'VIEW_3D' return context.area is not None and context.area.type == 'VIEW_3D'
def draw(self, context): def draw(self, context):
assert self.layout
psk_import_draw(self.layout, self) psk_import_draw(self.layout, self)
def invoke(self, context, event): def invoke(self, context, event):
assert context.window_manager
context.window_manager.invoke_props_dialog(self) context.window_manager.invoke_props_dialog(self)
return {'RUNNING_MODAL'} return {'RUNNING_MODAL'}
@@ -140,7 +144,7 @@ class PSK_OT_import_drag_and_drop(Operator, PskImportMixin):
for file in self.files: for file in self.files:
filepath = Path(self.directory) / file.name filepath = Path(self.directory) / file.name
try: try:
psk = read_psk(filepath) psk = read_psk_from_file(filepath)
except OSError as e: except OSError as e:
self.report({'ERROR'}, f'Failed to read "{filepath}". The file may be corrupted or not a valid PSK file: {e}') self.report({'ERROR'}, f'Failed to read "{filepath}". The file may be corrupted or not a valid PSK file: {e}')
return {'CANCELLED'} return {'CANCELLED'}
@@ -167,12 +171,15 @@ class PSK_FH_import(FileHandler):
bl_file_extensions = '.psk;.pskx' bl_file_extensions = '.psk;.pskx'
@classmethod @classmethod
def poll_drop(cls, context: Context): def poll_drop(cls, context: Context) -> bool:
return context.area and context.area.type == 'VIEW_3D' return context.area is not None and context.area.type == 'VIEW_3D'
classes = ( _classes = (
PSK_OT_import, PSK_OT_import,
PSK_OT_import_drag_and_drop, PSK_OT_import_drag_and_drop,
PSK_FH_import, PSK_FH_import,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -2,13 +2,13 @@ import bmesh
import bpy import bpy
import numpy as np import numpy as np
from bpy.types import Context, Object, VertexGroup from bpy.types import Context, Object, VertexGroup, ArmatureModifier, FloatColorAttribute
from mathutils import Matrix, Quaternion, Vector from mathutils import Matrix, Quaternion, Vector
from typing import List, Optional from typing import List, Optional, cast as typing_cast
from .data import Psk from psk_psa_py.psk.data import Psk
from psk_psa_py.shared.data import PsxBone
from .properties import poly_flags_to_triangle_type_and_bit_flags from .properties import poly_flags_to_triangle_type_and_bit_flags
from ..shared.data import PsxBone
from ..shared.helpers import is_bdk_addon_loaded, rgb_to_srgb from ..shared.helpers import is_bdk_addon_loaded, rgb_to_srgb
@@ -62,6 +62,9 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
armature_object = None armature_object = None
mesh_object = None mesh_object = None
assert context.scene
assert bpy.context.view_layer
if options.should_import_armature: if options.should_import_armature:
# Armature # Armature
armature_data = bpy.data.armatures.new(name) armature_data = bpy.data.armatures.new(name)
@@ -148,7 +151,6 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
mesh_triangle_type, mesh_triangle_bit_flags = poly_flags_to_triangle_type_and_bit_flags(psk_material.poly_flags) mesh_triangle_type, mesh_triangle_bit_flags = poly_flags_to_triangle_type_and_bit_flags(psk_material.poly_flags)
material.psk.mesh_triangle_type = mesh_triangle_type material.psk.mesh_triangle_type = mesh_triangle_type
material.psk.mesh_triangle_bit_flags = mesh_triangle_bit_flags material.psk.mesh_triangle_bit_flags = mesh_triangle_bit_flags
material.use_nodes = True
mesh_data.materials.append(material) mesh_data.materials.append(material)
@@ -163,8 +165,11 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
# Faces # Faces
invalid_face_indices = set() invalid_face_indices = set()
for face_index, face in enumerate(psk.faces): for face_index, face in enumerate(psk.faces):
point_indices = map(lambda i: psk.wedges[i].point_index, reversed(face.wedge_indices)) points = (
points = [bm.verts[i] for i in point_indices] bm.verts[psk.wedges[face.wedge_indices[2]].point_index],
bm.verts[psk.wedges[face.wedge_indices[1]].point_index],
bm.verts[psk.wedges[face.wedge_indices[0]].point_index],
)
try: try:
bm_face = bm.faces.new(points) bm_face = bm.faces.new(points)
bm_face.material_index = face.material_index bm_face.material_index = face.material_index
@@ -178,44 +183,49 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
if len(invalid_face_indices) > 0: if len(invalid_face_indices) > 0:
result.warnings.append(f'Discarded {len(invalid_face_indices)} invalid face(s).') result.warnings.append(f'Discarded {len(invalid_face_indices)} invalid face(s).')
face_count = len(bm.faces)
bm.to_mesh(mesh_data) bm.to_mesh(mesh_data)
# Texture Coordinates # Texture Coordinates
uv_layer_data_index = 0 uv_layer_data_index = 0
uv_layer = mesh_data.uv_layers.new(name='UVMap') uv_layer_data = np.zeros((face_count * 3, 2), dtype=np.float32)
for face_index, face in enumerate(psk.faces): for face_index, face in enumerate(psk.faces):
if face_index in invalid_face_indices: if face_index in invalid_face_indices:
continue continue
face_wedges = [psk.wedges[i] for i in reversed(face.wedge_indices)] for wedge in map(lambda i: psk.wedges[i], reversed(face.wedge_indices)):
for wedge in face_wedges: uv_layer_data[uv_layer_data_index] = wedge.u, 1.0 - wedge.v
uv_layer.data[uv_layer_data_index].uv = wedge.u, 1.0 - wedge.v
uv_layer_data_index += 1 uv_layer_data_index += 1
uv_layer = mesh_data.uv_layers.new(name='UVMap')
uv_layer.uv.foreach_set('vector', uv_layer_data.ravel())
# Extra UVs # Extra UVs
if psk.has_extra_uvs and options.should_import_extra_uvs: if psk.has_extra_uvs and options.should_import_extra_uvs:
extra_uv_channel_count = int(len(psk.extra_uvs) / len(psk.wedges))
wedge_index_offset = 0 wedge_index_offset = 0
for extra_uv_index in range(extra_uv_channel_count): for extra_uv_index, extra_uvs in enumerate(psk.extra_uvs):
uv_layer_data = np.zeros((face_count * 3, 2), dtype=np.float32)
uv_layer_data_index = 0 uv_layer_data_index = 0
uv_layer = mesh_data.uv_layers.new(name=f'EXTRAUV{extra_uv_index}')
for face_index, face in enumerate(psk.faces): for face_index, face in enumerate(psk.faces):
if face_index in invalid_face_indices: if face_index in invalid_face_indices:
continue continue
for wedge_index in reversed(face.wedge_indices): for wedge_index in reversed(face.wedge_indices):
u, v = psk.extra_uvs[wedge_index_offset + wedge_index] u, v = extra_uvs[wedge_index_offset + wedge_index]
uv_layer.data[uv_layer_data_index].uv = u, 1.0 - v uv_layer_data[uv_layer_data_index] = u, 1.0 - v
uv_layer_data_index += 1 uv_layer_data_index += 1
wedge_index_offset += len(psk.wedges) wedge_index_offset += len(psk.wedges)
uv_layer = mesh_data.uv_layers.new(name=f'EXTRAUV{extra_uv_index}')
uv_layer.uv.foreach_set('vector', uv_layer_data.ravel())
# Vertex Colors # Vertex Colors
if psk.has_vertex_colors and options.should_import_vertex_colors: if psk.has_vertex_colors and options.should_import_vertex_colors:
# Convert vertex colors to sRGB if necessary.
psk_vertex_colors = np.zeros((len(psk.vertex_colors), 4)) psk_vertex_colors = np.zeros((len(psk.vertex_colors), 4))
for vertex_color_index in range(len(psk.vertex_colors)): for vertex_color_index in range(len(psk.vertex_colors)):
psk_vertex_colors[vertex_color_index,:] = psk.vertex_colors[vertex_color_index].normalized() psk_vertex_colors[vertex_color_index] = tuple(psk.vertex_colors[vertex_color_index])
psk_vertex_colors /= 255.0
# Convert vertex colors to sRGB if necessary.
if options.vertex_color_space == 'SRGBA': if options.vertex_color_space == 'SRGBA':
for i in range(psk_vertex_colors.shape[0]): psk_vertex_colors[:, :3] = np.vectorize(rgb_to_srgb)(psk_vertex_colors[:, :3])
psk_vertex_colors[i, :3] = tuple(map(lambda x: rgb_to_srgb(x), psk_vertex_colors[i, :3]))
# Map the PSK vertex colors to the face corners. # Map the PSK vertex colors to the face corners.
face_count = len(psk.faces) - len(invalid_face_indices) face_count = len(psk.faces) - len(invalid_face_indices)
@@ -230,7 +240,8 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
# Create the vertex color attribute. # Create the vertex color attribute.
face_corner_color_attribute = mesh_data.attributes.new(name='VERTEXCOLOR', type='FLOAT_COLOR', domain='CORNER') face_corner_color_attribute = mesh_data.attributes.new(name='VERTEXCOLOR', type='FLOAT_COLOR', domain='CORNER')
face_corner_color_attribute.data.foreach_set('color', face_corner_colors.flatten()) face_corner_color_attribute = typing_cast(FloatColorAttribute, face_corner_color_attribute)
face_corner_color_attribute.data.foreach_set('color', face_corner_colors.ravel())
# Vertex Normals # Vertex Normals
if psk.has_vertex_normals and options.should_import_vertex_normals: if psk.has_vertex_normals and options.should_import_vertex_normals:
@@ -264,6 +275,7 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
for morph_info in psk.morph_infos: for morph_info in psk.morph_infos:
shape_key = mesh_object.shape_key_add(name=morph_info.name.decode('windows-1252'), from_mix=False) shape_key = mesh_object.shape_key_add(name=morph_info.name.decode('windows-1252'), from_mix=False)
shape_key.value = 0.0
for _ in range(morph_info.vertex_count): for _ in range(morph_info.vertex_count):
morph_data = next(morph_data_iterator) morph_data = next(morph_data_iterator)
@@ -275,10 +287,12 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
# Add armature modifier to our mesh object. # Add armature modifier to our mesh object.
if options.should_import_armature: if options.should_import_armature:
armature_modifier = mesh_object.modifiers.new(name='Armature', type='ARMATURE') armature_modifier = mesh_object.modifiers.new(name='Armature', type='ARMATURE')
armature_modifier = typing_cast(ArmatureModifier, armature_modifier)
armature_modifier.object = armature_object armature_modifier.object = armature_object
mesh_object.parent = armature_object mesh_object.parent = armature_object
root_object = armature_object if options.should_import_armature else mesh_object root_object = armature_object if options.should_import_armature else mesh_object
assert root_object
root_object.scale = (options.scale, options.scale, options.scale) root_object.scale = (options.scale, options.scale, options.scale)
try: try:

View File

@@ -20,9 +20,15 @@ mesh_triangle_bit_flags_items = (
) )
class PSX_PG_material(PropertyGroup): class PSX_PG_material(PropertyGroup):
mesh_triangle_type: EnumProperty(items=mesh_triangle_types_items, name='Triangle Type') mesh_triangle_type: EnumProperty(
mesh_triangle_bit_flags: EnumProperty(items=mesh_triangle_bit_flags_items, name='Triangle Bit Flags', name='Triangle Type',
options={'ENUM_FLAG'}) items=mesh_triangle_types_items
)
mesh_triangle_bit_flags: EnumProperty(
name='Triangle Bit Flags',
items=mesh_triangle_bit_flags_items,
options={'ENUM_FLAG'}
)
mesh_triangle_types_items_dict = {item[0]: item[3] for item in mesh_triangle_types_items} mesh_triangle_types_items_dict = {item[0]: item[3] for item in mesh_triangle_types_items}
mesh_triangle_bit_flags_items_dict = {item[0]: item[3] for item in mesh_triangle_bit_flags_items} mesh_triangle_bit_flags_items_dict = {item[0]: item[3] for item in mesh_triangle_bit_flags_items}
@@ -36,7 +42,7 @@ def triangle_type_and_bit_flags_to_poly_flags(mesh_triangle_type: str, mesh_tria
return poly_flags return poly_flags
def poly_flags_to_triangle_type_and_bit_flags(poly_flags: int) -> (str, set[str]): def poly_flags_to_triangle_type_and_bit_flags(poly_flags: int) -> tuple[str, set[str]]:
try: try:
triangle_type = next(item[0] for item in mesh_triangle_types_items if item[3] == (poly_flags & 15)) triangle_type = next(item[0] for item in mesh_triangle_types_items if item[3] == (poly_flags & 15))
except StopIteration: except StopIteration:
@@ -53,6 +59,17 @@ def should_import_skleton_get(self):
return self.components in {'ALL', 'ARMATURE'} return self.components in {'ALL', 'ARMATURE'}
vertex_color_space_items = (
('LINEAR', 'Linear', ''),
('SRGBA', 'sRGBA', ''),
)
psk_import_components_items = (
('ALL', 'Mesh & Armature', 'Import mesh and armature'),
('MESH', 'Mesh Only', 'Import mesh only'),
('ARMATURE', 'Armature Only', 'Import armature only'),
)
class PskImportMixin: class PskImportMixin:
should_import_vertex_colors: BoolProperty( should_import_vertex_colors: BoolProperty(
default=True, default=True,
@@ -65,10 +82,7 @@ class PskImportMixin:
options=set(), options=set(),
description='The source vertex color space', description='The source vertex color space',
default='SRGBA', default='SRGBA',
items=( items=vertex_color_space_items
('LINEAR', 'Linear', ''),
('SRGBA', 'sRGBA', ''),
)
) )
should_import_vertex_normals: BoolProperty( should_import_vertex_normals: BoolProperty(
default=True, default=True,
@@ -86,11 +100,7 @@ class PskImportMixin:
name='Components', name='Components',
options=set(), options=set(),
description='Which components to import', description='Which components to import',
items=( items=psk_import_components_items,
('ALL', 'Mesh & Armature', 'Import mesh and armature'),
('MESH', 'Mesh Only', 'Import mesh only'),
('ARMATURE', 'Armature Only', 'Import armature only'),
),
default='ALL' default='ALL'
) )
should_import_mesh: BoolProperty( should_import_mesh: BoolProperty(
@@ -135,6 +145,10 @@ class PskImportMixin:
) )
classes = ( _classes = (
PSX_PG_material, PSX_PG_material,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -1,95 +0,0 @@
import ctypes
import os
import re
import warnings
from pathlib import Path
from typing import List
from ..shared.data import Section
from .data import Color, Psk, PsxBone, Vector2, Vector3
def _read_types(fp, data_class, section: Section, data):
buffer_length = section.data_size * section.data_count
buffer = fp.read(buffer_length)
offset = 0
for _ in range(section.data_count):
data.append(data_class.from_buffer_copy(buffer, offset))
offset += section.data_size
def _read_material_references(path: str) -> List[str]:
property_file_path = Path(path).with_suffix('.props.txt')
if not property_file_path.is_file():
# Property file does not exist.
return []
# Do a crude regex match to find the Material list entries.
contents = property_file_path.read_text()
pattern = r'Material\s*=\s*([^\s^,]+)'
return re.findall(pattern, contents)
def read_psk(path: str) -> Psk:
psk = Psk()
# Read the PSK file sections.
with open(path, 'rb') as fp:
while fp.read(1):
fp.seek(-1, 1)
section = Section.from_buffer_copy(fp.read(ctypes.sizeof(Section)))
match section.name:
case b'ACTRHEAD':
pass
case b'PNTS0000':
_read_types(fp, Vector3, section, psk.points)
case b'VTXW0000':
if section.data_size == ctypes.sizeof(Psk.Wedge16):
_read_types(fp, Psk.Wedge16, section, psk.wedges)
elif section.data_size == ctypes.sizeof(Psk.Wedge32):
_read_types(fp, Psk.Wedge32, section, psk.wedges)
else:
raise RuntimeError('Unrecognized wedge format')
case b'FACE0000':
_read_types(fp, Psk.Face, section, psk.faces)
case b'MATT0000':
_read_types(fp, Psk.Material, section, psk.materials)
case b'REFSKELT':
_read_types(fp, PsxBone, section, psk.bones)
case b'RAWWEIGHTS':
_read_types(fp, Psk.Weight, section, psk.weights)
case b'FACE3200':
_read_types(fp, Psk.Face32, section, psk.faces)
case b'VERTEXCOLOR':
_read_types(fp, Color, section, psk.vertex_colors)
case b'VTXNORMS':
_read_types(fp, Vector3, section, psk.vertex_normals)
case b'MRPHINFO':
_read_types(fp, Psk.MorphInfo, section, psk.morph_infos)
case b'MRPHDATA':
_read_types(fp, Psk.MorphData, section, psk.morph_data)
case _:
if section.name.startswith(b'EXTRAUVS'):
_read_types(fp, Vector2, section, psk.extra_uvs)
else:
# Section is not handled, skip it.
fp.seek(section.data_size * section.data_count, os.SEEK_CUR)
warnings.warn(f'Unrecognized section "{section.name} at position {fp.tell():15}"')
"""
UEViewer exports a sidecar file (*.props.txt) with fully-qualified reference paths for each material
(e.g., Texture'Package.Group.Object').
"""
psk.material_references = _read_material_references(path)
"""
Tools like UEViewer and CUE4Parse write the point index as a 32-bit integer, exploiting the fact that due to struct
alignment, there were 16-bits of padding following the original 16-bit point index in the wedge struct.
However, this breaks compatibility with PSK files that were created with older tools that treated the
point index as a 16-bit integer and might have junk data written to the padding bits.
To work around this, we check if each point is still addressable using a 16-bit index, and if it is, assume the
point index is a 16-bit integer and truncate the high bits.
"""
if len(psk.points) <= 65536:
for wedge in psk.wedges:
wedge.point_index &= 0xFFFF
return psk

View File

@@ -15,6 +15,7 @@ class PSK_PT_material(Panel):
def draw(self, context): def draw(self, context):
layout = self.layout layout = self.layout
assert layout is not None
layout.use_property_split = True layout.use_property_split = True
layout.use_property_decorate = False layout.use_property_decorate = False
material = context.material material = context.material
@@ -23,6 +24,10 @@ class PSK_PT_material(Panel):
col.prop(material.psk, 'mesh_triangle_bit_flags', expand=True, text='Flags') col.prop(material.psk, 'mesh_triangle_bit_flags', expand=True, text='Flags')
classes = ( _classes = (
PSK_PT_material, PSK_PT_material,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -1,61 +0,0 @@
import os
from ctypes import Structure, sizeof
from typing import Type
from .data import Psk
from ..shared.data import PsxBone, Section, Vector3
MAX_WEDGE_COUNT = 65536
MAX_POINT_COUNT = 4294967296
MAX_BONE_COUNT = 2147483647
MAX_MATERIAL_COUNT = 256
def _write_section(fp, name: bytes, data_type: Type[Structure] = None, data: list = None):
section = Section()
section.name = name
if data_type is not None and data is not None:
section.data_size = sizeof(data_type)
section.data_count = len(data)
fp.write(section)
if data is not None:
for datum in data:
fp.write(datum)
def write_psk(psk: Psk, path: str):
if len(psk.wedges) > MAX_WEDGE_COUNT:
raise RuntimeError(f'Number of wedges ({len(psk.wedges)}) exceeds limit of {MAX_WEDGE_COUNT}')
if len(psk.points) > MAX_POINT_COUNT:
raise RuntimeError(f'Numbers of vertices ({len(psk.points)}) exceeds limit of {MAX_POINT_COUNT}')
if len(psk.materials) > MAX_MATERIAL_COUNT:
raise RuntimeError(f'Number of materials ({len(psk.materials)}) exceeds limit of {MAX_MATERIAL_COUNT}')
if len(psk.bones) > MAX_BONE_COUNT:
raise RuntimeError(f'Number of bones ({len(psk.bones)}) exceeds limit of {MAX_BONE_COUNT}')
if len(psk.bones) == 0:
raise RuntimeError(f'At least one bone must be marked for export')
# Make the directory for the file if it doesn't exist.
os.makedirs(os.path.dirname(path), exist_ok=True)
try:
with open(path, 'wb') as fp:
_write_section(fp, b'ACTRHEAD')
_write_section(fp, b'PNTS0000', Vector3, psk.points)
wedges = []
for index, w in enumerate(psk.wedges):
wedge = Psk.Wedge16()
wedge.material_index = w.material_index
wedge.u = w.u
wedge.v = w.v
wedge.point_index = w.point_index
wedges.append(wedge)
_write_section(fp, b'VTXW0000', Psk.Wedge16, wedges)
_write_section(fp, b'FACE0000', Psk.Face, psk.faces)
_write_section(fp, b'MATT0000', Psk.Material, psk.materials)
_write_section(fp, b'REFSKELT', PsxBone, psk.bones)
_write_section(fp, b'RAWWEIGHTS', Psk.Weight, psk.weights)
except PermissionError as e:
raise RuntimeError(f'The current user "{os.getlogin()}" does not have permission to write to "{path}"') from e

View File

@@ -1,108 +0,0 @@
from ctypes import Structure, c_char, c_int32, c_float, c_ubyte
from typing import Tuple
class Color(Structure):
_fields_ = [
('r', c_ubyte),
('g', c_ubyte),
('b', c_ubyte),
('a', c_ubyte),
]
def __iter__(self):
yield self.r
yield self.g
yield self.b
yield self.a
def __eq__(self, other):
return all(map(lambda x: x[0] == x[1], zip(self, other)))
def __repr__(self):
return repr(tuple(self))
def normalized(self) -> Tuple:
return tuple(map(lambda x: x / 255.0, iter(self)))
class Vector2(Structure):
_fields_ = [
('x', c_float),
('y', c_float),
]
def __iter__(self):
yield self.x
yield self.y
def __repr__(self):
return repr(tuple(self))
class Vector3(Structure):
_fields_ = [
('x', c_float),
('y', c_float),
('z', c_float),
]
def __iter__(self):
yield self.x
yield self.y
yield self.z
def __repr__(self):
return repr(tuple(self))
@classmethod
def zero(cls):
return Vector3(0, 0, 0)
class Quaternion(Structure):
_fields_ = [
('x', c_float),
('y', c_float),
('z', c_float),
('w', c_float),
]
def __iter__(self):
yield self.w
yield self.x
yield self.y
yield self.z
def __repr__(self):
return repr(tuple(self))
@classmethod
def identity(cls):
return Quaternion(0, 0, 0, 1)
class PsxBone(Structure):
_fields_ = [
('name', c_char * 64),
('flags', c_int32),
('children_count', c_int32),
('parent_index', c_int32),
('rotation', Quaternion),
('location', Vector3),
('length', c_float),
('size', Vector3)
]
class Section(Structure):
_fields_ = [
('name', c_char * 20),
('type_flags', c_int32),
('data_size', c_int32),
('data_count', c_int32)
]
def __init__(self, *args, **kw):
super().__init__(*args, **kw)
self.type_flags = 1999801

View File

@@ -146,16 +146,3 @@ def dfs_view_layer_objects(view_layer: ViewLayer) -> Iterable[DfsObject]:
yield from _dfs_collection_objects_recursive(layer_collection.collection, visited=visited) yield from _dfs_collection_objects_recursive(layer_collection.collection, visited=visited)
yield from layer_collection_objects_recursive(view_layer.layer_collection) yield from layer_collection_objects_recursive(view_layer.layer_collection)
def _is_dfs_object_visible(obj: Object, instance_objects: List[Object]) -> bool:
"""
Check if a DFS object is visible.
@param obj: The object.
@param instance_objects: The instance objects.
@return: True if the object is visible, False otherwise.
"""
if instance_objects:
return instance_objects[-1].visible_get()
return obj.visible_get()

View File

@@ -1,18 +1,15 @@
import bpy import bpy
from collections import Counter from collections import Counter
from typing import List, Iterable, Optional, Dict, Tuple, cast as typing_cast from typing import List, Iterable, Optional, Dict, Tuple, cast as typing_cast
from bpy.props import CollectionProperty from bpy.types import Armature, AnimData, Collection, Context, Object, ArmatureModifier, SpaceProperties
from bpy.types import Armature, AnimData, Object
from mathutils import Matrix, Vector, Quaternion as BpyQuaternion from mathutils import Matrix, Vector, Quaternion as BpyQuaternion
from .data import Vector3, Quaternion from psk_psa_py.shared.data import PsxBone, Vector3, Quaternion
from ..shared.data import PsxBone
def rgb_to_srgb(c: float): def rgb_to_srgb(c: float) -> float:
if c > 0.0031308: if c > 0.0031308:
return 1.055 * (pow(c, (1.0 / 2.4))) - 0.055 return 1.055 * (pow(c, (1.0 / 2.4))) - 0.055
else: return 12.92 * c
return 12.92 * c
def get_nla_strips_in_frame_range(animation_data: AnimData, frame_min: float, frame_max: float): def get_nla_strips_in_frame_range(animation_data: AnimData, frame_min: float, frame_max: float):
@@ -28,16 +25,27 @@ def get_nla_strips_in_frame_range(animation_data: AnimData, frame_min: float, fr
yield strip yield strip
def populate_bone_collection_list(armature_objects: Iterable[Object], bone_collection_list: CollectionProperty) -> None: def populate_bone_collection_list(bone_collection_list, armature_objects: Iterable[Object], primary_key: str = 'OBJECT'):
""" """
Updates the bone collections collection. Updates the bone collection list.
Bone collection selections are preserved between updates unless none of the groups were previously selected; Selection is preserved between updates unless none of the groups were previously selected.
otherwise, all collections are selected by default. Otherwise, all collections are selected by default.
The primary key is used to determine how to group the armature objects. For example, if the primary key is
'DATA', then all bone collections with the same armature data-block will be under one entry.
:param bone_collection_list: The list to update.
:param armature_objects: The armature objects to populate the collection with.
:param primary_key: The primary key to use for the collection (one of 'OBJECT' or 'DATA').
:return: None
""" """
has_selected_collections = any([g.is_selected for g in bone_collection_list]) has_selected_collections = any([g.is_selected for g in bone_collection_list])
unassigned_collection_is_selected, selected_assigned_collection_names = True, [] unassigned_collection_is_selected, selected_assigned_collection_names = True, []
if primary_key not in ('OBJECT', 'DATA'):
assert False, f'Invalid primary key: {primary_key}'
if not armature_objects: if not armature_objects:
return return
@@ -51,16 +59,26 @@ def populate_bone_collection_list(armature_objects: Iterable[Object], bone_colle
selected_assigned_collection_names = [ selected_assigned_collection_names = [
g.name for i, g in enumerate(bone_collection_list) if i != unassigned_collection_idx and g.is_selected] g.name for i, g in enumerate(bone_collection_list) if i != unassigned_collection_idx and g.is_selected]
bone_collection_list.clear() bone_collection_list.clear()
unique_armature_data = set()
for armature_object in armature_objects: for armature_object in armature_objects:
armature = typing_cast(Armature, armature_object.data) armature = typing_cast(Armature, armature_object.data)
if armature is None: if armature is None:
return continue
if primary_key == 'DATA' and armature_object.data in unique_armature_data:
# Skip this armature since we have already added an entry for it and we are using the data as the key.
continue
unique_armature_data.add(armature_object.data)
item = bone_collection_list.add() item = bone_collection_list.add()
item.armature_object_name = armature_object.name item.armature_object_name = armature_object.name
item.armature_data_name = armature_object.data.name if armature_object.data else ''
item.name = 'Unassigned' # TODO: localize item.name = 'Unassigned' # TODO: localize
item.index = -1 item.index = -1
# Count the number of bones without an assigned bone collection # Count the number of bones without an assigned bone collection
@@ -70,6 +88,7 @@ def populate_bone_collection_list(armature_objects: Iterable[Object], bone_colle
for bone_collection_index, bone_collection in enumerate(armature.collections_all): for bone_collection_index, bone_collection in enumerate(armature.collections_all):
item = bone_collection_list.add() item = bone_collection_list.add()
item.armature_object_name = armature_object.name item.armature_object_name = armature_object.name
item.armature_data_name = armature_object.data.name if armature_object.data else ''
item.name = bone_collection.name item.name = bone_collection.name
item.index = bone_collection_index item.index = bone_collection_index
item.count = len(bone_collection.bones) item.count = len(bone_collection.bones)
@@ -286,6 +305,16 @@ def convert_bpy_quaternion_to_psx_quaternion(other: BpyQuaternion) -> Quaternion
return quaternion return quaternion
class PsxBoneCollection:
"""
Stores the armature's object name, data-block name and bone collection index.
"""
def __init__(self, armature_object_name: str, armature_data_name: str, index: int):
self.armature_object_name = armature_object_name
self.armature_data_name = armature_data_name
self.index = index
def create_psx_bones( def create_psx_bones(
armature_objects: List[Object], armature_objects: List[Object],
export_space: str = 'WORLD', export_space: str = 'WORLD',
@@ -294,7 +323,8 @@ def create_psx_bones(
up_axis: str = 'Z', up_axis: str = 'Z',
scale: float = 1.0, scale: float = 1.0,
bone_filter_mode: str = 'ALL', bone_filter_mode: str = 'ALL',
bone_collection_indices: Optional[List[Tuple[str, int]]] = None, bone_collection_indices: Optional[List[PsxBoneCollection]] = None,
bone_collection_primary_key: str = 'OBJECT',
) -> PsxBoneCreateResult: ) -> PsxBoneCreateResult:
""" """
Creates a list of PSX bones from the given armature objects and options. Creates a list of PSX bones from the given armature objects and options.
@@ -306,19 +336,30 @@ def create_psx_bones(
bones: List[Tuple[PsxBone, Optional[Object]]] = [] bones: List[Tuple[PsxBone, Optional[Object]]] = []
if export_space != 'WORLD' and len(armature_objects) > 1: if export_space != 'WORLD' and len(armature_objects) >= 2:
raise RuntimeError('When exporting multiple armatures, the Export Space must be World') armature_object_names = [armature_object.name for armature_object in armature_objects]
raise RuntimeError(f'When exporting multiple armatures, the Export Space must be World.\n' \
f'The following armatures are attempting to be exported: {armature_object_names}')
coordinate_system_matrix = get_coordinate_system_transform(forward_axis, up_axis) coordinate_system_matrix = get_coordinate_system_transform(forward_axis, up_axis)
coordinate_system_default_rotation = coordinate_system_matrix.to_quaternion() coordinate_system_default_rotation = coordinate_system_matrix.to_quaternion()
total_bone_count = sum(len(armature_object.data.bones) for armature_object in armature_objects) total_bone_count = 0
for armature_object in filter(lambda x: x.data is not None, armature_objects):
armature_data = typing_cast(Armature, armature_object.data)
total_bone_count += len(armature_data.bones)
# Store the bone names to be exported for each armature object. # Store the bone names to be exported for each armature object.
armature_object_bone_names: Dict[Object, List[str]] = dict() armature_object_bone_names: Dict[Object, List[str]] = dict()
for armature_object in armature_objects: for armature_object in armature_objects:
armature_bone_collection_indices = [x[1] for x in bone_collection_indices if x[0] == armature_object.name] armature_bone_collection_indices: List[int] = []
match bone_collection_primary_key:
case 'OBJECT':
armature_bone_collection_indices.extend([x.index for x in bone_collection_indices if x.armature_object_name == armature_object.name])
case 'DATA':
armature_bone_collection_indices.extend([x.index for x in bone_collection_indices if armature_object.data and x.armature_data_name == armature_object.data.name])
case _:
assert False, f'Invalid primary key: {bone_collection_primary_key}'
bone_names = get_export_bone_names(armature_object, bone_filter_mode, armature_bone_collection_indices) bone_names = get_export_bone_names(armature_object, bone_filter_mode, armature_bone_collection_indices)
armature_object_bone_names[armature_object] = bone_names armature_object_bone_names[armature_object] = bone_names
@@ -428,3 +469,36 @@ def get_coordinate_system_transform(forward_axis: str = 'X', up_axis: str = 'Z')
(up.x, up.y, up.z, 0.0), (up.x, up.y, up.z, 0.0),
(0.0, 0.0, 0.0, 1.0) (0.0, 0.0, 0.0, 1.0)
)) ))
def get_armatures_for_mesh_objects(mesh_objects: Iterable[Object]):
"""
Returns a generator of unique armature objects that are used by the given mesh objects.
"""
armature_objects: set[Object] = set()
for mesh_object in mesh_objects:
armature_modifiers = [typing_cast(ArmatureModifier, x) for x in mesh_object.modifiers if x.type == 'ARMATURE']
for armature_object in map(lambda x: x.object, armature_modifiers):
if armature_object is not None:
armature_objects.add(armature_object)
yield from armature_objects
def get_collection_from_context(context: Context) -> Optional[Collection]:
if context.space_data is None or context.space_data.type != 'PROPERTIES':
return None
space_data = typing_cast(SpaceProperties, context.space_data)
if space_data.use_pin_id:
return typing_cast(Collection, space_data.pin_id)
else:
return context.collection
def get_collection_export_operator_from_context(context: Context) -> Optional[object]:
collection = get_collection_from_context(context)
if collection is None or collection.active_exporter_index is None:
return None
if 0 > collection.active_exporter_index >= len(collection.exporters):
return None
exporter = collection.exporters[collection.active_exporter_index]
return exporter.export_properties

View File

@@ -21,6 +21,7 @@ class PSX_UL_bone_collection_list(UIList):
class PSX_PG_bone_collection_list_item(PropertyGroup): class PSX_PG_bone_collection_list_item(PropertyGroup):
armature_object_name: StringProperty() armature_object_name: StringProperty()
armature_data_name: StringProperty()
name: StringProperty() name: StringProperty()
index: IntProperty() index: IntProperty()
count: IntProperty() count: IntProperty()
@@ -28,6 +29,7 @@ class PSX_PG_bone_collection_list_item(PropertyGroup):
class PSX_PG_action_export(PropertyGroup): class PSX_PG_action_export(PropertyGroup):
group: StringProperty(name='Group', description='The group of the sequence', maxlen=64)
compression_ratio: FloatProperty(name='Compression Ratio', default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames') compression_ratio: FloatProperty(name='Compression Ratio', default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames')
key_quota: IntProperty(name='Key Quota', default=0, min=1, description='The minimum number of frames to be exported') key_quota: IntProperty(name='Key Quota', default=0, min=1, description='The minimum number of frames to be exported')
fps: FloatProperty(name='FPS', default=30.0, min=0.0, description='The frame rate of the exported sequence') fps: FloatProperty(name='FPS', default=30.0, min=0.0, description='The frame rate of the exported sequence')
@@ -48,12 +50,16 @@ class PSX_PT_action(Panel):
def draw(self, context: 'Context'): def draw(self, context: 'Context'):
action = context.active_action action = context.active_action
layout = self.layout layout = self.layout
assert layout is not None
flow = layout.grid_flow(columns=1) flow = layout.grid_flow(columns=1)
flow.use_property_split = True flow.use_property_split = True
flow.use_property_decorate = False flow.use_property_decorate = False
flow.prop(action.psa_export, 'compression_ratio') psa_export = getattr(action, 'psa_export')
flow.prop(action.psa_export, 'key_quota') assert psa_export
flow.prop(action.psa_export, 'fps') flow.prop(psa_export, 'compression_ratio')
flow.prop(psa_export, 'key_quota')
flow.prop(psa_export, 'fps')
flow.prop(psa_export, 'group', placeholder='Group')
bone_filter_mode_items = ( bone_filter_mode_items = (
@@ -93,7 +99,7 @@ def up_axis_update(self, __context):
self.forward_axis = next((axis for axis in axis_identifiers if axis != self.up_axis), 'X') self.forward_axis = next((axis for axis in axis_identifiers if axis != self.up_axis), 'X')
class ForwardUpAxisMixin: class AxisMixin:
forward_axis: EnumProperty( forward_axis: EnumProperty(
name='Forward', name='Forward',
items=forward_items, items=forward_items,
@@ -108,6 +114,16 @@ class ForwardUpAxisMixin:
) )
class TransformMixin(AxisMixin):
scale: FloatProperty(
name='Scale',
default=1.0,
description='Scale factor to apply to all location data',
soft_min=0.0,
soft_max=100.0
)
export_space_items = [ export_space_items = [
('WORLD', 'World', 'Export in world space'), ('WORLD', 'World', 'Export in world space'),
('ARMATURE', 'Armature', 'Export the local space of the armature object'), ('ARMATURE', 'Armature', 'Export the local space of the armature object'),
@@ -139,9 +155,17 @@ class PsxBoneExportMixin:
) )
classes = ( class PSX_PG_scene_export(PropertyGroup, TransformMixin):
pass
_classes = (
PSX_PG_scene_export,
PSX_PG_action_export, PSX_PG_action_export,
PSX_PG_bone_collection_list_item, PSX_PG_bone_collection_list_item,
PSX_UL_bone_collection_list, PSX_UL_bone_collection_list,
PSX_PT_action, PSX_PT_action,
) )
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -1,4 +1,5 @@
from bpy.types import UILayout import bpy
from bpy.types import Context, UILayout, Panel
from .types import bone_filter_mode_items from .types import bone_filter_mode_items
@@ -16,3 +17,43 @@ def draw_bone_filter_mode(layout: UILayout, pg, should_always_show_bone_collecti
item_layout = row.row(align=True) item_layout = row.row(align=True)
item_layout.prop_enum(pg, 'bone_filter_mode', item_identifier) item_layout.prop_enum(pg, 'bone_filter_mode', item_identifier)
item_layout.enabled = should_always_show_bone_collections or is_bone_filter_mode_item_available(pg, identifier) item_layout.enabled = should_always_show_bone_collections or is_bone_filter_mode_item_available(pg, identifier)
class PSX_PT_scene(Panel):
bl_idname = 'PSX_PT_scene'
bl_label = 'PSK Export'
bl_space_type = 'PROPERTIES'
bl_region_type = 'WINDOW'
bl_context = 'scene'
bl_category = 'PSK/PSA'
@classmethod
def poll(cls, context):
return context.scene is not None
def draw(self, context: Context):
layout = self.layout
scene = bpy.context.scene
psx_export = getattr(scene, 'psx_export', None)
if psx_export is None:
return
# Transform
transform_header, transform_panel = layout.panel('Transform', default_closed=False)
transform_header.label(text='Transform')
if transform_panel:
flow = layout.grid_flow(columns=1)
flow.use_property_split = True
flow.use_property_decorate = False
flow.prop(psx_export, 'scale')
flow.prop(psx_export, 'forward_axis')
flow.prop(psx_export, 'up_axis')
_classes = (
PSX_PT_scene,
)
from bpy.utils import register_classes_factory
register, unregister = register_classes_factory(_classes)

View File

@@ -10,3 +10,6 @@ branch = true
[tool.coverage.report] [tool.coverage.report]
ignore_errors = true ignore_errors = true
[tool.pyright]
reportInvalidTypeForm = false

35
test.sh Executable file
View File

@@ -0,0 +1,35 @@
#!/usr/bin/env bash
# Exit immediately if a command exits with a non-zero status
set -e
# Function to find an available container command (podman or docker)
find_container_cli() {
if command -v podman &> /dev/null; then
echo "podman"
elif command -v docker &> /dev/null; then
echo "docker"
else
echo ""
fi
}
CONTAINER_CLI=$(find_container_cli)
if [ -z "$CONTAINER_CLI" ]; then
echo "Error: Neither Podman nor Docker was found. Please install one of them to proceed."
exit 1
fi
echo "Using container CLI: $CONTAINER_CLI"
# Build the image and capture its ID
# The '-q' flag is supported by both podman and docker build to suppress output and return only the image ID.
IMAGE_ID=$($CONTAINER_CLI build -q .)
# Run the container using the selected CLI and captured image ID
$CONTAINER_CLI run -it \
--volume "${PWD}:/io_scene_psk_psa:z" \
--volume "${PWD}/io_scene_psk_psa:/addons/io_scene_psk_psa:z" \
--volume "${PWD}/tests:/tests:z" \
"$IMAGE_ID"

BIN
tests/data/Bat.psk LFS Normal file

Binary file not shown.

View File

@@ -1,9 +1,13 @@
import bpy import bpy
import pytest import pytest
from typing import cast as typing_cast
from bpy.types import Mesh, Armature
SUZANNE_FILEPATH = 'tests/data/Suzanne.psk' SUZANNE_FILEPATH = 'tests/data/Suzanne.psk'
SARGE_FILEPATH = 'tests/data/CS_Sarge_S0_Skelmesh.pskx' SARGE_FILEPATH = 'tests/data/CS_Sarge_S0_Skelmesh.pskx'
SLURP_MONSTER_AXE_FILEPATH = 'tests/data/Slurp_Monster_Axe_LOD0.psk' SLURP_MONSTER_AXE_FILEPATH = 'tests/data/Slurp_Monster_Axe_LOD0.psk'
BAT_FILEPATH = 'tests/data/Bat.psk'
@pytest.fixture(autouse=True) @pytest.fixture(autouse=True)
@@ -28,14 +32,14 @@ def test_psk_import_all():
assert armature_object is not None, "Armature object not found in the scene" assert armature_object is not None, "Armature object not found in the scene"
assert len(armature_object.children) == 1, "Armature object should have one child" assert len(armature_object.children) == 1, "Armature object should have one child"
armature_data = armature_object.data armature_data = typing_cast(Armature, armature_object.data)
assert len(armature_data.bones) == 1, "Armature should have one bone" assert len(armature_data.bones) == 1, "Armature should have one bone"
mesh_object = bpy.data.objects.get('Suzanne.001', None) mesh_object = bpy.data.objects.get('Suzanne.001', None)
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert len(mesh_data.vertices) == 507 assert len(mesh_data.vertices) == 507
assert len(mesh_data.polygons) == 968 assert len(mesh_data.polygons) == 968
@@ -49,11 +53,11 @@ def test_psk_import_armature_only():
armature_object = bpy.data.objects.get('Suzanne', None) armature_object = bpy.data.objects.get('Suzanne', None)
assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE"
assert armature_object is not None, "Armature object not found in the scene" assert armature_object is not None, "Armature object not found in the scene"
assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE"
assert len(armature_object.children) == 0, "Armature object should have no children" assert len(armature_object.children) == 0, "Armature object should have no children"
armature_data = armature_object.data armature_data = typing_cast(Armature, armature_object.data)
assert len(armature_data.bones) == 1, "Armature should have one bone" assert len(armature_data.bones) == 1, "Armature should have one bone"
@@ -65,10 +69,10 @@ def test_psk_import_mesh_only():
) == {'FINISHED'} ) == {'FINISHED'}
mesh_object = bpy.data.objects.get('Suzanne', None) mesh_object = bpy.data.objects.get('Suzanne', None)
assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert len(mesh_data.vertices) == 507 assert len(mesh_data.vertices) == 507
assert len(mesh_data.polygons) == 968 assert len(mesh_data.polygons) == 968
@@ -104,7 +108,7 @@ def test_psk_import_bone_length():
assert armature_object is not None, "Armature object not found in the scene" assert armature_object is not None, "Armature object not found in the scene"
assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE" assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE"
armature_data = armature_object.data armature_data = typing_cast(Armature, armature_object.data)
assert armature_data is not None, "Armature data not found in the scene" assert armature_data is not None, "Armature data not found in the scene"
assert len(armature_data.bones) == 1, "Armature should have one bone" assert len(armature_data.bones) == 1, "Armature should have one bone"
assert 'ROOT' in armature_data.bones, "Armature should have a bone named 'ROOT'" assert 'ROOT' in armature_data.bones, "Armature should have a bone named 'ROOT'"
@@ -125,7 +129,7 @@ def test_psk_import_with_vertex_normals():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert mesh_data.has_custom_normals, "Mesh should have custom normals" assert mesh_data.has_custom_normals, "Mesh should have custom normals"
@@ -141,7 +145,7 @@ def test_psk_import_without_vertex_normals():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert not mesh_data.has_custom_normals, "Mesh should not have custom normals" assert not mesh_data.has_custom_normals, "Mesh should not have custom normals"
@@ -158,7 +162,7 @@ def test_psk_import_with_vertex_colors_srgba():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert len(mesh_data.color_attributes) == 1, "Mesh should have one vertex color layer" assert len(mesh_data.color_attributes) == 1, "Mesh should have one vertex color layer"
assert mesh_data.color_attributes[0].name == 'VERTEXCOLOR', "Vertex color layer should be named 'VERTEXCOLOR'" assert mesh_data.color_attributes[0].name == 'VERTEXCOLOR', "Vertex color layer should be named 'VERTEXCOLOR'"
@@ -177,7 +181,7 @@ def test_psk_import_vertex_colors_linear():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert len(mesh_data.color_attributes) == 1, "Mesh should have one vertex color layer" assert len(mesh_data.color_attributes) == 1, "Mesh should have one vertex color layer"
assert mesh_data.color_attributes[0].name == 'VERTEXCOLOR', "Vertex color layer should be named 'VERTEXCOLOR'" assert mesh_data.color_attributes[0].name == 'VERTEXCOLOR', "Vertex color layer should be named 'VERTEXCOLOR'"
@@ -195,7 +199,7 @@ def test_psk_import_without_vertex_colors():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert len(mesh_data.color_attributes) == 0, "Mesh should not have any vertex color layers" assert len(mesh_data.color_attributes) == 0, "Mesh should not have any vertex color layers"
@@ -212,13 +216,19 @@ def test_psk_import_extra_uvs():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert len(mesh_data.uv_layers) == 2, "Mesh should have two UV layers" assert len(mesh_data.uv_layers) == 2, "Mesh should have two UV layers"
assert mesh_data.uv_layers[0].name == 'UVMap', "First UV layer should be named 'UVMap'" assert mesh_data.uv_layers[0].name == 'UVMap', "First UV layer should be named 'UVMap'"
assert mesh_data.uv_layers[1].name == 'EXTRAUV0', "Second UV layer should be named 'EXTRAUV0'" assert mesh_data.uv_layers[1].name == 'EXTRAUV0', "Second UV layer should be named 'EXTRAUV0'"
# Verify that the data is actually different
assert mesh_data.uv_layers[0].uv[0].vector.x == 0.92480468750
assert mesh_data.uv_layers[0].uv[0].vector.y == 0.90533447265625
assert mesh_data.uv_layers[1].uv[0].vector.x == 3.0517578125e-05
assert mesh_data.uv_layers[1].uv[0].vector.y == 0.999969482421875
def test_psk_import_materials(): def test_psk_import_materials():
assert bpy.ops.psk.import_file( assert bpy.ops.psk.import_file(
@@ -230,7 +240,7 @@ def test_psk_import_materials():
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
mesh_data = mesh_object.data mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data not found in the scene" assert mesh_data is not None, "Mesh data not found in the scene"
assert len(mesh_data.materials) == 4, "Mesh should have four materials" assert len(mesh_data.materials) == 4, "Mesh should have four materials"
@@ -241,6 +251,7 @@ def test_psk_import_materials():
'CS_Sarge_S0_MI' 'CS_Sarge_S0_MI'
) )
for i, material in enumerate(mesh_data.materials): for i, material in enumerate(mesh_data.materials):
assert material is not None, f"Material {i} should not be None"
assert material.name == material_names[i], f"Material {i} name should be {material_names[i]}" assert material.name == material_names[i], f"Material {i} name should be {material_names[i]}"
@@ -253,7 +264,9 @@ def test_psk_import_shape_keys():
mesh_object = bpy.data.objects.get('Slurp_Monster_Axe_LOD0', None) mesh_object = bpy.data.objects.get('Slurp_Monster_Axe_LOD0', None)
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
assert mesh_object.data.shape_keys is not None, "Mesh object should have shape keys" mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data should not be None"
assert mesh_data.shape_keys is not None, "Mesh object should have shape keys"
shape_key_names = ( shape_key_names = (
'MORPH_BASE', 'MORPH_BASE',
@@ -263,10 +276,13 @@ def test_psk_import_shape_keys():
'Blob02', 'Blob02',
'Blob01', 'Blob01',
) )
shape_keys = mesh_object.data.shape_keys.key_blocks shape_keys = mesh_data.shape_keys.key_blocks
assert len(shape_keys) == 6, "Mesh object should have 6 shape keys" assert len(shape_keys) == 6, "Mesh object should have 6 shape keys"
for i, shape_key in enumerate(shape_keys): for i, shape_key in enumerate(shape_keys):
assert shape_key.name == shape_key_names[i], f"Shape key {i} name should be {shape_key_names[i]}" expected_value = 1.0 if i == 0 else 0.0
assert shape_key.value == expected_value, f"Shape key {shape_key.name} should have a value of {expected_value} (found {shape_key.value})"
assert shape_key.name == shape_key_names[i], f"Shape key {i} name should be named {shape_key_names[i]}"
def test_psk_import_without_shape_keys(): def test_psk_import_without_shape_keys():
assert bpy.ops.psk.import_file( assert bpy.ops.psk.import_file(
@@ -278,5 +294,14 @@ def test_psk_import_without_shape_keys():
mesh_object = bpy.data.objects.get('Slurp_Monster_Axe_LOD0', None) mesh_object = bpy.data.objects.get('Slurp_Monster_Axe_LOD0', None)
assert mesh_object is not None, "Mesh object not found in the scene" assert mesh_object is not None, "Mesh object not found in the scene"
assert mesh_object.type == 'MESH', "Mesh object type should be MESH" assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
assert mesh_object.data.shape_keys is None, "Mesh object should not have shape keys"
mesh_data = typing_cast(Mesh, mesh_object.data)
assert mesh_data is not None, "Mesh data should not be None"
assert mesh_data.shape_keys is None, "Mesh object should not have shape keys"
def test_psk_import_with_invalid_faces():
assert bpy.ops.psk.import_file(
filepath=BAT_FILEPATH,
components='MESH'
) == {'FINISHED'}

View File

@@ -1 +1,3 @@
pytest pytest
pytest-cov
psk-psa-py

6
tests/test.sh Normal file → Executable file
View File

@@ -1,6 +1,8 @@
# This file is meant to be executed inside a Docker container. # usr/bin/env bash
# This file is meant to be executed from inside a Docker container.
# To run tests on the host system, use the `test.sh` script in the root directory.
export BLENDER_EXECUTABLE=$(cat /blender_executable_path) export BLENDER_EXECUTABLE=$(cat /blender_executable_path)
pytest --cov-report xml --cov=/root/.config/blender -svv tests --blender-executable $BLENDER_EXECUTABLE --blender-addons-dirs ../addons pytest --cov-report xml --cov=/root/.config/blender -svv tests --blender-executable $BLENDER_EXECUTABLE --blender-addons-dirs ../addons
# Fixes the paths in the coverage report to be relative to the current directory. # Fixes the paths in the coverage report to be relative to the current directory.
sed -i 's|/root/.config/blender||g' coverage.xml sed -i 's|/root/.config/blender||g' coverage.xml
sed -i 's|4.4/scripts/addons/io_scene_psk_psa/||g' coverage.xml sed -i 's|5.0/scripts/addons/io_scene_psk_psa/||g' coverage.xml